patch 1306473

[wxWidgets.git] / docs / latex / wx / gauge.tex

diff --git a/docs/latex/wx/gauge.tex b/docs/latex/wx/gauge.tex
index 6f873858159398599107f4a6d6e5ca58fcb83db2..563bdbbc8e88a3f78516bd01cae677ea0cb6ef3c 100644 (file)
--- a/docs/latex/wx/gauge.tex
+++ b/docs/latex/wx/gauge.tex
@@ -7,35 +7,45 @@ There are no user commands for the gauge.
 
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\

-\helpref{wxEvtHandler}{wxEvtHandler}\\
+\helpref{wxEvtHandler}{wxevthandler}\\

 \helpref{wxObject}{wxobject}
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/gauge.h>
+

 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxGA\_HORIZONTAL}}{Creates a horizontal gauge.}
 \twocolitem{\windowstyle{wxGA\_VERTICAL}}{Creates a vertical gauge.}
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 \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\_PROGRESSBAR}}{Obsolete, doesn't do anything any more}
+\twocolitem{\windowstyle{wxGA\_SMOOTH}}{Creates smooth progress bar with one pixel wide update step (not supported by all platforms).}

 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.
 
 \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}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \wxheading{See also}
 
 \helpref{wxSlider}{wxslider}, \helpref{wxScrollBar}{wxscrollbar}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxGauge::wxGauge}\label{wxgaugeconstr}
+
+\membersection{wxGauge::wxGauge}\label{wxgaugector}

 
 \func{}{wxGauge}{\void}
 
 Default constructor.
 
 
 \func{}{wxGauge}{\void}
 
 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.
 
 
 Constructor, creating and showing a gauge.
 


@@ -55,30 +65,28 @@ Constructor, creating and showing a gauge.
 
 \docparam{name}{Window name.}
 
 
 \docparam{name}{Window name.}
 

-\wxheading{Remarks}
-
-Under Windows 95, there are two different styles of gauge: normal gauge, and progress bar (when
-the {\bf wxGA\_PROGRESSBAR} style is used). A progress bar is always horizontal.
-

 \wxheading{See also}
 
 \helpref{wxGauge::Create}{wxgaugecreate}
 
 \wxheading{See also}
 
 \helpref{wxGauge::Create}{wxgaugecreate}
 

-\membersection{wxGauge::\destruct{wxGauge}}
+
+\membersection{wxGauge::\destruct{wxGauge}}\label{wxgaugedtor}

 
 \func{}{\destruct{wxGauge}}{\void}
 
 Destructor, destroying the gauge.
 
 
 \func{}{\destruct{wxGauge}}{\void}
 
 Destructor, destroying the gauge.
 

+

 \membersection{wxGauge::Create}\label{wxgaugecreate}
 
 \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
+Creates the gauge for two-step construction. See \helpref{wxGauge::wxGauge}{wxgaugector}\rtfsp

 for further details.
 
 for further details.
 

+

 \membersection{wxGauge::GetBezelFace}\label{wxgaugegetbezelface}
 
 \constfunc{int}{GetBezelFace}{\void}
 \membersection{wxGauge::GetBezelFace}\label{wxgaugegetbezelface}
 
 \constfunc{int}{GetBezelFace}{\void}


@@ -87,22 +95,28 @@ Returns the width of the 3D bezel face.
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-Windows only, not for {\bf wxGA\_PROGRESSBAR}.
+This method is not implemented (returns $0$) for most platforms.

 
 \wxheading{See also}
 
 \helpref{wxGauge::SetBezelFace}{wxgaugesetbezelface}
 
 
 \wxheading{See also}
 
 \helpref{wxGauge::SetBezelFace}{wxgaugesetbezelface}
 

+

 \membersection{wxGauge::GetRange}\label{wxgaugegetrange}
 
 \constfunc{int}{GetRange}{\void}
 
 Returns the maximum position of the gauge.
 
 \membersection{wxGauge::GetRange}\label{wxgaugegetrange}
 
 \constfunc{int}{GetRange}{\void}
 
 Returns the maximum position of the gauge.
 

