## wxPaneInfo

wxPaneInfo is part of the wxAUI class framework. See also wxAUI overview.

wxPaneInfo 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

wxFrameManager

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

wxPaneInfo::wxPaneInfo
wxPaneInfo::~wxPaneInfo
wxPaneInfo::BestSize
wxPaneInfo::Bottom
wxPaneInfo::BottomDockable
wxPaneInfo::Caption
wxPaneInfo::CaptionVisible
wxPaneInfo::Center
wxPaneInfo::CenterPane
wxPaneInfo::Centre
wxPaneInfo::CentrePane
wxPaneInfo::CloseButton
wxPaneInfo::DefaultPane
wxPaneInfo::DestroyOnClose
wxPaneInfo::Direction
wxPaneInfo::Dock
wxPaneInfo::Dockable
wxPaneInfo::Fixed
wxPaneInfo::Float
wxPaneInfo::Floatable
wxPaneInfo::FloatingPosition
wxPaneInfo::FloatingSize
wxPaneInfo::Gripper
wxPaneInfo::GripperTop
wxPaneInfo::HasBorder
wxPaneInfo::HasCaption
wxPaneInfo::HasCloseButton
wxPaneInfo::HasFlag
wxPaneInfo::HasGripper
wxPaneInfo::HasGripperTop
wxPaneInfo::HasMaximizeButton
wxPaneInfo::HasMinimizeButton
wxPaneInfo::HasPinButton
wxPaneInfo::Hide
wxPaneInfo::IsBottomDockable
wxPaneInfo::IsDocked
wxPaneInfo::IsFixed
wxPaneInfo::IsFloatable
wxPaneInfo::IsFloating
wxPaneInfo::IsLeftDockable
wxPaneInfo::IsMovable
wxPaneInfo::IsOk
wxPaneInfo::IsResizable
wxPaneInfo::IsRightDockable
wxPaneInfo::IsShown
wxPaneInfo::IsToolbar
wxPaneInfo::IsTopDockable
wxPaneInfo::Layer
wxPaneInfo::Left
wxPaneInfo::LeftDockable
wxPaneInfo::MaxSize
wxPaneInfo::MaximizeButton
wxPaneInfo::MinSize
wxPaneInfo::MinimizeButton
wxPaneInfo::Movable
wxPaneInfo::Name
wxPaneInfo::PaneBorder
wxPaneInfo::PinButton
wxPaneInfo::Position
wxPaneInfo::Resizable
wxPaneInfo::Right
wxPaneInfo::RightDockable
wxPaneInfo::Row
wxPaneInfo::SafeSet
wxPaneInfo::SetFlag
wxPaneInfo::Show
wxPaneInfo::ToolbarPane
wxPaneInfo::Top
wxPaneInfo::TopDockable
wxPaneInfo::Window
wxPaneInfo::operator=

### wxPaneInfo::wxPaneInfo

wxPaneInfo()

wxPaneInfo(const wxPaneInfo& c)

### wxPaneInfo::~wxPaneInfo

~wxPaneInfo()

### wxPaneInfo::BestSize

wxPaneInfo& BestSize(const wxSize& size)

wxPaneInfo& BestSize(int x, int y)

### wxPaneInfo::Bottom

wxPaneInfo& Bottom()

### wxPaneInfo::BottomDockable

wxPaneInfo& BottomDockable(bool b = true)

### wxPaneInfo::Caption

wxPaneInfo& Caption(const wxString& c)

### wxPaneInfo::CaptionVisible

wxPaneInfo& CaptionVisible(bool visible = true)

### wxPaneInfo::Center

wxPaneInfo& Center()

### wxPaneInfo::CenterPane

wxPaneInfo& CenterPane()

### wxPaneInfo::Centre

wxPaneInfo& Centre()

### wxPaneInfo::CentrePane

wxPaneInfo& CentrePane()

### wxPaneInfo::CloseButton

wxPaneInfo& CloseButton(bool visible = true)

### wxPaneInfo::DefaultPane

wxPaneInfo& DefaultPane()

### wxPaneInfo::DestroyOnClose

wxPaneInfo& DestroyOnClose(bool b = true)

### wxPaneInfo::Direction

wxPaneInfo& Direction(int direction)

### wxPaneInfo::Dock

wxPaneInfo& Dock()

### wxPaneInfo::Dockable

wxPaneInfo& Dockable(bool b = true)

### wxPaneInfo::Fixed

wxPaneInfo& Fixed()

### wxPaneInfo::Float

wxPaneInfo& Float()

