Version: 3.0.4
wxWindow::ChildrenRepositioningGuard Class Reference

#include <wx/window.h>

Detailed Description

Helper for ensuring EndRepositioningChildren() is called correctly.

This class wraps the calls to BeginRepositioningChildren() and EndRepositioningChildren() by performing the former in its constructor and the latter in its destructor if, and only if, the first call returned true. This is the simplest way to call these methods and if this class is created as a local variable, it also ensures that EndRepositioningChildren() is correctly called (or not) on scope exit, so its use instead of calling these methods manually is highly recommended.

Since
2.9.5

Public Member Functions

 ChildrenRepositioningGuard (wxWindow *win)
 Constructor calls wxWindow::BeginRepositioningChildren(). More...
 
 ~ChildrenRepositioningGuard ()
 Destructor calls wxWindow::EndRepositioningChildren() if necessary. More...
 

Constructor & Destructor Documentation

wxWindow::ChildrenRepositioningGuard::ChildrenRepositioningGuard ( wxWindow win)
explicit

Constructor calls wxWindow::BeginRepositioningChildren().

Parameters
winThe window to call BeginRepositioningChildren() on. If it is NULL, nothing is done.
wxWindow::ChildrenRepositioningGuard::~ChildrenRepositioningGuard ( )

Destructor calls wxWindow::EndRepositioningChildren() if necessary.

EndRepositioningChildren() is called only if a valid window was passed to the constructor and if BeginRepositioningChildren() returned true.