nobody at rubyforge.org
2007-Apr-13 19:12 UTC
[Wxruby-development] [949] branches/wxruby2/wxwidgets_282: Changes in Gauge API 2.6->2.8, remove comment cruft in header
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type"
content="text/html; charset=utf-8" /><style
type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:'':'';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family:
verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;
font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding:
6px; }
#msg ul, pre { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid;
padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family:
verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch
.binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[949] branches/wxruby2/wxwidgets_282: Changes in Gauge API
2.6->2.8, remove comment cruft in header</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd>949</dd>
<dt>Author</dt> <dd>brokentoy</dd>
<dt>Date</dt> <dd>2007-04-13 15:12:30 -0400 (Fri, 13 Apr
2007)</dd>
</dl>
<h3>Log Message</h3>
<pre>Changes in Gauge API 2.6->2.8, remove comment cruft in
header</pre>
<h3>Modified Paths</h3>
<ul>
<li><a
href="#brancheswxruby2wxwidgets_282doctextilegaugetxtl">branches/wxruby2/wxwidgets_282/doc/textile/gauge.txtl</a></li>
<li><a
href="#brancheswxruby2wxwidgets_282swigclassesincludewxGaugeh">branches/wxruby2/wxwidgets_282/swig/classes/include/wxGauge.h</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a
id="brancheswxruby2wxwidgets_282doctextilegaugetxtl"></a>
<div class="modfile"><h4>Modified:
branches/wxruby2/wxwidgets_282/doc/textile/gauge.txtl (948 => 949)</h4>
<pre class="diff"><span>
<span class="info">---
branches/wxruby2/wxwidgets_282/doc/textile/gauge.txtl        2007-04-11
18:32:08 UTC (rev 948)
+++
branches/wxruby2/wxwidgets_282/doc/textile/gauge.txtl        2007-04-13
19:12:30 UTC (rev 949)
</span><span class="lines">@@ -1,6 +1,19 @@
</span><span class="cx"> h1(#wxgauge). Wx::Gauge
</span><span class="cx">
</span><span class="cx"> A gauge is a horizontal or
vertical bar which shows a quantity (often time).
</span><ins>+
+Gauge supports two working modes: determinate and indeterminate progress.
+
+The first is the usual working mode (see "set_value":#Gauge_setvalue
+and "set_range":#Gauge_setrange) while the second can be used when
+the program is doing some processing but you don''t know how much
progress is
+being done.
+In this case, you can periodically call the "Pulse":gaugepulse.html
+function to make the progress bar switch to indeterminate mode (graphically
+it''s usually a set of blocks which move or bounce in the bar control).
+
+Gauge supports dynamic switch between these two work modes.
+
</ins><span class="cx"> There are no user commands for the
gauge.
</span><span class="cx">
</span><span class="cx"> h2. Derived from
</span><span class="lines">@@ -47,6 +60,7 @@
</span><span class="cx"> *
"Gauge#set_range":#Gauge_setrange
</span><span class="cx"> *
"Gauge#set_shadow_width":#Gauge_setshadowwidth
</span><span class="cx"> *
"Gauge#set_value":#Gauge_setvalue
</span><ins>+* "Gauge#pulse":#Gauge_pulse
</ins><span class="cx">
</span><span class="cx"> </div>
</span><span class="cx">
</span><span class="lines">@@ -67,7 +81,7 @@
</span><span class="cx">
</span><span class="cx"> * _parent_ Window parent.
</span><span class="cx"> * _id_ Window identifier.
</span><del>-* _range_ Integer range (maximum value) of the gauge.
</del><ins>+* _range_ Integer range (maximum value) of the gauge. It
is ignored when the gauge is used in indeterminate mode.
</ins><span class="cx"> * _pos_ Window position.
</span><span class="cx"> * _size_ Window size.
</span><span class="cx"> * _style_ Gauge style. See
"Gauge":gauge.html.
</span><span class="lines">@@ -116,10 +130,6 @@
</span><span class="cx">
</span><span class="cx"> Returns the maximum position of
the gauge.
</span><span class="cx">
</span><del>-h4. Remarks
-
-This method is not implemented (doesn''t do anything) for most
platforms.
-
</del><span class="cx"> h4. See also
</span><span class="cx">
</span><span class="cx">
"Gauge#set_range":gauge.html#Gauge_setrange
</span><span class="lines">@@ -179,6 +189,7 @@
</span><span class="cx"> *set_range*(%(arg-type)Integer%
range)
</span><span class="cx">
</span><span class="cx"> Sets the range (maximum value) of
the gauge.
</span><ins>+This function makes the gauge switch to determinate
mode, if it''s not already.
</ins><span class="cx">
</span><span class="cx"> h4. See also
</span><span class="cx">
</span><span class="lines">@@ -201,6 +212,7 @@
</span><span class="cx"> *set_value*(%(arg-type)Integer%
pos)
</span><span class="cx">
</span><span class="cx"> Sets the position of the gauge.
</span><ins>+This function makes the gauge switch to determinate
mode, if it''s not already.
</ins><span class="cx">
</span><span class="cx"> h4. Parameters
</span><span class="cx">
</span><span class="lines">@@ -211,3 +223,14 @@
</span><span class="cx">
"Gauge#get_value":gauge.html#Gauge_getvalue
</span><span class="cx">
</span><span class="cx">
</span><ins>+h3(#Gauge_pulse). Gauge#pulse
+
+ *pulse*()
+
+Switch the gauge to indeterminate mode (if required) and makes the gauge move
+a bit to indicate the user that some progress has been made.
+
+Note that after calling this function the value returned by
"get_value":#Gauge_getvalue
+is undefined and thus you need to explicitely call
"set_value":#Gauge_setvalue if you
+want to restore the determinate mode.
+
</ins></span></pre></div>
<a
id="brancheswxruby2wxwidgets_282swigclassesincludewxGaugeh"></a>
<div class="modfile"><h4>Modified:
branches/wxruby2/wxwidgets_282/swig/classes/include/wxGauge.h (948 =>
949)</h4>
<pre class="diff"><span>
<span class="info">---
branches/wxruby2/wxwidgets_282/swig/classes/include/wxGauge.h        2007-04-11
18:32:08 UTC (rev 948)
+++
branches/wxruby2/wxwidgets_282/swig/classes/include/wxGauge.h        2007-04-13
19:12:30 UTC (rev 949)
</span><span class="lines">@@ -1,93 +1,23 @@
</span><del>-// wxGauge.h
-// This file was automatically generated
-// by extractxml.rb, part of the wxRuby project
-// Do not make changes directly to this file!
</del><ins>+// Copyright 2004-2007 by Kevin Smith
+// released under the MIT-style wxruby2 license
</ins><span class="cx">
</span><span class="cx"> #if !defined(_wxGauge_h_)
</span><span class="cx"> #define _wxGauge_h_
</span><span class="cx"> class wxGauge : public wxControl
</span><span class="cx"> {
</span><span class="cx"> public:
</span><del>-        /**
-         *
\brief Default constructor.
-        */
-
</del><span class="cx"> wxGauge() ;
</span><del>-        /**
-         *
\brief Constructor, creating and showing a gauge.
-         *
\param wxWindow*
-         *
\param wxWindowID
-         *
\param int
-         *
\param const wxPoint&
-         *
\param const wxSize&
-         *
\param long
-         *
\param const wxValidator&
-         *
\param const wxString&
-        */
-
</del><span class="cx"> wxGauge(wxWindow* parent ,
wxWindowID id , int range , const wxPoint& pos = wxDefaultPosition, const
wxSize& size = wxDefaultSize, long style = wxGA_HORIZONTAL, const
wxValidator& validator = wxDefaultValidator, const wxString& name =
wxT("gauge")) ;
</span><del>-        /**
-         *
\brief Destructor, destroying the gauge.
-        */
-
</del><span class="cx"> virtual ~wxGauge() ;
</span><del>-        /**
-         *
\brief Creates the gauge for two-step construction. See
-for further details.
-         *
\param wxWindow*
-         *
\param wxWindowID
-         *
\param int
-         *
\param const wxPoint&
-         *
\param const wxSize&
-         *
\param long
-         *
\param const wxValidator&
-         *
\param const wxString&
-        */
-
</del><span class="cx"> bool Create(wxWindow* parent ,
wxWindowID id , int range , const wxPoint& pos = wxDefaultPosition, const
wxSize& size = wxDefaultSize, long style = wxGA_HORIZONTAL, const
wxValidator& validator = wxDefaultValidator, const wxString& name =
wxT("gauge")) ;
</span><del>-        /**
-         *
\brief Returns the width of the 3D bezel face.
-        */
-
</del><span class="cx"> int GetBezelFace() const;
</span><del>-        /**
-         *
\brief Returns the maximum position of the gauge.
-        */
-
</del><span class="cx"> int GetRange() const;
</span><del>-        /**
-         *
\brief Returns the 3D shadow margin width.
-        */
-
</del><span class="cx"> int GetShadowWidth() const;
</span><del>-        /**
-         *
\brief Returns the current position of the gauge.
-        */
-
</del><span class="cx"> int GetValue() const;
</span><del>-        /**
-         *
\brief Sets the 3D bezel face width.
-         *
\param int
-        */
-
</del><ins>+ void Pulse();
</ins><span class="cx"> void SetBezelFace(int width ) ;
</span><del>-        /**
-         *
\brief Sets the range (maximum value) of the gauge.
-         *
\param int
-        */
-
</del><span class="cx"> void SetRange(int range ) ;
</span><del>-        /**
-         *
\brief Sets the 3D shadow width.
-         *
\param int
-        */
-
</del><span class="cx"> void SetShadowWidth(int width )
;
</span><del>-        /**
-         *
\brief Sets the position of the gauge.
-         *
\param int
-        */
-
</del><span class="cx"> void SetValue(int pos ) ;
</span><span class="cx"> };
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>
Seemingly Similar Threads
- [893] branches/wxruby2/wxwidgets_282: New hover bitmap methods in 2.6 -> 2.8 API
- [883] branches/wxruby2/wxwidgets_282/swig: API changes for move to WxWidgets 2.8
- [950] branches/wxruby2/wxwidgets_282: Changes in GenericDirCtrl API 2.6->2.8, fix TreeItemId mapping, remove cruft
- [977] branches/wxruby2/wxwidgets_282/swig/classes/include/wxScrolledWindow.h: Add missing DoPrepareDC method, remove comment cruft
- [926] branches/wxruby2/wxwidgets_282: Update Dialog wx2.6 -> wx2.8 API, remove deprecations and cruft, update doc
Wisdom of the Ancients
