wx.aui.AuiPaneInfo¶ wx.aui.AuiPaneInfo is part of the AUI class framework.
See also AUI Overview.
wx.aui.AuiPaneInfo 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.
See also
wx.aui.AuiManager, wx.aui.AuiDockArt
Class Hierarchy¶
Inheritance diagram for class AuiPaneInfo:

Methods Summary¶
|
|
|
|
|
|
|
|
CaptionVisible indicates that a pane caption should be visible. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
wx.DataObject.Direction determines the direction of the docked pane. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
wx.Icon sets the icon of the pane. |
|
|
|
Returns |
|
|
|
|
|
|
|
|
|
|
|
IsMoveable() returns |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Movable indicates whether a frame can be moved. |
|
|
|
PaneBorder indicates that a border should be drawn for the pane. |
|
|
|
wx.Position determines the position of the docked pane. |
|
|
|
|
|
|
|
|
|
Write the safe parts of a PaneInfo object “source” into “this”. |
|
|
|
|
|
|
|
|
|
|
|
wx.Window assigns the window pointer that the wx.aui.AuiPaneInfo should use. |
Properties Summary¶A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
|
A public C++ attribute of type |
Class API¶wx.aui.AuiPaneInfo(object)¶Possible constructors:
AuiPaneInfo()
AuiPaneInfo(c)
AuiPaneInfo is part of the AUI class framework.
__init__(self, *args, **kw)¶__init__ (self)
__init__ (self, c)
Copy constructor.
c (wx.aui.AuiPaneInfo) –
BestSize(self, *args, **kw)¶BestSize sets the ideal size for the pane.
The docking manager will attempt to use this size as much as possible when docking or floating the pane.
BestSize (self, size)
size (wx.Size) –
BestSize (self, x, y)
x (int) –
y (int) –
Bottom(self)¶wx.Bottom sets the pane dock position to the bottom side of the frame.
This is the same thing as calling Direction(wxAUI_DOCK_BOTTOM).
BottomDockable(self, b=True)¶BottomDockable indicates whether a pane can be docked at the bottom of the frame.
b (bool) –
CaptionVisible(self, visible=True)¶CaptionVisible indicates that a pane caption should be visible.
If False, no pane caption is drawn.
visible (bool) –
Center(self)¶wx.Center sets the pane dock position to the left side of the frame.
The centre pane is the space in the middle after all border panes (left, top, right, bottom) are subtracted from the layout. This is the same thing as calling Direction(wxAUI_DOCK_CENTRE).
CenterPane(self)¶CentrePane specifies that the pane should adopt the default center pane settings.
Centre 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.
Centre(self)¶wx.Center sets the pane dock position to the left side of the frame.
The centre pane is the space in the middle after all border panes (left, top, right, bottom) are subtracted from the layout. This is the same thing as calling Direction(wxAUI_DOCK_CENTRE).
CentrePane(self)¶CentrePane specifies that the pane should adopt the default center pane settings.
Centre 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.
CloseButton(self, visible=True)¶CloseButton indicates that a close button should be drawn for the pane.
visible (bool) –
DefaultPane(self)¶DefaultPane specifies that the pane should adopt the default pane settings.
DestroyOnClose(self, b=True)¶DestroyOnClose 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.
b (bool) –
Direction(self, direction)¶wx.DataObject.Direction determines the direction of the docked pane.
It is functionally the same as calling wx.Left , wx.Right , wx.Top or wx.Bottom , except that docking direction may be specified programmatically via the parameter.
direction (int) –
DockFixed(self, b=True)¶DockFixed 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.
b (bool) –
Dockable(self, b=True)¶Dockable specifies whether a frame can be docked or not.
It is the same as specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b).
b (bool) –
Fixed(self)¶Fixed forces a pane to be fixed size so that it cannot be resized.
After calling Fixed , IsFixed will return True.
Float(self)¶Float indicates that a pane should be floated.
It is the opposite of Dock .
Floatable(self, b=True)¶Floatable sets whether the user will be able to undock a pane and turn it into a floating window.
b (bool) –
FloatingPosition(self, *args, **kw)¶FloatingPosition sets the position of the floating pane.
FloatingPosition (self, pos)
pos (wx.Point) –
FloatingPosition (self, x, y)
x (int) –
y (int) –
FloatingSize(self, *args, **kw)¶FloatingSize sets the size of the floating pane.
FloatingSize (self, size)
size (wx.Size) –
FloatingSize (self, x, y)
x (int) –
y (int) –
Gripper(self, visible=True)¶Gripper indicates that a gripper should be drawn for the pane.
visible (bool) –
GripperTop(self, attop=True)¶GripperTop indicates that a gripper should be drawn at the top of the pane.
attop (bool) –
HasCaption(self)¶HasCaption returns True if the pane displays a caption.
bool
HasCloseButton(self)¶HasCloseButton returns True if the pane displays a button to close the pane.
bool
HasFlag(self, flag)¶HasFlag returns True if the property specified by flag is active for the pane.
flag (int) –
bool
HasGripper(self)¶HasGripper returns True if the pane displays a gripper.
bool
HasGripperTop(self)¶HasGripper returns True if the pane displays a gripper at the top.
bool
HasMaximizeButton(self)¶HasMaximizeButton returns True if the pane displays a button to maximize the pane.
bool
HasMinimizeButton(self)¶HasMinimizeButton returns True if the pane displays a button to minimize the pane.
bool
HasPinButton(self)¶HasPinButton returns True if the pane displays a button to float the pane.
bool
Icon(self, b)¶wx.Icon sets the icon of the pane.
Notice that the height of the icon should be smaller than the value returned by AuiDockArt.GetMetric(wxAUI_DOCKART_CAPTION_SIZE) to ensure that it appears correctly.
b (wx.BitmapBundle) –
New in version 2.9.2.
IsBottomDockable(self)¶IsBottomDockable returns True if the pane can be docked at the bottom of the managed frame.
bool
See also
IsDockable(self)¶Returns True if the pane can be docked at any side.
bool
New in version 2.9.2.
See also
IsTopDockable , IsBottomDockable , IsLeftDockable , IsRightDockable
IsFloatable(self)¶IsFloatable returns True if the pane can be undocked and displayed as a floating window.
bool
IsFloating(self)¶IsFloating returns True if the pane is floating.
bool
IsLeftDockable(self)¶IsLeftDockable returns True if the pane can be docked on the left of the managed frame.
bool
See also
IsMovable(self)¶IsMoveable() returns True if the docked frame can be undocked or moved to another dock position.
bool
IsOk(self)¶IsOk returns True if the wx.aui.AuiPaneInfo structure is valid.
A pane structure is valid if it has an associated window.
bool
IsResizable(self)¶IsResizable returns True if the pane can be resized.
bool
IsRightDockable(self)¶IsRightDockable returns True if the pane can be docked on the right of the managed frame.
bool
See also
IsTopDockable(self)¶IsTopDockable returns True if the pane can be docked at the top of the managed frame.
bool
See also
IsValid(self)¶bool
Layer(self, layer)¶Layer 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.
layer (int) –
Left(self)¶wx.Left sets the pane dock position to the left side of the frame.
This is the same thing as calling Direction(wxAUI_DOCK_LEFT).
LeftDockable(self, b=True)¶LeftDockable indicates whether a pane can be docked on the left of the frame.
b (bool) –
MaxSize(self, *args, **kw)¶MaxSize sets the maximum size of the pane.
MaxSize (self, size)
size (wx.Size) –
MaxSize (self, x, y)
x (int) –
y (int) –
MaximizeButton(self, visible=True)¶MaximizeButton indicates that a maximize button should be drawn for the pane.
visible (bool) –
MinSize(self, *args, **kw)¶MinSize sets the minimum size of the pane.
Please note that this is only partially supported as of this writing.
MinSize (self, size)
size (wx.Size) –
MinSize (self, x, y)
x (int) –
y (int) –
MinimizeButton(self, visible=True)¶MinimizeButton indicates that a minimize button should be drawn for the pane.
visible (bool) –
Movable(self, b=True)¶Movable indicates whether a frame can be moved.
b (bool) –
Name(self, n)¶Name 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.
n (string) –
PaneBorder(self, visible=True)¶PaneBorder indicates that a border should be drawn for the pane.
visible (bool) –
PinButton(self, visible=True)¶PinButton indicates that a pin button should be drawn for the pane.
visible (bool) –
Position(self, pos)¶wx.Position determines the position of the docked pane.
pos (int) –
Resizable(self, resizable=True)¶Resizable allows a pane to be resized if the parameter is True, and forces it to be a fixed size if the parameter is False.
This is simply an antonym for Fixed .
resizable (bool) –
Right(self)¶wx.Right sets the pane dock position to the right side of the frame.
This is the same thing as calling Direction(wxAUI_DOCK_RIGHT).
RightDockable(self, b=True)¶RightDockable indicates whether a pane can be docked on the right of the frame.
b (bool) –
SafeSet(self, source)¶Write the safe parts of a PaneInfo object “source” into “this”.
“Safe parts” are all non-UI elements (e.g. all layout determining parameters like the size, position etc.). “Unsafe parts” (pointers to button, frame and window) are not modified by this write operation.
source (wx.aui.AuiPaneInfo) –
Note
This method is used when loading perspectives.
SetFlag(self, flag, option_state)¶SetFlag turns the property given by flag on or off with the option_state parameter.
flag (int) –
option_state (bool) –
Show(self, show=True)¶Show indicates that a pane should be shown.
show (bool) –
ToolbarPane(self)¶ToolbarPane specifies that the pane should adopt the default toolbar pane settings.
Top(self)¶wx.Top sets the pane dock position to the top of the frame.
This is the same thing as calling Direction(wxAUI_DOCK_TOP).
TopDockable(self, b=True)¶TopDockable indicates whether a pane can be docked at the top of the frame.
b (bool) –
Window(self, w)¶wx.Window assigns the window pointer that the wx.aui.AuiPaneInfo should use.
This normally does not need to be specified, as the window pointer is automatically assigned to the wx.aui.AuiPaneInfo structure as soon as it is added to the manager.
w (wx.Window) –
caption¶A public C++ attribute of type string. caption displayed on the window
dock_direction¶A public C++ attribute of type int. dock direction (top, bottom, left, right, center)
dock_layer¶A public C++ attribute of type int. layer number (0 = innermost layer)
dock_pos¶A public C++ attribute of type int. position inside the row (0 = first position)
dock_proportion¶A public C++ attribute of type int. proportion while docked
dock_row¶A public C++ attribute of type int. row number on the docking bar (0 = first row)
icon¶A public C++ attribute of type BitmapBundle . icon of the pane, may be invalid
name¶A public C++ attribute of type string. name of the pane
state¶A public C++ attribute of type int. a combination of PaneState values