/////////////////////////////////////////////////////////////////////////////
// Name: gauge.h
-// Purpose: documentation for wxGauge class
+// Purpose: interface of wxGauge
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxGauge
@wxheader{gauge.h}
-
- A gauge is a horizontal or vertical bar which shows a quantity (often time).
-
+
+ A gauge is a horizontal or vertical bar which shows a quantity (often
+ time).
+
wxGauge supports two working modes: determinate and indeterminate progress.
-
- The first is the usual working mode (see wxGauge::SetValue
- and wxGauge::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 wxGauge::Pulse
- 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).
-
+
+ The first is the usual working mode (see SetValue() and 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() 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).
+
wxGauge supports dynamic switch between these two work modes.
-
+
There are no user commands for the gauge.
-
+
@beginStyleTable
- @style{wxGA_HORIZONTAL}:
+ @style{wxGA_HORIZONTAL}
Creates a horizontal gauge.
- @style{wxGA_VERTICAL}:
+ @style{wxGA_VERTICAL}
Creates a vertical gauge.
- @style{wxGA_SMOOTH}:
+ @style{wxGA_SMOOTH}
Creates smooth progress bar with one pixel wide update step (not
supported by all platforms).
@endStyleTable
-
+
@library{wxcore}
@category{ctrl}
- @appearance{gauge.png}
-
- @seealso
- wxSlider, wxScrollBar
+ <!-- @appearance{gauge.png} -->
+
+ @see wxSlider, wxScrollBar
*/
class wxGauge : public wxControl
{
public:
- //@{
/**
- Constructor, creating and showing a gauge.
-
- @param parent
- Window parent.
-
- @param id
- Window identifier.
-
- @param range
- Integer range (maximum value) of the gauge. It is ignored when the gauge is
- used in indeterminate mode.
-
- @param pos
- Window position.
-
- @param size
- Window size.
-
- @param style
- Gauge style. See wxGauge.
-
- @param name
- Window name.
-
- @sa Create()
+ Default constructor.
*/
wxGauge();
- 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 = "gauge");
- //@}
+ /**
+ Constructor, creating and showing a gauge.
+
+ @param parent
+ Window parent.
+ @param id
+ Window identifier.
+ @param range
+ Integer range (maximum value) of the gauge. It is ignored when the
+ gauge is used in indeterminate mode.
+ @param pos
+ Window position.
+ @param size
+ Window size.
+ @param style
+ Gauge style.
+ @param name
+ Window name.
+
+ @see Create()
+ */
+ 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 = "gauge");
/**
Destructor, destroying the gauge.
~wxGauge();
/**
- Creates the gauge for two-step construction. See wxGauge()
- for further details.
+ Creates the gauge for two-step construction. See wxGauge() for further
+ details.
*/
bool Create(wxWindow* parent, wxWindowID id, int range,
const wxPoint& pos = wxDefaultPosition,
/**
Returns the width of the 3D bezel face.
-
+
@remarks This method is not implemented (returns 0) for most platforms.
-
- @sa SetBezelFace()
+
+ @see SetBezelFace()
*/
- int GetBezelFace();
+ int GetBezelFace() const;
/**
Returns the maximum position of the gauge.
-
- @sa SetRange()
+
+ @see SetRange()
*/
- int GetRange();
+ int GetRange() const;
/**
Returns the 3D shadow margin width.
-
+
@remarks This method is not implemented (returns 0) for most platforms.
-
- @sa SetShadowWidth()
+
+ @see SetShadowWidth()
*/
- int GetShadowWidth();
+ int GetShadowWidth() const;
/**
Returns the current position of the gauge.
-
- @sa SetValue()
+
+ @see SetValue()
*/
- int GetValue();
+ int GetValue() const;
/**
- Returns @true if the gauge is vertical (has @c wxGA_VERTICAL style) and
+ Returns @true if the gauge is vertical (has @c wxGA_VERTICAL style) and
@false otherwise.
*/
- bool IsVertical();
+ bool IsVertical() const;
/**
- 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 GetValue()
- is undefined and thus you need to explicitely call SetValue() if you
- want to restore the determinate mode.
+ 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 After calling this function the value returned by GetValue() is
+ undefined and thus you need to explicitely call SetValue() if you
+ want to restore the determinate mode.
*/
void Pulse();
/**
Sets the 3D bezel face width.
-
+
@remarks This method is not implemented (doesn't do anything) for most
- platforms.
-
- @sa GetBezelFace()
+ platforms.
+
+ @see GetBezelFace()
*/
void SetBezelFace(int width);
/**
- Sets the range (maximum value) of the gauge.
- This function makes the gauge switch to determinate mode, if it's not already.
-
- @sa GetRange()
+ Sets the range (maximum value) of the gauge. This function makes the
+ gauge switch to determinate mode, if it's not already.
+
+ @see GetRange()
*/
void SetRange(int range);
/**
Sets the 3D shadow width.
-
+
@remarks This method is not implemented (doesn't do anything) for most
- platforms.
+ platforms.
*/
void SetShadowWidth(int width);
/**
- Sets the position of the gauge. The @e pos must be between 0 and the gauge
- range as returned by GetRange(), inclusive.
-
+ Sets the position of the gauge. The @a pos must be between 0 and the
+ gauge range as returned by GetRange(), inclusive.
+
This function makes the gauge switch to determinate mode, if it was in
indeterminate mode before.
-
- @param pos
- Position for the gauge level.
-
- @sa GetValue()
+
+ @param pos
+ Position for the gauge level.
+
+ @see GetValue()
*/
void SetValue(int pos);
};
+
projects / wxWidgets.git / blobdiff