]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/gauge.tex
Doc tweaks
[wxWidgets.git] / docs / latex / wx / gauge.tex
index 6f873858159398599107f4a6d6e5ca58fcb83db2..b3c01d474538c87ba1b5a6a8b5cb6f841d49a452 100644 (file)
@@ -7,9 +7,13 @@ There are no user commands for the gauge.
 
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
-\helpref{wxEvtHandler}{wxEvtHandler}\\
+\helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/gauge.h>
+
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
@@ -17,10 +21,15 @@ There are no user commands for the gauge.
 \twocolitem{\windowstyle{wxGA\_HORIZONTAL}}{Creates a horizontal gauge.}
 \twocolitem{\windowstyle{wxGA\_VERTICAL}}{Creates a vertical gauge.}
 \twocolitem{\windowstyle{wxGA\_PROGRESSBAR}}{Under Windows 95, creates a horizontal progress bar.}
+\twocolitem{\windowstyle{wxGA\_SMOOTH}}{Under Windows 95, creates smooth progress bar with one pixel wide update step.}
 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.
 
+\wxheading{Event handling}
+
+wxGauge is read-only so generates no events.
+
 \wxheading{See also}
 
 \helpref{wxSlider}{wxslider}, \helpref{wxScrollBar}{wxscrollbar}
@@ -33,9 +42,9 @@ See also \helpref{window styles overview}{windowstyles}.
 
 Default constructor.
 
-\func{}{wxGauge}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp
-\param{const int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
-\param{const long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}}
+\func{}{wxGauge}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
+\param{int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
+\param{long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}}
 
 Constructor, creating and showing a gauge.
 
@@ -72,9 +81,9 @@ Destructor, destroying the gauge.
 
 \membersection{wxGauge::Create}\label{wxgaugecreate}
 
-\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp
-\param{const int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
-\param{const long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}}
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
+\param{int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
+\param{long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}}
 
 Creates the gauge for two-step construction. See \helpref{wxGauge::wxGauge}{wxgaugeconstr}\rtfsp
 for further details.
@@ -129,7 +138,7 @@ Returns the current position of the gauge.
 
 \membersection{wxGauge::SetBezelFace}\label{wxgaugesetbezelface}
 
-\func{void}{SetBezelFace}{\param{const int }{width}}
+\func{void}{SetBezelFace}{\param{int }{width}}
 
 Sets the 3D bezel face width.
 
@@ -143,7 +152,7 @@ Windows only, not for {\bf wxGA\_PROGRESSBAR}.
 
 \membersection{wxGauge::SetRange}\label{wxgaugesetrange}
 
-\func{void}{SetRange}{\param{const int }{range}}
+\func{void}{SetRange}{\param{int }{range}}
 
 Sets the range (maximum value) of the gauge.
 
@@ -153,7 +162,7 @@ Sets the range (maximum value) of the gauge.
 
 \membersection{wxGauge::SetShadowWidth}\label{wxgaugesetshadowwidth}
 
-\func{void}{SetShadowWidth}{\param{const int }{width}}
+\func{void}{SetShadowWidth}{\param{int }{width}}
 
 Sets the 3D shadow width.
 
@@ -163,7 +172,7 @@ Windows only, not for {\bf wxGA\_PROGRESSBAR}.
 
 \membersection{wxGauge::SetValue}\label{wxgaugesetvalue}
 
-\func{void}{SetValue}{\param{const int }{pos}}
+\func{void}{SetValue}{\param{int }{pos}}
 
 Sets the position of the gauge.