wxAuiPaneInfo

wxAuiPaneInfo
wxAuiPaneInfo is part of the wxAUI class framework. See also the Advanced User Interface overview.

Creation Parameters

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

Functions/Procedures
Supertopics

wxAuiPaneInfo

[proc]
aui_best_size
( atom info, atom x, atom y )

Category: wxAuiPaneInfo

See best_size_pane.


wxAuiPaneInfo

[proc]
aui_bottom
( atom info )

Category: wxAuiPaneInfo

Sets the pane dock position to the bottom side of the frame. This is the same thing as calling aui_direction( wxAUI_DOCK_BOTTOM ).


wxAuiPaneInfo

[proc]
aui_bottom_dockable
( atom info, atom b )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_caption
( atom info, sequence c )

Category: wxAuiPaneInfo

Sets the caption of the pane.


wxAuiPaneInfo

[proc]
aui_caption_visible
( atom info, atom visible )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_center
( atom info )

Category: wxAuiPaneInfo

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 aui_direction( wxAUI_DOCK_CENTRE ).


wxAuiPaneInfo

[proc]
aui_center_pane
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_close_button
( atom info, atom visible )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_default_pane
( atom info )

Category: wxAuiPaneInfo

Specifies that the pane should adopt the default pane settings.


wxAuiPaneInfo

[proc]
aui_destroy_on_close
( atom info, atom b )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_direction
( atom info, atom direction )

Category: wxAuiPaneInfo

Determines the direction of the docked pane. It is functionally the same as calling aui_left, aui_right(), aui_top or aui_bottom, except that docking direction may be specified programmatically via the parameter.


wxAuiPaneInfo

[proc]
aui_dock
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_dockable
( atom info, atom b )

Category: wxAuiPaneInfo

Specifies whether a frame can be docked or not. It is the same as specifying aui_top_dockable, aui_bottom_dockable, aui_left_dockable, aui_right_dockable.


wxAuiPaneInfo

[proc]
aui_fixed
( atom info )

Category: wxAuiPaneInfo

Forces a pane to be fixed size so that it cannot be resized. After calling aui_fixed, aui_is_fixed will return true.


wxAuiPaneInfo

[proc]
aui_float
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_floatable
( atom info, atom b )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_floating_position
( atom info, atom x, atom y )

Category: wxAuiPaneInfo

Sets the position of the floating pane.


wxAuiPaneInfo

[proc]
aui_floating_size
( atom info, atom x, atom y )

Category: wxAuiPaneInfo

Sets the size of the floating pane.


wxAuiPaneInfo

[proc]
aui_gripper
( atom info, atom visible )

Category: wxAuiPaneInfo

Indicates that a gripper should be drawn for the pane.


wxAuiPaneInfo

[proc]
aui_gripper_top
( atom info, atom attop )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[func]
aui_has_border
( atom info )

Category: wxAuiPaneInfo

Returns true if the pane displays a border.


wxAuiPaneInfo

[func]
aui_has_caption
( atom info )

Category: wxAuiPaneInfo

Returns true if the pane displays a caption.


wxAuiPaneInfo

[func]
aui_has_close_button
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[func]
aui_has_flag
( atom info, atom flag )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[func]
aui_has_gripper
( atom info )

Category: wxAuiPaneInfo

Returns true if the pane displays a gripper.


wxAuiPaneInfo

[func]
aui_has_gripper_top
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[func]
aui_has_maximize_button
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[func]
aui_has_minimize_button
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[func]
aui_has_pin_button
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_hide
( atom info )

Category: wxAuiPaneInfo

Indicates that a pane should be hidden.


wxAuiPaneInfo

[func]
aui_is_bottom_dockable
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[func]
aui_is_docked
( atom info )

Category: wxAuiPaneInfo

Returns true if the pane is docked.


wxAuiPaneInfo

[func]
aui_is_fixed
( atom info )

Category: wxAuiPaneInfo

