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; }
 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     wxAuiPaneInfo& DockFixed(bool b = true) { return SetFlag(optionDockFixed, b); }
 302
 303     wxAuiPaneInfo& Dockable(bool b = true)
 304     {
 305         return TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b);
 306     }
 307
 308     wxAuiPaneInfo& DefaultPane()
 309     {
 310         state |= optionTopDockable | optionBottomDockable |
 311                  optionLeftDockable | optionRightDockable |
 312                  optionFloatable | optionMovable | optionResizable |
 313                  optionCaption | optionPaneBorder | buttonClose;
 314         return *this;
 315     }
 316
 317     wxAuiPaneInfo& CentrePane() { return CenterPane(); }
 318     wxAuiPaneInfo& CenterPane()
 319     {
 320         state = 0;
 321         return Center().PaneBorder().Resizable();
 322     }
 323
 324     wxAuiPaneInfo& ToolbarPane()
 325     {
 326         DefaultPane();
 327         state |= (optionToolbar | optionGripper);
 328         state &= ~(optionResizable | optionCaption);
 329         if (dock_layer == 0)
 330             dock_layer = 10;
 331         return *this;
 332     }
 333
 334     wxAuiPaneInfo& SetFlag(unsigned int flag, bool option_state)
 335     {
 336         if (option_state)
 337             state |= flag;
 338         else
 339             state &= ~flag;
 340         return *this;
 341     }
 342
 343     bool HasFlag(unsigned int flag) const
 344     {
 345         return (state & flag) != 0;
 346     }
 347
 348 #ifdef SWIG
 349     %typemap(out) wxAuiPaneInfo& ;
 350 #endif
 351
 352 public:
 353
 354     // NOTE: You can add and subtract flags from this list,
 355     // but do not change the values of the flags, because
 356     // they are stored in a binary integer format in the
 357     // perspective string.  If you really need to change the
 358     // values around, you'll have to ensure backwards-compatibility
 359     // in the perspective loading code.
 360     enum wxAuiPaneState
 361     {
 362         optionFloating        = 1 << 0,
 363         optionHidden          = 1 << 1,
 364         optionLeftDockable    = 1 << 2,
 365         optionRightDockable   = 1 << 3,
 366         optionTopDockable     = 1 << 4,
 367         optionBottomDockable  = 1 << 5,
 368         optionFloatable       = 1 << 6,
 369         optionMovable         = 1 << 7,
 370         optionResizable       = 1 << 8,
 371         optionPaneBorder      = 1 << 9,
 372         optionCaption         = 1 << 10,
 373         optionGripper         = 1 << 11,
 374         optionDestroyOnClose  = 1 << 12,
 375         optionToolbar         = 1 << 13,
 376         optionActive          = 1 << 14,
 377         optionGripperTop      = 1 << 15,
 378         optionMaximized       = 1 << 16,
 379         optionDockFixed       = 1 << 17,
 380
 381         buttonClose           = 1 << 21,
 382         buttonMaximize        = 1 << 22,
 383         buttonMinimize        = 1 << 23,
 384         buttonPin             = 1 << 24,
 385
 386         buttonCustom1         = 1 << 26,
 387         buttonCustom2         = 1 << 27,
 388         buttonCustom3         = 1 << 28,
 389
 390         savedHiddenState      = 1 << 30, // used internally
 391         actionPane            = 1 << 31  // used internally
 392     };
 393
 394 public:
 395     wxString name;        // name of the pane
 396     wxString caption;     // caption displayed on the window
 397
 398     wxWindow* window;     // window that is in this pane
 399     wxFrame* frame;       // floating frame window that holds the pane
 400     unsigned int state;   // a combination of wxPaneState values
 401
 402     int dock_direction;   // dock direction (top, bottom, left, right, center)
 403     int dock_layer;       // layer number (0 = innermost layer)
 404     int dock_row;         // row number on the docking bar (0 = first row)
 405     int dock_pos;         // position inside the row (0 = first position)
 406
 407     wxSize best_size;     // size that the layout engine will prefer
 408     wxSize min_size;      // minimum size the pane window can tolerate
 409     wxSize max_size;      // maximum size the pane window can tolerate
 410
 411     wxPoint floating_pos; // position while floating
 412     wxSize floating_size; // size while floating
 413     int dock_proportion;  // proportion while docked
 414
 415     wxAuiPaneButtonArray buttons; // buttons on the pane
 416
 417     wxRect rect;              // current rectangle (populated by wxAUI)
 418 };
 419
 420
 421
 422 class WXDLLIMPEXP_FWD_AUI wxAuiFloatingFrame;
 423
 424 class WXDLLIMPEXP_AUI wxAuiManager : public wxEvtHandler
 425 {
 426     friend class wxAuiFloatingFrame;
 427
 428 public:
 429
 430     wxAuiManager(wxWindow* managed_wnd = NULL,
 431                    unsigned int flags = wxAUI_MGR_DEFAULT);
 432     virtual ~wxAuiManager();
 433     void UnInit();
 434
 435     void SetFlags(unsigned int flags);
 436     unsigned int GetFlags() const;
 437
 438     void SetManagedWindow(wxWindow* managed_wnd);
 439     wxWindow* GetManagedWindow() const;
 440
 441     static wxAuiManager* GetManager(wxWindow* window);
 442
 443     void SetArtProvider(wxAuiDockArt* art_provider);
 444     wxAuiDockArt* GetArtProvider() const;
 445
 446     wxAuiPaneInfo& GetPane(wxWindow* window);
 447     wxAuiPaneInfo& GetPane(const wxString& name);
 448     wxAuiPaneInfoArray& GetAllPanes();
 449
 450     bool AddPane(wxWindow* window,
 451                  const wxAuiPaneInfo& pane_info);
 452
 453     bool AddPane(wxWindow* window,
 454                  const wxAuiPaneInfo& pane_info,
 455                  const wxPoint& drop_pos);
 456
 457     bool AddPane(wxWindow* window,
 458                  int direction = wxLEFT,
 459                  const wxString& caption = wxEmptyString);
 460
 461     bool InsertPane(wxWindow* window,
 462                  const wxAuiPaneInfo& insert_location,
 463                  int insert_level = wxAUI_INSERT_PANE);
 464
 465     bool DetachPane(wxWindow* window);
 466
 467     void Update();
 468
 469     wxString SavePaneInfo(wxAuiPaneInfo& pane);
 470     void LoadPaneInfo(wxString pane_part, wxAuiPaneInfo &pane);
 471     wxString SavePerspective();
 472     bool LoadPerspective(const wxString& perspective, bool update = true);
 473
 474     void SetDockSizeConstraint(double width_pct, double height_pct);
 475     void GetDockSizeConstraint(double* width_pct, double* height_pct) const;
 476
 477     void ClosePane(wxAuiPaneInfo& pane_info);
 478     void MaximizePane(wxAuiPaneInfo& pane_info);
 479     void RestorePane(wxAuiPaneInfo& pane_info);
 480     void RestoreMaximizedPane();
 481
 482 public:
 483
 484     virtual wxAuiFloatingFrame* CreateFloatingFrame(wxWindow* parent, const wxAuiPaneInfo& p);
 485     virtual bool CanDockPanel(const wxAuiPaneInfo & p);
 486
 487     void StartPaneDrag(
 488                  wxWindow* pane_window,
 489                  const wxPoint& offset);
 490
 491     wxRect CalculateHintRect(
 492                  wxWindow* pane_window,
 493                  const wxPoint& pt,
 494                  const wxPoint& offset);
 495
 496     void DrawHintRect(
 497                  wxWindow* pane_window,
 498                  const wxPoint& pt,
 499                  const wxPoint& offset);
 500
 501     virtual void ShowHint(const wxRect& rect);
 502     virtual void HideHint();
 503
 504     void OnHintActivate(wxActivateEvent& event);
 505
 506 public:
 507
 508     // deprecated -- please use SetManagedWindow() and
 509     // and GetManagedWindow() instead
 510
 511     wxDEPRECATED( void SetFrame(wxFrame* frame) );
 512     wxDEPRECATED( wxFrame* GetFrame() const );
 513
 514 protected:
 515
 516     void UpdateHintWindowConfig();
 517
 518     void DoFrameLayout();
 519
 520     void LayoutAddPane(wxSizer* container,
 521                        wxAuiDockInfo& dock,
 522                        wxAuiPaneInfo& pane,
 523                        wxAuiDockUIPartArray& uiparts,
 524                        bool spacer_only);
 525
 526     void LayoutAddDock(wxSizer* container,
 527                        wxAuiDockInfo& dock,
 528                        wxAuiDockUIPartArray& uiparts,
 529                        bool spacer_only);
 530
 531     wxSizer* LayoutAll(wxAuiPaneInfoArray& panes,
 532                        wxAuiDockInfoArray& docks,
 533                        wxAuiDockUIPartArray& uiparts,
 534                        bool spacer_only = false);
 535
 536     virtual bool ProcessDockResult(wxAuiPaneInfo& target,
 537                                    const wxAuiPaneInfo& new_pos);
 538
 539     bool DoDrop(wxAuiDockInfoArray& docks,
 540                 wxAuiPaneInfoArray& panes,
 541                 wxAuiPaneInfo& drop,
 542                 const wxPoint& pt,
 543                 const wxPoint& action_offset = wxPoint(0,0));
 544
 545     wxAuiDockUIPart* HitTest(int x, int y);
 546     wxAuiDockUIPart* GetPanePart(wxWindow* pane);
 547     int GetDockPixelOffset(wxAuiPaneInfo& test);
 548     void OnFloatingPaneMoveStart(wxWindow* window);
 549     void OnFloatingPaneMoving(wxWindow* window, wxDirection dir );
 550     void OnFloatingPaneMoved(wxWindow* window, wxDirection dir);
 551     void OnFloatingPaneActivated(wxWindow* window);
 552     void OnFloatingPaneClosed(wxWindow* window, wxCloseEvent& evt);
 553     void OnFloatingPaneResized(wxWindow* window, const wxSize& size);
 554     void Render(wxDC* dc);
 555     void Repaint(wxDC* dc = NULL);
 556     void ProcessMgrEvent(wxAuiManagerEvent& event);
 557     void UpdateButtonOnScreen(wxAuiDockUIPart* button_ui_part,
 558                               const wxMouseEvent& event);
 559     void GetPanePositionsAndSizes(wxAuiDockInfo& dock,
 560                               wxArrayInt& positions,
 561                               wxArrayInt& sizes);
 562
 563
 564 public:
 565
 566     // public events (which can be invoked externally)
 567     void OnRender(wxAuiManagerEvent& evt);
 568     void OnPaneButton(wxAuiManagerEvent& evt);
 569
 570 protected:
 571
 572     // protected events
 573     void OnPaint(wxPaintEvent& evt);
 574     void OnEraseBackground(wxEraseEvent& evt);
 575     void OnSize(wxSizeEvent& evt);
 576     void OnSetCursor(wxSetCursorEvent& evt);
 577     void OnLeftDown(wxMouseEvent& evt);
 578     void OnLeftUp(wxMouseEvent& evt);
 579     void OnMotion(wxMouseEvent& evt);
 580     void OnCaptureLost(wxMouseCaptureLostEvent& evt);
 581     void OnLeaveWindow(wxMouseEvent& evt);
 582     void OnChildFocus(wxChildFocusEvent& evt);
 583     void OnHintFadeTimer(wxTimerEvent& evt);
 584     void OnFindManager(wxAuiManagerEvent& evt);
 585
 586 protected:
 587
 588     enum
 589     {
 590         actionNone = 0,
 591         actionResize,
 592         actionClickButton,
 593         actionClickCaption,
 594         actionDragToolbarPane,
 595         actionDragFloatingPane
 596     };
 597
 598 protected:
 599
 600     wxWindow* m_frame;           // the window being managed
 601     wxAuiDockArt* m_art;            // dock art object which does all drawing
 602     unsigned int m_flags;        // manager flags wxAUI_MGR_*
 603
 604     wxAuiPaneInfoArray m_panes;     // array of panes structures
 605     wxAuiDockInfoArray m_docks;     // array of docks structures
 606     wxAuiDockUIPartArray m_uiparts; // array of UI parts (captions, buttons, etc)
 607
 608     int m_action;                // current mouse action
 609     wxPoint m_action_start;      // position where the action click started
 610     wxPoint m_action_offset;     // offset from upper left of the item clicked
 611     wxAuiDockUIPart* m_action_part; // ptr to the part the action happened to
 612     wxWindow* m_action_window;   // action frame or window (NULL if none)
 613     wxRect m_action_hintrect;    // hint rectangle for the action
 614     wxRect m_last_rect;
 615     wxAuiDockUIPart* m_hover_button;// button uipart being hovered over
 616     wxRect m_last_hint;          // last hint rectangle
 617     wxPoint m_last_mouse_move;   // last mouse move position (see OnMotion)
 618     bool m_skipping;
 619     bool m_has_maximized;
 620
 621     double m_dock_constraint_x;  // 0.0 .. 1.0; max pct of window width a dock can consume
 622     double m_dock_constraint_y;  // 0.0 .. 1.0; max pct of window height a dock can consume
 623
 624     wxFrame* m_hint_wnd;         // transparent hint window, if supported by platform
 625     wxTimer m_hint_fadetimer;    // transparent fade timer
 626     wxByte m_hint_fadeamt;       // transparent fade amount
 627     wxByte m_hint_fademax;       // maximum value of hint fade
 628
 629     void* m_reserved;
 630
 631 #ifndef SWIG
 632     DECLARE_EVENT_TABLE()
 633     DECLARE_CLASS(wxAuiManager)
 634 #endif // SWIG
 635 };
 636
 637
 638
 639 // event declarations/classes
 640
 641 class WXDLLIMPEXP_AUI wxAuiManagerEvent : public wxEvent
 642 {
 643 public:
 644     wxAuiManagerEvent(wxEventType type=wxEVT_NULL) : wxEvent(0, type)
 645     {
 646         manager = NULL;
 647         pane = NULL;
 648         button = 0;
 649         veto_flag = false;
 650         canveto_flag = true;
 651         dc = NULL;
 652     }
 653 #ifndef SWIG
 654     wxAuiManagerEvent(const wxAuiManagerEvent& c) : wxEvent(c)
 655     {
 656         manager = c.manager;
 657         pane = c.pane;
 658         button = c.button;
 659         veto_flag = c.veto_flag;
 660         canveto_flag = c.canveto_flag;
 661         dc = c.dc;
 662     }
 663 #endif
 664     wxEvent *Clone() const { return new wxAuiManagerEvent(*this); }
 665
 666     void SetManager(wxAuiManager* mgr) { manager = mgr; }
 667     void SetPane(wxAuiPaneInfo* p) { pane = p; }
 668     void SetButton(int b) { button = b; }
 669     void SetDC(wxDC* pdc) { dc = pdc; }
 670
 671     wxAuiManager* GetManager() const { return manager; }
 672     wxAuiPaneInfo* GetPane() const { return pane; }
 673     int GetButton() const { return button; }
 674     wxDC* GetDC() const { return dc; }
 675
 676     void Veto(bool veto = true) { veto_flag = veto; }
 677     bool GetVeto() const { return veto_flag; }
 678     void SetCanVeto(bool can_veto) { canveto_flag = can_veto; }
 679     bool CanVeto() const { return  canveto_flag && veto_flag; }
 680
 681 public:
 682     wxAuiManager* manager;
 683     wxAuiPaneInfo* pane;
 684     int button;
 685     bool veto_flag;
 686     bool canveto_flag;
 687     wxDC* dc;
 688
 689 #ifndef SWIG
 690 private:
 691     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxAuiManagerEvent)
 692 #endif
 693 };
 694
 695
 696 class WXDLLIMPEXP_AUI wxAuiDockInfo
 697 {
 698 public:
 699     wxAuiDockInfo()
 700     {
 701         dock_direction = 0;
 702         dock_layer = 0;
 703         dock_row = 0;
 704         size = 0;
 705         min_size = 0;
 706         resizable = true;
 707         fixed = false;
 708         toolbar = false;
 709         reserved1 = false;
 710     }
 711
 712 #ifndef SWIG
 713     wxAuiDockInfo(const wxAuiDockInfo& c)
 714     {
 715         dock_direction = c.dock_direction;
 716         dock_layer = c.dock_layer;
 717         dock_row = c.dock_row;
 718         size = c.size;
 719         min_size = c.min_size;
 720         resizable = c.resizable;
 721         fixed = c.fixed;
 722         toolbar = c.toolbar;
 723         panes = c.panes;
 724         rect = c.rect;
 725         reserved1 = c.reserved1;
 726     }
 727
 728     wxAuiDockInfo& operator=(const wxAuiDockInfo& c)
 729     {
 730         dock_direction = c.dock_direction;
 731         dock_layer = c.dock_layer;
 732         dock_row = c.dock_row;
 733         size = c.size;
 734         min_size = c.min_size;
 735         resizable = c.resizable;
 736         fixed = c.fixed;
 737         toolbar = c.toolbar;
 738         panes = c.panes;
 739         rect = c.rect;
 740         reserved1 = c.reserved1;
 741         return *this;
 742     }
 743 #endif // SWIG
 744
 745     bool IsOk() const { return dock_direction != 0; }
 746     bool IsHorizontal() const { return dock_direction == wxAUI_DOCK_TOP ||
 747                              dock_direction == wxAUI_DOCK_BOTTOM; }
 748     bool IsVertical() const { return dock_direction == wxAUI_DOCK_LEFT ||
 749                              dock_direction == wxAUI_DOCK_RIGHT ||
 750                              dock_direction == wxAUI_DOCK_CENTER; }
 751 public:
 752     wxAuiPaneInfoPtrArray panes; // array of panes
 753     wxRect rect;              // current rectangle
 754     int dock_direction;       // dock direction (top, bottom, left, right, center)
 755     int dock_layer;           // layer number (0 = innermost layer)
 756     int dock_row;             // row number on the docking bar (0 = first row)
 757     int size;                 // size of the dock
 758     int min_size;             // minimum size of a dock (0 if there is no min)
 759     bool resizable;           // flag indicating whether the dock is resizable
 760     bool toolbar;             // flag indicating dock contains only toolbars
 761     bool fixed;               // flag indicating that the dock operates on
 762                               // absolute coordinates as opposed to proportional
 763     bool reserved1;
 764 };
 765
 766
 767 class WXDLLIMPEXP_AUI wxAuiDockUIPart
 768 {
 769 public:
 770     enum
 771     {
 772         typeCaption,
 773         typeGripper,
 774         typeDock,
 775         typeDockSizer,
 776         typePane,
 777         typePaneSizer,
 778         typeBackground,
 779         typePaneBorder,
 780         typePaneButton
 781     };
 782
 783     int type;                // ui part type (see enum above)
 784     int orientation;         // orientation (either wxHORIZONTAL or wxVERTICAL)
 785     wxAuiDockInfo* dock;        // which dock the item is associated with
 786     wxAuiPaneInfo* pane;        // which pane the item is associated with
 787     wxAuiPaneButton* button;    // which pane button the item is associated with
 788     wxSizer* cont_sizer;     // the part's containing sizer
 789     wxSizerItem* sizer_item; // the sizer item of the part
 790     wxRect rect;             // client coord rectangle of the part itself
 791 };
 792
 793
 794 class WXDLLIMPEXP_AUI wxAuiPaneButton
 795 {
 796 public:
 797     int button_id;        // id of the button (e.g. buttonClose)
 798 };
 799
 800
 801
 802 #ifndef SWIG
 803
 804 extern WXDLLIMPEXP_AUI const wxEventType wxEVT_AUI_PANE_BUTTON;
 805 extern WXDLLIMPEXP_AUI const wxEventType wxEVT_AUI_PANE_CLOSE;
 806 extern WXDLLIMPEXP_AUI const wxEventType wxEVT_AUI_PANE_MAXIMIZE;
 807 extern WXDLLIMPEXP_AUI const wxEventType wxEVT_AUI_PANE_RESTORE;
 808 extern WXDLLIMPEXP_AUI const wxEventType wxEVT_AUI_RENDER;
 809 extern WXDLLIMPEXP_AUI const wxEventType wxEVT_AUI_FIND_MANAGER;
 810
 811 typedef void (wxEvtHandler::*wxAuiManagerEventFunction)(wxAuiManagerEvent&);
 812
 813 #define wxAuiManagerEventHandler(func) \
 814     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxAuiManagerEventFunction, &func)
 815
 816 #define EVT_AUI_PANE_BUTTON(func) \
 817    wx__DECLARE_EVT0(wxEVT_AUI_PANE_BUTTON, wxAuiManagerEventHandler(func))
 818 #define EVT_AUI_PANE_CLOSE(func) \
 819    wx__DECLARE_EVT0(wxEVT_AUI_PANE_CLOSE, wxAuiManagerEventHandler(func))
 820 #define EVT_AUI_PANE_MAXIMIZE(func) \
 821    wx__DECLARE_EVT0(wxEVT_AUI_PANE_MAXIMIZE, wxAuiManagerEventHandler(func))
 822 #define EVT_AUI_PANE_RESTORE(func) \
 823    wx__DECLARE_EVT0(wxEVT_AUI_PANE_RESTORE, wxAuiManagerEventHandler(func))
 824 #define EVT_AUI_RENDER(func) \
 825    wx__DECLARE_EVT0(wxEVT_AUI_RENDER, wxAuiManagerEventHandler(func))
 826 #define EVT_AUI_FIND_MANAGER(func) \
 827    wx__DECLARE_EVT0(wxEVT_AUI_FIND_MANAGER, wxAuiManagerEventHandler(func))
 828
 829 #else
 830
 831 %constant wxEventType wxEVT_AUI_PANE_BUTTON;
 832 %constant wxEventType wxEVT_AUI_PANE_CLOSE;
 833 %constant wxEventType wxEVT_AUI_PANE_MAXIMIZE;
 834 %constant wxEventType wxEVT_AUI_PANE_RESTORE;
 835 %constant wxEventType wxEVT_AUI_RENDER;
 836 %constant wxEventType wxEVT_AUI_FIND_MANAGER;
 837
 838 %pythoncode {
 839     EVT_AUI_PANE_BUTTON = wx.PyEventBinder( wxEVT_AUI_PANE_BUTTON )
 840     EVT_AUI_PANE_CLOSE = wx.PyEventBinder( wxEVT_AUI_PANE_CLOSE )
 841     EVT_AUI_PANE_MAXIMIZE = wx.PyEventBinder( wxEVT_AUI_PANE_MAXIMIZE )
 842     EVT_AUI_PANE_RESTORE = wx.PyEventBinder( wxEVT_AUI_PANE_RESTORE )
 843     EVT_AUI_RENDER = wx.PyEventBinder( wxEVT_AUI_RENDER )
 844     EVT_AUI_FIND_MANAGER = wx.PyEventBinder( wxEVT_AUI_FIND_MANAGER )
 845 }
 846 #endif // SWIG
 847
 848 #endif // wxUSE_AUI
 849 #endif //_WX_FRAMEMANAGER_H_
 850