docs/latex/wx/busycurs.tex

   1 \section{\class{wxBusyCursor}}\label{wxbusycursor}
   2
   3 This class makes it easy to tell your user that the program is temporarily busy.
   4 Just create a wxBusyCursor object on the stack, and within the current scope,
   5 the hourglass will be shown.
   6
   7 For example:
   8
   9 \begin{verbatim}
  10   wxBusyCursor wait;
  11
  12   for (int i = 0; i < 100000; i++)
  13     DoACalculation();
  14 \end{verbatim}
  15
  16 It works by calling \helpref{wxBeginBusyCursor}{wxbeginbusycursor} in the constructor,
  17 and \helpref{wxEndBusyCursor}{wxendbusycursor} in the destructor.
  18
  19 \wxheading{Derived from}
  20
  21 None
  22
  23 \wxheading{Include files}
  24
  25 <wx/utils.h>
  26
  27 \wxheading{Library}
  28
  29 \helpref{wxCore}{librarieslist}
  30
  31 \wxheading{See also}
  32
  33 \helpref{wxBeginBusyCursor}{wxbeginbusycursor},\rtfsp
  34 \helpref{wxEndBusyCursor}{wxendbusycursor},\rtfsp
  35 \helpref{wxWindowDisabler}{wxwindowdisabler}
  36
  37 \latexignore{\rtfignore{\wxheading{Members}}}
  38
  39 \membersection{wxBusyCursor::wxBusyCursor}\label{wxbusycursorctor}
  40
  41 \func{}{wxBusyCursor}{\param{wxCursor*}{ cursor = wxHOURGLASS\_CURSOR}}
  42
  43 Constructs a busy cursor object, calling \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
  44
  45 \membersection{wxBusyCursor::\destruct{wxBusyCursor}}\label{wxbusycursordtor}
  46
  47 \func{}{\destruct{wxBusyCursor}}{\void}
  48
  49 Destroys the busy cursor object, calling \helpref{wxEndBusyCursor}{wxendbusycursor}.
  50