// Purpose: interface of wxGauge
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
+
+// ----------------------------------------------------------------------------
+// wxGauge style flags
+// ----------------------------------------------------------------------------
+
+#define wxGA_HORIZONTAL wxHORIZONTAL
+#define wxGA_VERTICAL wxVERTICAL
+
+// Win32 only, is default (and only) on some other platforms
+#define wxGA_SMOOTH 0x0020
+
/**
@class wxGauge
- @wxheader{gauge.h}
A gauge is a horizontal or vertical bar which shows a quantity (often
time).
@library{wxcore}
@category{ctrl}
- <!-- @appearance{gauge.png} -->
+ @appearance{gauge}
@see wxSlider, wxScrollBar
*/
Default constructor.
*/
wxGauge();
+
/**
Constructor, creating and showing a gauge.
@param id
Window identifier.
@param range
- Integer range (maximum value) of the gauge. It is ignored when the
- gauge is used in indeterminate mode.
+ Integer range (maximum value) of the gauge.
+ See SetRange() for more details about the meaning of this value
+ when using the gauge in indeterminate mode.
@param pos
Window position.
@param size
Window size.
@param style
Gauge style.
+ @param validator
+ Window validator.
@param name
Window name.
const wxSize& size = wxDefaultSize,
long style = wxGA_HORIZONTAL,
const wxValidator& validator = wxDefaultValidator,
- const wxString& name = "gauge");
+ const wxString& name = wxGaugeNameStr);
/**
Destructor, destroying the gauge.
*/
- ~wxGauge();
+ virtual ~wxGauge();
/**
Creates the gauge for two-step construction. See wxGauge() for further
*/
bool Create(wxWindow* parent, wxWindowID id, int range,
const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = wxGA_HORIZONTAL,
+ const wxSize& size = wxDefaultSize, long style = wxGA_HORIZONTAL,
const wxValidator& validator = wxDefaultValidator,
- const wxString& name = "gauge");
+ const wxString& name = wxGaugeNameStr);
/**
Returns the width of the 3D bezel face.
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
+ undefined and thus you need to explicitly call SetValue() if you
want to restore the determinate mode.
*/
- void Pulse();
+ virtual void Pulse();
/**
Sets the 3D bezel face width.
Sets the range (maximum value) of the gauge. This function makes the
gauge switch to determinate mode, if it's not already.
+ When the gauge is in indeterminate mode, under wxMSW the gauge
+ repeatedly goes from zero to @a range and back; under other ports
+ when in indeterminate mode, the @a range setting is ignored.
+
@see GetRange()
*/
void SetRange(int range);