X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..1b7751aaa9a86d76a850b9267bc0c201e3cea30f:/interface/wx/wupdlock.h diff --git a/interface/wx/wupdlock.h b/interface/wx/wupdlock.h index 525a9a09f6..c95b4d03c4 100644 --- a/interface/wx/wupdlock.h +++ b/interface/wx/wupdlock.h @@ -3,18 +3,17 @@ // Purpose: interface of wxWindowUpdateLocker // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @class wxWindowUpdateLocker - @wxheader{wupdlock.h} - This tiny class prevents redrawing of a wxWindow during its - lifetime by using wxWindow::Freeze and - wxWindow::Thaw methods. It is typically used for creating - automatic objects to temporarily suppress window updates before a batch of - operations is performed: + This tiny class prevents redrawing of a wxWindow during its lifetime by using + wxWindow::Freeze() and wxWindow::Thaw() methods. + + It is typically used for creating automatic objects to temporarily suppress + window updates before a batch of operations is performed: @code void MyFrame::Foo() @@ -28,19 +27,18 @@ } @endcode - Using this class is easier and safer than calling - wxWindow::Freeze and wxWindow::Thaw because you - don't risk to forget calling the latter. + Using this class is easier and safer than calling wxWindow::Freeze() and + wxWindow::Thaw() because you don't risk to forget calling the latter. @library{wxbase} - @category{FIXME} + @category{misc} */ class wxWindowUpdateLocker { public: /** - Creates an object preventing the updates of the specified @e win. The - parameter must be non-@NULL and the window must exist for longer than + Creates an object preventing the updates of the specified @e win. + The parameter must be non-@NULL and the window must exist for longer than wxWindowUpdateLocker object itself. */ wxWindowUpdateLocker(wxWindow* win);