wxPaneInfo Class Reference

#include <albaGUIDockManager.h>

Public Types
enum	wxPaneState {   optionFloating = 1 << 0 , optionHidden = 1 << 1 , optionLeftDockable = 1 << 2 , optionRightDockable = 1 << 3 ,   optionTopDockable = 1 << 4 , optionBottomDockable = 1 << 5 , optionFloatable = 1 << 6 , optionMovable = 1 << 7 ,   optionResizable = 1 << 8 , optionPaneBorder = 1 << 9 , optionCaption = 1 << 10 , optionGripper = 1 << 11 ,   optionDestroyOnClose = 1 << 12 , optionToolbar = 1 << 13 , optionActive = 1 << 14 , buttonClose = 1 << 24 ,   buttonMaximize = 1 << 25 , buttonMinimize = 1 << 26 , buttonPin = 1 << 27 , buttonCustom1 = 1 << 28 ,   buttonCustom2 = 1 << 29 , buttonCustom3 = 1 << 30 , actionPane = 1 << 31 }

Public Member Functions
	wxPaneInfo ()
	wxPaneInfo (const wxPaneInfo &c)
wxPaneInfo &	operator= (const wxPaneInfo &c)
bool	IsOk () const
bool	IsFixed () const
bool	IsResizable () const
bool	IsShown () const
bool	IsFloating () const
bool	IsDocked () const
bool	IsToolbar () const
bool	IsTopDockable () const
bool	IsBottomDockable () const
bool	IsLeftDockable () const
bool	IsRightDockable () const
bool	IsFloatable () const
bool	IsMovable () const
bool	HasCaption () const
bool	HasGripper () const
bool	HasBorder () const
bool	HasCloseButton () const
bool	HasMaximizeButton () const
bool	HasMinimizeButton () const
bool	HasPinButton () const
wxPaneInfo &	Window (wxWindow *w)
wxPaneInfo &	Name (const wxString &n)
wxPaneInfo &	Caption (const wxString &c)
wxPaneInfo &	Left ()
wxPaneInfo &	Right ()
wxPaneInfo &	Top ()
wxPaneInfo &	Bottom ()
wxPaneInfo &	Center ()
wxPaneInfo &	Centre ()
wxPaneInfo &	Direction (int direction)
wxPaneInfo &	Layer (int layer)
wxPaneInfo &	Row (int row)
wxPaneInfo &	Position (int pos)
wxPaneInfo &	BestSize (const wxSize &size)
wxPaneInfo &	MinSize (const wxSize &size)
wxPaneInfo &	MaxSize (const wxSize &size)
wxPaneInfo &	BestSize (int x, int y)
wxPaneInfo &	MinSize (int x, int y)
wxPaneInfo &	MaxSize (int x, int y)
wxPaneInfo &	FloatingPosition (const wxPoint &pos)
wxPaneInfo &	FloatingPosition (int x, int y)
wxPaneInfo &	FloatingSize (const wxSize &size)
wxPaneInfo &	FloatingSize (int x, int y)
wxPaneInfo &	Fixed ()
wxPaneInfo &	Resizable (bool resizable=true)
wxPaneInfo &	Dock ()
wxPaneInfo &	Float ()
wxPaneInfo &	Hide ()
wxPaneInfo &	Show (bool show=true)
wxPaneInfo &	CaptionVisible (bool visible=true)
wxPaneInfo &	PaneBorder (bool visible=true)
wxPaneInfo &	Gripper (bool visible=true)
wxPaneInfo &	CloseButton (bool visible=true)
wxPaneInfo &	MaximizeButton (bool visible=true)
wxPaneInfo &	MinimizeButton (bool visible=true)
wxPaneInfo &	PinButton (bool visible=true)
wxPaneInfo &	DestroyOnClose (bool b=true)
wxPaneInfo &	TopDockable (bool b=true)
wxPaneInfo &	BottomDockable (bool b=true)
wxPaneInfo &	LeftDockable (bool b=true)
wxPaneInfo &	RightDockable (bool b=true)
wxPaneInfo &	Floatable (bool b=true)
wxPaneInfo &	Movable (bool b=true)
wxPaneInfo &	Dockable (bool b=true)
wxPaneInfo &	DefaultPane ()
wxPaneInfo &	CentrePane ()
wxPaneInfo &	CenterPane ()
wxPaneInfo &	ToolbarPane ()
wxPaneInfo &	SetFlag (unsigned int flag, bool option_state)
bool	HasFlag (unsigned int flag) const

