Moved all interface headers into a 'wx' subdirectory for proper use of Doxygen path settings.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54385 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
53
interface/wx/wupdlock.h
Normal file
53
interface/wx/wupdlock.h
Normal file
@@ -0,0 +1,53 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: wupdlock.h
|
||||
// Purpose: interface of wxWindowUpdateLocker
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
@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:
|
||||
|
||||
@code
|
||||
void MyFrame::Foo()
|
||||
{
|
||||
m_text = new wxTextCtrl(this, ...);
|
||||
|
||||
wxWindowUpdateLocker noUpdates(m_text);
|
||||
m_text-AppendText();
|
||||
... many other operations with m_text...
|
||||
m_text-WriteText();
|
||||
}
|
||||
@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.
|
||||
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
*/
|
||||
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
|
||||
wxWindowUpdateLocker object itself.
|
||||
*/
|
||||
wxWindowUpdateLocker(wxWindow* win);
|
||||
|
||||
/**
|
||||
Destructor reenables updates for the window this object is associated with.
|
||||
*/
|
||||
~wxWindowUpdateLocker();
|
||||
};
|
||||
|
Reference in New Issue
Block a user