### wxPaneInfo::Floatable

wxPaneInfo& Floatable(bool b = true)

### wxPaneInfo::FloatingPosition

wxPaneInfo& FloatingPosition(const wxPoint& pos)

wxPaneInfo& FloatingPosition(int x, int y)

### wxPaneInfo::FloatingSize

wxPaneInfo& FloatingSize(const wxSize& size)

wxPaneInfo& FloatingSize(int x, int y)

### wxPaneInfo::Gripper

wxPaneInfo& Gripper(bool visible = true)

### wxPaneInfo::GripperTop

wxPaneInfo& GripperTop(bool attop = true)

### wxPaneInfo::HasBorder

bool HasBorder() const

### wxPaneInfo::HasCaption

bool HasCaption() const

### wxPaneInfo::HasCloseButton

bool HasCloseButton() const

### wxPaneInfo::HasFlag

bool HasFlag(unsigned int flag) const

### wxPaneInfo::HasGripper

bool HasGripper() const

### wxPaneInfo::HasGripperTop

bool HasGripperTop() const

### wxPaneInfo::HasMaximizeButton

bool HasMaximizeButton() const

### wxPaneInfo::HasMinimizeButton

bool HasMinimizeButton() const

### wxPaneInfo::HasPinButton

bool HasPinButton() const

### wxPaneInfo::Hide

wxPaneInfo& Hide()

### wxPaneInfo::IsBottomDockable

bool IsBottomDockable() const

### wxPaneInfo::IsDocked

bool IsDocked() const

### wxPaneInfo::IsFixed

bool IsFixed() const

### wxPaneInfo::IsFloatable

bool IsFloatable() const

### wxPaneInfo::IsFloating

bool IsFloating() const

### wxPaneInfo::IsLeftDockable

bool IsLeftDockable() const

### wxPaneInfo::IsMovable

bool IsMovable() const

### wxPaneInfo::IsOk

bool IsOk() const

### wxPaneInfo::IsResizable

bool IsResizable() const

### wxPaneInfo::IsRightDockable

bool IsRightDockable() const

### wxPaneInfo::IsShown

bool IsShown() const

### wxPaneInfo::IsToolbar

bool IsToolbar() const

### wxPaneInfo::IsTopDockable

bool IsTopDockable() const

### wxPaneInfo::Layer

wxPaneInfo& Layer(int layer)

### wxPaneInfo::Left

wxPaneInfo& Left()

### wxPaneInfo::LeftDockable

wxPaneInfo& LeftDockable(bool b = true)

### wxPaneInfo::MaxSize

wxPaneInfo& MaxSize(const wxSize& size)

wxPaneInfo& MaxSize(int x, int y)

### wxPaneInfo::MaximizeButton

wxPaneInfo& MaximizeButton(bool visible = true)

### wxPaneInfo::MinSize

wxPaneInfo& MinSize(const wxSize& size)

wxPaneInfo& MinSize(int x, int y)

### wxPaneInfo::MinimizeButton

wxPaneInfo& MinimizeButton(bool visible = true)

### wxPaneInfo::Movable

wxPaneInfo& Movable(bool b = true)

### wxPaneInfo::Name

wxPaneInfo& Name(const wxString& n)

### wxPaneInfo::PaneBorder

wxPaneInfo& PaneBorder(bool visible = true)

### wxPaneInfo::PinButton

wxPaneInfo& PinButton(bool visible = true)

### wxPaneInfo::Position

wxPaneInfo& Position(int pos)

### wxPaneInfo::Resizable

wxPaneInfo& Resizable(bool resizable = true)

### wxPaneInfo::Right

wxPaneInfo& Right()

### wxPaneInfo::RightDockable

wxPaneInfo& RightDockable(bool b = true)

### wxPaneInfo::Row

wxPaneInfo& Row(int row)

### wxPaneInfo::SafeSet

void SafeSet(wxPaneInfo source)

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

### wxPaneInfo::SetFlag

wxPaneInfo& SetFlag(unsigned int flag, bool option_state)

### wxPaneInfo::Show

wxPaneInfo& Show(bool show = true)

### wxPaneInfo::ToolbarPane

wxPaneInfo& ToolbarPane()

### wxPaneInfo::Top

wxPaneInfo& Top()

### wxPaneInfo::TopDockable

wxPaneInfo& TopDockable(bool b = true)

### wxPaneInfo::Window

wxPaneInfo& Window(wxWindow* w)

### wxPaneInfo::operator=

wxPaneInfo& operator operator=(const wxPaneInfo& c)