Navigation
- Home |
- Gallery |
- API Docs »
- wx.lib »
- wx.lib.agw »
- wx.lib.agw.aui »
- wx.lib.agw.aui.framemanager »
- wx.lib.agw.aui.framemanager.AuiPaneInfo
- index
- modules |
- next |
- previous |
wx.lib.agw.aui.framemanager.AuiPaneInfo¶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.
Methods Summary¶Default class constructor. |
|
Sets the ideal size for the pane. The docking manager will attempt to use |
|
Sets the best size of the pane. |
|
Sets the best size of the pane. |
|
Sets the pane dock position to the bottom of the frame. |
|
Indicates whether a pane can be docked at the bottom of the frame. |
|
Indicates whether a pane can be snapped at the bottom of the main frame. |
|
Sets the caption of the pane. |
|
Indicates that a pane caption should be visible. If visible is |
|
Sets the pane to the center position of the frame. |
|
Specifies that the pane should adopt the default center pane settings. |
|
Sets the pane to the center position of the frame. |
|
Specifies that the pane should adopt the default center pane settings. |
|
Indicates that a close button should be drawn for the pane. |
|
Returns the number of visible buttons in the docked pane. |
|
Specifies that the pane should adopt the default pane settings. |
|
Indicates whether a pane should be destroyed when it is closed. |
|
Determines the direction of the docked pane. It is functionally the |
|
Indicates that a pane should be docked. It is the opposite of |
|
Getter for the dock_direction. |
|
Setter for the dock_direction. |
|
Specifies whether a frame can be docked or not. It is the same as specifying |
|
Causes the containing dock to have no resize sash. This is useful |
|
Forces a pane to be fixed size so that it cannot be resized. |
|
Indicates that a pane should be floated. It is the opposite of |
|
Sets whether the user will be able to undock a pane and turn it |
|
Sets the position of the floating pane. |
|
Sets the size of the floating pane. |
|
Indicates whether a pane, when floating, has a “fly-out” effect |
|
Returns the minimization style for this pane. |
|
Indicates that a gripper should be drawn for the pane. |
|
Indicates that a gripper should be drawn at the top of the pane. |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns whether a pane has a |
|
Returns |
|
Indicates that a pane should be hidden. |
|
Specifies whether an icon is drawn on the left of the caption text when |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns whether the pane is a notebook control ( |
|
Returns |
|
Returns whether the pane is a notebook page in a |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Determines the layer of the docked pane. |
|
Sets the pane dock position to the left side of the frame. |
|
Indicates whether a pane can be docked on the left of the frame. |
|
Indicates whether a pane can be snapped on the left of the main frame. |
|
Makes the pane take up the full area. |
|
Indicates that a maximize button should be drawn for the pane. |
|
Sets the maximum size of the pane. |
|
Sets the maximum size of the pane. |
|
Sets the maximum size of the pane. |
|
Makes the pane minimized in a |
|
Indicates that a minimize button should be drawn for the pane. |
|
Sets the expected minimized mode if the minimize button is visible. |
|
Minimizes the panes using a |
|
Sets the minimum size of the pane. |
|
Sets the minimum size of the pane. |
|
Sets the minimum size of the pane. |
|
Indicates whether a pane can be moved. |
|
Sets the name of the pane so it can be referenced in lookup functions. |
|
Forces a pane to be a notebook control ( |
|
Indicates whether a pane can be docked in an automatic |
|
Forces a pane to be a notebook page, so that the pane can be |
|
Indicates that a border should be drawn for the pane. |
|
Indicates that a pin button should be drawn for the pane. |
|
Determines the position of the docked pane. |
|
Resets all the buttons and recreates them from scratch depending on the |
|
Allows a pane to be resizable if resizable is |
|
Is the reverse of |
|
Sets the pane dock position to the right side of the frame. |
|
Indicates whether a pane can be docked on the right of the frame. |
|
Indicates whether a pane can be snapped on the right of the main frame. |
|
Determines the row of the docked pane. |
|
Copies the source pane members that pertain to docking position to self. |
|
Turns the property given by flag on or off with the option_state |
|
Sets the pane name once docked in a |
|
Indicates that a pane should be shown. |
|
Indicates whether a pane can be snapped on the main frame. This is |
|
Specifies that the pane should adopt the default toolbar pane settings. |
|
Sets the pane dock position to the top of the frame. |
|
Indicates whether a pane can be docked at the top of the frame. |
|
Indicates whether a pane can be snapped at the top of the main frame. |
|
Makes the pane transparent when floating. |
|
Associate a |
Class API¶
Inheritance diagram for class AuiPaneInfo:
AuiPaneInfo(object)¶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.
__init__(self)¶Default class constructor.
BestSize(self, arg1=None, arg2=None)¶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.
This method is split in 2 versions depending on the input type. If arg1 is
a wx.Size object, then BestSize1 is called. Otherwise, BestSize2 is called.
arg1 – a wx.Size object, a (x, y) tuple or a x coordinate.
arg2 – a y coordinate (only if arg1 is a x coordinate, otherwise unused).
BestSize1(self, size)¶Sets the best size of the pane.
See also
BestSize for an explanation of input parameters.
BestSize2(self, x, y)¶Sets the best size of the pane.
See also
BestSize for an explanation of input parameters.
Bottom(self)¶Sets the pane dock position to the bottom of the frame.
Note
This is the same thing as calling Direction with AUI_DOCK_BOTTOM as
parameter.
BottomDockable(self, b=True)¶Indicates whether a pane can be docked at the bottom of the frame.
b (bool) – whether the pane can be docked at the bottom or not.
BottomSnappable(self, b=True)¶Indicates whether a pane can be snapped at the bottom of the main frame.
b (bool) – whether the pane can be snapped at the bottom of the main frame or not.
Caption(self, caption)¶Sets the caption of the pane.
caption (string) – a string specifying the pane caption.
CaptionVisible(self, visible=True, left=False)¶Indicates that a pane caption should be visible. If visible is False, no pane
caption is drawn.
visible (bool) – whether the caption should be visible or not;
left (bool) – whether the caption should be drawn on the left (rotated by 90 degrees) or not.
Center(self)¶Sets the pane to the center position 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.
Note
This is the same thing as calling Direction with AUI_DOCK_CENTER as
parameter.
CenterPane(self)¶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)¶Sets the pane to the center position 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.
Note
This is the same thing as calling Direction with AUI_DOCK_CENTRE as
parameter.
CentrePane(self)¶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)¶Indicates that a close button should be drawn for the pane.
visible (bool) – whether the close button should be visible or not.
CountButtons(self)¶Returns the number of visible buttons in the docked pane.
DefaultPane(self)¶Specifies that the pane should adopt the default pane settings.
DestroyOnClose(self, b=True)¶Indicates whether a pane should be destroyed when it is closed.
Normally a pane is simply hidden when the close button is clicked. Setting
b to True will cause the window to be destroyed when the user clicks
the pane’s close button.
b (bool) – whether the pane should be destroyed when it is closed or not.
Direction(self, direction)¶Determines the direction of the docked pane. It is functionally the
same as calling Left, Right, Top or Bottom,
except that docking direction may be specified programmatically via the parameter direction.
direction (integer) – the direction of the docked pane.
See also
dock_direction_set for a list of valid docking directions.
dock_direction_get(self)¶Getter for the dock_direction.
See also
dock_direction_set for a set of valid docking directions.
dock_direction_set(self, value)¶Setter for the dock_direction.
value (integer) – the docking direction. This can be one of the following bits:
Dock Flag |
Value |
Description |
|---|---|---|
|
0 |
No docking direction. |
|
1 |
Top docking direction. |
|
2 |
Right docking direction. |
|
3 |
Bottom docking direction. |
|
4 |
Left docking direction. |
|
5 |
Center docking direction. |
|
5 |
Centre docking direction. |
|
6 |
Automatic AuiNotebooks docking style. |
Dockable(self, b=True)¶Specifies whether a frame can be docked or not. It is the same as specifying
TopDockable . BottomDockable . LeftDockable . RightDockable .
b (bool) – whether the frame can be docked or not.
DockFixed(self, b=True)¶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) – whether the pane will have a resize sash or not.
Fixed(self)¶Forces a pane to be fixed size so that it cannot be resized.
After calling Fixed, IsFixed will return True.
Floatable(self, b=True)¶Sets whether the user will be able to undock a pane and turn it into a floating window.
b (bool) – whether the pane can be floated or not.
FloatingPosition(self, pos)¶Sets the position of the floating pane.
pos – a wx.Point or a tuple indicating the pane floating position.
FloatingSize(self, size)¶Sets the size of the floating pane.
size – a wx.Size or a tuple indicating the pane floating size.
FlyOut(self, b=True)¶Indicates whether a pane, when floating, has a “fly-out” effect (i.e., floating panes which only show themselves when moused over).
b (bool) – whether the pane can be snapped on the main frame or not.
GetMinimizeMode(self)¶Returns the minimization style for this pane.
Possible return values are:
Minimize Mode Flag |
Hex Value |
Description |
|---|---|---|
|
0x01 |
Minimizes the pane on the closest tool bar |
|
0x02 |
Minimizes the pane on the top tool bar |
|
0x03 |
Minimizes the pane on its left tool bar |
|
0x04 |
Minimizes the pane on its right tool bar |
|
0x05 |
Minimizes the pane on its bottom tool bar |
|
0x06 |
Minimizes the pane on a target |
|
0x17 |
Mask to filter the position flags |
|
0x0 |
Hides the caption of the minimized pane |
|
0x08 |
Displays the caption in the best rotation (horizontal or clockwise) |
|
0x10 |
Displays the caption horizontally |
|
0x18 |
Mask to filter the caption flags |
The flags can be filtered with the following masks:
Minimize Mask Flag |
Hex Value |
Description |
|---|---|---|
|
0x17 |
Filters the position flags |
|
0x18 |
Filters the caption flags |
Gripper(self, visible=True)¶Indicates that a gripper should be drawn for the pane.
visible (bool) – whether the gripper should be visible or not.
GripperTop(self, attop=True)¶Indicates that a gripper should be drawn at the top of the pane.
attop (bool) – whether the gripper should be drawn at the top or not.
HasBorder(self)¶Returns True if the pane displays a border.
HasCaption(self)¶Returns True if the pane displays a caption.
HasCaptionLeft(self)¶Returns True if the pane displays a caption on the left (rotated by 90 degrees).
HasCloseButton(self)¶Returns True if the pane displays a button to close the pane.
HasFlag(self, flag)¶Returns True if the the property specified by flag is active for the pane.
flag (integer) – the property to check for activity.
HasGripper(self)¶Returns True if the pane displays a gripper.
HasGripperTop(self)¶Returns True if the pane displays a gripper at the top.
HasMaximizeButton(self)¶Returns True if the pane displays a button to maximize the pane.
HasMinimizeButton(self)¶Returns True if the pane displays a button to minimize the pane.
HasNotebook(self)¶Returns whether a pane has a AuiNotebook or not.
HasPinButton(self)¶Returns True if the pane displays a button to float the pane.
Hide(self)¶Indicates that a pane should be hidden.
Calling Show(False) achieve the same effect.
Icon(self, icon)¶Specifies whether an icon is drawn on the left of the caption text when
the pane is docked. If icon is None or NullIcon, no icon is drawn on
the caption space.
icon (Icon or None) – an icon to draw on the caption space, or None.
IsBottomDockable(self)¶Returns True if the pane can be docked at the bottom
of the managed frame.
IsBottomSnappable(self)¶Returns True if the pane can be snapped at the bottom of the managed frame.
IsDestroyOnClose(self)¶Returns True if the pane should be destroyed when it is closed.
Normally a pane is simply hidden when the close button is clicked. Calling DestroyOnClose
with a True input parameter will cause the window to be destroyed when the user clicks
the pane’s close button.
IsDockable(self)¶Returns True if the pane can be docked.
IsDocked(self)¶Returns True if the pane is docked.
IsFixed(self)¶Returns True if the pane cannot be resized.
IsFloatable(self)¶Returns True if the pane can be undocked and displayed as a
floating window.
IsFloating(self)¶Returns True if the pane is floating.
IsFlyOut(self)¶Returns True if the floating pane has a “fly-out” effect.
IsHorizontal(self)¶Returns True if the pane dock_direction is horizontal.
IsLeftDockable(self)¶Returns True if the pane can be docked at the left
of the managed frame.
IsLeftSnappable(self)¶Returns True if the pane can be snapped on the left of the managed frame.
IsMaximized(self)¶Returns True if the pane is maximized.
IsMinimized(self)¶Returns True if the pane is minimized.
IsMovable(self)¶Returns True if the docked frame can be undocked or moved to
another dock position.
IsNotebookControl(self)¶Returns whether the pane is a notebook control (AuiNotebook).
IsNotebookDockable(self)¶Returns True if a pane can be docked on top to another to create a
AuiNotebook.
IsNotebookPage(self)¶Returns whether the pane is a notebook page in a AuiNotebook.
IsOk(self)¶Returns True if the AuiPaneInfo structure is valid.
Note
A pane structure is valid if it has an associated window.
IsResizeable(self)¶Returns True if the pane can be resized.
IsRightDockable(self)¶Returns True if the pane can be docked at the right
of the managed frame.
IsRightSnappable(self)¶Returns True if the pane can be snapped on the right of the managed frame.
IsShown(self)¶Returns True if the pane is currently shown.
IsSnappable(self)¶Returns True if the pane can be snapped.
IsToolbar(self)¶Returns True if the pane contains a toolbar.
IsTopDockable(self)¶Returns True if the pane can be docked at the top
of the managed frame.
IsTopSnappable(self)¶Returns True if the pane can be snapped at the top of the managed frame.
IsVertical(self)¶Returns True if the pane dock_direction is vertical.
Layer(self, 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 (integer) – the layer of the docked pane.
Left(self)¶Sets the pane dock position to the left side of the frame.
Note
This is the same thing as calling Direction with AUI_DOCK_LEFT as
parameter.
LeftDockable(self, b=True)¶Indicates whether a pane can be docked on the left of the frame.
b (bool) – whether the pane can be docked at the left or not.
LeftSnappable(self, b=True)¶Indicates whether a pane can be snapped on the left of the main frame.
b (bool) – whether the pane can be snapped at the left of the main frame or not.
Maximize(self)¶Makes the pane take up the full area.
MaximizeButton(self, visible=True)¶Indicates that a maximize button should be drawn for the pane.
visible (bool) – whether the maximize button should be visible or not.
MaxSize(self, arg1=None, arg2=None)¶Sets the maximum size of the pane.
This method is split in 2 versions depending on the input type. If arg1 is
a wx.Size object, then MaxSize1 is called. Otherwise, MaxSize2 is called.
arg1 – a wx.Size object, a (x, y) tuple or a x coordinate.
arg2 – a y coordinate (only if arg1 is a x coordinate, otherwise unused).
MaxSize1(self, size)¶Sets the maximum size of the pane.
See also
MaxSize for an explanation of input parameters.
MaxSize2(self, x, y)¶Sets the maximum size of the pane.
See also
MaxSize for an explanation of input parameters.
Minimize(self)¶Makes the pane minimized in a AuiToolBar.
Clicking on the minimize button causes a new AuiToolBar to be created
and added to the frame manager, (currently the implementation is such that
panes at West will have a toolbar at the right, panes at South will have
toolbars at the bottom etc…) and the pane is hidden in the manager.
Clicking on the restore button on the newly created toolbar will result in the toolbar being removed and the original pane being restored.
MinimizeButton(self, visible=True)¶Indicates that a minimize button should be drawn for the pane.
visible (bool) – whether the minimize button should be visible or not.
MinimizeMode(self, mode)¶Sets the expected minimized mode if the minimize button is visible.
mode (integer) – the minimized pane can have a specific position in the work space:
Minimize Mode Flag |
Hex Value |
Description |
|---|---|---|
|
0x01 |
Minimizes the pane on the closest tool bar |
|
0x02 |
Minimizes the pane on the top tool bar |
|
0x03 |
Minimizes the pane on its left tool bar |
|
0x04 |
Minimizes the pane on its right tool bar |
|
0x05 |
Minimizes the pane on its bottom tool bar |
|
0x06 |
Minimizes the pane on a target |
The caption of the minimized pane can be displayed in different modes:
Caption Mode Flag |
Hex Value |
Description |
|---|---|---|
|
0x0 |
Hides the caption of the minimized pane |
|
0x08 |
Displays the caption in the best rotation (horizontal in the top and in the bottom tool bar or clockwise in the right and in the left tool bar) |
|
0x10 |
Displays the caption horizontally |
Note
In order to use the AUI_MINIMIZE_POS_TOOLBAR flag, the instance of AuiManager
you pass as an input for MinimizeTarget must have a real name and not the randomly
generated one. Remember to set the Name property of the toolbar pane before calling this method.
MinimizeTarget(self, toolbarPane)¶Minimizes the panes using a AuiPaneInfo as a target. As AuiPaneInfo properties
need to be copied back and forth every time the perspective has changed, we
only store the toobar name.
toolbarPane – an instance of AuiPaneInfo, containing a AuiToolBar.
Note
In order to use this functionality (and with the AUI_MINIMIZE_POS_TOOLBAR
flag set), the instance of AuiPaneInfo you pass as an input must have a real
name and not the randomly generated one. Remember to set the Name property of
the toolbar pane before calling this method.
MinSize(self, arg1=None, arg2=None)¶Sets the minimum size of the pane.
This method is split in 2 versions depending on the input type. If arg1 is
a wx.Size object, then MinSize1 is called. Otherwise, MinSize2 is called.
arg1 – a wx.Size object, a (x, y) tuple or or a x coordinate.
arg2 – a y coordinate (only if arg1 is a x coordinate, otherwise unused).
MinSize1(self, size)¶Sets the minimum size of the pane.
See also
MinSize for an explanation of input parameters.
MinSize2(self, x, y)¶Sets the minimum size of the pane.
See also
MinSize for an explanation of input parameters.
Movable(self, b=True)¶Indicates whether a pane can be moved.
b (bool) – whether the pane can be moved or not.
Name(self, 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.
name – a string specifying the pane name.
Warning
If you are using AuiManager.SavePerspective and AuiManager.LoadPerspective,
you will have to specify a name for your pane using Name, as perspectives
containing randomly generated names can not be properly restored.
NotebookControl(self, id)¶Forces a pane to be a notebook control (AuiNotebook).
id (integer) – the notebook id.
NotebookDockable(self, b=True)¶Indicates whether a pane can be docked in an automatic AuiNotebook.
b (bool) – whether the pane can be docked in a notebook or not.
NotebookPage(self, id, tab_position=1000)¶Forces a pane to be a notebook page, so that the pane can be
docked on top to another to create a AuiNotebook.
id (integer) – the notebook id;
tab_position (integer) – the tab number of the pane once docked in a notebook.
PaneBorder(self, visible=True)¶Indicates that a border should be drawn for the pane.
visible (bool) – whether the pane border should be visible or not.
PinButton(self, visible=True)¶Indicates that a pin button should be drawn for the pane.
visible (bool) – whether the pin button should be visible or not.
Position(self, pos)¶Determines the position of the docked pane.
pos (integer) – the position of the docked pane.
ResetButtons(self)¶Resets all the buttons and recreates them from scratch depending on the
AuiManager flags.
Resizable(self, resizable=True)¶Allows a pane to be resizable if resizable is True, and forces
it to be a fixed size if resizeable is False.
If resizable is False, this is simply an antonym for Fixed.
resizable (bool) – whether the pane will be resizeable or not.
Right(self)¶Sets the pane dock position to the right side of the frame.
Note
This is the same thing as calling Direction with AUI_DOCK_RIGHT as
parameter.
RightDockable(self, b=True)¶Indicates whether a pane can be docked on the right of the frame.
b (bool) – whether the pane can be docked at the right or not.
RightSnappable(self, b=True)¶Indicates whether a pane can be snapped on the right of the main frame.
b (bool) – whether the pane can be snapped at the right of the main frame or not.
Row(self, row)¶Determines the row of the docked pane.
row (integer) – the row of the docked pane.
SetDockPos(self, source)¶Copies the source pane members that pertain to docking position to self.
source – the source pane from where to copy the attributes,
an instance of AuiPaneInfo.
SetFlag(self, flag, option_state)¶Turns the property given by flag on or off with the option_state parameter.
flag (integer) – the property to set;
option_state (bool) – either True or False.
SetNameFromNotebookId(self)¶Sets the pane name once docked in a AuiNotebook using the notebook id.
Show(self, show=True)¶Indicates that a pane should be shown.
show (bool) – whether the pane should be shown or not.
Snappable(self, b=True)¶Indicates whether a pane can be snapped on the main frame. This is
equivalent as calling TopSnappable . BottomSnappable . LeftSnappable . RightSnappable .
b (bool) – whether the pane can be snapped on the main frame or not.
ToolbarPane(self)¶Specifies that the pane should adopt the default toolbar pane settings.
Top(self)¶Sets the pane dock position to the top of the frame.
Note
This is the same thing as calling Direction with AUI_DOCK_TOP as
parameter.
TopDockable(self, b=True)¶Indicates whether a pane can be docked at the top of the frame.
b (bool) – whether the pane can be docked at the top or not.
TopSnappable(self, b=True)¶Indicates whether a pane can be snapped at the top of the main frame.
b (bool) – whether the pane can be snapped at the top of the main frame or not.
Transparent(self, alpha)¶Makes the pane transparent when floating.
alpha (integer) – a value between 0 and 255 for pane transparency.
Window(self, w)¶Associate a wx.Window derived window to this pane.
This normally does not need to be specified, as the window pointer is
automatically assigned to the AuiPaneInfo structure as soon as it is
added to the manager.
w – a wx.Window derived window.
dock_direction¶Getter for the dock_direction.
See also
dock_direction_set for a set of valid docking directions.