+\wxheading{Remarks}
+
+This method is not implemented (doesn't do anything) for most platforms.
+

 \wxheading{See also}
 
 \helpref{wxGauge::SetRange}{wxgaugesetrange}
 
 \wxheading{See also}
 
 \helpref{wxGauge::SetRange}{wxgaugesetrange}
 

+

 \membersection{wxGauge::GetShadowWidth}\label{wxgaugegetshadowwidth}
 
 \constfunc{int}{GetShadowWidth}{\void}
 \membersection{wxGauge::GetShadowWidth}\label{wxgaugegetshadowwidth}
 
 \constfunc{int}{GetShadowWidth}{\void}


@@ -111,12 +125,13 @@ Returns the 3D shadow margin width.
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-Windows only, not for {\bf wxGA\_PROGRESSBAR}.
+This method is not implemented (returns $0$) for most platforms.

 
 \wxheading{See also}
 
 \helpref{wxGauge::SetShadowWidth}{wxgaugesetshadowwidth}
 
 
 \wxheading{See also}
 
 \helpref{wxGauge::SetShadowWidth}{wxgaugesetshadowwidth}
 

+

 \membersection{wxGauge::GetValue}\label{wxgaugegetvalue}
 
 \constfunc{int}{GetValue}{\void}
 \membersection{wxGauge::GetValue}\label{wxgaugegetvalue}
 
 \constfunc{int}{GetValue}{\void}


@@ -127,23 +142,33 @@ Returns the current position of the gauge.
 
 \helpref{wxGauge::SetValue}{wxgaugesetvalue}
 
 
 \helpref{wxGauge::SetValue}{wxgaugesetvalue}
 

+
+\membersection{wxGauge::IsVertical}\label{wxgaugeisvertical}
+
+\constfunc{bool}{IsVertical}{\void}
+
+Returns \true if the gauge is vertical (has \texttt{wxGA\_VERTICAL} style) and 
+\false otherwise.
+
+

 \membersection{wxGauge::SetBezelFace}\label{wxgaugesetbezelface}
 
 \membersection{wxGauge::SetBezelFace}\label{wxgaugesetbezelface}
 

-\func{void}{SetBezelFace}{\param{const int }{width}}
+\func{void}{SetBezelFace}{\param{int }{width}}

 
 Sets the 3D bezel face width.
 
 \wxheading{Remarks}
 
 
 Sets the 3D bezel face width.
 
 \wxheading{Remarks}
 

-Windows only, not for {\bf wxGA\_PROGRESSBAR}.
+This method is not implemented (doesn't do anything) for most platforms.

 
 \wxheading{See also}
 
 \helpref{wxGauge::GetBezelFace}{wxgaugegetbezelface}
 
 
 \wxheading{See also}
 
 \helpref{wxGauge::GetBezelFace}{wxgaugegetbezelface}
 

+

 \membersection{wxGauge::SetRange}\label{wxgaugesetrange}
 
 \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.
 
 
 Sets the range (maximum value) of the gauge.
 


@@ -151,19 +176,21 @@ Sets the range (maximum value) of the gauge.
 
 \helpref{wxGauge::GetRange}{wxgaugegetrange}
 
 
 \helpref{wxGauge::GetRange}{wxgaugegetrange}
 

+

 \membersection{wxGauge::SetShadowWidth}\label{wxgaugesetshadowwidth}
 
 \membersection{wxGauge::SetShadowWidth}\label{wxgaugesetshadowwidth}
 

-\func{void}{SetShadowWidth}{\param{const int }{width}}
+\func{void}{SetShadowWidth}{\param{int }{width}}

 
 Sets the 3D shadow width.
 
 \wxheading{Remarks}
 
 
 Sets the 3D shadow width.
 
 \wxheading{Remarks}
 

-Windows only, not for {\bf wxGA\_PROGRESSBAR}.
+This method is not implemented (doesn't do anything) for most platforms.
+

 
 \membersection{wxGauge::SetValue}\label{wxgaugesetvalue}
 
 
 \membersection{wxGauge::SetValue}\label{wxgaugesetvalue}
 

-\func{void}{SetValue}{\param{const int }{pos}}
+\func{void}{SetValue}{\param{int }{pos}}

 
 Sets the position of the gauge.
 
 
 Sets the position of the gauge.