Version: 3.0.3
Window Docking (wxAUI)

Detailed Description

wxAUI is a set classes for writing a customizable application interface with built-in docking, floatable panes and a flexible MDI-like interface.

Related Overviews: wxAUI Overview

Classes

class  wxAuiDefaultTabArt
 Default art provider for wxAuiNotebook. More...
 
class  wxAuiToolBarEvent
 wxAuiToolBarEvent is used for the events generated by wxAuiToolBar. More...
 
class  wxAuiToolBarItem
 wxAuiToolBarItem is part of the wxAUI class framework, representing a toolbar element. More...
 
class  wxAuiToolBarArt
 wxAuiToolBarArt is part of the wxAUI class framework. More...
 
class  wxAuiDefaultToolBarArt
 wxAuiDefaultToolBarArt is part of the wxAUI class framework. More...
 
class  wxAuiToolBar
 wxAuiToolBar is a dockable toolbar, part of the wxAUI class framework. More...
 
class  wxAuiNotebook
 wxAuiNotebook is part of the wxAUI class framework, which represents a notebook control, managing multiple windows with associated tabs. More...
 
class  wxAuiNotebookPage
 A simple class which holds information about the notebook's pages and their state. More...
 
class  wxAuiTabContainerButton
 A simple class which holds information about wxAuiNotebook tab buttons and their state. More...
 
class  wxAuiTabContainer
 wxAuiTabContainer is a class which contains information about each tab. More...
 
class  wxAuiTabArt
 Tab art provider defines all the drawing functions used by wxAuiNotebook. More...
 
class  wxAuiSimpleTabArt
 Another standard tab art provider for wxAuiNotebook. More...
 
class  wxAuiDockArt
 wxAuiDockArt is part of the wxAUI class framework. More...
 
class  wxAuiManager
 wxAuiManager is the central class of the wxAUI class framework. More...
 
class  wxAuiPaneInfo
 wxAuiPaneInfo is part of the wxAUI class framework. More...
 
class  wxAuiManagerEvent
 Event used to indicate various actions taken with wxAuiManager. More...
 

Enumerations

enum  wxAuiToolBarStyle {
  wxAUI_TB_TEXT = 1 << 0,
  wxAUI_TB_NO_TOOLTIPS = 1 << 1,
  wxAUI_TB_NO_AUTORESIZE = 1 << 2,
  wxAUI_TB_GRIPPER = 1 << 3,
  wxAUI_TB_OVERFLOW = 1 << 4,
  wxAUI_TB_VERTICAL = 1 << 5,
  wxAUI_TB_HORZ_LAYOUT = 1 << 6,
  wxAUI_TB_HORIZONTAL = 1 << 7,
  wxAUI_TB_PLAIN_BACKGROUND = 1 << 8,
  wxAUI_TB_HORZ_TEXT = (wxAUI_TB_HORZ_LAYOUT | wxAUI_TB_TEXT),
  wxAUI_ORIENTATION_MASK = (wxAUI_TB_VERTICAL | wxAUI_TB_HORIZONTAL),
  wxAUI_TB_DEFAULT_STYLE = 0
}
 wxAuiToolBarStyle is part of the wxAUI class framework, used to define the appearance of a wxAuiToolBar. More...
 
enum  wxAuiToolBarArtSetting {
  wxAUI_TBART_SEPARATOR_SIZE = 0,
  wxAUI_TBART_GRIPPER_SIZE = 1,
  wxAUI_TBART_OVERFLOW_SIZE = 2
}
 wxAuiToolBarArtSetting More...
 
enum  wxAuiToolBarToolTextOrientation {
  wxAUI_TBTOOL_TEXT_LEFT = 0,
  wxAUI_TBTOOL_TEXT_RIGHT = 1,
  wxAUI_TBTOOL_TEXT_TOP = 2,
  wxAUI_TBTOOL_TEXT_BOTTOM = 3
}
 wxAuiToolBarToolTextOrientation More...
 
enum  wxAuiPaneDockArtSetting {
  wxAUI_DOCKART_SASH_SIZE = 0,
  wxAUI_DOCKART_CAPTION_SIZE = 1,
  wxAUI_DOCKART_GRIPPER_SIZE = 2,
  wxAUI_DOCKART_PANE_BORDER_SIZE = 3,
  wxAUI_DOCKART_PANE_BUTTON_SIZE = 4,
  wxAUI_DOCKART_BACKGROUND_COLOUR = 5,
  wxAUI_DOCKART_SASH_COLOUR = 6,
  wxAUI_DOCKART_ACTIVE_CAPTION_COLOUR = 7,
  wxAUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
  wxAUI_DOCKART_INACTIVE_CAPTION_COLOUR = 9,
  wxAUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
  wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
  wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
  wxAUI_DOCKART_BORDER_COLOUR = 13,
  wxAUI_DOCKART_GRIPPER_COLOUR = 14,
  wxAUI_DOCKART_CAPTION_FONT = 15,
  wxAUI_DOCKART_GRADIENT_TYPE = 16
}
 These are the possible pane dock art settings for wxAuiDefaultDockArt. More...
 

