docs/latex/wx/wnddisbl.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        wnddsbl.tex
   3 %% Purpose:     wxWindowDisabler class documentation
   4 %% Author:      Vadim Zeitlin
   5 %% Modified by:
   6 %% Created:     03.03.00
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) Vadim Zeitlin
   9 %% License:     wxWidgets license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxWindowDisabler}}\label{wxwindowdisabler}
  13
  14 This class disables all windows of the application (may be with the exception
  15 of one of them) in its constructor and enables them back in its destructor.
  16 This comes in handy when you want to indicate to the user that the application
  17 is currently busy and cannot respond to user input.
  18
  19 \wxheading{Derived from}
  20
  21 None
  22
  23 \wxheading{Include files}
  24
  25 <wx/utils.h>
  26
  27 \wxheading{See also}
  28
  29 \helpref{wxBusyCursor}{wxbusycursor}
  30
  31 \latexignore{\rtfignore{\wxheading{Members}}}
  32
  33 \membersection{wxWindowDisabler::wxWindowDisabler}\label{wxwindowdisablerctor}
  34
  35 \func{}{wxWindowDisabler}{\param{wxWindow *}{winToSkip = NULL}}
  36
  37 Disables all top level windows of the applications with the exception of
  38 {\it winToSkip} if it is not {\tt NULL}.
  39
  40 \membersection{wxWindowDisabler::\destruct{wxWindowDisabler}}\label{wxwindowdisablerdtor}
  41
  42 \func{}{\destruct{wxWindowDisabler}}{\void}
  43
  44 Reenables back the windows disabled by the constructor.
  45