Public Attributes
wxString	m_Name
wxString	m_Caption
wxWindow *	m_Window
wxWindow *	m_Frame
unsigned int	m_State
int	m_DockDirection
int	m_DockLayer
int	m_DockRow
int	m_DockPos
wxSize	m_BestSize
wxSize	m_MinSize
wxSize	m_MaxSize
wxPoint	m_FloatingPos
wxSize	m_FloatingSize
int	m_DockProportion
wxPaneButtonArray	m_Buttons
wxRect	m_Rect

Detailed Description

class name: wxPaneInfo This class define properties of a pane.

That is a panel that can be floating, dockable with a proper side.

Definition at line 114 of file albaGUIDockManager.h.

Member Enumeration Documentation

wxPaneState

enum wxPaneInfo::wxPaneState

Enumerator
optionFloating
optionHidden
optionLeftDockable
optionRightDockable
optionTopDockable
optionBottomDockable
optionFloatable
optionMovable
optionResizable
optionPaneBorder
optionCaption
optionGripper
optionDestroyOnClose
optionToolbar
optionActive
buttonClose
buttonMaximize
buttonMinimize
buttonPin
buttonCustom1
buttonCustom2
buttonCustom3
actionPane

Definition at line 364 of file albaGUIDockManager.h.

Constructor & Destructor Documentation

wxPaneInfo() [1/2]

wxPaneInfo::wxPaneInfo ( )

inline

constructor

Definition at line 119 of file albaGUIDockManager.h.

References wxAUI_DOCK_LEFT.

wxPaneInfo() [2/2]

wxPaneInfo::wxPaneInfo ( const wxPaneInfo &  c )

inline

copy constructor

Definition at line 139 of file albaGUIDockManager.h.

References m_BestSize, m_Buttons, m_Caption, m_DockDirection, m_DockLayer, m_DockPos, m_DockProportion, m_DockRow, m_FloatingPos, m_FloatingSize, m_Frame, m_MaxSize, m_MinSize, m_Name, m_Rect, m_State, and m_Window.

Member Function Documentation

operator=()

wxPaneInfo & wxPaneInfo::operator= ( const wxPaneInfo &  c )

inline

assignment operator

Definition at line 161 of file albaGUIDockManager.h.

References m_BestSize, m_Buttons, m_Caption, m_DockDirection, m_DockLayer, m_DockPos, m_DockProportion, m_DockRow, m_FloatingPos, m_FloatingSize, m_Frame, m_MaxSize, m_MinSize, m_Name, m_Rect, m_State, and m_Window.

IsOk()

bool wxPaneInfo::IsOk ( ) const

inline

retrive if the pane exist

Definition at line 184 of file albaGUIDockManager.h.

IsFixed()

bool wxPaneInfo::IsFixed ( ) const

inline

check flag optionResizable

Definition at line 186 of file albaGUIDockManager.h.

IsResizable()

bool wxPaneInfo::IsResizable ( ) const

inline

check flag optionResizable

Definition at line 188 of file albaGUIDockManager.h.

IsShown()

bool wxPaneInfo::IsShown ( ) const

inline

check flag optionHidden

Definition at line 190 of file albaGUIDockManager.h.

IsFloating()

bool wxPaneInfo::IsFloating ( ) const

inline

check flag optionFloating

Definition at line 192 of file albaGUIDockManager.h.

IsDocked()

bool wxPaneInfo::IsDocked ( ) const

inline

check flag optionFloating

Definition at line 194 of file albaGUIDockManager.h.

IsToolbar()

bool wxPaneInfo::IsToolbar ( ) const

inline

check flag optionToolbar

Definition at line 196 of file albaGUIDockManager.h.

IsTopDockable()

bool wxPaneInfo::IsTopDockable ( ) const

inline

check flag optionTopDockable

Definition at line 198 of file albaGUIDockManager.h.

IsBottomDockable()

bool wxPaneInfo::IsBottomDockable ( ) const

inline

check flag optionBottomDockable

Definition at line 200 of file albaGUIDockManager.h.

IsLeftDockable()

bool wxPaneInfo::IsLeftDockable ( ) const

inline

check flag optionLeftDockable

Definition at line 202 of file albaGUIDockManager.h.

IsRightDockable()

bool wxPaneInfo::IsRightDockable ( ) const

inline

check flag optionRightDockable

Definition at line 204 of file albaGUIDockManager.h.

IsFloatable()

bool wxPaneInfo::IsFloatable ( ) const

inline

check flag optionFloatable

Definition at line 206 of file albaGUIDockManager.h.

IsMovable()

bool wxPaneInfo::IsMovable ( ) const

inline

check flag optionMovable

Definition at line 208 of file albaGUIDockManager.h.

