View Source wxAuiPaneInfo (wx v2.4.3)
wxAuiPaneInfo is part of the wxAUI class framework.
See also overview_aui.
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.
See:
wxWidgets docs: wxAuiPaneInfo
Summary
Functions
bestSize/3 sets the ideal size for the pane.
bottom/1 sets the pane dock position to the bottom side of the frame.
Equivalent to bottomDockable(This, []).
bottomDockable/2 indicates whether a pane can be docked at the bottom of the frame.
caption/2 sets the caption of the pane.
Equivalent to captionVisible(This, []).
CaptionVisible indicates that a pane caption should be visible.
Center() (not implemented in wx) sets the pane dock position to the left side of the
frame.
centrePane/1 specifies that the pane should adopt the default center pane settings.
Equivalent to closeButton(This, []).
closeButton/2 indicates that a close button should be drawn for the pane.
defaultPane/1 specifies that the pane should adopt the default pane settings.
Destroys the object
Equivalent to destroyOnClose(This, []).
destroyOnClose/2 indicates whether a pane should be destroyed when it is closed.
direction/2 determines the direction of the docked pane.
dock/1 indicates that a pane should be docked.
Equivalent to dockable(This, []).
dockable/2 specifies whether a frame can be docked or not.
fixed/1 forces a pane to be fixed size so that it cannot be resized.
float/1 indicates that a pane should be floated.
Equivalent to floatable(This, []).
floatable/2 sets whether the user will be able to undock a pane and turn it into a
floating window.
floatingPosition/3 sets the position of the floating pane.
floatingSize/3 sets the size of the floating pane.
Equivalent to gripper(This, []).
Equivalent to gripperTop(This, []).
gripperTop/2 indicates that a gripper should be drawn at the top of the pane.
hasBorder/1 returns true if the pane displays a border.
hasCaption/1 returns true if the pane displays a caption.
hasCloseButton/1 returns true if the pane displays a button to close the pane.
hasFlag/2 returns true if the property specified by flag is active for the pane.
hasGripper/1 returns true if the pane displays a gripper.
hasGripper/1 returns true if the pane displays a gripper at the top.
hasMaximizeButton/1 returns true if the pane displays a button to maximize the pane.
hasMinimizeButton/1 returns true if the pane displays a button to minimize the pane.
hasPinButton/1 returns true if the pane displays a button to float the pane.
hide/1 indicates that a pane should be hidden.
isBottomDockable/1 returns true if the pane can be docked at the bottom of the managed
frame.
isDocked/1 returns true if the pane is currently docked.
isFixed/1 returns true if the pane cannot be resized.
isFloatable/1 returns true if the pane can be undocked and displayed as a floating
window.
isFloating/1 returns true if the pane is floating.
isLeftDockable/1 returns true if the pane can be docked on the left of the managed
frame.
IsMoveable() returns true if the docked frame can be undocked or moved to another dock position.
isOk/1 returns true if the wxAuiPaneInfo structure is valid.
isResizable/1 returns true if the pane can be resized.
isRightDockable/1 returns true if the pane can be docked on the right of the managed
frame.
isShown/1 returns true if the pane is currently shown.
isToolbar/1 returns true if the pane contains a toolbar.
isTopDockable/1 returns true if the pane can be docked at the top of the managed frame.
layer/2 determines the layer of the docked pane.
left/1 sets the pane dock position to the left side of the frame.
Equivalent to leftDockable(This, []).
leftDockable/2 indicates whether a pane can be docked on the left of the frame.
Equivalent to maximizeButton(This, []).
maximizeButton/2 indicates that a maximize button should be drawn for the pane.
maxSize/3 sets the maximum size of the pane.
Equivalent to minimizeButton(This, []).
minimizeButton/2 indicates that a minimize button should be drawn for the pane.
minSize/3 sets the minimum size of the pane.
Equivalent to movable(This, []).
Movable indicates whether a frame can be moved.
name/2 sets the name of the pane so it can be referenced in lookup functions.
Copy constructor.
Equivalent to paneBorder(This, []).
PaneBorder indicates that a border should be drawn for the pane.
Equivalent to pinButton(This, []).
pinButton/2 indicates that a pin button should be drawn for the pane.
position/2 determines the position of the docked pane.
Equivalent to resizable(This, []).
resizable/2 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/1 sets the pane dock position to the right side of the frame.
Equivalent to rightDockable(This, []).
rightDockable/2 indicates whether a pane can be docked on the right of the frame.
row/2 determines the row of the docked pane.
Write the safe parts of a PaneInfo object "source" into "this".
setFlag/3 turns the property given by flag on or off with the option_state parameter.
Equivalent to show(This, []).
toolbarPane/1 specifies that the pane should adopt the default toolbar pane settings.
Equivalent to topDockable(This, []).
topDockable/2 indicates whether a pane can be docked at the top of the frame.
window/2 assigns the window pointer that the wxAuiPaneInfo should use.
Types
-type wxAuiPaneInfo() :: wx:wx_object().
Functions
-spec bestSize(This, Size) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Size :: {W :: integer(), H :: integer()}.
bestSize/3 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.
-spec bestSize(This, X, Y) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), X :: integer(), Y :: integer().
-spec bottom(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
bottom/1 sets the pane dock position to the bottom side of the frame.
This is the same thing as calling Direction(wxAUI_DOCK_BOTTOM).
-spec bottomDockable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to bottomDockable(This, []).
-spec bottomDockable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
bottomDockable/2 indicates whether a pane can be docked at the bottom of the frame.
-spec caption(This, C) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), C :: unicode:chardata().
caption/2 sets the caption of the pane.
-spec captionVisible(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to captionVisible(This, []).
-spec captionVisible(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
CaptionVisible indicates that a pane caption should be visible.
If false, no pane caption is drawn.
-spec centre(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Center() (not implemented in wx) 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).
-spec centrePane(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
centrePane/1 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.
-spec closeButton(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to closeButton(This, []).
-spec closeButton(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
closeButton/2 indicates that a close button should be drawn for the pane.
-spec defaultPane(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
defaultPane/1 specifies that the pane should adopt the default pane settings.
-spec destroy(This :: wxAuiPaneInfo()) -> ok.
Destroys the object
-spec destroyOnClose(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to destroyOnClose(This, []).
-spec destroyOnClose(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
destroyOnClose/2 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.
-spec direction(This, Direction) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Direction :: integer().
direction/2 determines the direction of the docked pane.
It is functionally the same as calling left/1, right/1, top/1 or bottom/1, except that docking direction may be
specified programmatically via the parameter.
-spec dock(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
dock/1 indicates that a pane should be docked.
It is the opposite of float/1.
-spec dockable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to dockable(This, []).
-spec dockable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
dockable/2 specifies whether a frame can be docked or not.
It is the same as specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b).
-spec fixed(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
fixed/1 forces a pane to be fixed size so that it cannot be resized.
-spec float(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
float/1 indicates that a pane should be floated.
It is the opposite of dock/1.
-spec floatable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to floatable(This, []).
-spec floatable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
floatable/2 sets whether the user will be able to undock a pane and turn it into a
floating window.
-spec floatingPosition(This, Pos) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Pos :: {X :: integer(), Y :: integer()}.
floatingPosition/3 sets the position of the floating pane.
-spec floatingPosition(This, X, Y) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), X :: integer(), Y :: integer().
-spec floatingSize(This, Size) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Size :: {W :: integer(), H :: integer()}.
floatingSize/3 sets the size of the floating pane.
-spec floatingSize(This, X, Y) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), X :: integer(), Y :: integer().
-spec getDirection(This) -> integer() when This :: wxAuiPaneInfo().
-spec getFloatingPosition(This) -> {X :: integer(), Y :: integer()} when This :: wxAuiPaneInfo().
-spec getFloatingSize(This) -> {W :: integer(), H :: integer()} when This :: wxAuiPaneInfo().
-spec getFrame(This) -> wxFrame:wxFrame() when This :: wxAuiPaneInfo().
-spec getLayer(This) -> integer() when This :: wxAuiPaneInfo().
-spec getPosition(This) -> integer() when This :: wxAuiPaneInfo().
-spec getRow(This) -> integer() when This :: wxAuiPaneInfo().
-spec getWindow(This) -> wxWindow:wxWindow() when This :: wxAuiPaneInfo().
-spec gripper(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to gripper(This, []).
-spec gripper(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
gripper/2 indicates that a gripper should be drawn for the pane.
-spec gripperTop(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to gripperTop(This, []).
-spec gripperTop(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {attop, boolean()}.
gripperTop/2 indicates that a gripper should be drawn at the top of the pane.
-spec hasBorder(This) -> boolean() when This :: wxAuiPaneInfo().
hasBorder/1 returns true if the pane displays a border.
-spec hasCaption(This) -> boolean() when This :: wxAuiPaneInfo().
hasCaption/1 returns true if the pane displays a caption.
-spec hasCloseButton(This) -> boolean() when This :: wxAuiPaneInfo().
hasCloseButton/1 returns true if the pane displays a button to close the pane.
-spec hasFlag(This, Flag) -> boolean() when This :: wxAuiPaneInfo(), Flag :: integer().
hasFlag/2 returns true if the property specified by flag is active for the pane.
-spec hasGripper(This) -> boolean() when This :: wxAuiPaneInfo().
hasGripper/1 returns true if the pane displays a gripper.
-spec hasGripperTop(This) -> boolean() when This :: wxAuiPaneInfo().
hasGripper/1 returns true if the pane displays a gripper at the top.
-spec hasMaximizeButton(This) -> boolean() when This :: wxAuiPaneInfo().
hasMaximizeButton/1 returns true if the pane displays a button to maximize the pane.
-spec hasMinimizeButton(This) -> boolean() when This :: wxAuiPaneInfo().
hasMinimizeButton/1 returns true if the pane displays a button to minimize the pane.
-spec hasPinButton(This) -> boolean() when This :: wxAuiPaneInfo().
hasPinButton/1 returns true if the pane displays a button to float the pane.
-spec hide(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
hide/1 indicates that a pane should be hidden.
-spec isBottomDockable(This) -> boolean() when This :: wxAuiPaneInfo().
isBottomDockable/1 returns true if the pane can be docked at the bottom of the managed
frame.
-spec isDocked(This) -> boolean() when This :: wxAuiPaneInfo().
isDocked/1 returns true if the pane is currently docked.
-spec isFixed(This) -> boolean() when This :: wxAuiPaneInfo().
isFixed/1 returns true if the pane cannot be resized.
-spec isFloatable(This) -> boolean() when This :: wxAuiPaneInfo().
isFloatable/1 returns true if the pane can be undocked and displayed as a floating
window.
-spec isFloating(This) -> boolean() when This :: wxAuiPaneInfo().
isFloating/1 returns true if the pane is floating.
-spec isLeftDockable(This) -> boolean() when This :: wxAuiPaneInfo().
isLeftDockable/1 returns true if the pane can be docked on the left of the managed
frame.
-spec isMovable(This) -> boolean() when This :: wxAuiPaneInfo().
IsMoveable() returns true if the docked frame can be undocked or moved to another dock position.
-spec isOk(This) -> boolean() when This :: wxAuiPaneInfo().
isOk/1 returns true if the wxAuiPaneInfo structure is valid.
A pane structure is valid if it has an associated window.
-spec isResizable(This) -> boolean() when This :: wxAuiPaneInfo().
isResizable/1 returns true if the pane can be resized.
-spec isRightDockable(This) -> boolean() when This :: wxAuiPaneInfo().
isRightDockable/1 returns true if the pane can be docked on the right of the managed
frame.
-spec isShown(This) -> boolean() when This :: wxAuiPaneInfo().
isShown/1 returns true if the pane is currently shown.
-spec isToolbar(This) -> boolean() when This :: wxAuiPaneInfo().
isToolbar/1 returns true if the pane contains a toolbar.
-spec isTopDockable(This) -> boolean() when This :: wxAuiPaneInfo().
isTopDockable/1 returns true if the pane can be docked at the top of the managed frame.
-spec layer(This, Layer) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Layer :: integer().
layer/2 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.
-spec left(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
left/1 sets the pane dock position to the left side of the frame.
This is the same thing as calling Direction(wxAUI_DOCK_LEFT).
-spec leftDockable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to leftDockable(This, []).
-spec leftDockable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
leftDockable/2 indicates whether a pane can be docked on the left of the frame.
-spec maximizeButton(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to maximizeButton(This, []).
-spec maximizeButton(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
maximizeButton/2 indicates that a maximize button should be drawn for the pane.
-spec maxSize(This, Size) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Size :: {W :: integer(), H :: integer()}.
maxSize/3 sets the maximum size of the pane.
-spec maxSize(This, X, Y) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), X :: integer(), Y :: integer().
-spec minimizeButton(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to minimizeButton(This, []).
-spec minimizeButton(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
minimizeButton/2 indicates that a minimize button should be drawn for the pane.
-spec minSize(This, Size) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Size :: {W :: integer(), H :: integer()}.
minSize/3 sets the minimum size of the pane.
Please note that this is only partially supported as of this writing.
-spec minSize(This, X, Y) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), X :: integer(), Y :: integer().
-spec movable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to movable(This, []).
-spec movable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
Movable indicates whether a frame can be moved.
-spec name(This, N) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), N :: unicode:chardata().
name/2 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.
-spec new() -> wxAuiPaneInfo().
-spec new(C) -> wxAuiPaneInfo() when C :: wxAuiPaneInfo().
Copy constructor.
-spec paneBorder(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to paneBorder(This, []).
-spec paneBorder(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
PaneBorder indicates that a border should be drawn for the pane.
-spec pinButton(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to pinButton(This, []).
-spec pinButton(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {visible, boolean()}.
pinButton/2 indicates that a pin button should be drawn for the pane.
-spec position(This, Pos) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Pos :: integer().
position/2 determines the position of the docked pane.
-spec resizable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to resizable(This, []).
-spec resizable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {resizable, boolean()}.
resizable/2 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/1.
-spec right(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
right/1 sets the pane dock position to the right side of the frame.
This is the same thing as calling Direction(wxAUI_DOCK_RIGHT).
-spec rightDockable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to rightDockable(This, []).
-spec rightDockable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
rightDockable/2 indicates whether a pane can be docked on the right of the frame.
-spec row(This, Row) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Row :: integer().
row/2 determines the row of the docked pane.
-spec safeSet(This, Source) -> ok when This :: wxAuiPaneInfo(), Source :: wxAuiPaneInfo().
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.
Remark: This method is used when loading perspectives.
-spec setFlag(This, Flag, Option_state) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Flag :: integer(), Option_state :: boolean().
setFlag/3 turns the property given by flag on or off with the option_state parameter.
-spec show(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to show(This, []).
-spec show(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {show, boolean()}.
show/2 indicates that a pane should be shown.
-spec toolbarPane(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
toolbarPane/1 specifies that the pane should adopt the default toolbar pane settings.
-spec top(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
top/1 sets the pane dock position to the top of the frame.
This is the same thing as calling Direction(wxAUI_DOCK_TOP).
-spec topDockable(This) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo().
Equivalent to topDockable(This, []).
-spec topDockable(This, [Option]) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), Option :: {b, boolean()}.
topDockable/2 indicates whether a pane can be docked at the top of the frame.
-spec window(This, W) -> wxAuiPaneInfo() when This :: wxAuiPaneInfo(), W :: wxWindow:wxWindow().
window/2 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.