include/wx/aui/framemanager.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/aui/framemanager.h
   3 // Purpose:     wxaui: wx advanced user interface - docking window manager
   4 // Author:      Benjamin I. Williams
   5 // Modified by:
   6 // Created:     2005-05-17
   7 // RCS-ID:      $Id$
   8 // Copyright:   (C) Copyright 2005, Kirix Corporation, All Rights Reserved.
   9 // Licence:     wxWindows Library Licence, Version 3.1
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_FRAMEMANAGER_H_
  13 #define _WX_FRAMEMANAGER_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_AUI
  22
  23 #include "wx/dynarray.h"
  24 #include "wx/gdicmn.h"
  25 #include "wx/window.h"
  26 #include "wx/timer.h"
  27 #include "wx/sizer.h"
  28
  29 enum wxAuiManagerDock
  30 {
  31     wxAUI_DOCK_NONE = 0,
  32     wxAUI_DOCK_TOP = 1,
  33     wxAUI_DOCK_RIGHT = 2,
  34     wxAUI_DOCK_BOTTOM = 3,
  35     wxAUI_DOCK_LEFT = 4,
  36     wxAUI_DOCK_CENTER = 5,
  37     wxAUI_DOCK_CENTRE = wxAUI_DOCK_CENTER
  38 };
  39
  40 enum wxAuiManagerOption
  41 {
  42     wxAUI_MGR_ALLOW_FLOATING           = 1 << 0,
  43     wxAUI_MGR_ALLOW_ACTIVE_PANE        = 1 << 1,
  44     wxAUI_MGR_TRANSPARENT_DRAG         = 1 << 2,
  45     wxAUI_MGR_TRANSPARENT_HINT         = 1 << 3,
  46     wxAUI_MGR_VENETIAN_BLINDS_HINT     = 1 << 4,
  47     wxAUI_MGR_RECTANGLE_HINT           = 1 << 5,
  48     wxAUI_MGR_HINT_FADE                = 1 << 6,
  49     wxAUI_MGR_NO_VENETIAN_BLINDS_FADE  = 1 << 7,
  50
  51     wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING |
  52                         wxAUI_MGR_TRANSPARENT_HINT |
  53                         wxAUI_MGR_HINT_FADE |
  54                         wxAUI_MGR_NO_VENETIAN_BLINDS_FADE
  55 };
  56
  57
  58 enum wxAuiPaneDockArtSetting
  59 {
  60     wxAUI_DOCKART_SASH_SIZE = 0,
  61     wxAUI_DOCKART_CAPTION_SIZE = 1,
  62     wxAUI_DOCKART_GRIPPER_SIZE = 2,
  63     wxAUI_DOCKART_PANE_BORDER_SIZE = 3,
  64     wxAUI_DOCKART_PANE_BUTTON_SIZE = 4,
  65     wxAUI_DOCKART_BACKGROUND_COLOUR = 5,
  66     wxAUI_DOCKART_SASH_COLOUR = 6,
  67     wxAUI_DOCKART_ACTIVE_CAPTION_COLOUR = 7,
  68     wxAUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
  69     wxAUI_DOCKART_INACTIVE_CAPTION_COLOUR = 9,
  70     wxAUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
  71     wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
  72     wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
  73     wxAUI_DOCKART_BORDER_COLOUR = 13,
  74     wxAUI_DOCKART_GRIPPER_COLOUR = 14,
  75     wxAUI_DOCKART_CAPTION_FONT = 15,
  76     wxAUI_DOCKART_GRADIENT_TYPE = 16
  77 };
  78
  79 enum wxAuiPaneDockArtGradients
  80 {
  81     wxAUI_GRADIENT_NONE = 0,
  82     wxAUI_GRADIENT_VERTICAL = 1,
  83     wxAUI_GRADIENT_HORIZONTAL = 2
  84 };
  85
  86 enum wxAuiPaneButtonState
  87 {
  88     wxAUI_BUTTON_STATE_NORMAL   = 0,
  89     wxAUI_BUTTON_STATE_HOVER    = 1 << 1,
  90     wxAUI_BUTTON_STATE_PRESSED  = 1 << 2,
  91     wxAUI_BUTTON_STATE_DISABLED = 1 << 3,
  92     wxAUI_BUTTON_STATE_HIDDEN   = 1 << 4,
  93     wxAUI_BUTTON_STATE_CHECKED  = 1 << 5
  94 };
  95
  96 enum wxAuiButtonId
  97 {
  98     wxAUI_BUTTON_CLOSE = 101,
  99     wxAUI_BUTTON_MAXIMIZE_RESTORE = 102,
 100     wxAUI_BUTTON_MINIMIZE = 103,
 101     wxAUI_BUTTON_PIN = 104,
 102     wxAUI_BUTTON_OPTIONS = 105,
 103     wxAUI_BUTTON_WINDOWLIST = 106,
 104     wxAUI_BUTTON_LEFT = 107,
 105     wxAUI_BUTTON_RIGHT = 108,
 106     wxAUI_BUTTON_UP = 109,
 107     wxAUI_BUTTON_DOWN = 110,
 108     wxAUI_BUTTON_CUSTOM1 = 201,
 109     wxAUI_BUTTON_CUSTOM2 = 202,
 110     wxAUI_BUTTON_CUSTOM3 = 203
 111 };
 112
 113 enum wxAuiPaneInsertLevel
 114 {
 115     wxAUI_INSERT_PANE = 0,
 116     wxAUI_INSERT_ROW = 1,
 117     wxAUI_INSERT_DOCK = 2
 118 };
 119
 120
 121
 122
 123 // forwards and array declarations
 124 class wxAuiDockUIPart;
 125 class wxAuiPaneButton;
 126 class wxAuiPaneInfo;
 127 class wxAuiDockInfo;
 128 class wxAuiDockArt;
 129 class wxAuiManagerEvent;
 130
 131 #ifndef SWIG
 132 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiDockInfo, wxAuiDockInfoArray, WXDLLIMPEXP_AUI);
 133 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiDockUIPart, wxAuiDockUIPartArray, WXDLLIMPEXP_AUI);
 134 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiPaneButton, wxAuiPaneButtonArray, WXDLLIMPEXP_AUI);
 135 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiPaneInfo, wxAuiPaneInfoArray, WXDLLIMPEXP_AUI);
 136 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxAuiPaneInfo*, wxAuiPaneInfoPtrArray, class WXDLLIMPEXP_AUI);
 137 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxAuiDockInfo*, wxAuiDockInfoPtrArray, class WXDLLIMPEXP_AUI);
 138 #endif // SWIG
 139
 140 extern WXDLLIMPEXP_AUI wxAuiDockInfo wxAuiNullDockInfo;
 141 extern WXDLLIMPEXP_AUI wxAuiPaneInfo wxAuiNullPaneInfo;
 142
 143
 144
 145 class WXDLLIMPEXP_AUI wxAuiPaneInfo
 146 {
 147 public:
 148
 149     wxAuiPaneInfo()
 150     {
 151         window = NULL;
 152         frame = NULL;
 153         state = 0;
 154         dock_direction = wxAUI_DOCK_LEFT;
 155         dock_layer = 0;
 156         dock_row = 0;
 157         dock_pos = 0;
 158         floating_pos = wxDefaultPosition;
 159         floating_size = wxDefaultSize;
 160         best_size = wxDefaultSize;
 161         min_size = wxDefaultSize;
 162         max_size = wxDefaultSize;
 163         dock_proportion = 0;
 164
 165         DefaultPane();
 166     }
 167
 168     ~wxAuiPaneInfo() {}
 169
 170 #ifndef SWIG
 171     wxAuiPaneInfo(const wxAuiPaneInfo& c)
 172     {
 173         name = c.name;
 174         caption = c.caption;
 175         window = c.window;
 176         frame = c.frame;
 177         state = c.state;
 178         dock_direction = c.dock_direction;
 179         dock_layer = c.dock_layer;
 180         dock_row = c.dock_row;
 181         dock_pos = c.dock_pos;
 182         best_size = c.best_size;
 183         min_size = c.min_size;
 184         max_size = c.max_size;
 185         floating_pos = c.floating_pos;
 186         floating_size = c.floating_size;
 187         dock_proportion = c.dock_proportion;
 188         buttons = c.buttons;
 189         rect = c.rect;
 190     }
 191
 192     wxAuiPaneInfo& operator=(const wxAuiPaneInfo& c)
 193     {
 194         name = c.name;
 195         caption = c.caption;
 196         window = c.window;
 197         frame = c.frame;
 198         state = c.state;
 199         dock_direction = c.dock_direction;
 200         dock_layer = c.dock_layer;
 201         dock_row = c.dock_row;
 202         dock_pos = c.dock_pos;
 203         best_size = c.best_size;
 204         min_size = c.min_size;
 205         max_size = c.max_size;
 206         floating_pos = c.floating_pos;
 207         floating_size = c.floating_size;
 208         dock_proportion = c.dock_proportion;
 209         buttons = c.buttons;
 210         rect = c.rect;
 211         return *this;
 212     }
 213 #endif // SWIG
 214
 215     // Write the safe parts of a newly loaded PaneInfo structure "source" into "this"
 216     // used on loading perspectives etc.
 217     void SafeSet(wxAuiPaneInfo source)
 218     {
 219         // note source is not passed by reference so we can overwrite, to keep the
 220         // unsafe bits of "dest"
 221         source.window = window;
 222         source.frame = frame;
 223         source.buttons = buttons;
 224         // now assign
 225         *this = source;
 226     }
 227
 228     bool IsOk() const { return (window != NULL) ? true : false; }
 229     bool IsFixed() const { return !HasFlag(optionResizable); }
 230     bool IsResizable() const { return HasFlag(optionResizable); }
 231     bool IsShown() const { return !HasFlag(optionHidden); }
 232     bool IsFloating() const { return HasFlag(optionFloating); }
 233     bool IsDocked() const { return !HasFlag(optionFloating); }
 234     bool IsToolbar() const { return HasFlag(optionToolbar); }
 235     bool IsTopDockable() const { return HasFlag(optionTopDockable); }
 236     bool IsBottomDockable() const { return HasFlag(optionBottomDockable); }
 237     bool IsLeftDockable() const { return HasFlag(optionLeftDockable); }
 238     bool IsRightDockable() const { return HasFlag(optionRightDockable); }
 239     bool IsFloatable() const { return HasFlag(optionFloatable); }
 240     bool IsMovable() const { return HasFlag(optionMovable); }
 241     bool IsDestroyOnClose() const { return HasFlag(optionDestroyOnClose); }
 242     bool IsMaximized() const { return HasFlag(optionMaximized); }
 243     bool HasCaption() const { return HasFlag(optionCaption); }
 244     bool HasGripper() const { return HasFlag(optionGripper); }
 245     bool HasBorder() const { return HasFlag(optionPaneBorder); }
 246     bool HasCloseButton() const { return HasFlag(buttonClose); }
 247     bool HasMaximizeButton() const { return HasFlag(buttonMaximize); }
 248     bool HasMinimizeButton() const { return HasFlag(buttonMinimize); }
 249     bool HasPinButton() const { return HasFlag(buttonPin); }
 250     bool HasGripperTop() const { return HasFlag(optionGripperTop); }
 251
 252 #ifdef SWIG
 253     %typemap(out) wxAuiPaneInfo& { $result = $self; Py_INCREF($result); }
 254 #endif
 255     wxAuiPaneInfo& Window(wxWindow* w) { window = w; return *this; }
 256     wxAuiPaneInfo& Name(const wxString& n) { name = n; return *this; }
 257     wxAuiPaneInfo& Caption(const wxString& c) { caption = c; return *this; }
 258     wxAuiPaneInfo& Left() { dock_direction = wxAUI_DOCK_LEFT; return *this; }
 259     wxAuiPaneInfo& Right() { dock_direction = wxAUI_DOCK_RIGHT; return *this; }
 260     wxAuiPaneInfo& Top() { dock_direction = wxAUI_DOCK_TOP; return *this; }
 261     wxAuiPaneInfo& Bottom() { dock_direction = wxAUI_DOCK_BOTTOM; return *this; }
 262     wxAuiPaneInfo& Center() { dock_direction = wxAUI_DOCK_CENTER; return *this; }
 263     wxAuiPaneInfo& Centre() { dock_direction = wxAUI_DOCK_CENTRE; return *this; }
 264     wxAuiPaneInfo& Direction(int direction) { dock_direction = direction; return *this; }
 265     wxAuiPaneInfo& Layer(int layer) { dock_layer = layer; return *this; }
 266     wxAuiPaneInfo& Row(int row) { dock_row = row; return *this; }
 267     wxAuiPaneInfo& Position(int pos) { dock_pos = pos; return *this; }
 268     wxAuiPaneInfo& BestSize(const wxSize& size) { best_size = size; return *this; }
 269     wxAuiPaneInfo& MinSize(const wxSize& size) { min_size = size; return *this; }
 270     wxAuiPaneInfo& MaxSize(const wxSize& size) { max_size = size; return *this; }
 271     wxAuiPaneInfo& BestSize(int x, int y) { best_size.Set(x,y); return *this; }
 272     wxAuiPaneInfo& MinSize(int x, int y) { min_size.Set(x,y); return *this; }
 273     wxAuiPaneInfo& MaxSize(int x, int y) { max_size.Set(x,y); return *this; }
 274     wxAuiPaneInfo& FloatingPosition(const wxPoint& pos) { floating_pos = pos; return *this; }
 275     wxAuiPaneInfo& FloatingPosition(int x, int y) { floating_pos.x = x; floating_pos.y = y; return *this; }
 276     wxAuiPaneInfo& FloatingSize(const wxSize& size) { floating_size = size; return *this; }
 277     wxAuiPaneInfo& FloatingSize(int x, int y) { floating_size.Set(x,y); return *this; }
 278     wxAuiPaneInfo& Fixed() { return SetFlag(optionResizable, false); }
 279     wxAuiPaneInfo& Resizable(bool resizable = true) { return SetFlag(optionResizable, resizable); }
 280     wxAuiPaneInfo& Dock() { return SetFlag(optionFloating, false); }
 281     wxAuiPaneInfo& Float() { return SetFlag(optionFloating, true); }
 282     wxAuiPaneInfo& Hide() { return SetFlag(optionHidden, true); }
 283     wxAuiPaneInfo& Show(bool show = true) { return SetFlag(optionHidden, !show); }
 284     wxAuiPaneInfo& CaptionVisible(bool visible = true) { return SetFlag(optionCaption, visible); }
 285     wxAuiPaneInfo& Maximize() { return SetFlag(optionMaximized, true); }
 286     wxAuiPaneInfo& Restore() { return SetFlag(optionMaximized, false); }
 287     wxAuiPaneInfo& PaneBorder(bool visible = true) { return SetFlag(optionPaneBorder, visible); }
 288     wxAuiPaneInfo& Gripper(bool visible = true) { return SetFlag(optionGripper, visible); }
 289     wxAuiPaneInfo& GripperTop(bool attop = true) { return SetFlag(optionGripperTop, attop); }
 290     wxAuiPaneInfo& CloseButton(bool visible = true) { return SetFlag(buttonClose, visible); }
 291     wxAuiPaneInfo& MaximizeButton(bool visible = true) { return SetFlag(buttonMaximize, visible); }
 292     wxAuiPaneInfo& MinimizeButton(bool visible = true) { return SetFlag(buttonMinimize, visible); }
 293     wxAuiPaneInfo& PinButton(bool visible = true) { return SetFlag(buttonPin, visible); }
 294     wxAuiPaneInfo& DestroyOnClose(bool b = true) { return SetFlag(optionDestroyOnClose, b); }
 295     wxAuiPaneInfo& TopDockable(bool b = true) { return SetFlag(optionTopDockable, b); }
 296     wxAuiPaneInfo& BottomDockable(bool b = true) { return SetFlag(optionBottomDockable, b); }
 297     wxAuiPaneInfo& LeftDockable(bool b = true) { return SetFlag(optionLeftDockable, b); }
 298     wxAuiPaneInfo& RightDockable(bool b = true) { return SetFlag(optionRightDockable, b); }
 299     wxAuiPaneInfo& Floatable(bool b = true) { return SetFlag(optionFloatable, b); }
 300     wxAuiPaneInfo& Movable(bool b = true) { return SetFlag(optionMovable, b); }
 301
 302     wxAuiPaneInfo& SaveHidden() { return SetFlag(optionSavedHidden, HasFlag(optionHidden)); }
 303     wxAuiPaneInfo& RestoreHidden() { return SetFlag(optionHidden, HasFlag(optionSavedHidden)); }
 304
 305     wxAuiPaneInfo& Dockable(bool b = true)
 306     {
 307         return TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b);
 308     }
 309
 310     wxAuiPaneInfo& DefaultPane()
 311     {
 312         state |= optionTopDockable | optionBottomDockable |
 313                  optionLeftDockable | optionRightDockable |
 314                  optionFloatable | optionMovable | optionResizable |
 315                  optionCaption | optionPaneBorder | buttonClose;
 316         return *this;
 317     }
 318
 319     wxAuiPaneInfo& CentrePane() { return CenterPane(); }
 320     wxAuiPaneInfo& CenterPane()
 321     {
 322         state = 0;
 323         return Center().PaneBorder().Resizable();
 324     }
 325
 326     wxAuiPaneInfo& ToolbarPane()
 327     {
 328         DefaultPane();
 329         state |= (optionToolbar | optionGripper);
 330         state &= ~(optionResizable | optionCaption);
 331         if (dock_layer == 0)
 332             dock_layer = 10;
 333         return *this;
 334     }
 335
 336     wxAuiPaneInfo& SetFlag(unsigned int flag, bool option_state)
 337     {
 338         if (option_state)
 339             state |= flag;
 340              else
 341             state &= ~flag;
 342         return *this;
 343     }
 344
 345     bool HasFlag(unsigned int flag) const
 346     {
 347         return (state & flag) ? true:false;
 348     }
 349
 350 #ifdef SWIG
 351     %typemap(out) wxAuiPaneInfo& ;
 352 #endif
 353
 354 public:
 355
 356     enum wxAuiPaneState
 357     {
 358         optionFloating        = 1 << 0,
 359         optionHidden          = 1 << 1,
 360         optionLeftDockable    = 1 << 2,
 361         optionRightDockable   = 1 << 3,
 362         optionTopDockable     = 1 << 4,
 363         optionBottomDockable  = 1 << 5,
 364         optionFloatable       = 1 << 6,
 365         optionMovable         = 1 << 7,
 366         optionResizable       = 1 << 8,
 367         optionPaneBorder      = 1 << 9,
 368         optionCaption         = 1 << 10,
 369         optionGripper         = 1 << 11,
 370         optionDestroyOnClose  = 1 << 12,
 371         optionToolbar         = 1 << 13,
 372         optionActive          = 1 << 14,
 373         optionGripperTop      = 1 << 15,
 374         optionMaximized       = 1 << 16,
 375         optionSavedHidden     = 1 << 17,
 376
 377         buttonClose           = 1 << 24,
 378         buttonMaximize        = 1 << 25,
 379         buttonMinimize        = 1 << 26,
 380         buttonPin             = 1 << 27,
 381         buttonCustom1         = 1 << 28,
 382         buttonCustom2         = 1 << 29,
 383         buttonCustom3         = 1 << 30,
 384         actionPane            = 1 << 31  // used internally
 385     };
 386
 387 public:
 388     wxString name;        // name of the pane
 389     wxString caption;     // caption displayed on the window
 390
 391     wxWindow* window;     // window that is in this pane
 392     wxFrame* frame;       // floating frame window that holds the pane
 393     unsigned int state;   // a combination of wxPaneState values
 394
 395     int dock_direction;   // dock direction (top, bottom, left, right, center)
 396     int dock_layer;       // layer number (0 = innermost layer)
 397     int dock_row;         // row number on the docking bar (0 = first row)
 398     int dock_pos;         // position inside the row (0 = first position)
 399
 400     wxSize best_size;     // size that the layout engine will prefer
 401     wxSize min_size;      // minimum size the pane window can tolerate
 402     wxSize max_size;      // maximum size the pane window can tolerate
 403
 404     wxPoint floating_pos; // position while floating
 405     wxSize floating_size; // size while floating
 406     int dock_proportion;  // proportion while docked
 407
 408     wxAuiPaneButtonArray buttons; // buttons on the pane
 409
 410     wxRect rect;              // current rectangle (populated by wxAUI)
 411 };
 412
 413
 414
 415 class WXDLLIMPEXP_AUI wxAuiFloatingFrame;
 416
 417 class WXDLLIMPEXP_AUI wxAuiManager : public wxEvtHandler
 418 {
 419 friend class wxAuiFloatingFrame;
 420
 421 public:
 422
 423     wxAuiManager(wxWindow* managed_wnd = NULL,
 424                    unsigned int flags = wxAUI_MGR_DEFAULT);
 425     virtual ~wxAuiManager();
 426     void UnInit();
 427
 428     void SetFlags(unsigned int flags);
 429     unsigned int GetFlags() const;
 430
 431     void SetManagedWindow(wxWindow* managed_wnd);
 432     wxWindow* GetManagedWindow() const;
 433
 434     static wxAuiManager* GetManager(wxWindow* window);
 435
 436 #ifdef SWIG
 437     %disownarg( wxAuiDockArt* art_provider );
 438 #endif
 439     void SetArtProvider(wxAuiDockArt* art_provider);
 440     wxAuiDockArt* GetArtProvider() const;
 441
 442     wxAuiPaneInfo& GetPane(wxWindow* window);
 443     wxAuiPaneInfo& GetPane(const wxString& name);
 444     wxAuiPaneInfoArray& GetAllPanes();
 445
 446     bool AddPane(wxWindow* window,
 447                  const wxAuiPaneInfo& pane_info);
 448
 449     bool AddPane(wxWindow* window,
 450                  const wxAuiPaneInfo& pane_info,
 451                  const wxPoint& drop_pos);
 452
 453     bool AddPane(wxWindow* window,
 454                  int direction = wxLEFT,
 455                  const wxString& caption = wxEmptyString);
 456
 457     bool InsertPane(wxWindow* window,
 458                  const wxAuiPaneInfo& insert_location,
 459                  int insert_level = wxAUI_INSERT_PANE);
 460
 461     bool DetachPane(wxWindow* window);
 462
 463     void ClosePane(wxAuiPaneInfo& pane_info);
 464     void MaximizePane(wxAuiPaneInfo& pane_info);
 465     void RestorePane(wxAuiPaneInfo& pane_info);
 466     void RestoreMaximizedPane();
 467
 468     wxString SavePaneInfo(wxAuiPaneInfo& pane);
 469     void LoadPaneInfo(wxString pane_part, wxAuiPaneInfo &pane);
 470
 471     wxString SavePerspective();
 472
 473     bool LoadPerspective(const wxString& perspective,
 474                  bool update = true);
 475
 476     void Update();
 477
 478 public:
 479
 480     virtual wxAuiFloatingFrame* CreateFloatingFrame(wxWindow* parent, const wxAuiPaneInfo& p);
 481
 482     void StartPaneDrag(
 483                  wxWindow* pane_window,
 484                  const wxPoint& offset);
 485
 486     wxRect CalculateHintRect(
 487                  wxWindow* pane_window,
 488                  const wxPoint& pt,
 489                  const wxPoint& offset);
 490
 491     void DrawHintRect(
 492                  wxWindow* pane_window,
 493                  const wxPoint& pt,
 494                  const wxPoint& offset);
 495
 496     virtual void ShowHint(const wxRect& rect);
 497     virtual void HideHint();
 498
 499 public:
 500
 501     // deprecated -- please use SetManagedWindow() and
 502     // and GetManagedWindow() instead
 503
 504     wxDEPRECATED( void SetFrame(wxFrame* frame) );
 505     wxDEPRECATED( wxFrame* GetFrame() const );
 506
 507 protected:
 508
 509     void UpdateHintWindowConfig();
 510
 511     void DoFrameLayout();
 512
 513     void LayoutAddPane(wxSizer* container,
 514                        wxAuiDockInfo& dock,
 515                        wxAuiPaneInfo& pane,
 516                        wxAuiDockUIPartArray& uiparts,
 517                        bool spacer_only);
 518
 519     void LayoutAddDock(wxSizer* container,
 520                        wxAuiDockInfo& dock,
 521                        wxAuiDockUIPartArray& uiparts,
 522                        bool spacer_only);
 523
 524     wxSizer* LayoutAll(wxAuiPaneInfoArray& panes,
 525                        wxAuiDockInfoArray& docks,
 526                        wxAuiDockUIPartArray& uiparts,
 527                        bool spacer_only = false);
 528
 529     virtual bool ProcessDockResult(wxAuiPaneInfo& target,
 530                                    const wxAuiPaneInfo& new_pos);
 531
 532     bool DoDrop(wxAuiDockInfoArray& docks,
 533                 wxAuiPaneInfoArray& panes,
 534                 wxAuiPaneInfo& drop,
 535                 const wxPoint& pt,
 536                 const wxPoint& action_offset = wxPoint(0,0));
 537
 538     wxAuiPaneInfo& LookupPane(wxWindow* window);
 539     wxAuiPaneInfo& LookupPane(const wxString& name);
 540     wxAuiDockUIPart* HitTest(int x, int y);
 541     wxAuiDockUIPart* GetPanePart(wxWindow* pane);
 542     int GetDockPixelOffset(wxAuiPaneInfo& test);
 543     void OnFloatingPaneMoveStart(wxWindow* window);
 544     void OnFloatingPaneMoving(wxWindow* window, wxDirection dir );
 545     void OnFloatingPaneMoved(wxWindow* window, wxDirection dir);
 546     void OnFloatingPaneActivated(wxWindow* window);
 547     void OnFloatingPaneClosed(wxWindow* window, wxCloseEvent& evt);
 548     void OnFloatingPaneResized(wxWindow* window, const wxSize& size);
 549     void Render(wxDC* dc);
 550     void Repaint(wxDC* dc = NULL);
 551     void ProcessMgrEvent(wxAuiManagerEvent& event);
 552     void UpdateButtonOnScreen(wxAuiDockUIPart* button_ui_part,
 553                               const wxMouseEvent& event);
 554     void GetPanePositionsAndSizes(wxAuiDockInfo& dock,
 555                               wxArrayInt& positions,
 556                               wxArrayInt& sizes);
 557
 558
 559 public:
 560
 561     // public events (which can be invoked externally)
 562     void OnRender(wxAuiManagerEvent& evt);
 563     void OnPaneButton(wxAuiManagerEvent& evt);
 564
 565 protected:
 566
 567     // protected events
 568     void OnPaint(wxPaintEvent& evt);
 569     void OnEraseBackground(wxEraseEvent& evt);
 570     void OnSize(wxSizeEvent& evt);
 571     void OnSetCursor(wxSetCursorEvent& evt);
 572     void OnLeftDown(wxMouseEvent& evt);
 573     void OnLeftUp(wxMouseEvent& evt);
 574     void OnMotion(wxMouseEvent& evt);
 575     void OnLeaveWindow(wxMouseEvent& evt);
 576     void OnChildFocus(wxChildFocusEvent& evt);
 577     void OnHintFadeTimer(wxTimerEvent& evt);
 578     void OnFindManager(wxAuiManagerEvent& evt);
 579
 580 protected:
 581
 582     enum
 583     {
 584         actionNone = 0,
 585         actionResize,
 586         actionClickButton,
 587         actionClickCaption,
 588         actionDragToolbarPane,
 589         actionDragFloatingPane
 590     };
 591
 592 protected:
 593
 594     wxWindow* m_frame;           // the window being managed
 595     wxAuiDockArt* m_art;            // dock art object which does all drawing
 596     unsigned int m_flags;        // manager flags wxAUI_MGR_*
 597
 598     wxAuiPaneInfoArray m_panes;     // array of panes structures
 599     wxAuiDockInfoArray m_docks;     // array of docks structures
 600     wxAuiDockUIPartArray m_uiparts; // array of UI parts (captions, buttons, etc)
 601
 602     int m_action;                // current mouse action
 603     wxPoint m_action_start;      // position where the action click started
 604     wxPoint m_action_offset;     // offset from upper left of the item clicked
 605     wxAuiDockUIPart* m_action_part; // ptr to the part the action happened to
 606     wxWindow* m_action_window;   // action frame or window (NULL if none)
 607     wxRect m_action_hintrect;    // hint rectangle for the action
 608     bool m_skipping;
 609     bool m_has_maximized;
 610     wxRect m_last_rect;
 611     wxAuiDockUIPart* m_hover_button;// button uipart being hovered over
 612     wxRect m_last_hint;          // last hint rectangle
 613     wxPoint m_last_mouse_move;   // last mouse move position (see OnMotion)
 614
 615     wxFrame* m_hint_wnd;         // transparent hint window, if supported by platform
 616     wxTimer m_hint_fadetimer;    // transparent fade timer
 617     wxByte m_hint_fadeamt;       // transparent fade amount
 618     wxByte m_hint_fademax;       // maximum value of hint fade
 619
 620 #ifndef SWIG
 621     DECLARE_EVENT_TABLE()
 622     DECLARE_CLASS(wxAuiManager)
 623 #endif // SWIG
 624 };
 625
 626
 627
 628 // event declarations/classes
 629
 630 class WXDLLIMPEXP_AUI wxAuiManagerEvent : public wxEvent
 631 {
 632 public:
 633     wxAuiManagerEvent(wxEventType type=wxEVT_NULL) : wxEvent(0, type)
 634     {
 635         manager = NULL;
 636         pane = NULL;
 637         button = 0;
 638         veto_flag = false;
 639         canveto_flag = true;
 640         dc = NULL;
 641     }
 642 #ifndef SWIG
 643     wxAuiManagerEvent(const wxAuiManagerEvent& c) : wxEvent(c)
 644     {
 645         manager = c.manager;
 646         pane = c.pane;
 647         button = c.button;
 648         veto_flag = c.veto_flag;
 649         canveto_flag = c.canveto_flag;
 650         dc = c.dc;
 651     }
 652 #endif
 653     wxEvent *Clone() const { return new wxAuiManagerEvent(*this); }
 654
 655     void SetManager(wxAuiManager* mgr) { manager = mgr; }
 656     void SetPane(wxAuiPaneInfo* p) { pane = p; }
 657     void SetButton(int b) { button = b; }
 658     void SetDC(wxDC* pdc) { dc = pdc; }
 659
 660     wxAuiManager* GetManager() const { return manager; }
 661     wxAuiPaneInfo* GetPane() const { return pane; }
 662     int GetButton() const { return button; }
 663     wxDC* GetDC() const { return dc; }
 664
 665     void Veto(bool veto = true) { veto_flag = veto; }
 666     bool GetVeto() const { return veto_flag; }
 667     void SetCanVeto(bool can_veto) { canveto_flag = can_veto; }
 668     bool CanVeto() const { return  canveto_flag && veto_flag; }
 669
 670 public:
 671     wxAuiManager* manager;
 672     wxAuiPaneInfo* pane;
 673     int button;
 674     bool veto_flag;
 675     bool canveto_flag;
 676     wxDC* dc;
 677
 678 #ifndef SWIG
 679 private:
 680     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxAuiManagerEvent)
 681 #endif
 682 };
 683
 684
 685 class WXDLLIMPEXP_AUI wxAuiDockInfo
 686 {
 687 public:
 688     wxAuiDockInfo()
 689     {
 690         dock_direction = 0;
 691         dock_layer = 0;
 692         dock_row = 0;
 693         size = 0;
 694         min_size = 0;
 695         resizable = true;
 696         fixed = false;
 697         toolbar = false;
 698     }
 699
 700 #ifndef SWIG
 701     wxAuiDockInfo(const wxAuiDockInfo& c)
 702     {
 703         dock_direction = c.dock_direction;
 704         dock_layer = c.dock_layer;
 705         dock_row = c.dock_row;
 706         size = c.size;
 707         min_size = c.min_size;
 708         resizable = c.resizable;
 709         fixed = c.fixed;
 710         toolbar = c.toolbar;
 711         panes = c.panes;
 712         rect = c.rect;
 713     }
 714
 715     wxAuiDockInfo& operator=(const wxAuiDockInfo& c)
 716     {
 717         dock_direction = c.dock_direction;
 718         dock_layer = c.dock_layer;
 719         dock_row = c.dock_row;
 720         size = c.size;
 721         min_size = c.min_size;
 722         resizable = c.resizable;
 723         fixed = c.fixed;
 724         toolbar = c.toolbar;
 725         panes = c.panes;
 726         rect = c.rect;
 727         return *this;
 728     }
 729 #endif // SWIG
 730
 731     bool IsOk() const { return (dock_direction != 0) ? true : false; }
 732     bool IsHorizontal() const { return (dock_direction == wxAUI_DOCK_TOP ||
 733                              dock_direction == wxAUI_DOCK_BOTTOM) ? true:false; }
 734     bool IsVertical() const { return (dock_direction == wxAUI_DOCK_LEFT ||
 735                              dock_direction == wxAUI_DOCK_RIGHT ||
 736                              dock_direction == wxAUI_DOCK_CENTER) ? true:false; }
 737 public:
 738     wxAuiPaneInfoPtrArray panes; // array of panes
 739     wxRect rect;              // current rectangle
 740     int dock_direction;       // dock direction (top, bottom, left, right, center)
 741     int dock_layer;           // layer number (0 = innermost layer)
 742     int dock_row;             // row number on the docking bar (0 = first row)
 743     int size;                 // size of the dock
 744     int min_size;             // minimum size of a dock (0 if there is no min)
 745     bool resizable;           // flag indicating whether the dock is resizable
 746     bool toolbar;             // flag indicating dock contains only toolbars
 747     bool fixed;               // flag indicating that the dock operates on
 748                               // absolute coordinates as opposed to proportional
 749 };
 750
 751
 752 class WXDLLIMPEXP_AUI wxAuiDockUIPart
 753 {
 754 public:
 755     enum
 756     {
 757         typeCaption,
 758         typeGripper,
 759         typeDock,
 760         typeDockSizer,
 761         typePane,
 762         typePaneSizer,
 763         typeBackground,
 764         typePaneBorder,
 765         typePaneButton
 766     };
 767
 768     int type;                // ui part type (see enum above)
 769     int orientation;         // orientation (either wxHORIZONTAL or wxVERTICAL)
 770     wxAuiDockInfo* dock;        // which dock the item is associated with
 771     wxAuiPaneInfo* pane;        // which pane the item is associated with
 772     wxAuiPaneButton* button;    // which pane button the item is associated with
 773     wxSizer* cont_sizer;     // the part's containing sizer
 774     wxSizerItem* sizer_item; // the sizer item of the part
 775     wxRect rect;             // client coord rectangle of the part itself
 776 };
 777
 778
 779 class WXDLLIMPEXP_AUI wxAuiPaneButton
 780 {
 781 public:
 782     int button_id;        // id of the button (e.g. buttonClose)
 783 };
 784
 785
 786
 787 #ifndef SWIG
 788 // wx event machinery
 789
 790 BEGIN_DECLARE_EVENT_TYPES()
 791     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANEBUTTON, 0)
 792     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANECLOSE, 0)
 793     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANEMAXIMIZE, 0)
 794     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANERESTORE, 0)
 795     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_RENDER, 0)
 796     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_FINDMANAGER, 0)
 797 END_DECLARE_EVENT_TYPES()
 798
 799 typedef void (wxEvtHandler::*wxAuiManagerEventFunction)(wxAuiManagerEvent&);
 800
 801 #define wxAuiManagerEventHandler(func) \
 802     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxAuiManagerEventFunction, &func)
 803
 804 #define EVT_AUI_PANEBUTTON(func) \
 805    wx__DECLARE_EVT0(wxEVT_AUI_PANEBUTTON, wxAuiManagerEventHandler(func))
 806 #define EVT_AUI_PANECLOSE(func) \
 807    wx__DECLARE_EVT0(wxEVT_AUI_PANECLOSE, wxAuiManagerEventHandler(func))
 808 #define EVT_AUI_PANEMAXIMIZE(func) \
 809    wx__DECLARE_EVT0(wxEVT_AUI_PANEMAXIMIZE, wxAuiManagerEventHandler(func))
 810 #define EVT_AUI_PANERESTORE(func) \
 811    wx__DECLARE_EVT0(wxEVT_AUI_PANERESTORE, wxAuiManagerEventHandler(func))
 812 #define EVT_AUI_RENDER(func) \
 813    wx__DECLARE_EVT0(wxEVT_AUI_RENDER, wxAuiManagerEventHandler(func))
 814 #define EVT_AUI_FINDMANAGER(func) \
 815    wx__DECLARE_EVT0(wxEVT_AUI_FINDMANAGER, wxAuiManagerEventHandler(func))
 816
 817 #else
 818
 819 %constant wxEventType wxEVT_AUI_PANEBUTTON;
 820 %constant wxEventType wxEVT_AUI_PANECLOSE;
 821 %constant wxEventType wxEVT_AUI_PANEMAXIMIZE;
 822 %constant wxEventType wxEVT_AUI_PANERESTORE;
 823 %constant wxEventType wxEVT_AUI_RENDER;
 824 %constant wxEventType wxEVT_AUI_FINDMANAGER;
 825
 826 %pythoncode {
 827     EVT_AUI_PANEBUTTON = wx.PyEventBinder( wxEVT_AUI_PANEBUTTON )
 828     EVT_AUI_PANECLOSE = wx.PyEventBinder( wxEVT_AUI_PANECLOSE )
 829     EVT_AUI_PANEMAXIMIZE = wx.PyEventBinder( wxEVT_AUI_PANEMAXIMIZE )
 830     EVT_AUI_PANERESTORE = wx.PyEventBinder( wxEVT_AUI_PANERESTORE )
 831     EVT_AUI_RENDER = wx.PyEventBinder( wxEVT_AUI_RENDER )
 832     EVT_AUI_FINDMANAGER = wx.PyEventBinder( wxEVT_AUI_FINDMANAGER )
 833 }
 834 #endif // SWIG
 835
 836 #endif // wxUSE_AUI
 837 #endif //_WX_FRAMEMANAGER_H_
 838