AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated; added IsVertical()

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@23813 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2003-09-22 12:29:36 +00:00
parent 9446dc2642
commit 0a4e332382
1 changed files with 33 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/latex/wx/gauge.tex
View File

@ -20,8 +20,8 @@ There are no user commands for the gauge.
\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\_SMOOTH}}{Under Windows 95, creates smooth progress bar with one pixel wide update step.}
%\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}.
@ -36,6 +36,7 @@ wxGauge is read-only so generates no events.
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxGauge::wxGauge}\label{wxgaugeconstr}
\func{}{wxGauge}{\void}
@ -64,21 +65,18 @@ Constructor, creating and showing a gauge.
\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}
\membersection{wxGauge::\destruct{wxGauge}}
\func{}{\destruct{wxGauge}}{\void}
Destructor, destroying the gauge.
\membersection{wxGauge::Create}\label{wxgaugecreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
@ -88,6 +86,7 @@ Destructor, destroying the gauge.
Creates the gauge for two-step construction. See \helpref{wxGauge::wxGauge}{wxgaugeconstr}\rtfsp
for further details.
\membersection{wxGauge::GetBezelFace}\label{wxgaugegetbezelface}
\constfunc{int}{GetBezelFace}{\void}
@ -96,22 +95,28 @@ Returns the width of the 3D bezel face.
\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}
\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}
\membersection{wxGauge::GetShadowWidth}\label{wxgaugegetshadowwidth}
\constfunc{int}{GetShadowWidth}{\void}
@ -120,22 +125,36 @@ Returns the 3D shadow margin width.
\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}
\membersection{wxGauge::GetValue}\label{wxgaugegetvalue}
\constfunc{int}{GetValue}{\void}
Returns the current position of the gauge.
\wxheading{Remarks}
This method is not implemented (doesn't do anything) for most platforms.
\wxheading{See also}
\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}
\func{void}{SetBezelFace}{\param{int }{width}}
@ -144,12 +163,13 @@ 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}
\membersection{wxGauge::SetRange}\label{wxgaugesetrange}
\func{void}{SetRange}{\param{int }{range}}
@ -160,6 +180,7 @@ Sets the range (maximum value) of the gauge.
\helpref{wxGauge::GetRange}{wxgaugegetrange}
\membersection{wxGauge::SetShadowWidth}\label{wxgaugesetshadowwidth}
\func{void}{SetShadowWidth}{\param{int }{width}}
@ -168,7 +189,8 @@ 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}