Contents Up Previous Next

wxAuiPaneInfo

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

wxAuiManager

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

wxAuiPaneInfo()

wxAuiPaneInfo(const wxAuiPaneInfo& c)


wxAuiPaneInfo::~wxAuiPaneInfo

~wxAuiPaneInfo()


wxAuiPaneInfo::BestSize

wxAuiPaneInfo& BestSize(const wxSize& size)

wxAuiPaneInfo& BestSize(int x, int y)


wxAuiPaneInfo::Bottom

wxAuiPaneInfo& Bottom()


wxAuiPaneInfo::BottomDockable

wxAuiPaneInfo& BottomDockable(bool b = true)


wxAuiPaneInfo::Caption

wxAuiPaneInfo& Caption(const wxString& c)


wxAuiPaneInfo::CaptionVisible

wxAuiPaneInfo& CaptionVisible(bool visible = true)


wxAuiPaneInfo::Center

wxAuiPaneInfo& Center()


wxAuiPaneInfo::CenterPane

wxAuiPaneInfo& CenterPane()


wxAuiPaneInfo::Centre

wxAuiPaneInfo& Centre()


wxAuiPaneInfo::CentrePane

wxAuiPaneInfo& CentrePane()


wxAuiPaneInfo::CloseButton

wxAuiPaneInfo& CloseButton(bool visible = true)


wxAuiPaneInfo::DefaultPane

wxAuiPaneInfo& DefaultPane()


wxAuiPaneInfo::DestroyOnClose

wxAuiPaneInfo& DestroyOnClose(bool b = true)


wxAuiPaneInfo::Direction

wxAuiPaneInfo& Direction(int direction)


wxAuiPaneInfo::Dock

wxAuiPaneInfo& Dock()


wxAuiPaneInfo::Dockable

wxAuiPaneInfo& Dockable(bool b = true)


wxAuiPaneInfo::Fixed

wxAuiPaneInfo& Fixed()


wxAuiPaneInfo::Float

wxAuiPaneInfo& Float()


wxAuiPaneInfo::Floatable

wxAuiPaneInfo& Floatable(bool b = true)


wxAuiPaneInfo::FloatingPosition

wxAuiPaneInfo& FloatingPosition(const wxPoint& pos)

wxAuiPaneInfo& FloatingPosition(int x, int y)


wxAuiPaneInfo::FloatingSize

wxAuiPaneInfo& FloatingSize(const wxSize& size)

wxAuiPaneInfo& FloatingSize(int x, int y)


wxAuiPaneInfo::Gripper

wxAuiPaneInfo& Gripper(bool visible = true)


wxAuiPaneInfo::GripperTop

wxAuiPaneInfo& GripperTop(bool attop = true)


wxAuiPaneInfo::HasBorder

bool HasBorder() const


wxAuiPaneInfo::HasCaption

bool HasCaption() const


wxAuiPaneInfo::HasCloseButton

bool HasCloseButton() const


wxAuiPaneInfo::HasFlag

bool HasFlag(unsigned int flag) const


wxAuiPaneInfo::HasGripper

bool HasGripper() const


wxAuiPaneInfo::HasGripperTop

bool HasGripperTop() const


wxAuiPaneInfo::HasMaximizeButton

bool HasMaximizeButton() const


wxAuiPaneInfo::HasMinimizeButton

bool HasMinimizeButton() const


wxAuiPaneInfo::HasPinButton

bool HasPinButton() const


wxAuiPaneInfo::Hide

wxAuiPaneInfo& Hide()


wxAuiPaneInfo::IsBottomDockable

bool IsBottomDockable() const


wxAuiPaneInfo::IsDocked

bool IsDocked() const


wxAuiPaneInfo::IsFixed

bool IsFixed() const


wxAuiPaneInfo::IsFloatable

bool IsFloatable() const


wxAuiPaneInfo::IsFloating

bool IsFloating() const


wxAuiPaneInfo::IsLeftDockable

bool IsLeftDockable() const


wxAuiPaneInfo::IsMovable

bool IsMovable() const


wxAuiPaneInfo::IsOk

bool IsOk() const


wxAuiPaneInfo::IsResizable

bool IsResizable() const


wxAuiPaneInfo::IsRightDockable

bool IsRightDockable() const


wxAuiPaneInfo::IsShown

bool IsShown() const


wxAuiPaneInfo::IsToolbar

bool IsToolbar() const


wxAuiPaneInfo::IsTopDockable

bool IsTopDockable() const


wxAuiPaneInfo::Layer

wxAuiPaneInfo& Layer(int layer)


wxAuiPaneInfo::Left

wxAuiPaneInfo& Left()


wxAuiPaneInfo::LeftDockable

wxAuiPaneInfo& LeftDockable(bool b = true)


wxAuiPaneInfo::MaxSize

wxAuiPaneInfo& MaxSize(const wxSize& size)

wxAuiPaneInfo& MaxSize(int x, int y)


wxAuiPaneInfo::MaximizeButton

wxAuiPaneInfo& MaximizeButton(bool visible = true)


wxAuiPaneInfo::MinSize

wxAuiPaneInfo& MinSize(const wxSize& size)

wxAuiPaneInfo& MinSize(int x, int y)


wxAuiPaneInfo::MinimizeButton

wxAuiPaneInfo& MinimizeButton(bool visible = true)


wxAuiPaneInfo::Movable

wxAuiPaneInfo& Movable(bool b = true)


wxAuiPaneInfo::Name

wxAuiPaneInfo& Name(const wxString& n)


wxAuiPaneInfo::PaneBorder

wxAuiPaneInfo& PaneBorder(bool visible = true)


wxAuiPaneInfo::PinButton

wxAuiPaneInfo& PinButton(bool visible = true)


wxAuiPaneInfo::Position

wxAuiPaneInfo& Position(int pos)


wxAuiPaneInfo::Resizable

wxAuiPaneInfo& Resizable(bool resizable = true)


wxAuiPaneInfo::Right

wxAuiPaneInfo& Right()


wxAuiPaneInfo::RightDockable

wxAuiPaneInfo& RightDockable(bool b = true)


wxAuiPaneInfo::Row

wxAuiPaneInfo& Row(int row)


wxAuiPaneInfo::SafeSet

void SafeSet(wxAuiPaneInfo source)

Write the safe parts of a newly loaded PaneInfo structure "source" into "this" used on loading perspectives etc.


wxAuiPaneInfo::SetFlag

wxAuiPaneInfo& SetFlag(unsigned int flag, bool option_state)


wxAuiPaneInfo::Show

wxAuiPaneInfo& Show(bool show = true)


wxAuiPaneInfo::ToolbarPane

wxAuiPaneInfo& ToolbarPane()


wxAuiPaneInfo::Top

wxAuiPaneInfo& Top()


wxAuiPaneInfo::TopDockable

wxAuiPaneInfo& TopDockable(bool b = true)


wxAuiPaneInfo::Window

wxAuiPaneInfo& Window(wxWindow* w)


wxAuiPaneInfo::operator=

wxAuiPaneInfo& operator operator=(const wxAuiPaneInfo& c)