HasCaption()

bool wxPaneInfo::HasCaption ( ) const

inline

check flag optionCaption

Definition at line 210 of file albaGUIDockManager.h.

HasGripper()

bool wxPaneInfo::HasGripper ( ) const

inline

check flag optionGripper

Definition at line 212 of file albaGUIDockManager.h.

HasBorder()

bool wxPaneInfo::HasBorder ( ) const

inline

check flag optionPaneBorder

Definition at line 214 of file albaGUIDockManager.h.

HasCloseButton()

bool wxPaneInfo::HasCloseButton ( ) const

inline

check flag buttonClose

Definition at line 216 of file albaGUIDockManager.h.

HasMaximizeButton()

bool wxPaneInfo::HasMaximizeButton ( ) const

inline

check flag buttonMaximize

Definition at line 218 of file albaGUIDockManager.h.

HasMinimizeButton()

bool wxPaneInfo::HasMinimizeButton ( ) const

inline

check flag buttonMinimize

Definition at line 220 of file albaGUIDockManager.h.

HasPinButton()

bool wxPaneInfo::HasPinButton ( ) const

inline

check flag buttonPin

Definition at line 222 of file albaGUIDockManager.h.

Window()

wxPaneInfo & wxPaneInfo::Window ( wxWindow *  w )

inline

set window and retrieve this pointer

Definition at line 225 of file albaGUIDockManager.h.

Name()

wxPaneInfo & wxPaneInfo::Name ( const wxString &  n )

inline

set name and retrieve this pointer

Definition at line 227 of file albaGUIDockManager.h.

Caption()

wxPaneInfo & wxPaneInfo::Caption ( const wxString &  c )

inline

set caption and retrieve this pointer

Definition at line 229 of file albaGUIDockManager.h.

Left()

wxPaneInfo & wxPaneInfo::Left ( )

inline

set dock direction to left and retrieve this pointer

Definition at line 231 of file albaGUIDockManager.h.

References wxAUI_DOCK_LEFT.

Right()

wxPaneInfo & wxPaneInfo::Right ( )

inline

set dock direction to right and retrieve this pointer

Definition at line 233 of file albaGUIDockManager.h.

References wxAUI_DOCK_RIGHT.

Top()

wxPaneInfo & wxPaneInfo::Top ( )

inline

set dock direction to top and retrieve this pointer

Definition at line 235 of file albaGUIDockManager.h.

References wxAUI_DOCK_TOP.

Bottom()

wxPaneInfo & wxPaneInfo::Bottom ( )

inline

set dock direction to bottom and retrieve this pointer

Definition at line 237 of file albaGUIDockManager.h.

References wxAUI_DOCK_BOTTOM.

Center()

wxPaneInfo & wxPaneInfo::Center ( )

inline

set dock direction to center and retrieve this pointer

Definition at line 239 of file albaGUIDockManager.h.

References wxAUI_DOCK_CENTER.

Centre()

wxPaneInfo & wxPaneInfo::Centre ( )

inline

set dock direction to center and retrieve this pointer

Definition at line 241 of file albaGUIDockManager.h.

References wxAUI_DOCK_CENTRE.

Direction()

wxPaneInfo & wxPaneInfo::Direction ( int  direction )

inline

set dock direction and retrieve this pointer

Definition at line 243 of file albaGUIDockManager.h.

Layer()

wxPaneInfo & wxPaneInfo::Layer ( int  layer )

inline

set layer and retrieve this pointer

Definition at line 245 of file albaGUIDockManager.h.

Row()

wxPaneInfo & wxPaneInfo::Row ( int  row )

inline

set row and retrieve this pointer

Definition at line 247 of file albaGUIDockManager.h.

Position()

wxPaneInfo & wxPaneInfo::Position ( int  pos )

inline

set position and retrieve this pointer

Definition at line 249 of file albaGUIDockManager.h.

BestSize() [1/2]

wxPaneInfo & wxPaneInfo::BestSize ( const wxSize &  size )

inline

set best size and retrieve this pointer

Definition at line 251 of file albaGUIDockManager.h.

MinSize() [1/2]

wxPaneInfo & wxPaneInfo::MinSize ( const wxSize &  size )

inline

set min size and retrieve this pointer

Definition at line 253 of file albaGUIDockManager.h.

MaxSize() [1/2]

wxPaneInfo & wxPaneInfo::MaxSize ( const wxSize &  size )

inline

set max size and retrieve this pointer

Definition at line 255 of file albaGUIDockManager.h.

BestSize() [2/2]

wxPaneInfo & wxPaneInfo::BestSize ( int  x, int  y  )