Enumeration Type Documentation

These are the possible pane dock art settings for wxAuiDefaultDockArt.

Library:  wxAui
Category:  Window Docking (wxAUI)
Enumerator
wxAUI_DOCKART_SASH_SIZE 

Customizes the sash size.

wxAUI_DOCKART_CAPTION_SIZE 

Customizes the caption size.

wxAUI_DOCKART_GRIPPER_SIZE 

Customizes the gripper size.

wxAUI_DOCKART_PANE_BORDER_SIZE 

Customizes the pane border size.

wxAUI_DOCKART_PANE_BUTTON_SIZE 

Customizes the pane button size.

wxAUI_DOCKART_BACKGROUND_COLOUR 

Customizes the background colour, which corresponds to the client area.

wxAUI_DOCKART_SASH_COLOUR 

Customizes the sash colour.

wxAUI_DOCKART_ACTIVE_CAPTION_COLOUR 

Customizes the active caption colour.

wxAUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR 

Customizes the active caption gradient colour.

wxAUI_DOCKART_INACTIVE_CAPTION_COLOUR 

Customizes the inactive caption colour.

wxAUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR 

Customizes the inactive gradient caption colour.

wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR 

Customizes the active caption text colour.

wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR 

Customizes the inactive caption text colour.

wxAUI_DOCKART_BORDER_COLOUR 

Customizes the border colour.

wxAUI_DOCKART_GRIPPER_COLOUR 

Customizes the gripper colour.

wxAUI_DOCKART_CAPTION_FONT 

Customizes the caption font.

wxAUI_DOCKART_GRADIENT_TYPE 

Customizes the gradient type (no gradient, vertical or horizontal)

wxAuiToolBarArtSetting

Library:  wxAui
Category:  Window Docking (wxAUI)
Enumerator
wxAUI_TBART_SEPARATOR_SIZE 

wxAuiToolBar seperator size.

wxAUI_TBART_GRIPPER_SIZE 

wxAuiToolBar gripper size.

wxAUI_TBART_OVERFLOW_SIZE 

Overflow button size in wxAuiToolBar.

wxAuiToolBarStyle is part of the wxAUI class framework, used to define the appearance of a wxAuiToolBar.

See also wxAUI Overview.

Library:  wxAui
Category:  Window Docking (wxAUI)
Enumerator
wxAUI_TB_TEXT 

Shows the text in the toolbar buttons; by default only icons are shown.

wxAUI_TB_NO_TOOLTIPS 

Don't show tooltips on wxAuiToolBar items.

wxAUI_TB_NO_AUTORESIZE 

Do not auto-resize the wxAuiToolBar.

wxAUI_TB_GRIPPER 

Shows a gripper on the wxAuiToolBar.

wxAUI_TB_OVERFLOW 

The wxAuiToolBar can contain overflow items.

wxAUI_TB_VERTICAL 

Using this style forces the toolbar to be vertical and be only dockable to the left or right sides of the window whereas by default it can be horizontal or vertical and be docked anywhere.

wxAUI_TB_HORZ_LAYOUT 

Shows the text and the icons alongside, not vertically stacked.

This style must be used with wxAUI_TB_TEXT

wxAUI_TB_HORIZONTAL 

Analogous to wxAUI_TB_VERTICAL, but forces the toolbar to be horizontal, docking to the top or bottom of the window.

wxAUI_TB_PLAIN_BACKGROUND 

Draw a plain background (based on parent) instead of the default gradient background.

Since
2.9.5
wxAUI_TB_HORZ_TEXT 

Shows the text alongside the icons, not vertically stacked.

wxAUI_ORIENTATION_MASK 

Shows the text in the toolbar buttons; by default only icons are shown.

wxAUI_TB_DEFAULT_STYLE 

By default only icons are shown.

wxAuiToolBarToolTextOrientation

Library:  wxAui
Category:  Window Docking (wxAUI)
Enumerator
wxAUI_TBTOOL_TEXT_LEFT 

Text in wxAuiToolBar items is left aligned, currently unused/unimplemented.

wxAUI_TBTOOL_TEXT_RIGHT 

Text in wxAuiToolBar items is right aligned.

wxAUI_TBTOOL_TEXT_TOP 

Text in wxAuiToolBar items is top aligned, currently unused/unimplemented.

wxAUI_TBTOOL_TEXT_BOTTOM 

Text in wxAuiToolBar items is bottom aligned.