wxJavaScript

back to gui 

wxAuiPaneInfo

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

wxAuiPaneInfo specifies all the parameters for a pane. These parameters specify where the pane is on the screen, whether it is docked or floating, or hidden. In addition, these parameters specify the pane's docked position, floating position, preferred size, minimum size, caption text among many other parameters.

Constants

wxAuiPaneInsertLevel

Name	Description
PANE
ROW
DOCK

wxAuiPaneInsertLevel is ported as a separate JavaScript object.

Constructor

wxAuiPaneInfo

wxAuiPaneInfo()
 

wxAuiPaneInfo(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
bestSize	wxSize	Get/Sets the ideal size for the pane.
bottomDockable	Boolean	Indicates whether a pane can be docked at the bottom of the frame
caption	String	Get/Set the caption of the pane.
captionVisible	Boolean	Indicates that a pane caption should be visible. If false, no pane caption is drawn.
closeButton	Boolean	Indicates that a close button should be drawn for the pane.
destroyOnClose	Boolean	Indicates whether a pane should be destroyed when it is closed. Normally a pane is simply hidden when the close button is clicked. Setting destroyOnClose to true will cause the window to be destroyed when the user clicks the pane's close button.
direction	Integer	Get/Set the direction of the docked pane.
dockFixed	Boolean	Causes the containing dock to have no resize sash. This is useful for creating panes that span the entire width or height of a dock, but should not be resizable in the other direction.
dockable	Boolean	Specifies whether a frame can be docked or not.
docked	Boolean	Is the pane docked?
fixed	Boolean	Forces a pane to be fixed size so that it cannot be resized
floatable	Boolean	Sets whether the user will be able to undock a pane and turn it into a floating window.
floating	Boolean	Is the pane floating?
floatingPosition	wxPoint	Get/Sets the position of the floating pane.
floatingSize	wxSize	Get/Sets the size of the floating pane.
gripper	Boolean	Indicates that a gripper should be drawn for the pane.
gripperTop	Boolean	Indicates that a gripper should be drawn at the top of the pane
maximizeButton	Boolean	Indicates that a maximize button should be drawn for the pane.
minimizeButton	Boolean	Indicates that a minimize button should be drawn for the pane.
moveable	Boolean	Is the frame movable?
name	String	Gets/Sets the name of the pane so it can be referenced in lookup functions. If a name is not specified by the user, a random name is assigned to the pane when it is added to the manager.
ok	Boolean	Returns true if the wxAuiPaneInfo object is valid. A pane is valid if it has an associated window.
paneBorder	Boolean	Indicates that a border should be drawn for the pane.
pinButton	Boolean	Indicates that a pin button should be drawn for the pane.
position	Integer	The position of the docked pane.
resizeable	Boolean	Allows a pane to be resized if the property is true, and forces it to be a fixed size if the property is false.
row	Integer	The row of the docked pane.
toolbar	Boolean	Returns true if the pane contains a toolbar.

Methods

bottom

bottom() : wxAuiPaneInfo
 

Sets the pane dock position to the bottom side of the frame.

center

center() : wxAuiPaneInfo
 

Sets the pane dock position to the left side of the frame. The center pane is the space in the middle after all border panes (left, top, right, bottom) are subtracted from the layout. Can also be called as centre.

centerPane

centerPane() : wxAuiPaneInfo
 

centerPane specifies that the pane should adopt the default center pane settings. Center panes usually do not have caption bars. This function provides an easy way of preparing a pane to be displayed in the center dock position. Can also be called as centrePane.

defaultPane

defaultPane() : wxAuiPaneInfo
 

Specifies that the pane should adopt the default pane settings.

dock

dock() : wxAuiPaneInfo
 

indicates that a pane should be docked.

float

float() : wxAuiPaneInfo
 

indicates that a pane should be docked.

hide

hide() : wxAuiPaneInfo
 

Hide the pane

layer

layer(Layer) : wxAuiPaneInfo
 

Name	Type	Default	Description
Layer	Integer

Determines the layer of the docked pane. The dock layer is similar to an onion, the inner-most layer being layer 0. Each shell moving in the outward direction has a higher layer number. This allows for more complex docking layout formation.

left

left() : wxAuiPaneInfo
 

Sets the pane dock position to the left side of the frame.

right

right() : wxAuiPaneInfo
 

Sets the pane dock position to the right side of the frame.

show

show(Sw = true) : wxAuiPaneInfo
 

Name	Type	Default	Description
Sw	Boolean	true

Show/hide the pane

top

top() : wxAuiPaneInfo
 

Sets the pane dock position to the top side of the frame.