X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12fd0e1d61b9dc33137ddbd09b3d946e66ce82b7..33baee46ee5c2476ac75d7893bf2272a65e525ab:/interface/wx/gauge.h?ds=sidebyside diff --git a/interface/wx/gauge.h b/interface/wx/gauge.h index 2ac9e8934c..1abe6bca20 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,8 +57,9 @@ 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 @@ -136,7 +138,7 @@ public: 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. */ virtual void Pulse(); @@ -155,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);