Erlang -- wxAuiPaneInfo

# wxAuiPaneInfo

###
Module

wxAuiPaneInfo

###
Module Summary

Functions for wxAuiPaneInfo class

###
Description

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: wxAuiManager, wxAuiDockArt

wxWidgets docs: wxAuiPaneInfo

###
Data Types

####
wxAuiPaneInfo() = wx:wx_object()

###
Exports

####
new() -> wxAuiPaneInfo()

####
new(C) -> wxAuiPaneInfo()

### Types

C = wxAuiPaneInfo()

Copy constructor.

####
bestSize(This, Size) -> wxAuiPaneInfo()

### Types

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.

####
bestSize(This, X, Y) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
X = Y = integer()

####
bottom(This) -> wxAuiPaneInfo()

### Types

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

####
bottomDockable(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
bottomDockable(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {b, boolean()}

bottomDockable/2 indicates whether a pane can be docked at the bottom of the frame.

####
caption(This, C) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
C = unicode:chardata()

caption/2 sets the caption of the pane.

####
captionVisible(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
captionVisible(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {visible, boolean()}

CaptionVisible indicates that a pane caption should be visible.

If false, no pane caption is drawn.

####
centre(This) -> wxAuiPaneInfo()

### Types

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

####
centrePane(This) -> wxAuiPaneInfo()

### Types

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.

####
closeButton(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
closeButton(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {visible, boolean()}

closeButton/2 indicates that a close button should be drawn for the pane.

####
defaultPane(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

defaultPane/1 specifies that the pane should adopt the default pane settings.

####
destroyOnClose(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
destroyOnClose(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

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.

####
direction(This, Direction) -> wxAuiPaneInfo()

### Types

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.

####
dock(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

dock/1 indicates that a pane should be docked.

It is the opposite of float/1.

####
dockable(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
dockable(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

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

####
fixed(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

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

After calling fixed/1, isFixed/1 will return true.

####
float(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

float/1 indicates that a pane should be floated.

It is the opposite of dock/1.

####
floatable(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
floatable(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

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.

####
floatingPosition(This, Pos) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Pos = {X :: integer(), Y :: integer()}

floatingPosition/3 sets the position of the floating pane.

####
floatingPosition(This, X, Y) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
X = Y = integer()

####
floatingSize(This, Size) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Size = {W :: integer(), H :: integer()}

floatingSize/3 sets the size of the floating pane.

####
floatingSize(This, X, Y) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
X = Y = integer()

####
gripper(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
gripper(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {visible, boolean()}

gripper/2 indicates that a gripper should be drawn for the pane.

####
gripperTop(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
gripperTop(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {attop, boolean()}

gripperTop/2 indicates that a gripper should be drawn at the top of the pane.

####
hasBorder(This) -> boolean()

### Types

This = wxAuiPaneInfo()

hasBorder/1 returns true if the pane displays a border.

####
hasCaption(This) -> boolean()

### Types

This = wxAuiPaneInfo()

hasCaption/1 returns true if the pane displays a caption.

####
hasCloseButton(This) -> boolean()

### Types

This = wxAuiPaneInfo()

hasCloseButton/1 returns true if the pane displays a button to close the pane.

####
hasFlag(This, Flag) -> boolean()

### Types

This = wxAuiPaneInfo()
Flag = integer()

hasFlag/2 returns true if the property specified by flag is active for the pane.

####
hasGripper(This) -> boolean()

### Types

This = wxAuiPaneInfo()

hasGripper/1 returns true if the pane displays a gripper.

####
hasGripperTop(This) -> boolean()

### Types

This = wxAuiPaneInfo()

hasGripper/1 returns true if the pane displays a gripper at the top.

####
hasMaximizeButton(This) -> boolean()

### Types

This = wxAuiPaneInfo()

hasMaximizeButton/1 returns true if the pane displays a button to maximize the pane.

####
hasMinimizeButton(This) -> boolean()

### Types

This = wxAuiPaneInfo()

hasMinimizeButton/1 returns true if the pane displays a button to minimize the pane.

####
hasPinButton(This) -> boolean()

### Types

This = wxAuiPaneInfo()

hasPinButton/1 returns true if the pane displays a button to float the pane.

####
hide(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

hide/1 indicates that a pane should be hidden.

####
isBottomDockable(This) -> boolean()

### Types

This = wxAuiPaneInfo()

isBottomDockable/1 returns true if the pane can be docked at the bottom of the managed frame.

See: IsDockable() (not implemented in wx)

####
isDocked(This) -> boolean()

### Types

This = wxAuiPaneInfo()

isDocked/1 returns true if the pane is currently docked.

####
isFixed(This) -> boolean()

### Types

This = wxAuiPaneInfo()

isFixed/1 returns true if the pane cannot be resized.

####
isFloatable(This) -> boolean()

### Types

This = wxAuiPaneInfo()

isFloatable/1 returns true if the pane can be undocked and displayed as a floating window.

####
isFloating(This) -> boolean()

### Types

This = wxAuiPaneInfo()

isFloating/1 returns true if the pane is floating.

####
isLeftDockable(This) -> boolean()

### Types

This = wxAuiPaneInfo()

isLeftDockable/1 returns true if the pane can be docked on the left of the managed frame.

See: IsDockable() (not implemented in wx)

####
isMovable(This) -> boolean()

### Types

This = wxAuiPaneInfo()

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

####
isOk(This) -> boolean()

### Types

This = wxAuiPaneInfo()

isOk/1 returns true if the wxAuiPaneInfo structure is valid.

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

####
isResizable(This) -> boolean()

### Types

This = wxAuiPaneInfo()

isResizable/1 returns true if the pane can be resized.

####
isRightDockable(This) -> boolean()

### Types

This = wxAuiPaneInfo()

isRightDockable/1 returns true if the pane can be docked on the right of the managed frame.

See: IsDockable() (not implemented in wx)

####
isShown(This) -> boolean()

### Types

This = wxAuiPaneInfo()

isShown/1 returns true if the pane is currently shown.

####
isToolbar(This) -> boolean()

### Types

This = wxAuiPaneInfo()

isToolbar/1 returns true if the pane contains a toolbar.

####
isTopDockable(This) -> boolean()

### Types

This = wxAuiPaneInfo()

isTopDockable/1 returns true if the pane can be docked at the top of the managed frame.

See: IsDockable() (not implemented in wx)

####
layer(This, Layer) -> wxAuiPaneInfo()

### Types

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.

####
left(This) -> wxAuiPaneInfo()

### Types

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

####
leftDockable(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
leftDockable(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {b, boolean()}

leftDockable/2 indicates whether a pane can be docked on the left of the frame.

####
maxSize(This, Size) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Size = {W :: integer(), H :: integer()}

maxSize/3 sets the maximum size of the pane.

####
maxSize(This, X, Y) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
X = Y = integer()

####
maximizeButton(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
maximizeButton(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {visible, boolean()}

maximizeButton/2 indicates that a maximize button should be drawn for the pane.

####
minSize(This, Size) -> wxAuiPaneInfo()

### Types

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.

####
minSize(This, X, Y) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
X = Y = integer()

####
minimizeButton(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
minimizeButton(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {visible, boolean()}

minimizeButton/2 indicates that a minimize button should be drawn for the pane.

####
movable(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
movable(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {b, boolean()}

Movable indicates whether a frame can be moved.

####
name(This, N) -> wxAuiPaneInfo()

### Types

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.

####
paneBorder(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
paneBorder(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {visible, boolean()}

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

####
pinButton(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
pinButton(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {visible, boolean()}

pinButton/2 indicates that a pin button should be drawn for the pane.

####
position(This, Pos) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Pos = integer()

position/2 determines the position of the docked pane.

####
resizable(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
resizable(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

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.

####
right(This) -> wxAuiPaneInfo()

### Types

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

####
rightDockable(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
rightDockable(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {b, boolean()}

rightDockable/2 indicates whether a pane can be docked on the right of the frame.

####
row(This, Row) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Row = integer()

row/2 determines the row of the docked pane.

####
safeSet(This, Source) -> ok

### Types

This = 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.

####
setFlag(This, Flag, Option_state) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Flag = integer()
Option_state = boolean()

setFlag/3 turns the property given by flag on or off with the option_state parameter.

####
show(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
show(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {show, boolean()}

show/2 indicates that a pane should be shown.

####
toolbarPane(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

toolbarPane/1 specifies that the pane should adopt the default toolbar pane settings.

####
top(This) -> wxAuiPaneInfo()

### Types

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

####
topDockable(This) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()

####
topDockable(This, Options :: [Option]) -> wxAuiPaneInfo()

### Types

This = wxAuiPaneInfo()
Option = {b, boolean()}

topDockable/2 indicates whether a pane can be docked at the top of the frame.

####
window(This, W) -> wxAuiPaneInfo()

### Types

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.

####
getWindow(This) -> wxWindow:wxWindow()

### Types

This = wxAuiPaneInfo()

####
getFrame(This) -> wxFrame:wxFrame()

### Types

This = wxAuiPaneInfo()

####
getDirection(This) -> integer()

### Types

This = wxAuiPaneInfo()

####
getLayer(This) -> integer()

### Types

This = wxAuiPaneInfo()

####
getRow(This) -> integer()

### Types

This = wxAuiPaneInfo()

####
getPosition(This) -> integer()

### Types

This = wxAuiPaneInfo()

####
getFloatingPosition(This) -> {X :: integer(), Y :: integer()}

### Types

This = wxAuiPaneInfo()

####
getFloatingSize(This) -> {W :: integer(), H :: integer()}

### Types

This = wxAuiPaneInfo()

####
destroy(This :: wxAuiPaneInfo()) -> ok

Destroys the object.