docs/latex/wx/gauge.tex

   1 \section{\class{wxGauge}}\label{wxgauge}
   2
   3 A gauge is a horizontal or vertical bar which shows a quantity (often time).
   4 There are no user commands for the gauge.
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxControl}{wxcontrol}\\
   9 \helpref{wxWindow}{wxwindow}\\
  10 \helpref{wxEvtHandler}{wxevthandler}\\
  11 \helpref{wxObject}{wxobject}
  12
  13 \wxheading{Include files}
  14
  15 <wx/gauge.h>
  16
  17 \wxheading{Window styles}
  18
  19 \twocolwidtha{5cm}
  20 \begin{twocollist}\itemsep=0pt
  21 \twocolitem{\windowstyle{wxGA\_HORIZONTAL}}{Creates a horizontal gauge.}
  22 \twocolitem{\windowstyle{wxGA\_VERTICAL}}{Creates a vertical gauge.}
  23 %\twocolitem{\windowstyle{wxGA\_PROGRESSBAR}}{Obsolete, doesn't do anything any more}
  24 \twocolitem{\windowstyle{wxGA\_SMOOTH}}{Creates smooth progress bar with one pixel wide update step (not supported by all platforms).}
  25 \end{twocollist}
  26
  27 See also \helpref{window styles overview}{windowstyles}.
  28
  29 \wxheading{Event handling}
  30
  31 wxGauge is read-only so generates no events.
  32
  33 \wxheading{See also}
  34
  35 \helpref{wxSlider}{wxslider}, \helpref{wxScrollBar}{wxscrollbar}
  36
  37 \latexignore{\rtfignore{\wxheading{Members}}}
  38
  39
  40 \membersection{wxGauge::wxGauge}\label{wxgaugector}
  41
  42 \func{}{wxGauge}{\void}
  43
  44 Default constructor.
  45
  46 \func{}{wxGauge}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
  47 \param{int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
  48 \param{long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}}
  49
  50 Constructor, creating and showing a gauge.
  51
  52 \wxheading{Parameters}
  53
  54 \docparam{parent}{Window parent.}
  55
  56 \docparam{id}{Window identifier.}
  57
  58 \docparam{range}{Integer range (maximum value) of the gauge.}
  59
  60 \docparam{pos}{Window position.}
  61
  62 \docparam{size}{Window size.}
  63
  64 \docparam{style}{Gauge style. See \helpref{wxGauge}{wxgauge}.}
  65
  66 \docparam{name}{Window name.}
  67
  68 \wxheading{See also}
  69
  70 \helpref{wxGauge::Create}{wxgaugecreate}
  71
  72
  73 \membersection{wxGauge::\destruct{wxGauge}}\label{wxgaugedtor}
  74
  75 \func{}{\destruct{wxGauge}}{\void}
  76
  77 Destructor, destroying the gauge.
  78
  79
  80 \membersection{wxGauge::Create}\label{wxgaugecreate}
  81
  82 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
  83 \param{int}{ range}, \param{const wxPoint\& }{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
  84 \param{long}{ style = wxGA\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``gauge"}}
  85
  86 Creates the gauge for two-step construction. See \helpref{wxGauge::wxGauge}{wxgaugector}\rtfsp
  87 for further details.
  88
  89
  90 \membersection{wxGauge::GetBezelFace}\label{wxgaugegetbezelface}
  91
  92 \constfunc{int}{GetBezelFace}{\void}
  93
  94 Returns the width of the 3D bezel face.
  95
  96 \wxheading{Remarks}
  97
  98 This method is not implemented (returns $0$) for most platforms.
  99
 100 \wxheading{See also}
 101
 102 \helpref{wxGauge::SetBezelFace}{wxgaugesetbezelface}
 103
 104
 105 \membersection{wxGauge::GetRange}\label{wxgaugegetrange}
 106
 107 \constfunc{int}{GetRange}{\void}
 108
 109 Returns the maximum position of the gauge.
 110
 111 \wxheading{Remarks}
 112
 113 This method is not implemented (doesn't do anything) for most platforms.
 114
 115 \wxheading{See also}
 116
 117 \helpref{wxGauge::SetRange}{wxgaugesetrange}
 118
 119
 120 \membersection{wxGauge::GetShadowWidth}\label{wxgaugegetshadowwidth}
 121
 122 \constfunc{int}{GetShadowWidth}{\void}
 123
 124 Returns the 3D shadow margin width.
 125
 126 \wxheading{Remarks}
 127
 128 This method is not implemented (returns $0$) for most platforms.
 129
 130 \wxheading{See also}
 131
 132 \helpref{wxGauge::SetShadowWidth}{wxgaugesetshadowwidth}
 133
 134
 135 \membersection{wxGauge::GetValue}\label{wxgaugegetvalue}
 136
 137 \constfunc{int}{GetValue}{\void}
 138
 139 Returns the current position of the gauge.
 140
 141 \wxheading{See also}
 142
 143 \helpref{wxGauge::SetValue}{wxgaugesetvalue}
 144
 145
 146 \membersection{wxGauge::IsVertical}\label{wxgaugeisvertical}
 147
 148 \constfunc{bool}{IsVertical}{\void}
 149
 150 Returns \true if the gauge is vertical (has \texttt{wxGA\_VERTICAL} style) and
 151 \false otherwise.
 152
 153
 154 \membersection{wxGauge::SetBezelFace}\label{wxgaugesetbezelface}
 155
 156 \func{void}{SetBezelFace}{\param{int }{width}}
 157
 158 Sets the 3D bezel face width.
 159
 160 \wxheading{Remarks}
 161
 162 This method is not implemented (doesn't do anything) for most platforms.
 163
 164 \wxheading{See also}
 165
 166 \helpref{wxGauge::GetBezelFace}{wxgaugegetbezelface}
 167
 168
 169 \membersection{wxGauge::SetRange}\label{wxgaugesetrange}
 170
 171 \func{void}{SetRange}{\param{int }{range}}
 172
 173 Sets the range (maximum value) of the gauge.
 174
 175 \wxheading{See also}
 176
 177 \helpref{wxGauge::GetRange}{wxgaugegetrange}
 178
 179
 180 \membersection{wxGauge::SetShadowWidth}\label{wxgaugesetshadowwidth}
 181
 182 \func{void}{SetShadowWidth}{\param{int }{width}}
 183
 184 Sets the 3D shadow width.
 185
 186 \wxheading{Remarks}
 187
 188 This method is not implemented (doesn't do anything) for most platforms.
 189
 190
 191 \membersection{wxGauge::SetValue}\label{wxgaugesetvalue}
 192
 193 \func{void}{SetValue}{\param{int }{pos}}
 194
 195 Sets the position of the gauge.
 196
 197 \wxheading{Parameters}
 198
 199 \docparam{pos}{Position for the gauge level.}
 200
 201 \wxheading{See also}
 202
 203 \helpref{wxGauge::GetValue}{wxgaugegetvalue}
 204
 205