wx.aui.AuiPaneInfo

Inheritance diagram for wx.aui.AuiPaneInfo:

Description

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

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

Constants

wxAuiPaneInsertLevel data structure:

Flags	Value
wx.aui.AUI_INSERT_PANE	0
wx.aui.AUI_INSERT_ROW	1
wx.aui.AUI_INSERT_DOCK	2

Methods Summary

• __init__
• BestSize
• Bottom
• BottomDockable
• Caption
• CaptionVisible
• Center
• CenterPane
• Centre
• CentrePane
• CloseButton
• DefaultPane
• DestroyOnClose
• Direction
• Dock
• DockFixed
• Dockable
• Fixed
• Float
• Floatable
• FloatingPosition
• FloatingSize
• Gripper
• GripperTop
• HasBorder
• HasCaption
• HasCloseButton
• HasFlag
• HasGripper
• HasGripperTop
• HasMaximizeButton
• HasMinimizeButton
• HasPinButton
• Hide
• IsBottomDockable
• IsDestroyOnClose
• IsDocked
• IsFixed
• IsFloatable
• IsFloating
• IsLeftDockable
• IsMaximized
• IsMovable
• IsOk
• IsResizable
• IsRightDockable
• IsShown
• IsToolbar
• IsTopDockable
• Layer
• Left
• LeftDockable
• MaxSize
• Maximize
• MaximizeButton
• MinSize
• MinimizeButton
• Movable
• Name
• PaneBorder
• PinButton
• Position
• Resizable
• Restore
• Right
• RightDockable
• Row
• SafeSet
• SetFlag
• Show
• ToolbarPane
• Top
• TopDockable
• Window

Properties Summary

• best_size
• buttons
• caption
• dock_direction
• dock_layer
• dock_pos
• dock_proportion
• dock_row
• floating_pos
• floating_size
• frame
• max_size
• min_size
• name
• rect
• state
• window

Class API

Methods

__init__()

No docstrings available for this method.

---

BestSize(size)

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.

Parameters:

• size (wx.Size)

Returns:

wx.aui.AuiPaneInfo

---

Bottom()

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

This is the same thing as calling Direction (wx.aui.AUI_DOCK_BOTTOM).

Returns:

wx.aui.AuiPaneInfo

---

BottomDockable(b=True)

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

Parameters:

• b (bool): True if the pane can be docked at the bottom, False otherwise.

Returns:

wx.aui.AuiPaneInfo

---

Caption(c)

Sets the caption of the pane.

Parameters:

• c (string): The pane caption.

Returns:

wx.aui.AuiPaneInfo

---

CaptionVisible(visible=True)

Indicates that a pane caption should be visible. If False, no pane caption is drawn.

Parameters:

• visible (bool)

Returns:

wx.aui.AuiPaneInfo

---

Center()

See Centre.

---

CenterPane()

See CentrePane.

---

Centre()

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 (wx.aui.AUI_DOCK_CENTRE).

Returns:

wx.aui.AuiPaneInfo

---

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.

Returns:

wx.aui.AuiPaneInfo

---

CloseButton(visible=True)

Indicates that a close button should be drawn for the pane.

Parameters:

• visible (bool): True to show the close button, False otherwise.

Returns:

wx.aui.AuiPaneInfo

---

DefaultPane()

Specifies that the pane should adopt the default pane settings.

Returns:

wx.aui.AuiPaneInfo

---

DestroyOnClose(b=True)

Indicates whether a pane should be detroyed 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)

Returns:

wx.aui.AuiPaneInfo

---

Direction(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.

Parameters:

• direction (int)

Returns:

wx.aui.AuiPaneInfo

---

Dock()

Indicates that a pane should be docked. It is the opposite of Float.

Returns:

wx.aui.AuiPaneInfo

---

DockFixed(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.

Parameters:

• b (bool)

Returns:

wx.aui.AuiPaneInfo

---

Dockable(b=True)

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)

Returns:

wx.aui.AuiPaneInfo

---

Fixed()

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

After calling Fixed, IsFixed will return True.

Returns:

wx.aui.AuiPaneInfo

---

Float()

Indicates that a pane should be floated. It is the opposite of Dock.

Returns:

wx.aui.AuiPaneInfo

---

Floatable(b=True)

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

Parameters:

• b (bool)

Returns:

wx.aui.AuiPaneInfo

---

FloatingPosition(pos)

Sets the position of the floating pane.

Parameters:

• pos (wx.Point)

Returns:

wx.aui.AuiPaneInfo

---

FloatingSize(size)

Sets the size of the floating pane.

Parameters:

• size (wx.Size)

Returns:

wx.aui.AuiPaneInfo

---

Gripper(visible=True)

Indicates that a gripper should be drawn for the pane.

Parameters:

• visible (bool): True to show the gripper, False otherwise.

Returns:

wx.aui.AuiPaneInfo

---

GripperTop(attop=True)

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

Parameters:

• attop (bool)

Returns:

wx.aui.AuiPaneInfo

---

HasBorder()

Returns True if the pane displays a border.

Returns:

bool

---

HasCaption()

Returns True if the pane displays a caption.

Returns:

bool

---

HasCloseButton()

Returns True if the pane displays a button to close the pane.

Returns:

bool

---

HasFlag(flag)

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

Parameters:

• flag (int)

Returns:

bool

---

HasGripper()

Returns True if the pane displays a gripper.

Returns:

bool

---

HasGripperTop()

Returns True if the pane displays a gripper at the top.

Returns:

bool

---

HasMaximizeButton()

Returns True if the pane displays a button to maximize the pane.

Returns:

bool

---

HasMinimizeButton()

Returns True if the pane displays a button to minimize the pane.

Returns:

bool

---

HasPinButton()

Returns True if the pane displays a button to float the pane.

Returns:

bool

---

Hide()

Indicates that a pane should be hidden.

Returns:

wx.aui.AuiPaneInfo

---

IsBottomDockable()

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

Returns:

bool

---

IsDestroyOnClose()

No docstrings available for this method.

---

IsDocked()

Returns True if the pane is docked.

Returns:

bool

---

IsFixed()

Returns True if the pane cannot be resized.

Returns:

bool

---

IsFloatable()

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

Returns:

bool

---

IsFloating()

Returns True if the pane is floating.

Returns:

bool

---

IsLeftDockable()

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

Returns:

bool

---

IsMaximized()

No docstrings available for this method.

---

IsMovable()

Returns True if the docked frame can be undocked or moved to another dock position.

Returns:

bool

---

IsOk()

Returns True if the wx.aui.AuiPaneInfo structure is valid.

A pane structure is valid if it has an associated window.

Returns:

bool

---

IsResizable()

Returns True if the pane can be resized.

Returns:

bool

---

IsRightDockable()

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

Returns:

bool

---

IsShown()

Returns True if the pane is currently shown.

Returns:

bool

---

IsToolbar()

Returns True if the pane contains a toolbar.

Returns:

bool

---

IsTopDockable()

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

Returns:

bool

---

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)