inline

set best size and retrieve this pointer

Definition at line 257 of file albaGUIDockManager.h.

MinSize() [2/2]

wxPaneInfo & wxPaneInfo::MinSize ( int  x, int  y  )

inline

set min size and retrieve this pointer

Definition at line 259 of file albaGUIDockManager.h.

MaxSize() [2/2]

wxPaneInfo & wxPaneInfo::MaxSize ( int  x, int  y  )

inline

set max size and retrieve this pointer

Definition at line 261 of file albaGUIDockManager.h.

FloatingPosition() [1/2]

wxPaneInfo & wxPaneInfo::FloatingPosition ( const wxPoint &  pos )

inline

set floating position and retrieve this pointer

Definition at line 263 of file albaGUIDockManager.h.

FloatingPosition() [2/2]

wxPaneInfo & wxPaneInfo::FloatingPosition ( int  x, int  y  )

inline

set floating position and retrieve this pointer

Definition at line 265 of file albaGUIDockManager.h.

FloatingSize() [1/2]

wxPaneInfo & wxPaneInfo::FloatingSize ( const wxSize &  size )

inline

set floating size and retrieve this pointer

Definition at line 267 of file albaGUIDockManager.h.

FloatingSize() [2/2]

wxPaneInfo & wxPaneInfo::FloatingSize ( int  x, int  y  )

inline

set floating size and retrieve this pointer

Definition at line 269 of file albaGUIDockManager.h.

Fixed()

wxPaneInfo & wxPaneInfo::Fixed ( )

inline

set flag optionResizable and retrieve this pointer

Definition at line 271 of file albaGUIDockManager.h.

Resizable()

wxPaneInfo & wxPaneInfo::Resizable ( bool  resizable = true )

inline

set flag optionResizable and retrieve this pointer

Definition at line 273 of file albaGUIDockManager.h.

Referenced by CenterPane().

Dock()

wxPaneInfo & wxPaneInfo::Dock ( )

inline

set flag optionFloating and retrieve this pointer

Definition at line 275 of file albaGUIDockManager.h.

Float()

wxPaneInfo & wxPaneInfo::Float ( )

inline

set flag optionFloating and retrieve this pointer

Definition at line 277 of file albaGUIDockManager.h.

Hide()

wxPaneInfo & wxPaneInfo::Hide ( )

inline

set flag optionHidden and retrieve this pointer

Definition at line 279 of file albaGUIDockManager.h.

Show()

wxPaneInfo & wxPaneInfo::Show ( bool  show = true )

inline

set flag optionHidden and retrieve this pointer

Definition at line 281 of file albaGUIDockManager.h.

CaptionVisible()

wxPaneInfo & wxPaneInfo::CaptionVisible ( bool  visible = true )

inline

set flag optionCaption and retrieve this pointer

Definition at line 283 of file albaGUIDockManager.h.

PaneBorder()

wxPaneInfo & wxPaneInfo::PaneBorder ( bool  visible = true )

inline

set flag optionPaneBorder and retrieve this pointer

Definition at line 285 of file albaGUIDockManager.h.

Referenced by CenterPane().

Gripper()

wxPaneInfo & wxPaneInfo::Gripper ( bool  visible = true )

inline

set flag optionGripper and retrieve this pointer

Definition at line 287 of file albaGUIDockManager.h.

CloseButton()

wxPaneInfo & wxPaneInfo::CloseButton ( bool  visible = true )

inline

set flag buttonClose and retrieve this pointer

Definition at line 289 of file albaGUIDockManager.h.

MaximizeButton()

wxPaneInfo & wxPaneInfo::MaximizeButton ( bool  visible = true )

inline

set flag buttonMaximize and retrieve this pointer

Definition at line 291 of file albaGUIDockManager.h.

MinimizeButton()

wxPaneInfo & wxPaneInfo::MinimizeButton ( bool  visible = true )

inline

set flag buttonMinimize and retrieve this pointer

Definition at line 293 of file albaGUIDockManager.h.

PinButton()

wxPaneInfo & wxPaneInfo::PinButton ( bool  visible = true )

inline

set flag buttonPin and retrieve this pointer

Definition at line 295 of file albaGUIDockManager.h.

DestroyOnClose()

wxPaneInfo & wxPaneInfo::DestroyOnClose ( bool  b = true )

inline

set flag optionDestroyOnClose and retrieve this pointer

Definition at line 297 of file albaGUIDockManager.h.

TopDockable()

wxPaneInfo & wxPaneInfo::TopDockable ( bool  b = true )

inline

