X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..40c53d1b49569facfd71e30ef56d26df790621c4:/interface/gauge.h?ds=sidebyside diff --git a/interface/gauge.h b/interface/gauge.h index b9a3fd1cb4..94bda71bfe 100644 --- a/interface/gauge.h +++ b/interface/gauge.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: gauge.h -// Purpose: documentation for wxGauge class +// Purpose: interface of wxGauge // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -40,8 +40,7 @@ @category{ctrl} @appearance{gauge.png} - @seealso - wxSlider, wxScrollBar + @see wxSlider, wxScrollBar */ class wxGauge : public wxControl { @@ -49,7 +48,7 @@ public: //@{ /** Constructor, creating and showing a gauge. - + @param parent Window parent. @param id @@ -65,7 +64,7 @@ public: Gauge style. See wxGauge. @param name Window name. - + @see Create() */ wxGauge(); @@ -95,41 +94,41 @@ public: /** Returns the width of the 3D bezel face. - + @remarks This method is not implemented (returns 0) for most platforms. - + @see SetBezelFace() */ - int GetBezelFace(); + int GetBezelFace() const; /** Returns the maximum position of the gauge. - + @see SetRange() */ - int GetRange(); + int GetRange() const; /** Returns the 3D shadow margin width. - + @remarks This method is not implemented (returns 0) for most platforms. - + @see SetShadowWidth() */ - int GetShadowWidth(); + int GetShadowWidth() const; /** Returns the current position of the gauge. - + @see SetValue() */ - int GetValue(); + int GetValue() const; /** 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 @@ -142,10 +141,10 @@ public: /** Sets the 3D bezel face width. - + @remarks This method is not implemented (doesn't do anything) for most platforms. - + @see GetBezelFace() */ void SetBezelFace(int width); @@ -153,14 +152,14 @@ public: /** 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. */ @@ -171,11 +170,12 @@ public: 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. - + @see GetValue() */ void SetValue(int pos); }; +