wx.aui.AuiPaneInfo¶

wx.aui.AuiPaneInfo is part of the AUI class framework.

See also

Class Hierarchy¶

Inheritance diagram for class AuiPaneInfo:

Methods Summary¶

`__init__`
`BestSize`	`BestSize` sets the ideal size for the pane.
`Bottom`	`wx.Bottom` sets the pane dock position to the bottom side of the frame.
`BottomDockable`	`BottomDockable` indicates whether a pane can be docked at the bottom of the frame.
`Caption`	`Caption` sets the caption of the pane.
`CaptionVisible`	CaptionVisible indicates that a pane caption should be visible.
`Center`	`wx.Center` sets the pane dock position to the left side of the frame.
`CenterPane`	`CentrePane` specifies that the pane should adopt the default center pane settings.
`Centre`	`wx.Center` sets the pane dock position to the left side of the frame.
`CentrePane`	`CentrePane` specifies that the pane should adopt the default center pane settings.
`CloseButton`	`CloseButton` indicates that a close button should be drawn for the pane.
`DefaultPane`	`DefaultPane` specifies that the pane should adopt the default pane settings.
`DestroyOnClose`	`DestroyOnClose` indicates whether a pane should be destroyed when it is closed.
`Direction`	wx.DataObject.Direction determines the direction of the docked pane.
`Dock`	`Dock` indicates that a pane should be docked.
`DockFixed`	`DockFixed` causes the containing dock to have no resize sash.
`Dockable`	`Dockable` specifies whether a frame can be docked or not.
`Fixed`	`Fixed` forces a pane to be fixed size so that it cannot be resized.
`Float`	`Float` indicates that a pane should be floated.
`Floatable`	`Floatable` sets whether the user will be able to undock a pane and turn it into a floating window.
`FloatingPosition`	`FloatingPosition` sets the position of the floating pane.
`FloatingSize`	`FloatingSize` sets the size of the floating pane.
`Gripper`	`Gripper` indicates that a gripper should be drawn for the pane.
`GripperTop`	`GripperTop` indicates that a gripper should be drawn at the top of the pane.
`HasBorder`	`HasBorder` returns `True` if the pane displays a border.
`HasCaption`	`HasCaption` returns `True` if the pane displays a caption.
`HasCloseButton`	`HasCloseButton` returns `True` if the pane displays a button to close the pane.
`HasFlag`	`HasFlag` returns `True` if the property specified by flag is active for the pane.
`HasGripper`	`HasGripper` returns `True` if the pane displays a gripper.
`HasGripperTop`	`HasGripper` returns `True` if the pane displays a gripper at the top.
`HasMaximizeButton`	`HasMaximizeButton` returns `True` if the pane displays a button to maximize the pane.
`HasMinimizeButton`	`HasMinimizeButton` returns `True` if the pane displays a button to minimize the pane.
`HasPinButton`	`HasPinButton` returns `True` if the pane displays a button to float the pane.
`Hide`	`Hide` indicates that a pane should be hidden.
`Icon`	wx.Icon sets the icon of the pane.
`IsBottomDockable`	`IsBottomDockable` returns `True` if the pane can be docked at the bottom of the managed frame.
`IsDockable`	Returns `True` if the pane can be docked at any side.
`IsDocked`	`IsDocked` returns `True` if the pane is currently docked.
`IsFixed`	`IsFixed` returns `True` if the pane cannot be resized.
`IsFloatable`	`IsFloatable` returns `True` if the pane can be undocked and displayed as a floating window.
`IsFloating`	`IsFloating` returns `True` if the pane is floating.
`IsLeftDockable`	`IsLeftDockable` returns `True` if the pane can be docked on the left of the managed frame.
`IsMovable`	IsMoveable() returns `True` if the docked frame can be undocked or moved to another dock position.
`IsOk`	`IsOk` returns `True` if the wx.aui.AuiPaneInfo structure is valid.
`IsResizable`	`IsResizable` returns `True` if the pane can be resized.
`IsRightDockable`	`IsRightDockable` returns `True` if the pane can be docked on the right of the managed frame.
`IsShown`	`IsShown` returns `True` if the pane is currently shown.
`IsToolbar`	`IsToolbar` returns `True` if the pane contains a toolbar.
`IsTopDockable`	`IsTopDockable` returns `True` if the pane can be docked at the top of the managed frame.
`IsValid`
`Layer`	`Layer` determines the layer of the docked pane.
`Left`	`wx.Left` sets the pane dock position to the left side of the frame.
`LeftDockable`	`LeftDockable` indicates whether a pane can be docked on the left of the frame.
`MaxSize`	`MaxSize` sets the maximum size of the pane.
`MaximizeButton`	`MaximizeButton` indicates that a maximize button should be drawn for the pane.
`MinSize`	`MinSize` sets the minimum size of the pane.
`MinimizeButton`	`MinimizeButton` indicates that a minimize button should be drawn for the pane.
`Movable`	Movable indicates whether a frame can be moved.
`Name`	`Name` sets the name of the pane so it can be referenced in lookup functions.
`PaneBorder`	PaneBorder indicates that a border should be drawn for the pane.
`PinButton`	`PinButton` indicates that a pin button should be drawn for the pane.
`Position`	wx.Position determines the position of the docked pane.
`Resizable`	`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`.
`Right`	`wx.Right` sets the pane dock position to the right side of the frame.
`RightDockable`	`RightDockable` indicates whether a pane can be docked on the right of the frame.
`Row`	`Row` determines the row of the docked pane.
`SafeSet`	Write the safe parts of a PaneInfo object “source” into “this”.
`SetFlag`	`SetFlag` turns the property given by flag on or off with the option_state parameter.
`Show`	`Show` indicates that a pane should be shown.
`ToolbarPane`	`ToolbarPane` specifies that the pane should adopt the default toolbar pane settings.
`Top`	`wx.Top` sets the pane dock position to the top of the frame.
`TopDockable`	`TopDockable` indicates whether a pane can be docked at the top of the frame.
`Window`	wx.Window assigns the window pointer that the wx.aui.AuiPaneInfo should use.

