Inheritance diagram for 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.
Bases: 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.
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.
This method is splitted in 2 versions depending on the input type. If arg1 is a wx.Size object, then L{BestSize1) is called. Otherwise, L{BestSize2} is called.
Parameters: |
|
---|
Bottom() sets the pane dock position to the bottom of the frame.
This is the same thing as calling Direction(AUI_DOCK_BOTTOM).
BottomDockable() indicates whether a pane can be docked at the bottom of the frame.
Parameter: | b – whether the pane can be docked at the bottom or not. |
---|
BottomSnappable() indicates whether a pane can be snapped at the bottom of the main frame.
Parameter: | b – whether the pane can be snapped at the bottom of the main frame or not. |
---|
Caption() sets the caption of the pane.
Parameter: | caption – a string specifying the pane caption. |
---|
CaptionVisible() indicates that a pane caption should be visible. If False, no pane caption is drawn.
Parameter: | visible – whether the caption should be visible or not. |
---|
Center() 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.
This is the same thing as calling Direction(AUI_DOCK_CENTER).
Centre() 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.
This is the same thing as calling Direction(AUI_DOCK_CENTRE).
CloseButton() indicates that a close button should be drawn for the pane.
Parameter: | visible – whether the close button should be visible or not. |
---|
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.
Parameter: | b – whether the pane should be destroyed when it is closed or not. |
---|
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.
Parameter: | direction – the direction of the docked pane (see L{aui_constants}). |
---|
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.
Parameter: | b – whether the pane will have a resize sash or not. |
---|
Dockable() specifies whether a frame can be docked or not. It is the same as specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b).
Parameter: | b – whether the frame can be docked or not. |
---|
Floatable() sets whether the user will be able to undock a pane and turn it into a floating window.
Parameter: | b – whether the pane can be floated or not. |
---|
FloatingPosition() sets the position of the floating pane.
Parameter: | pos – a wx.Point or a tuple indicating the pane floating position. |
---|
FloatingSize() sets the size of the floating pane.
Parameter: | size – a wx.Size or a tuple indicating the pane floating size. |
---|
Gripper() indicates that a gripper should be drawn for the pane.
Parameter: | visible – whether the gripper should be visible or not. |
---|
GripperTop() indicates that a gripper should be drawn at the top of the pane.
Parameter: | attop – whether the gripper should be drawn at the top or not. |
---|
HasFlag() returns True if the the property specified by flag is active for the pane.
Parameter: | flag – the property to check for activity. |
---|
Icon specifies whether an icon is drawn on the left of the caption text when the pane is docked. If icon is None or wx.NullIcon, no icon is drawn on the caption space.
Parameter: | icon – an icon to draw on the caption space, or None. |
---|
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.
Parameter: | layer – the layer of the docked pane. |
---|
Left() sets the pane dock position to the left side of the frame.
This is the same thing as calling Direction(AUI_DOCK_LEFT).
LeftDockable() indicates whether a pane can be docked on the left of the frame.
Parameter: | b – whether the pane can be docked at the left or not. |
---|
LeftSnappable() indicates whether a pane can be snapped on the left of the main frame.
Parameter: | b – whether the pane can be snapped at the left of the main frame or not. |
---|
MaxSize() sets the maximum size of the pane.
This method is splitted in 2 versions depending on the input type. If arg1 is a wx.Size object, then L{MaxSize1) is called. Otherwise, L{MaxSize2} is called.
Parameters: |
|
---|
MaximizeButton() indicates that a maximize button should be drawn for the pane.
Parameter: | visible – whether the maximize button should be visible or not. |
---|
MinSize() sets the minimum size of the pane.
This method is splitted in 2 versions depending on the input type. If arg1 is a wx.Size object, then L{MinSize1) is called. Otherwise, L{MinSize2} is called.
Parameters: |
|
---|
Minimize() makes the pane minimized in a L{auibar.AuiToolBar}.
Clicking on the minimize button causes a new L{auibar.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() indicates that a minimize button should be drawn for the pane.
Parameter: | visible – whether the minimize button should be visible or not. |
---|
Movable() indicates whether a frame can be moved.
Parameter: | b – whether the pane can be moved or not. |
---|
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.
Parameter: | name – a string specifying the pane name. |
---|
NotebookControl() forces a pane to be a notebook control (L{auibook.AuiNotebook}).
Parameter: | id – the notebook id. |
---|
NotebookDockable() indicates whether a pane can be docked in an automatic L{auibook.AuiNotebook}.
Parameter: | b – whether the pane can be docked in a notebook or not. |
---|
NotebookPage() forces a pane to be a notebook page, so that the pane can be docked on top to another to create a L{auibook.AuiNotebook}.
Parameters: |
|
---|
PaneBorder() indicates that a border should be drawn for the pane.
Parameter: | visible – whether the pane border should be visible or not. |
---|
PinButton() indicates that a pin button should be drawn for the pane.
Parameter: | visible – whether the pin button should be visible or not. |
---|
Position() determines the position of the docked pane.
Parameter: | pos – the position of the docked pane. |
---|
Resizable() allows a pane to be resizable if resizable is True, and forces it to be a fixed size if resizeable is False.
If resizeable is False, this is simply an antonym for L{Fixed()}.
Parameter: | resizeable – whether the pane will be resizeable or not. |
---|
Right() sets the pane dock position to the right side of the frame.
This is the same thing as calling Direction(AUI_DOCK_RIGHT).
RightDockable() indicates whether a pane can be docked on the right of the frame.
Parameter: | b – whether the pane can be docked at the right or not. |
---|
RightSnappable() indicates whether a pane can be snapped on the right of the main frame.
Parameter: | b – whether the pane can be snapped at the right of the main frame or not. |
---|
Row() determines the row of the docked pane.
Parameter: | row – the row of the docked pane. |
---|
Copies the source pane members that pertain to docking position to self.
Parameter: | source – the source pane from where to copy the attributes. |
---|
SetFlag() turns the property given by flag on or off with the option_state parameter.
Parameters: |
|
---|
Show() indicates that a pane should be shown.
Parameter: | show – whether the pane should be shown or not. |
---|
Snappable() indicates whether a pane can be snapped on the main frame. This is equivalent as calling TopSnappable(b).BottomSnappable(b).LeftSnappable(b).RightSnappable(b).
Parameter: | b – whether the pane can be snapped on the main frame or not. |
---|
Top() sets the pane dock position to the top of the frame.
This is the same thing as calling Direction(AUI_DOCK_TOP).
TopDockable() indicates whether a pane can be docked at the top of the frame.
Parameter: | b – whether the pane can be docked at the top or not. |
---|
TopSnappable() indicates whether a pane can be snapped at the top of the main frame.
Parameter: | b – whether the pane can be snapped at the top of the main frame or not. |
---|
Transparent() makes the pane transparent when floating.
Parameter: | alpha – an integer value between 0 and 255 for pane transparency. |
---|
Associate a L{wx.Window} derived window to this pane.
This normally does not need to be specified, as the window pointer is automatically assigned to the L{AuiPaneInfo} structure as soon as it is added to the manager.
Parameter: | window – a L{wx.Window} derived window. |
---|
Setter for the dock_direction.
Parameter: | value – the docking direction (see L{aui_constants}). |
---|