docstring fix

[wxWidgets.git] / docs / latex / wx / wnddisbl.tex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name:        wnddsbl.tex
%% Purpose:     wxWindowDisabler class documentation
%% Author:      Vadim Zeitlin
%% Modified by:
%% Created:     03.03.00
%% RCS-ID:      $Id$
%% Copyright:   (c) Vadim Zeitlin
%% License:     wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{\class{wxWindowDisabler}}\label{wxwindowdisabler}

This class disables all windows of the application (may be with the exception
of one of them) in its constructor and enables them back in its destructor.
This comes in handy when you want to indicate to the user that the application
is currently busy and cannot respond to user input.

\wxheading{Derived from}

None

\wxheading{Include files}

<wx/utils.h>

\wxheading{See also}

\helpref{wxBusyCursor}{wxbusycursor}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxWindowDisabler::wxWindowDisabler}\label{wxwindowdisablerctor}

\func{}{wxWindowDisabler}{\param{wxWindow *}{winToSkip = NULL}}

Disables all top level windows of the applications with the exception of 
{\it winToSkip} if it is not {\tt NULL}.

\membersection{wxWindowDisabler::\destruct{wxWindowDisabler}}\label{wxwindowdisablerdtor}

\func{}{\destruct{wxWindowDisabler}}{\void}

Reenables back the windows disabled by the constructor.