4f4c5fcfdf
This is a combination of running clang-tidy with modernize-use-nullptr check for some ports (GTK, X11, OSX) and manual changes to the ports for which it couldn't be used easily (MSW, DFB) and also manually updating the docs. Also replace NULL with null or nullptr in the comments as this is more consistent with the use of nullptr in the code and makes it simpler to grep for the remaining occurrences of NULL itself. And also use null in the assert messages. Only a few occurrences of "NULL" are still left in non-C files, mostly corresponding to unclear comments or string output which it might not be safe to change.
73 lines
2.1 KiB
Objective-C
73 lines
2.1 KiB
Objective-C
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wupdlock.h
|
|
// Purpose: interface of wxWindowUpdateLocker
|
|
// Author: wxWidgets team
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
@class wxWindowUpdateLocker
|
|
|
|
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{misc}
|
|
*/
|
|
class wxWindowUpdateLocker
|
|
{
|
|
public:
|
|
/**
|
|
Default constructor doesn't do anything.
|
|
|
|
Prefer using the non-default constructor if possible, this constructor
|
|
is only useful if Lock() must be called conditionally, i.e. if it may
|
|
or not be called depending on some run-time condition.
|
|
|
|
@since 3.1.4
|
|
*/
|
|
wxWindowUpdateLocker();
|
|
|
|
/**
|
|
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.
|
|
*/
|
|
explicit wxWindowUpdateLocker(wxWindow* win);
|
|
|
|
/**
|
|
Really lock window updates.
|
|
|
|
This method can only be called on an object initialized using the
|
|
default constructor.
|
|
|
|
@param win Non-@NULL window which must exist for longer than this object.
|
|
|
|
@since 3.1.4
|
|
*/
|
|
void Lock(wxWindow *win);
|
|
|
|
/**
|
|
Destructor reenables updates for the window this object is associated with.
|
|
*/
|
|
~wxWindowUpdateLocker();
|
|
};
|
|
|