Returns true if the pane cannot be resized.


wxAuiPaneInfo

[func]
aui_is_floatable
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[func]
aui_is_floating
( atom info )

Category: wxAuiPaneInfo

Returns true if the pane is floating.


wxAuiPaneInfo

[func]
aui_is_left_dockable
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[func]
aui_is_movable
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[func]
aui_is_ok
( atom info )

Category: wxAuiPaneInfo

Returns true if the wxAuiPaneInfo structure is valid. A pane structure is valid if it has an associated window.


wxAuiPaneInfo

[func]
aui_is_resizable
( atom info )

Category: wxAuiPaneInfo

Returns true if the pane can be resized.


wxAuiPaneInfo

[func]
aui_is_right_dockable
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[func]
aui_is_shown
( atom info )

Category: wxAuiPaneInfo

Returns true if the pane is currently shown.


wxAuiPaneInfo

[func]
aui_is_toolbar
( atom info )

Category: wxAuiPaneInfo

Returns true if the pane contains a toolbar.


wxAuiPaneInfo

[func]
aui_is_top_dockable
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_layer
( atom info, atom layer )

Category: wxAuiPaneInfo

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.


wxAuiPaneInfo

[proc]
aui_left
( atom info )

Category: wxAuiPaneInfo

Sets the pane dock position to the left side of the frame. This is the same thing as calling aui_direction( wxAUI_DOCK_LEFT ).


wxAuiPaneInfo

[proc]
aui_left_dockable
( atom info, atom b )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_maximize_button
( atom info, atom visible )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_max_size
( atom info, atom x, atom y )

Category: wxAuiPaneInfo

Sets the maximum size of the pane.


wxAuiPaneInfo

[proc]
aui_minimize_button
( atom info, atom visible )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_min_size
( atom info, atom x, atom y )

Category: wxAuiPaneInfo

Sets the minimum size of the pane. Please note that this is only partially supported as of this writing.


wxAuiPaneInfo

[proc]
aui_movable
( atom info, atom b )

Category: wxAuiPaneInfo

Indicates whether a frame can be moved.


wxAuiPaneInfo

[proc]
aui_name
( atom info, sequence n )

Category: wxAuiPaneInfo

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.


wxAuiPaneInfo

[proc]
aui_pane_border
( atom info, atom visible )

Category: wxAuiPaneInfo

Indicates that a border should be drawn for the pane.


wxAuiPaneInfo

[proc]
aui_pin_button
( atom info, atom visible )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_position
( atom info, atom pos )

Category: wxAuiPaneInfo

Determines the position of the docked pane.


wxAuiPaneInfo

[proc]
aui_resizable
( atom info, atom resizable )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_right
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_right_dockable
( atom info, atom b )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_row
( atom info, atom row )

Category: wxAuiPaneInfo

Determines the row of the docked pane.


wxAuiPaneInfo

[proc]
aui_safe_set
( atom info, atom source )

Category: wxAuiPaneInfo

Write the safe parts of a newly loaded PaneInfo structure source into info (used on loading perspectives etc).


wxAuiPaneInfo

[proc]
aui_set_flag
( atom info, atom flag, atom option_state )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_show
( atom info, atom show )

Category: wxAuiPaneInfo

Indicates that a pane should be shown.


wxAuiPaneInfo

[proc]
aui_toolbar_pane
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_top
( atom info )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_top_dockable
( atom info, atom b )

Category: wxAuiPaneInfo

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


wxAuiPaneInfo

[proc]
aui_window
( atom info, atom w )

Category: wxAuiPaneInfo

Assigns the window pointer that the wxAuiPaneInfo should use. This normally does not need to be specified, as the window pointer is automatically assigned to the wxAuiPaneInfo structure as soon as it is added to the manager.


wxAuiPaneInfo

[proc]
best_size_pane
( atom info, atom x, atom y )

Category: wxAuiPaneInfo

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.