| 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: wxWindows 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{Library} |
| 28 | |
| 29 | \helpref{wxCore}{librarieslist} |
| 30 | |
| 31 | \wxheading{See also} |
| 32 | |
| 33 | \helpref{wxBusyCursor}{wxbusycursor} |
| 34 | |
| 35 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 36 | |
| 37 | \membersection{wxWindowDisabler::wxWindowDisabler}\label{wxwindowdisablerctor} |
| 38 | |
| 39 | \func{}{wxWindowDisabler}{\param{wxWindow *}{winToSkip = NULL}} |
| 40 | |
| 41 | Disables all top level windows of the applications with the exception of |
| 42 | {\it winToSkip} if it is not {\tt NULL}. |
| 43 | |
| 44 | \membersection{wxWindowDisabler::\destruct{wxWindowDisabler}}\label{wxwindowdisablerdtor} |
| 45 | |
| 46 | \func{}{\destruct{wxWindowDisabler}}{\void} |
| 47 | |
| 48 | Reenables back the windows disabled by the constructor. |
| 49 | |