wxAuiManager

Implements methods from the following classes

• wxEvtHandler

Methods

• wxAuiManager
  Constructor.
• AddPane
  AddPane() tells the frame manager to start managing a child window.
• DetachPane
  Tells the wxAuiManager to stop managing the pane specified by window.
• GetArtProvider
  Returns the current art provider being used.
• GetDockSizeConstraint
  Returns the current dock constraint values.
• GetFlags
  Returns the current wxAuiManagerOption's flags.
• GetManagedWindow
  Returns the frame currently being managed by wxAuiManager.
• GetPane
  GetPane() is used to lookup a wxAuiPaneInfo object either by window pointer or by pane name, which acts as a unique id for a window pane.
• HideHint
  HideHint() hides any docking hint that may be visible.
• InsertPane
  This method is used to insert either a previously unmanaged pane window into the frame manager, or to insert a currently managed pane somewhere else.
• LoadPaneInfo
  LoadPaneInfo() is similar to LoadPerspective, with the exception that it only loads information about a single pane.
• LoadPerspective
  Loads a saved perspective.
• ProcessDockResult
  ProcessDockResult() is a protected member of the wxAUI layout manager.
• SavePaneInfo
  SavePaneInfo() is similar to SavePerspective, with the exception that it only saves information about a single pane.
• SavePerspective
  Saves the entire user interface layout into an encoded wxString, which can then be stored by the application (probably using wxConfig).
• SetArtProvider
  Instructs wxAuiManager to use art provider specified by parameter art_provider for all drawing calls.
• SetDockSizeConstraint
  When a user creates a new dock by dragging a window into a docked position, often times the large size of the window will create a dock that is unwieldly large.
• SetFlags
  This method is used to specify wxAuiManagerOption's flags.
• SetManagedWindow
  Called to specify the frame or window which is to be managed by wxAuiManager.
• ShowHint
  This function is used by controls to explicitly show a hint window at the specified rectangle.
• UnInit
  Uninitializes the framework and should be called before a managed frame or window is destroyed.
• Update
  This method is called after any number of changes are made to any of the managed panes.

Static Methods

• GetManager
  Calling this method will return the wxAuiManager for a given window.

wxAuiManager

wxAuiManager ( wxWindow &$managed_wnd=NULL, integer $flags=wxAUI_MGR_DEFAULT )

Constructor.

AddPane

bool AddPane ( wxWindow &$window, wxAuiPaneInfo $pane_info, wxPoint $drop_pos )

AddPane() tells the frame manager to start managing a child window.
bool AddPane ( wxWindow &$window, integer $direction=wxLEFT, string $caption=wxEmptyString )

AddPane() tells the frame manager to start managing a child window.
bool AddPane ( wxWindow &$window, wxAuiPaneInfo $pane_info )

AddPane() tells the frame manager to start managing a child window.

DetachPane

bool DetachPane ( wxWindow &$window )

Tells the wxAuiManager to stop managing the pane specified by window.

GetArtProvider

wxAuiDockArt& GetArtProvider ( )

Returns the current art provider being used.

GetDockSizeConstraint

GetDockSizeConstraint ( float &$widthpct, float &$heightpct )

Returns the current dock constraint values.

GetFlags

integer GetFlags ( )

Returns the current wxAuiManagerOption's flags.

GetManagedWindow

wxWindow& GetManagedWindow ( )

Returns the frame currently being managed by wxAuiManager.

GetManager

static wxAuiManager& GetManager ( wxWindow &$window )

Calling this method will return the wxAuiManager for a given window.

GetPane

wxAuiPaneInfo& GetPane ( string $name )

GetPane() is used to lookup a wxAuiPaneInfo object either by window pointer or by pane name, which acts as a unique id for a window pane.
wxAuiPaneInfo& GetPane ( wxWindow &$window )

GetPane() is used to lookup a wxAuiPaneInfo object either by window pointer or by pane name, which acts as a unique id for a window pane.

HideHint

HideHint ( )

HideHint() hides any docking hint that may be visible.

InsertPane

bool InsertPane ( wxWindow &$window, wxAuiPaneInfo $insert_location, integer $insert_level=wxAUI_INSERT_PANE )

This method is used to insert either a previously unmanaged pane window into the frame manager, or to insert a currently managed pane somewhere else.

LoadPaneInfo

LoadPaneInfo ( string $pane_part, wxAuiPaneInfo &$pane )

LoadPaneInfo() is similar to LoadPerspective, with the exception that it only loads information about a single pane.

LoadPerspective

bool LoadPerspective ( string $perspective, bool $update=true )

Loads a saved perspective.

ProcessDockResult

bool ProcessDockResult ( wxAuiPaneInfo &$target, wxAuiPaneInfo $new_pos )

ProcessDockResult() is a protected member of the wxAUI layout manager.

SavePaneInfo

string SavePaneInfo ( wxAuiPaneInfo &$pane )

SavePaneInfo() is similar to SavePerspective, with the exception that it only saves information about a single pane.

SavePerspective

string SavePerspective ( )

Saves the entire user interface layout into an encoded wxString, which can then be stored by the application (probably using wxConfig).

SetArtProvider

SetArtProvider ( wxAuiDockArt &$art_provider )

Instructs wxAuiManager to use art provider specified by parameter art_provider for all drawing calls.

SetDockSizeConstraint

SetDockSizeConstraint ( float $widthpct, float $heightpct )

When a user creates a new dock by dragging a window into a docked position, often times the large size of the window will create a dock that is unwieldly large.

SetFlags

SetFlags ( integer $flags )

This method is used to specify wxAuiManagerOption's flags.

SetManagedWindow

SetManagedWindow ( wxWindow &$managed_wnd )

Called to specify the frame or window which is to be managed by wxAuiManager.

ShowHint

ShowHint ( wxRect $rect )

This function is used by controls to explicitly show a hint window at the specified rectangle.

UnInit

UnInit ( )

Uninitializes the framework and should be called before a managed frame or window is destroyed.

Update

Update ( )

This method is called after any number of changes are made to any of the managed panes.