set flag optionTopDockable and retrieve this pointer

Definition at line 299 of file albaGUIDockManager.h.

BottomDockable()

wxPaneInfo & wxPaneInfo::BottomDockable ( bool  b = true )

inline

set flag optionBottomDockable and retrieve this pointer

Definition at line 301 of file albaGUIDockManager.h.

Referenced by Dockable().

LeftDockable()

wxPaneInfo & wxPaneInfo::LeftDockable ( bool  b = true )

inline

set flag optionLeftDockable and retrieve this pointer

Definition at line 303 of file albaGUIDockManager.h.

Referenced by Dockable().

RightDockable()

wxPaneInfo & wxPaneInfo::RightDockable ( bool  b = true )

inline

set flag optionRightDockable and retrieve this pointer

Definition at line 305 of file albaGUIDockManager.h.

Referenced by Dockable().

Floatable()

wxPaneInfo & wxPaneInfo::Floatable ( bool  b = true )

inline

set flag optionFloatable and retrieve this pointer

Definition at line 307 of file albaGUIDockManager.h.

Movable()

wxPaneInfo & wxPaneInfo::Movable ( bool  b = true )

inline

set flag optionMovable and retrieve this pointer

Definition at line 309 of file albaGUIDockManager.h.

Dockable()

wxPaneInfo & wxPaneInfo::Dockable ( bool  b = true )

inline

set TopDockable BottomDockable LeftDockable RightDockable and retrieve this pointer

Definition at line 311 of file albaGUIDockManager.h.

References BottomDockable(), LeftDockable(), and RightDockable().

Here is the call graph for this function:

DefaultPane()

wxPaneInfo & wxPaneInfo::DefaultPane ( )

inline

initialize pane flags and retrieve this pointer

Definition at line 317 of file albaGUIDockManager.h.

CentrePane()

wxPaneInfo & wxPaneInfo::CentrePane ( )

inline

set Center PaneBorder Resizable and retrieve this pointer

Definition at line 327 of file albaGUIDockManager.h.

CenterPane()

wxPaneInfo & wxPaneInfo::CenterPane ( )

inline

set Center PaneBorder Resizable and retrieve this pointer

Definition at line 329 of file albaGUIDockManager.h.

References PaneBorder(), and Resizable().

Here is the call graph for this function:

ToolbarPane()

wxPaneInfo & wxPaneInfo::ToolbarPane ( )

inline

set optionToolbar optionGripper , remove optionResizable and optionCaption and retrieve this pointer

Definition at line 336 of file albaGUIDockManager.h.

SetFlag()

wxPaneInfo & wxPaneInfo::SetFlag ( unsigned int  flag, bool  option_state  )

inline

set generic flag and retrieve this pointer

Definition at line 347 of file albaGUIDockManager.h.

HasFlag()

bool wxPaneInfo::HasFlag ( unsigned int  flag ) const

inline

check if flag is active

Definition at line 357 of file albaGUIDockManager.h.

Member Data Documentation

m_Name

wxString wxPaneInfo::m_Name

Definition at line 393 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_Caption

wxString wxPaneInfo::m_Caption

Definition at line 394 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_Window

wxWindow* wxPaneInfo::m_Window

Definition at line 396 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_Frame

wxWindow* wxPaneInfo::m_Frame

Definition at line 397 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_State

unsigned int wxPaneInfo::m_State

Definition at line 398 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_DockDirection

int wxPaneInfo::m_DockDirection

Definition at line 400 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_DockLayer

int wxPaneInfo::m_DockLayer

Definition at line 401 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_DockRow

int wxPaneInfo::m_DockRow

Definition at line 402 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_DockPos

int wxPaneInfo::m_DockPos

Definition at line 403 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_BestSize

wxSize wxPaneInfo::m_BestSize

Definition at line 405 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_MinSize

wxSize wxPaneInfo::m_MinSize

Definition at line 406 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_MaxSize

wxSize wxPaneInfo::m_MaxSize

Definition at line 407 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_FloatingPos

wxPoint wxPaneInfo::m_FloatingPos

Definition at line 409 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_FloatingSize

wxSize wxPaneInfo::m_FloatingSize

Definition at line 410 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_DockProportion

int wxPaneInfo::m_DockProportion

Definition at line 411 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_Buttons

wxPaneButtonArray wxPaneInfo::m_Buttons

Definition at line 413 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

m_Rect

wxRect wxPaneInfo::m_Rect

Definition at line 415 of file albaGUIDockManager.h.

Referenced by operator=(), and wxPaneInfo().

---

The documentation for this class was generated from the following file:

• albaGUIDockManager.h