Returns:

wx.aui.AuiPaneInfo

---

Left()

Sets the pane dock position to the left side of the frame. This is the same thing as calling Direction (wx.aui.AUI_DOCK_LEFT).

Returns:

wx.aui.AuiPaneInfo

---

LeftDockable(b=True)

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

Parameters:

• b (bool)

Returns:

wx.aui.AuiPaneInfo

---

MaxSize(size)

Sets the maximum size of the pane.

Parameters:

• size (wx.Size)

Returns:

wx.aui.AuiPaneInfo

---

Maximize()

No docstrings available for this method.

---

MaximizeButton(visible=True)

Indicates that a maximize button should be drawn for the pane.

Parameters:

• visible (bool): True to show the maximize button, False otherwise.

Returns:

wx.aui.AuiPaneInfo

---

MinSize(size)

Sets the minimum size of the pane.

Parameters:

• size (wx.Size)

Returns:

wx.aui.AuiPaneInfo

Note

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

---

MinimizeButton(visible=True)

Indicates that a minimize button should be drawn for the pane.

Parameters:

• visible (bool): True to show the minimize button, False otherwise.

Returns:

wx.aui.AuiPaneInfo

---

Movable(b=True)

Indicates whether a frame can be moved.

Parameters:

• b (bool)

Returns:

wx.aui.AuiPaneInfo

---

Name(n)

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)

Returns:

wx.aui.AuiPaneInfo

---

PaneBorder(visible=True)

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

Parameters:

• visible (bool): whether to show a pane border or not.

Returns:

wx.aui.AuiPaneInfo

---

PinButton(visible=True)

Indicates that a pin button should be drawn for the pane.

Parameters:

• visible (bool): whether to show a pin button or not.

Returns:

wx.aui.AuiPaneInfo

---

Position(pos)

Determines the position of the docked pane.

Parameters:

• pos (int)

Returns:

wx.aui.AuiPaneInfo

---

Resizable(resizable=True)

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): whether the pane should be resizable or not.

Returns:

wx.aui.AuiPaneInfo

---

Restore()

No docstrings available for this method.

---

Right()

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

Returns:

wx.aui.AuiPaneInfo

---

RightDockable(b=True)

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

Parameters:

• b (bool)

Returns:

wx.aui.AuiPaneInfo

---

Row(row)

Determines the row of the docked pane.

Parameters:

• row (int)

Returns:

wx.aui.AuiPaneInfo

---

SafeSet(source)

Write the safe parts of a newly loaded wx.aui.AuiPaneInfo structure source into self.

Used on loading perspectives etc...

Parameters:

• source (wx.aui.AuiPaneInfo)

---

SetFlag(flag, option_state)

Turns the property given by flag on or off with the option_state parameter.

Parameters:

• flag (unsigned int)
• option_state (bool)

Returns:

wx.aui.AuiPaneInfo

---

Show(show=True)

Indicates that a pane should be shown.

Parameters:

• show (bool): whether to show or not the pane.

Returns:

wx.aui.AuiPaneInfo

---

ToolbarPane()

Specifies that the pane should adopt the default toolbar pane settings.

Returns:

wx.aui.AuiPaneInfo

---

Top()

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

Returns:

wx.aui.AuiPaneInfo

---

TopDockable(b=True)

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

Parameters:

• b (bool)

Returns:

wx.aui.AuiPaneInfo

---

Window(w)

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)

Returns:

wx.aui.AuiPaneInfo

---

Properties

best_size

buttons

caption

dock_direction

dock_layer

dock_pos

dock_proportion

dock_row

floating_pos

floating_size

frame

max_size

min_size

name

rect

state

window