wxJavaScript

back to gui 

wxAuiManager

^{generated from ../src/mod_gui/control/auimgr.cpp}

wxAuiManager is the central class of the wxAUI class framework.

Constants

Name	Description
INSERT_PANE
INSERT_ROW
INSERT_DOCK

wxAuiManagerDock

Name	Description
NONE
TOP
RIGHT
BOTTOM
LEFT
CENTER
CENTRE

wxAuiManagerDock is ported as a separate JavaScript object.

Constructor

wxAuiManager

wxAuiManager()
 

wxAuiManager(ManagedWindow, 
             Option = wxAuiManagerOption.DEFAULT)
 

Name	Type	Default	Description
ManagedWindow	wxWindow		The wxFrame which should be managed
Option	Integer	wxAuiManagerOption.DEFAULT

Constructs a new wxAuiManager.

Properties

Name	Type	Description
allPanes	Array	Array with all pane info (see wxAuiPaneInfo).
dockSizeConstraint	Array	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. wxAuiManager by default limits the size of any new dock to 1/3 of the window size. For horizontal docks, this would be 1/3 of the window height. For vertical docks, 1/3 of the width. Setting this property will adjust this constraint value. The numbers must be between 0.0 and 1.0. For instance, setting dockSizeContraint to [0.5, 0.5] will cause new docks to be limited to half of the size of the entire managed window.
flags	Integer
managedWindow	wxWindow	Get/Set the frame or window which is to be managed by wxAuiManager.

Methods

addPane

addPane(Window, 
        PaneInfo) : Boolean
 

Name	Type	Default	Description
Window	wxWindow
PaneInfo	wxAuiPaneInfo

addPane(Window, 
        Direction = wxDirection.LEFT, 
        Caption = "") : Boolean
 

Name	Type	Default	Description
Window	wxWindow
Direction	Integer	wxDirection.LEFT
Caption	String

addPane(Window, 
        PaneInfo, 
        Pos) : Boolean
 

Name	Type	Default	Description
Window	wxWindow
PaneInfo	wxAuiPaneInfo
Pos	wxPoint

addPane() tells the frame manager to start managing a child window. There are several versions of this function. The first version allows the full spectrum of pane parameter possibilities. The second version is used for simpler user interfaces which do not require as much configuration. The last version allows a drop position to be specified, which will determine where the pane will be added.

detachPane

detachPane(Window) : Boolean
 

Name	Type	Default	Description
Window	wxWindow

Tells the wxAuiManager to stop managing the pane specified by window. The window, if in a floated frame, is reparented to the frame managed by wxAuiManager.

getPane

getPane(Window) : wxAuiPaneInfo
 

Name	Type	Default	Description
Window	wxWindow

getPane(Name) : wxAuiPaneInfo
 

Name	Type	Default	Description
Name	String

getPane is used to lookup a wxAuiPaneInfo object either by window or by pane name, which acts as a unique id for a window pane. The returned wxAuiPaneInfo object may then be modified to change a pane's look, state or position. After one or more modifications to wxAuiPaneInfo, update should be called to commit the changes to the user interface. If the lookup failed (meaning the pane could not be found in the manager), ok will return false.

hideHint

hideHint()
 

Hides any docking hint that may be visible.

insertPane

insertPane(Window, 
           InsertLocation, 
           InsertLevel = wxAuiManager.INSERT_PANE) : Boolean
 

Name	Type	Default	Description
Window	wxWindow
InsertLocation	wxAuiPaneInfo
InsertLevel	Integer	wxAuiManager.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. insertPane will push all panes, rows, or docks aside and insert the window into the position specified by InsertLocation. Because InsertLocation can specify either a pane, dock row, or dock layer, the InsertLevel parameter is used to disambiguate this. The parameter InsertLevel can take a value of wxAuiManager.INSERT_PANE, wxAuiManager.INSERT_ROW or wxAuiManager.INSERT_DOCK.

loadPaneInfo

loadPaneInfo(PanePart, 
             Pane)
 

Name	Type	Default	Description
PanePart	String
Pane	wxAuiPaneInfo

loadPaneInfo is similar to to loadPerspective, with the exception that it only loads information about a single pane. It is used in combination with savePaneInfo.

loadPerspective

loadPerspective(Perspective, 
                Update = true) : Boolean
 

Name	Type	Default	Description
Perspective	String
Update	Boolean	true

Loads a saved perspective. If Update is true, update is automatically invoked, thus realizing the saved perspective on screen.

savePaneInfo

savePaneInfo(Pane) : String
 

Name	Type	Default	Description
Pane	wxAuiPaneInfo

savePaneInfo is similar to savePerspective, with the exception that it only saves information about a single pane. It is used in combination with loadPaneInfo.

savePerspective

savePerspective() : String
 

Saves the entire user interface layout into an encoded wxString, which can then be stored by the application (probably using wxConfig). When a perspective is restored using loadPerspective, the entire user interface will return to the state it was when the perspective was saved.

showHint

showHint(Rect)
 

Name	Type	Default	Description
Rect	wxRect

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. update must be invoked after addPane or insertPane are called in order to "realize" or "commit" the changes. In addition, any number of changes may be made to wxAuiPaneInfo structures (retrieved with getPane), but to realize the changes, update must be called. This construction allows pane flicker to be avoided by updating the whole layout at one time.