AuiPaneInfo is part of the AUI class framework. See also AUI overview.
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.
No base class
enum AuiPaneInsertLevel
{
AUI_INSERT_PANE = 0,
AUI_INSERT_ROW = 1,
AUI_INSERT_DOCK = 2
}AuiPaneInfo.new(AuiPaneInfo c)Copy constructor.
destructor()AuiPaneInfo best_size(Size size)AuiPaneInfo best_size(Integer x, Integer y)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.
AuiPaneInfo bottom()Bottom() sets the pane dock position to the bottom side of the frame. This is the same thing as calling Direction(AUI_DOCK_BOTTOM).
AuiPaneInfo bottom_dockable(Boolean b = true)BottomDockable() indicates whether a pane can be docked at the bottom of the frame.
AuiPaneInfo caption(String c)Caption() sets the caption of the pane.
AuiPaneInfo caption_visible(Boolean visible = true)CaptionVisible indicates that a pane caption should be visible. If false, no pane caption is drawn.
AuiPaneInfo centre()AuiPaneInfo center()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(AUI_DOCK_CENTRE).
AuiPaneInfo centre_pane()AuiPaneInfo center_pane()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.
AuiPaneInfo close_button(Boolean visible = true)CloseButton() indicates that a close button should be drawn for the pane.
AuiPaneInfo default_pane()DefaultPane() specifies that the pane should adopt the default pane settings.
AuiPaneInfo destroy_on_close(Boolean b = true)DestroyOnClose() 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.
AuiPaneInfo direction(Integer 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.
AuiPaneInfo dock()AuiPaneInfo dockable(Boolean 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).
AuiPaneInfo fixed()Fixed() forces a pane to be fixed size so that it cannot be resized. After calling Fixed(), IsFixed() will return true.
AuiPaneInfo float()Float() indicates that a pane should be floated.
AuiPaneInfo floatable(Boolean b = true)Floatable() sets whether the user will be able to undock a pane and turn it into a floating window.
AuiPaneInfo floating_position(Point pos)AuiPaneInfo floating_position(Integer x, Integer y)FloatingPosition() sets the position of the floating pane.
AuiPaneInfo floating_size(Size size)AuiPaneInfo floating_size(Integer x, Integer y)FloatingSize() sets the size of the floating pane.
AuiPaneInfo gripper(Boolean visible = true)Gripper() indicates that a gripper should be drawn for the pane.
AuiPaneInfo gripper_top(Boolean attop = true)GripperTop() indicates that a gripper should be drawn at the top of the pane.
Boolean has_border()HasBorder() returns true if the pane displays a border.
Boolean has_caption()HasCaption() returns true if the pane displays a caption.
Boolean has_close_button()HasCloseButton() returns true if the pane displays a button to close the pane.
Boolean has_flag(unsigned int flag)HasFlag() returns true if the the property specified by flag is active for the pane.
Boolean has_gripper()HasGripper() returns true if the pane displays a gripper.
Boolean has_gripper_top()HasGripper() returns true if the pane displays a gripper at the top.
Boolean has_maximize_button()HasMaximizeButton() returns true if the pane displays a button to maximize the pane.
Boolean has_minimize_button()HasMinimizeButton() returns true if the pane displays a button to minimize the pane.
Boolean has_pin_button()HasPinButton() returns true if the pane displays a button to float the pane.
AuiPaneInfo hide()Hide() indicates that a pane should be hidden.
Boolean is_bottom_dockable()IsBottomDockable() returns true if the pane can be docked at the bottom of the managed frame.
Boolean is_docked()IsDocked() returns true if the pane is docked.
Boolean is_fixed()IsFixed() returns true if the pane cannot be resized.
Boolean is_floatable()IsFloatable() returns true if the pane can be undocked and displayed as a floating window.
Boolean is_floating()IsFloating() returns true if the pane is floating.
Boolean is_left_dockable()IsLeftDockable() returns true if the pane can be docked on the left of the managed frame.
Boolean is_movable()IsMoveable() returns true if the docked frame can be undocked or moved to another dock position.
Boolean is_ok()IsOk() returns true if the AuiPaneInfo structure is valid. A pane structure is valid if it has an associated window.
Boolean is_resizable()IsResizable() returns true if the pane can be resized.
Boolean is_right_dockable()IsRightDockable() returns true if the pane can be docked on the right of the managed frame.
Boolean is_shown()IsShown() returns true if the pane is currently shown.
Boolean is_toolbar()IsToolbar() returns true if the pane contains a toolbar.
Boolean is_top_dockable()IsTopDockable() returns true if the pane can be docked at the top of the managed frame.
AuiPaneInfo layer(Integer 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.
AuiPaneInfo left()Left() sets the pane dock position to the left side of the frame. This is the same thing as calling Direction(AUI_DOCK_LEFT).
AuiPaneInfo left_dockable(Boolean b = true)LeftDockable() indicates whether a pane can be docked on the left of the frame.
AuiPaneInfo max_size(Size size)AuiPaneInfo max_size(Integer x, Integer y)MaxSize() sets the maximum size of the pane.
AuiPaneInfo maximize_button(Boolean visible = true)MaximizeButton() indicates that a maximize button should be drawn for the pane.
AuiPaneInfo min_size(Size size)AuiPaneInfo min_size(Integer x, Integer y)MinSize() sets the minimum size of the pane. Please note that this is only partially supported as of this writing.
AuiPaneInfo minimize_button(Boolean visible = true)MinimizeButton() indicates that a minimize button should be drawn for the pane.
AuiPaneInfo movable(Boolean b = true)Movable indicates whether a frame can be moved.
AuiPaneInfo name(String 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.
AuiPaneInfo pane_border(Boolean visible = true)PaneBorder indicates that a border should be drawn for the pane.
AuiPaneInfo pin_button(Boolean visible = true)PinButton() indicates that a pin button should be drawn for the pane.
AuiPaneInfo position(Integer pos)Position() determines the position of the docked pane.
AuiPaneInfo resizable(Boolean 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().
AuiPaneInfo right()Right() sets the pane dock position to the right side of the frame.
AuiPaneInfo right_dockable(Boolean b = true)RightDockable() indicates whether a pane can be docked on the right of the frame.
AuiPaneInfo row(Integer row)Row() determines the row of the docked pane.
safe_set(AuiPaneInfo source)Write the safe parts of a newly loaded PaneInfo structure “source” into “this” used on loading perspectives etc.
AuiPaneInfo set_flag(unsigned int flag,
Boolean option_state)SetFlag() turns the property given by flag on or off with the option_state parameter.
AuiPaneInfo show(Boolean show = true)Show() indicates that a pane should be shown.
AuiPaneInfo toolbar_pane()ToolbarPane() specifies that the pane should adopt the default toolbar pane settings.
AuiPaneInfo top()Top() sets the pane dock position to the top of the frame.
AuiPaneInfo top_dockable(Boolean b = true)TopDockable() indicates whether a pane can be docked at the top of the frame.
AuiPaneInfo window(Window w)Window() assigns the window pointer that the AuiPaneInfo should use. This normally does not need to be specified, as the window pointer is automatically assigned to the AuiPaneInfo structure as soon as it is added to the manager.
AuiPaneInfo& operator% operator.html operator=(AuiPaneInfo c)Makes a copy of the AuiPaneInfo object.
[This page automatically generated from the Textile source at Fri Oct 31 16:06:38 +0000 2008]