X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/43c48e1e53d74cef62d15f08f015d9efeb45a0c1..b8737371e220ef1920e6a3d2aed88c4bc2b04daf:/interface/wx/gauge.h diff --git a/interface/wx/gauge.h b/interface/wx/gauge.h index a36e7a444a..7ec0c9bfc5 100644 --- a/interface/wx/gauge.h +++ b/interface/wx/gauge.h @@ -3,7 +3,7 @@ // Purpose: interface of wxGauge // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -48,6 +48,7 @@ public: Default constructor. */ wxGauge(); + /** Constructor, creating and showing a gauge. @@ -56,14 +57,17 @@ public: @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. @@ -74,7 +78,7 @@ public: const wxSize& size = wxDefaultSize, long style = wxGA_HORIZONTAL, const wxValidator& validator = wxDefaultValidator, - const wxString& name = "gauge"); + const wxString& name = wxGaugeNameStr); /** Destructor, destroying the gauge. @@ -153,6 +157,10 @@ public: 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);