X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23ac76056fd0ae75149dab806fc266e6ee9b0115..c36cdfc084f779b67668af8cad3eb6906182af21:/docs/latex/wx/gauge.tex diff --git a/docs/latex/wx/gauge.tex b/docs/latex/wx/gauge.tex index 49bf0d7346..ddef4738db 100644 --- a/docs/latex/wx/gauge.tex +++ b/docs/latex/wx/gauge.tex @@ -27,6 +27,10 @@ There are no user commands for the gauge. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Window styles} \twocolwidtha{5cm} @@ -202,8 +206,11 @@ This method is not implemented (doesn't do anything) for most platforms. \func{void}{SetValue}{\param{int }{pos}} -Sets the position of the gauge. -This function makes the gauge switch to determinate mode, if it's not already. +Sets the position of the gauge. The \arg{pos} must be between $0$ and the gauge +range as returned by \helpref{GetRange}{wxgaugegetrange}, inclusive. + +This function makes the gauge switch to determinate mode, if it was in +indeterminate mode before. \wxheading{Parameters} @@ -224,3 +231,4 @@ a bit to indicate the user that some progress has been made. Note that after calling this function the value returned by \helpref{GetValue}{wxgaugegetvalue} is undefined and thus you need to explicitely call \helpref{SetValue}{wxgaugesetvalue} if you want to restore the determinate mode. +