Properties Summary¶

`best_size`	A public C++ attribute of type `Size` . size that the layout engine will prefer
`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)
`floating_pos`	A public C++ attribute of type `Point` . position while floating
`floating_size`	A public C++ attribute of type `Size` . size while floating
`frame`	A public C++ attribute of type `Frame` . floating frame window that holds the pane
`icon`	A public C++ attribute of type `BitmapBundle` . icon of the pane, may be invalid
`max_size`	A public C++ attribute of type `Size` . maximum size the pane window can tolerate
`min_size`	A public C++ attribute of type `Size` . minimum size the pane window can tolerate
`name`	A public C++ attribute of type `string`. name of the pane
`rect`	A public C++ attribute of type `Rect` . current rectangle (populated by `AUI`)
`state`	A public C++ attribute of type `int`. a combination of PaneState values
`window`	A public C++ attribute of type `Window` . window that is in this pane

Class API¶

class wx.aui.AuiPaneInfo(object)¶

Possible constructors:

AuiPaneInfo()

AuiPaneInfo(c)

AuiPaneInfo is part of the AUI class framework.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

__init__ (self, c)

Copy constructor.

Parameters: 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.

Overloaded Implementations:

BestSize (self, size)

Parameters: size (wx.Size) –
Return type: wx.aui.AuiPaneInfo

BestSize (self, x, y)

Parameters

x (int) –
y (int) –

Return type

wx.aui.AuiPaneInfo

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).

Return type: wx.aui.AuiPaneInfo

BottomDockable(self, b=True)¶

BottomDockable indicates whether a pane can be docked at the bottom of the frame.

Parameters: b (bool) –
Return type: wx.aui.AuiPaneInfo

Caption(self, c)¶

Caption sets the caption of the pane.

Parameters: c (string) –
Return type: wx.aui.AuiPaneInfo

CaptionVisible(self, visible=True)¶

CaptionVisible indicates that a pane caption should be visible.

If False, no pane caption is drawn.

Parameters: visible (bool) –
Return type: wx.aui.AuiPaneInfo

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).

Return type: wx.aui.AuiPaneInfo

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.

Return type: wx.aui.AuiPaneInfo

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).

Return type: wx.aui.AuiPaneInfo

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.

Return type: wx.aui.AuiPaneInfo

CloseButton(self, visible=True)¶

CloseButton indicates that a close button should be drawn for the pane.

Parameters: visible (bool) –
Return type: wx.aui.AuiPaneInfo

DefaultPane(self)¶

DefaultPane specifies that the pane should adopt the default pane settings.

Return type: wx.aui.AuiPaneInfo

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.

Parameters: b (bool) –
Return type: wx.aui.AuiPaneInfo

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.

Parameters: direction (int) –
Return type: wx.aui.AuiPaneInfo

Dock(self)¶

Dock indicates that a pane should be docked.

It is the opposite of Float .

Return type: wx.aui.AuiPaneInfo

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.

Parameters: b (bool) –
Return type: wx.aui.AuiPaneInfo

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).

Parameters: b (bool) –
Return type: wx.aui.AuiPaneInfo

Fixed(self)¶

Fixed forces a pane to be fixed size so that it cannot be resized.

After calling Fixed , IsFixed will return True.

Return type: wx.aui.AuiPaneInfo

Float(self)¶

Float indicates that a pane should be floated.

It is the opposite of Dock .

Return type: wx.aui.AuiPaneInfo

Floatable(self, b=True)¶

Floatable sets whether the user will be able to undock a pane and turn it into a floating window.

Parameters: b (bool) –
Return type: wx.aui.AuiPaneInfo

FloatingPosition(self, *args, **kw)¶

FloatingPosition sets the position of the floating pane.

Overloaded Implementations:

FloatingPosition (self, pos)

Parameters: pos (wx.Point) –
Return type: wx.aui.AuiPaneInfo

FloatingPosition (self, x, y)

Parameters

x (int) –
y (int) –

Return type

wx.aui.AuiPaneInfo

FloatingSize(self, *args, **kw)¶

FloatingSize sets the size of the floating pane.

Overloaded Implementations:

FloatingSize (self, size)

Parameters: size (wx.Size) –
Return type: wx.aui.AuiPaneInfo

FloatingSize (self, x, y)

Parameters

x (int) –
y (int) –

Return type

wx.aui.AuiPaneInfo

Gripper(self, visible=True)¶

Gripper indicates that a gripper should be drawn for the pane.

Parameters: visible (bool) –
Return type: wx.aui.AuiPaneInfo

GripperTop(self, attop=True)¶

GripperTop indicates that a gripper should be drawn at the top of the pane.

Parameters: attop (bool) –
Return type: wx.aui.AuiPaneInfo

HasBorder(self)¶

HasBorder returns True if the pane displays a border.

Return type: bool

HasCaption(self)¶

HasCaption returns True if the pane displays a caption.

Return type: bool

HasCloseButton(self)¶

HasCloseButton returns True if the pane displays a button to close the pane.

Return type: bool

HasFlag(self, flag)¶

HasFlag returns True if the property specified by flag is active for the pane.

Parameters: flag (int) –
Return type: bool

HasGripper(self)¶

HasGripper returns True if the pane displays a gripper.

Return type: bool

HasGripperTop(self)¶

HasGripper returns True if the pane displays a gripper at the top.

Return type: bool

HasMaximizeButton(self)¶

HasMaximizeButton returns True if the pane displays a button to maximize the pane.

Return type: bool

HasMinimizeButton(self)¶

HasMinimizeButton returns True if the pane displays a button to minimize the pane.

Return type: bool

HasPinButton(self)¶

HasPinButton returns True if the pane displays a button to float the pane.

Return type: bool

Hide(self)¶

Hide indicates that a pane should be hidden.

Return type: wx.aui.AuiPaneInfo

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.

Parameters: b (wx.BitmapBundle) –
Return type: wx.aui.AuiPaneInfo

New in version 2.9.2.

IsBottomDockable(self)¶

IsBottomDockable returns True if the pane can be docked at the bottom of the managed frame.

Return type: bool

See also

IsDockable

IsDockable(self)¶

Returns True if the pane can be docked at any side.

Return type: bool

New in version 2.9.2.

IsDocked(self)¶

IsDocked returns True if the pane is currently docked.

Return type: bool

IsFixed(self)¶

IsFixed returns True if the pane cannot be resized.

Return type: bool

IsFloatable(self)¶

IsFloatable returns True if the pane can be undocked and displayed as a floating window.

Return type: bool

IsFloating(self)¶

IsFloating returns True if the pane is floating.

Return type: bool

IsLeftDockable(self)¶

IsLeftDockable returns True if the pane can be docked on the left of the managed frame.

Return type: bool

See also

IsDockable

IsMovable(self)¶

IsMoveable() returns True if the docked frame can be undocked or moved to another dock position.

Return type: 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.

Return type: bool

IsResizable(self)¶

IsResizable returns True if the pane can be resized.

Return type: bool

IsRightDockable(self)¶

IsRightDockable returns True if the pane can be docked on the right of the managed frame.

Return type: bool

See also

IsDockable

IsShown(self)¶

IsShown returns True if the pane is currently shown.

Return type: bool

IsToolbar(self)¶

IsToolbar returns True if the pane contains a toolbar.

Return type: bool

IsTopDockable(self)¶

IsTopDockable returns True if the pane can be docked at the top of the managed frame.

Return type: bool

See also

IsDockable

IsValid(self)¶

Return type: 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.

Parameters: layer (int) –
Return type: wx.aui.AuiPaneInfo

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).

Return type: wx.aui.AuiPaneInfo

LeftDockable(self, b=True)¶

LeftDockable indicates whether a pane can be docked on the left of the frame.

Parameters: b (bool) –
Return type: wx.aui.AuiPaneInfo

MaxSize(self, *args, **kw)¶

MaxSize sets the maximum size of the pane.

Overloaded Implementations:

MaxSize (self, size)

Parameters: size (wx.Size) –
Return type: wx.aui.AuiPaneInfo

MaxSize (self, x, y)

Parameters

x (int) –
y (int) –

Return type

wx.aui.AuiPaneInfo

MaximizeButton(self, visible=True)¶

MaximizeButton indicates that a maximize button should be drawn for the pane.

Parameters: visible (bool) –
Return type: wx.aui.AuiPaneInfo

MinSize(self, *args, **kw)¶

MinSize sets the minimum size of the pane.

Please note that this is only partially supported as of this writing.

Overloaded Implementations:

MinSize (self, size)

Parameters: size (wx.Size) –
Return type: wx.aui.AuiPaneInfo

MinSize (self, x, y)

Parameters

x (int) –
y (int) –

Return type

wx.aui.AuiPaneInfo

MinimizeButton(self, visible=True)¶

MinimizeButton indicates that a minimize button should be drawn for the pane.

Parameters: visible (bool) –
Return type: wx.aui.AuiPaneInfo

Movable(self, b=True)¶

Movable indicates whether a frame can be moved.

Parameters: b (bool) –
Return type: wx.aui.AuiPaneInfo

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.

Parameters: n (string) –
Return type: wx.aui.AuiPaneInfo

PaneBorder(self, visible=True)¶

PaneBorder indicates that a border should be drawn for the pane.

Parameters: visible (bool) –
Return type: wx.aui.AuiPaneInfo

PinButton(self, visible=True)¶

PinButton indicates that a pin button should be drawn for the pane.

Parameters: visible (bool) –
Return type: wx.aui.AuiPaneInfo

Position(self, pos)¶

wx.Position determines the position of the docked pane.

Parameters: pos (int) –
Return type: wx.aui.AuiPaneInfo

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 .

Parameters: resizable (bool) –
Return type: wx.aui.AuiPaneInfo

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).

Return type: wx.aui.AuiPaneInfo

RightDockable(self, b=True)¶

RightDockable indicates whether a pane can be docked on the right of the frame.

Parameters: b (bool) –
Return type: wx.aui.AuiPaneInfo

Row(self, row)¶

Row determines the row of the docked pane.

Parameters: row (int) –
Return type: wx.aui.AuiPaneInfo

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.

Parameters: 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.

Parameters

flag (int) –
option_state (bool) –

Return type

wx.aui.AuiPaneInfo

Show(self, show=True)¶

Show indicates that a pane should be shown.

Parameters: show (bool) –
Return type: wx.aui.AuiPaneInfo

ToolbarPane(self)¶

ToolbarPane specifies that the pane should adopt the default toolbar pane settings.

Return type: wx.aui.AuiPaneInfo

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).

Return type: wx.aui.AuiPaneInfo

TopDockable(self, b=True)¶

TopDockable indicates whether a pane can be docked at the top of the frame.

Parameters: b (bool) –
Return type: wx.aui.AuiPaneInfo

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.

Parameters: w (wx.Window) –
Return type: wx.aui.AuiPaneInfo

Properties¶

best_size¶: A public C++ attribute of type Size . size that the layout engine will prefer

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)

floating_pos¶: A public C++ attribute of type Point . position while floating

floating_size¶: A public C++ attribute of type Size . size while floating

frame¶: A public C++ attribute of type Frame . floating frame window that holds the pane

icon¶: A public C++ attribute of type BitmapBundle . icon of the pane, may be invalid

max_size¶: A public C++ attribute of type Size . maximum size the pane window can tolerate

min_size¶: A public C++ attribute of type Size . minimum size the pane window can tolerate

name¶: A public C++ attribute of type string. name of the pane

rect¶: A public C++ attribute of type Rect . current rectangle (populated by AUI)

state¶: A public C++ attribute of type int. a combination of PaneState values

window¶: A public C++ attribute of type Window . window that is in this pane

Navigation

wx.aui.AuiPaneInfo¶

Class Hierarchy¶

Methods Summary¶

Properties Summary¶

Class API¶

Methods¶

Properties¶