wxAuiPaneInfo is part of the wxAUI class framework. See also wxAUI overview.
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.
Derived from
No base class
Include files
<wx/aui/aui.h>
See also
Data structures
enum wxPaneDockArtSetting { wxAUI_ART_SASH_SIZE = 0, wxAUI_ART_CAPTION_SIZE = 1, wxAUI_ART_GRIPPER_SIZE = 2, wxAUI_ART_PANE_BORDER_SIZE = 3, wxAUI_ART_PANE_BUTTON_SIZE = 4, wxAUI_ART_BACKGROUND_COLOUR = 5, wxAUI_ART_SASH_COLOUR = 6, wxAUI_ART_ACTIVE_CAPTION_COLOUR = 7, wxAUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8, wxAUI_ART_INACTIVE_CAPTION_COLOUR = 9, wxAUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10, wxAUI_ART_ACTIVE_CAPTION_TEXT_COLOUR = 11, wxAUI_ART_INACTIVE_CAPTION_TEXT_COLOUR = 12, wxAUI_ART_BORDER_COLOUR = 13, wxAUI_ART_GRIPPER_COLOUR = 14, wxAUI_ART_CAPTION_FONT = 15, wxAUI_ART_GRADIENT_TYPE = 16 }
enum wxPaneDockArtGradients wxAUI_GRADIENT_NONE = 0, wxAUI_GRADIENT_VERTICAL = 1, wxAUI_GRADIENT_HORIZONTAL = 2
enum wxPaneButtonState { wxAUI_BUTTON_STATE_NORMAL = 0, wxAUI_BUTTON_STATE_HOVER = 1, wxAUI_BUTTON_STATE_PRESSED = 2 }
enum wxPaneInsertLevel wxAUI_INSERT_PANE = 0, wxAUI_INSERT_ROW = 1, wxAUI_INSERT_DOCK = 2
Members
wxAuiPaneInfo::wxAuiPaneInfo
wxAuiPaneInfo::~wxAuiPaneInfo
wxAuiPaneInfo::BestSize
wxAuiPaneInfo::Bottom
wxAuiPaneInfo::BottomDockable
wxAuiPaneInfo::Caption
wxAuiPaneInfo::CaptionVisible
wxAuiPaneInfo::Center
wxAuiPaneInfo::CenterPane
wxAuiPaneInfo::Centre
wxAuiPaneInfo::CentrePane
wxAuiPaneInfo::CloseButton
wxAuiPaneInfo::DefaultPane
wxAuiPaneInfo::DestroyOnClose
wxAuiPaneInfo::Direction
wxAuiPaneInfo::Dock
wxAuiPaneInfo::Dockable
wxAuiPaneInfo::Fixed
wxAuiPaneInfo::Float
wxAuiPaneInfo::Floatable
wxAuiPaneInfo::FloatingPosition
wxAuiPaneInfo::FloatingSize
wxAuiPaneInfo::Gripper
wxAuiPaneInfo::GripperTop
wxAuiPaneInfo::HasBorder
wxAuiPaneInfo::HasCaption
wxAuiPaneInfo::HasCloseButton
wxAuiPaneInfo::HasFlag
wxAuiPaneInfo::HasGripper
wxAuiPaneInfo::HasGripperTop
wxAuiPaneInfo::HasMaximizeButton
wxAuiPaneInfo::HasMinimizeButton
wxAuiPaneInfo::HasPinButton
wxAuiPaneInfo::Hide
wxAuiPaneInfo::IsBottomDockable
wxAuiPaneInfo::IsDocked
wxAuiPaneInfo::IsFixed
wxAuiPaneInfo::IsFloatable
wxAuiPaneInfo::IsFloating
wxAuiPaneInfo::IsLeftDockable
wxAuiPaneInfo::IsMovable
wxAuiPaneInfo::IsOk
wxAuiPaneInfo::IsResizable
wxAuiPaneInfo::IsRightDockable
wxAuiPaneInfo::IsShown
wxAuiPaneInfo::IsToolbar
wxAuiPaneInfo::IsTopDockable
wxAuiPaneInfo::Layer
wxAuiPaneInfo::Left
wxAuiPaneInfo::LeftDockable
wxAuiPaneInfo::MaxSize
wxAuiPaneInfo::MaximizeButton
wxAuiPaneInfo::MinSize
wxAuiPaneInfo::MinimizeButton
wxAuiPaneInfo::Movable
wxAuiPaneInfo::Name
wxAuiPaneInfo::PaneBorder
wxAuiPaneInfo::PinButton
wxAuiPaneInfo::Position
wxAuiPaneInfo::Resizable
wxAuiPaneInfo::Right
wxAuiPaneInfo::RightDockable
wxAuiPaneInfo::Row
wxAuiPaneInfo::SafeSet
wxAuiPaneInfo::SetFlag
wxAuiPaneInfo::Show
wxAuiPaneInfo::ToolbarPane
wxAuiPaneInfo::Top
wxAuiPaneInfo::TopDockable
wxAuiPaneInfo::Window
wxAuiPaneInfo::operator=
wxAuiPaneInfo()
wxAuiPaneInfo(const wxAuiPaneInfo& c)
~wxAuiPaneInfo()
wxAuiPaneInfo& BestSize(const wxSize& size)
wxAuiPaneInfo& BestSize(int x, int y)
wxAuiPaneInfo& Bottom()
wxAuiPaneInfo& BottomDockable(bool b = true)
wxAuiPaneInfo& Caption(const wxString& c)
wxAuiPaneInfo& CaptionVisible(bool visible = true)
wxAuiPaneInfo& Center()
wxAuiPaneInfo& CenterPane()
wxAuiPaneInfo& Centre()
wxAuiPaneInfo& CentrePane()
wxAuiPaneInfo& CloseButton(bool visible = true)
wxAuiPaneInfo& DefaultPane()
wxAuiPaneInfo& DestroyOnClose(bool b = true)
wxAuiPaneInfo& Direction(int direction)
wxAuiPaneInfo& Dock()
wxAuiPaneInfo& Dockable(bool b = true)
wxAuiPaneInfo& Fixed()
wxAuiPaneInfo& Float()
wxAuiPaneInfo& Floatable(bool b = true)
wxAuiPaneInfo& FloatingPosition(const wxPoint& pos)
wxAuiPaneInfo& FloatingPosition(int x, int y)
wxAuiPaneInfo& FloatingSize(const wxSize& size)
wxAuiPaneInfo& FloatingSize(int x, int y)
wxAuiPaneInfo& Gripper(bool visible = true)
wxAuiPaneInfo& GripperTop(bool attop = true)
bool HasBorder() const
bool HasCaption() const
bool HasCloseButton() const
bool HasFlag(unsigned int flag) const
bool HasGripper() const
bool HasGripperTop() const
bool HasMaximizeButton() const
bool HasMinimizeButton() const
bool HasPinButton() const
wxAuiPaneInfo& Hide()
bool IsBottomDockable() const
bool IsDocked() const
bool IsFixed() const
bool IsFloatable() const
bool IsFloating() const
bool IsLeftDockable() const
bool IsMovable() const
bool IsOk() const
bool IsResizable() const
bool IsRightDockable() const
bool IsShown() const
bool IsToolbar() const
bool IsTopDockable() const
wxAuiPaneInfo& Layer(int layer)
wxAuiPaneInfo& Left()
wxAuiPaneInfo& LeftDockable(bool b = true)
wxAuiPaneInfo& MaxSize(const wxSize& size)
wxAuiPaneInfo& MaxSize(int x, int y)
wxAuiPaneInfo& MaximizeButton(bool visible = true)
wxAuiPaneInfo& MinSize(const wxSize& size)
wxAuiPaneInfo& MinSize(int x, int y)
wxAuiPaneInfo& MinimizeButton(bool visible = true)
wxAuiPaneInfo& Movable(bool b = true)
wxAuiPaneInfo& Name(const wxString& n)
wxAuiPaneInfo& PaneBorder(bool visible = true)
wxAuiPaneInfo& PinButton(bool visible = true)
wxAuiPaneInfo& Position(int pos)
wxAuiPaneInfo& Resizable(bool resizable = true)
wxAuiPaneInfo& Right()
wxAuiPaneInfo& RightDockable(bool b = true)
wxAuiPaneInfo& Row(int row)
void SafeSet(wxAuiPaneInfo source)
Write the safe parts of a newly loaded PaneInfo structure "source" into "this" used on loading perspectives etc.
wxAuiPaneInfo& SetFlag(unsigned int flag, bool option_state)
wxAuiPaneInfo& Show(bool show = true)
wxAuiPaneInfo& ToolbarPane()
wxAuiPaneInfo& Top()
wxAuiPaneInfo& TopDockable(bool b = true)
wxAuiPaneInfo& Window(wxWindow* w)
wxAuiPaneInfo& operator operator=(const wxAuiPaneInfo& c)