Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Search for 

wxAuiPaneInfo Class Reference

#include <framemanager.h>

List of all members.

Public Types

enum  wxAuiPaneState {
  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, optionGripperTop = 1 << 15,
  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

 wxAuiPaneInfo ()
 ~wxAuiPaneInfo ()
 wxAuiPaneInfo (const wxAuiPaneInfo &c)
wxAuiPaneInfo & operator= (const wxAuiPaneInfo &c)
void SafeSet (wxAuiPaneInfo source)
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
bool HasGripperTop () const
wxAuiPaneInfo & Window (wxWindow *w)
wxAuiPaneInfo & Name (const wxString &n)
wxAuiPaneInfo & Caption (const wxString &c)
wxAuiPaneInfo & Left ()
wxAuiPaneInfo & Right ()
wxAuiPaneInfo & Top ()
wxAuiPaneInfo & Bottom ()
wxAuiPaneInfo & Center ()
wxAuiPaneInfo & Centre ()
wxAuiPaneInfo & Direction (int direction)
wxAuiPaneInfo & Layer (int layer)
wxAuiPaneInfo & Row (int row)
wxAuiPaneInfo & Position (int pos)
wxAuiPaneInfo & BestSize (const wxSize &size)
wxAuiPaneInfo & MinSize (const wxSize &size)
wxAuiPaneInfo & MaxSize (const wxSize &size)
wxAuiPaneInfo & BestSize (int x, int y)
wxAuiPaneInfo & MinSize (int x, int y)
wxAuiPaneInfo & MaxSize (int x, int y)
wxAuiPaneInfo & FloatingPosition (const wxPoint &pos)
wxAuiPaneInfo & FloatingPosition (int x, int y)
wxAuiPaneInfo & FloatingSize (const wxSize &size)
wxAuiPaneInfo & FloatingSize (int x, int y)
wxAuiPaneInfo & Fixed ()
wxAuiPaneInfo & Resizable (bool resizable=true)
wxAuiPaneInfo & Dock ()
wxAuiPaneInfo & Float ()
wxAuiPaneInfo & Hide ()
wxAuiPaneInfo & Show (bool show=true)
wxAuiPaneInfo & CaptionVisible (bool visible=true)
wxAuiPaneInfo & PaneBorder (bool visible=true)
wxAuiPaneInfo & Gripper (bool visible=true)
wxAuiPaneInfo & GripperTop (bool attop=true)
wxAuiPaneInfo & CloseButton (bool visible=true)
wxAuiPaneInfo & MaximizeButton (bool visible=true)
wxAuiPaneInfo & MinimizeButton (bool visible=true)
wxAuiPaneInfo & PinButton (bool visible=true)
wxAuiPaneInfo & DestroyOnClose (bool b=true)
wxAuiPaneInfo & TopDockable (bool b=true)
wxAuiPaneInfo & BottomDockable (bool b=true)
wxAuiPaneInfo & LeftDockable (bool b=true)
wxAuiPaneInfo & RightDockable (bool b=true)
wxAuiPaneInfo & Floatable (bool b=true)
wxAuiPaneInfo & Movable (bool b=true)
wxAuiPaneInfo & Dockable (bool b=true)
wxAuiPaneInfo & DefaultPane ()
wxAuiPaneInfo & CentrePane ()
wxAuiPaneInfo & CenterPane ()
wxAuiPaneInfo & ToolbarPane ()
wxAuiPaneInfo & SetFlag (unsigned int flag, bool option_state)
bool HasFlag (unsigned int flag) const

Public Attributes

wxString name
wxString caption
wxWindow * window
wxFrame * frame
unsigned int state
int dock_direction
int dock_layer
int dock_row
int dock_pos
wxSize best_size
wxSize min_size
wxSize max_size
wxPoint floating_pos
wxSize floating_size
int dock_proportion
wxAuiPaneButtonArray buttons
wxRect rect

Detailed Description

Definition at line 131 of file framemanager.h.

Member Enumeration Documentation

enum wxAuiPaneInfo::wxAuiPaneState
 

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

Definition at line 334 of file framemanager.h.

00335     {
00336         optionFloating        = 1 << 0,
00337         optionHidden          = 1 << 1,
00338         optionLeftDockable    = 1 << 2,
00339         optionRightDockable   = 1 << 3,
00340         optionTopDockable     = 1 << 4,
00341         optionBottomDockable  = 1 << 5,
00342         optionFloatable       = 1 << 6,
00343         optionMovable         = 1 << 7,
00344         optionResizable       = 1 << 8,
00345         optionPaneBorder      = 1 << 9,
00346         optionCaption         = 1 << 10,
00347         optionGripper         = 1 << 11,
00348         optionDestroyOnClose  = 1 << 12,
00349         optionToolbar         = 1 << 13,
00350         optionActive          = 1 << 14,
00351         optionGripperTop      = 1 << 15,
00352 
00353         buttonClose           = 1 << 24,
00354         buttonMaximize        = 1 << 25,
00355         buttonMinimize        = 1 << 26,
00356         buttonPin             = 1 << 27,
00357         buttonCustom1         = 1 << 28,
00358         buttonCustom2         = 1 << 29,
00359         buttonCustom3         = 1 << 30,
00360         actionPane            = 1 << 31  // used internally
00361     };

Constructor & Destructor Documentation

wxAuiPaneInfo::wxAuiPaneInfo (   )  [inline]
 

Definition at line 135 of file framemanager.h.

00136     {
00137         window = NULL;
00138         frame = NULL;
00139         state = 0;
00140         dock_direction = wxAUI_DOCK_LEFT;
00141         dock_layer = 0;
00142         dock_row = 0;
00143         dock_pos = 0;
00144         floating_pos = wxDefaultPosition;
00145         floating_size = wxDefaultSize;
00146         best_size = wxDefaultSize;
00147         min_size = wxDefaultSize;
00148         max_size = wxDefaultSize;
00149         dock_proportion = 0;
00150 
00151         DefaultPane();
00152     }

wxAuiPaneInfo::~wxAuiPaneInfo (   )  [inline]
 

Definition at line 154 of file framemanager.h.

00154 {}

wxAuiPaneInfo::wxAuiPaneInfo (  const wxAuiPaneInfo &  c  )  [inline]
 

Definition at line 157 of file framemanager.h.

00158     {
00159         name = c.name;
00160         caption = c.caption;
00161         window = c.window;
00162         frame = c.frame;
00163         state = c.state;
00164         dock_direction = c.dock_direction;
00165         dock_layer = c.dock_layer;
00166         dock_row = c.dock_row;
00167         dock_pos = c.dock_pos;
00168         best_size = c.best_size;
00169         min_size = c.min_size;
00170         max_size = c.max_size;
00171         floating_pos = c.floating_pos;
00172         floating_size = c.floating_size;
00173         dock_proportion = c.dock_proportion;
00174         buttons = c.buttons;
00175         rect = c.rect;
00176     }

Member Function Documentation

wxAuiPaneInfo& wxAuiPaneInfo::BestSize (  int  x,
int  y
)  [inline]
 

Definition at line 255 of file framemanager.h.

00255 { best_size.Set(x,y); return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::BestSize (  const wxSize &  size  )  [inline]
 

Definition at line 252 of file framemanager.h.

00252 { best_size = size; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::Bottom (   )  [inline]
 

Definition at line 245 of file framemanager.h.

00245 { dock_direction = wxAUI_DOCK_BOTTOM; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::BottomDockable (  bool  b = true  )  [inline]
 

Definition at line 278 of file framemanager.h.

00278 { return SetFlag(optionBottomDockable, b); }

wxAuiPaneInfo& wxAuiPaneInfo::Caption (  const wxString &  c  )  [inline]
 

Definition at line 241 of file framemanager.h.

00241 { caption = c; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::CaptionVisible (  bool  visible = true  )  [inline]
 

Definition at line 268 of file framemanager.h.

00268 { return SetFlag(optionCaption, visible); }

wxAuiPaneInfo& wxAuiPaneInfo::Center (   )  [inline]
 

Definition at line 246 of file framemanager.h.

00246 { dock_direction = wxAUI_DOCK_CENTER; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::CenterPane (   )  [inline]
 

Definition at line 298 of file framemanager.h.

00299     {
00300         state = 0;
00301         return Center().PaneBorder().Resizable();
00302     }

wxAuiPaneInfo& wxAuiPaneInfo::Centre (   )  [inline]
 

Definition at line 247 of file framemanager.h.

00247 { dock_direction = wxAUI_DOCK_CENTRE; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::CentrePane (   )  [inline]
 

Definition at line 297 of file framemanager.h.

00297 { return CenterPane(); }

wxAuiPaneInfo& wxAuiPaneInfo::CloseButton (  bool  visible = true  )  [inline]
 

Definition at line 272 of file framemanager.h.

00272 { return SetFlag(buttonClose, visible); }

wxAuiPaneInfo& wxAuiPaneInfo::DefaultPane (   )  [inline]
 

Definition at line 288 of file framemanager.h.

00289     {
00290         state |= optionTopDockable | optionBottomDockable |
00291                  optionLeftDockable | optionRightDockable |
00292                  optionFloatable | optionMovable | optionResizable |
00293                  optionCaption | optionPaneBorder | buttonClose;
00294         return *this;
00295     }

wxAuiPaneInfo& wxAuiPaneInfo::DestroyOnClose (  bool  b = true  )  [inline]
 

Definition at line 276 of file framemanager.h.

00276 { return SetFlag(optionDestroyOnClose, b); }

wxAuiPaneInfo& wxAuiPaneInfo::Direction (  int  direction  )  [inline]
 

Definition at line 248 of file framemanager.h.

00248 { dock_direction = direction; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::Dock (   )  [inline]
 

Definition at line 264 of file framemanager.h.

00264 { return SetFlag(optionFloating, false); }

wxAuiPaneInfo& wxAuiPaneInfo::Dockable (  bool  b = true  )  [inline]
 

Definition at line 283 of file framemanager.h.

00284     {
00285         return TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b);
00286     }

wxAuiPaneInfo& wxAuiPaneInfo::Fixed (   )  [inline]
 

Definition at line 262 of file framemanager.h.

00262 { return SetFlag(optionResizable, false); }

wxAuiPaneInfo& wxAuiPaneInfo::Float (   )  [inline]
 

Definition at line 265 of file framemanager.h.

00265 { return SetFlag(optionFloating, true); }

wxAuiPaneInfo& wxAuiPaneInfo::Floatable (  bool  b = true  )  [inline]
 

Definition at line 281 of file framemanager.h.

00281 { return SetFlag(optionFloatable, b); }

wxAuiPaneInfo& wxAuiPaneInfo::FloatingPosition (  int  x,
int  y
)  [inline]
 

Definition at line 259 of file framemanager.h.

00259 { floating_pos.x = x; floating_pos.y = y; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::FloatingPosition (  const wxPoint &  pos  )  [inline]
 

Definition at line 258 of file framemanager.h.

00258 { floating_pos = pos; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::FloatingSize (  int  x,
int  y
)  [inline]
 

Definition at line 261 of file framemanager.h.

00261 { floating_size.Set(x,y); return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::FloatingSize (  const wxSize &  size  )  [inline]
 

Definition at line 260 of file framemanager.h.

00260 { floating_size = size; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::Gripper (  bool  visible = true  )  [inline]
 

Definition at line 270 of file framemanager.h.

00270 { return SetFlag(optionGripper, visible); }

wxAuiPaneInfo& wxAuiPaneInfo::GripperTop (  bool  attop = true  )  [inline]
 

Definition at line 271 of file framemanager.h.

00271 { return SetFlag(optionGripperTop, attop); }

bool wxAuiPaneInfo::HasBorder (   )  const [inline]
 

Definition at line 229 of file framemanager.h.

00229 { return HasFlag(optionPaneBorder); }

bool wxAuiPaneInfo::HasCaption (   )  const [inline]
 

Definition at line 227 of file framemanager.h.

00227 { return HasFlag(optionCaption); }

bool wxAuiPaneInfo::HasCloseButton (   )  const [inline]
 

Definition at line 230 of file framemanager.h.

00230 { return HasFlag(buttonClose); }

bool wxAuiPaneInfo::HasFlag (  unsigned int  flag  )  const [inline]
 

Definition at line 323 of file framemanager.h.

00324     {
00325         return (state & flag) ? true:false;
00326     }

bool wxAuiPaneInfo::HasGripper (   )  const [inline]
 

Definition at line 228 of file framemanager.h.

00228 { return HasFlag(optionGripper); }

bool wxAuiPaneInfo::HasGripperTop (   )  const [inline]
 

Definition at line 234 of file framemanager.h.

00234 { return HasFlag(optionGripperTop); }

bool wxAuiPaneInfo::HasMaximizeButton (   )  const [inline]
 

Definition at line 231 of file framemanager.h.

00231 { return HasFlag(buttonMaximize); }

bool wxAuiPaneInfo::HasMinimizeButton (   )  const [inline]
 

Definition at line 232 of file framemanager.h.

00232 { return HasFlag(buttonMinimize); }

bool wxAuiPaneInfo::HasPinButton (   )  const [inline]
 

Definition at line 233 of file framemanager.h.

00233 { return HasFlag(buttonPin); }

wxAuiPaneInfo& wxAuiPaneInfo::Hide (   )  [inline]
 

Definition at line 266 of file framemanager.h.

00266 { return SetFlag(optionHidden, true); }

bool wxAuiPaneInfo::IsBottomDockable (   )  const [inline]
 

Definition at line 222 of file framemanager.h.

00222 { return HasFlag(optionBottomDockable); }

bool wxAuiPaneInfo::IsDocked (   )  const [inline]
 

Definition at line 219 of file framemanager.h.

00219 { return !HasFlag(optionFloating); }

bool wxAuiPaneInfo::IsFixed (   )  const [inline]
 

Definition at line 215 of file framemanager.h.

00215 { return !HasFlag(optionResizable); }

bool wxAuiPaneInfo::IsFloatable (   )  const [inline]
 

Definition at line 225 of file framemanager.h.

00225 { return HasFlag(optionFloatable); }

bool wxAuiPaneInfo::IsFloating (   )  const [inline]
 

Definition at line 218 of file framemanager.h.

00218 { return HasFlag(optionFloating); }

bool wxAuiPaneInfo::IsLeftDockable (   )  const [inline]
 

Definition at line 223 of file framemanager.h.

00223 { return HasFlag(optionLeftDockable); }

bool wxAuiPaneInfo::IsMovable (   )  const [inline]
 

Definition at line 226 of file framemanager.h.

00226 { return HasFlag(optionMovable); }

bool wxAuiPaneInfo::IsOk (   )  const [inline]
 

Definition at line 214 of file framemanager.h.

00214 { return (window != NULL) ? true : false; }

bool wxAuiPaneInfo::IsResizable (   )  const [inline]
 

Definition at line 216 of file framemanager.h.

00216 { return HasFlag(optionResizable); }

bool wxAuiPaneInfo::IsRightDockable (   )  const [inline]
 

Definition at line 224 of file framemanager.h.

00224 { return HasFlag(optionRightDockable); }

bool wxAuiPaneInfo::IsShown (   )  const [inline]
 

Definition at line 217 of file framemanager.h.

00217 { return !HasFlag(optionHidden); }

bool wxAuiPaneInfo::IsToolbar (   )  const [inline]
 

Definition at line 220 of file framemanager.h.

00220 { return HasFlag(optionToolbar); }

bool wxAuiPaneInfo::IsTopDockable (   )  const [inline]
 

Definition at line 221 of file framemanager.h.

00221 { return HasFlag(optionTopDockable); }

wxAuiPaneInfo& wxAuiPaneInfo::Layer (  int  layer  )  [inline]
 

Definition at line 249 of file framemanager.h.

00249 { dock_layer = layer; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::Left (   )  [inline]
 

Definition at line 242 of file framemanager.h.

00242 { dock_direction = wxAUI_DOCK_LEFT; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::LeftDockable (  bool  b = true  )  [inline]
 

Definition at line 279 of file framemanager.h.

00279 { return SetFlag(optionLeftDockable, b); }

wxAuiPaneInfo& wxAuiPaneInfo::MaximizeButton (  bool  visible = true  )  [inline]
 

Definition at line 273 of file framemanager.h.

00273 { return SetFlag(buttonMaximize, visible); }

wxAuiPaneInfo& wxAuiPaneInfo::MaxSize (  int  x,
int  y
)  [inline]
 

Definition at line 257 of file framemanager.h.

00257 { max_size.Set(x,y); return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::MaxSize (  const wxSize &  size  )  [inline]
 

Definition at line 254 of file framemanager.h.

00254 { max_size = size; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::MinimizeButton (  bool  visible = true  )  [inline]
 

Definition at line 274 of file framemanager.h.

00274 { return SetFlag(buttonMinimize, visible); }

wxAuiPaneInfo& wxAuiPaneInfo::MinSize (  int  x,
int  y
)  [inline]
 

Definition at line 256 of file framemanager.h.

00256 { min_size.Set(x,y); return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::MinSize (  const wxSize &  size  )  [inline]
 

Definition at line 253 of file framemanager.h.

00253 { min_size = size; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::Movable (  bool  b = true  )  [inline]
 

Definition at line 282 of file framemanager.h.

00282 { return SetFlag(optionMovable, b); }

wxAuiPaneInfo& wxAuiPaneInfo::Name (  const wxString &  n  )  [inline]
 

Definition at line 240 of file framemanager.h.

00240 { name = n; return *this; }

wxAuiPaneInfo& wxAuiPaneInfo::operator= (  const wxAuiPaneInfo &  c  )  [inline]
 

Definition at line 178 of file framemanager.h.

00179     {
00180         name = c.name;
00181         caption = c.caption;
00182         window = c.window;
00183         frame = c.frame;
00184         state = c.state;
00185         dock_direction = c.dock_direction;
00186         dock_layer = c.dock_layer;
00187         dock_row = c.dock_row;
00188         dock_pos = c.dock_pos;
00189         best_size = c.best_size;
00190         min_size = c.min_size;
00191         max_size = c.max_size;
00192         floating_pos = c.floating_pos;
00193         floating_size = c.floating_size;
00194         dock_proportion = c.dock_proportion;
00195         buttons = c.buttons;
00196         rect = c.rect;
00197         return *this;
00198     }

wxAuiPaneInfo& wxAuiPaneInfo::PaneBorder (  bool  visible = true  )  [inline]
 

Definition at line 269 of file framemanager.h.

00269 { return SetFlag(optionPaneBorder, visible); }

wxAuiPaneInfo& wxAuiPaneInfo::PinButton (  bool  visible = true  )  [inline]
 

Definition at line 275 of file framemanager.h.

00275 { return SetFlag(buttonPin, visible); }

wxAuiPaneInfo& wxAuiPaneInfo::Position (  int