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 wxFrameManagerDock
  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 wxFrameManagerOption
  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_TRANSPARENT_HINT_FADE = 1 << 4,
  47
  48     wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING |
  49                         wxAUI_MGR_TRANSPARENT_HINT |
  50                         wxAUI_MGR_TRANSPARENT_HINT_FADE
  51 };
  52
  53 enum wxPaneDockArtSetting
  54 {
  55     wxAUI_ART_SASH_SIZE = 0,
  56     wxAUI_ART_CAPTION_SIZE = 1,
  57     wxAUI_ART_GRIPPER_SIZE = 2,
  58     wxAUI_ART_PANE_BORDER_SIZE = 3,
  59     wxAUI_ART_PANE_BUTTON_SIZE = 4,
  60     wxAUI_ART_BACKGROUND_COLOUR = 5,
  61     wxAUI_ART_SASH_COLOUR = 6,
  62     wxAUI_ART_ACTIVE_CAPTION_COLOUR = 7,
  63     wxAUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
  64     wxAUI_ART_INACTIVE_CAPTION_COLOUR = 9,
  65     wxAUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
  66     wxAUI_ART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
  67     wxAUI_ART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
  68     wxAUI_ART_BORDER_COLOUR = 13,
  69     wxAUI_ART_GRIPPER_COLOUR = 14,
  70     wxAUI_ART_CAPTION_FONT = 15,
  71     wxAUI_ART_GRADIENT_TYPE = 16
  72 };
  73
  74 enum wxPaneDockArtGradients
  75 {
  76     wxAUI_GRADIENT_NONE = 0,
  77     wxAUI_GRADIENT_VERTICAL = 1,
  78     wxAUI_GRADIENT_HORIZONTAL = 2
  79 };
  80
  81 enum wxPaneButtonState
  82 {
  83     wxAUI_BUTTON_STATE_NORMAL = 0,
  84     wxAUI_BUTTON_STATE_HOVER = 1,
  85     wxAUI_BUTTON_STATE_PRESSED = 2
  86 };
  87
  88 enum wxPaneInsertLevel
  89 {
  90     wxAUI_INSERT_PANE = 0,
  91     wxAUI_INSERT_ROW = 1,
  92     wxAUI_INSERT_DOCK = 2
  93 };
  94
  95
  96
  97 // forwards and array declarations
  98 class wxDockUIPart;
  99 class wxPaneButton;
 100 class wxPaneInfo;
 101 class wxDockInfo;
 102 class wxDockArt;
 103 class wxFrameManagerEvent;
 104
 105 #ifndef SWIG
 106 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxDockInfo, wxDockInfoArray, WXDLLIMPEXP_AUI);
 107 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxDockUIPart, wxDockUIPartArray, WXDLLIMPEXP_AUI);
 108 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxPaneButton, wxPaneButtonArray, WXDLLIMPEXP_AUI);
 109 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxPaneInfo, wxPaneInfoArray, WXDLLIMPEXP_AUI);
 110 WX_DEFINE_ARRAY_PTR(wxPaneInfo*, wxPaneInfoPtrArray);
 111 WX_DEFINE_ARRAY_PTR(wxDockInfo*, wxDockInfoPtrArray);
 112 #endif // SWIG
 113
 114 extern WXDLLIMPEXP_AUI wxDockInfo wxNullDockInfo;
 115 extern WXDLLIMPEXP_AUI wxPaneInfo wxNullPaneInfo;
 116
 117
 118
 119 class WXDLLIMPEXP_AUI wxPaneInfo
 120 {
 121 public:
 122
 123     wxPaneInfo()
 124     {
 125         window = NULL;
 126         frame = NULL;
 127         state = 0;
 128         dock_direction = wxAUI_DOCK_LEFT;
 129         dock_layer = 0;
 130         dock_row = 0;
 131         dock_pos = 0;
 132         floating_pos = wxDefaultPosition;
 133         floating_size = wxDefaultSize;
 134         best_size = wxDefaultSize;
 135         min_size = wxDefaultSize;
 136         max_size = wxDefaultSize;
 137         dock_proportion = 0;
 138
 139         DefaultPane();
 140     }
 141
 142     ~wxPaneInfo() {}
 143
 144 #ifndef SWIG
 145     wxPaneInfo(const wxPaneInfo& c)
 146     {
 147         name = c.name;
 148         caption = c.caption;
 149         window = c.window;
 150         frame = c.frame;
 151         state = c.state;
 152         dock_direction = c.dock_direction;
 153         dock_layer = c.dock_layer;
 154         dock_row = c.dock_row;
 155         dock_pos = c.dock_pos;
 156         best_size = c.best_size;
 157         min_size = c.min_size;
 158         max_size = c.max_size;
 159         floating_pos = c.floating_pos;
 160         floating_size = c.floating_size;
 161         dock_proportion = c.dock_proportion;
 162         buttons = c.buttons;
 163         rect = c.rect;
 164     }
 165
 166     wxPaneInfo& operator=(const wxPaneInfo& c)
 167     {
 168         name = c.name;
 169         caption = c.caption;
 170         window = c.window;
 171         frame = c.frame;
 172         state = c.state;
 173         dock_direction = c.dock_direction;
 174         dock_layer = c.dock_layer;
 175         dock_row = c.dock_row;
 176         dock_pos = c.dock_pos;
 177         best_size = c.best_size;
 178         min_size = c.min_size;
 179         max_size = c.max_size;
 180         floating_pos = c.floating_pos;
 181         floating_size = c.floating_size;
 182         dock_proportion = c.dock_proportion;
 183         buttons = c.buttons;
 184         rect = c.rect;
 185         return *this;
 186     }
 187 #endif // SWIG
 188
 189     bool IsOk() const { return (window != NULL) ? true : false; }
 190     bool IsFixed() const { return !HasFlag(optionResizable); }
 191     bool IsResizable() const { return HasFlag(optionResizable); }
 192     bool IsShown() const { return !HasFlag(optionHidden); }
 193     bool IsFloating() const { return HasFlag(optionFloating); }
 194     bool IsDocked() const { return !HasFlag(optionFloating); }
 195     bool IsToolbar() const { return HasFlag(optionToolbar); }
 196     bool IsTopDockable() const { return HasFlag(optionTopDockable); }
 197     bool IsBottomDockable() const { return HasFlag(optionBottomDockable); }
 198     bool IsLeftDockable() const { return HasFlag(optionLeftDockable); }
 199     bool IsRightDockable() const { return HasFlag(optionRightDockable); }
 200     bool IsFloatable() const { return HasFlag(optionFloatable); }
 201     bool IsMovable() const { return HasFlag(optionMovable); }
 202     bool HasCaption() const { return HasFlag(optionCaption); }
 203     bool HasGripper() const { return HasFlag(optionGripper); }
 204     bool HasBorder() const { return HasFlag(optionPaneBorder); }
 205     bool HasCloseButton() const { return HasFlag(buttonClose); }
 206     bool HasMaximizeButton() const { return HasFlag(buttonMaximize); }
 207     bool HasMinimizeButton() const { return HasFlag(buttonMinimize); }
 208     bool HasPinButton() const { return HasFlag(buttonPin); }
 209     bool HasGripperTop() const { return HasFlag(optionGripperTop); }
 210
 211 #ifdef SWIG
 212     %typemap(out) wxPaneInfo& { $result = $self; Py_INCREF($result); }
 213 #endif
 214     wxPaneInfo& Window(wxWindow* w) { window = w; return *this; }
 215     wxPaneInfo& Name(const wxString& n) { name = n; return *this; }
 216     wxPaneInfo& Caption(const wxString& c) { caption = c; return *this; }
 217     wxPaneInfo& Left() { dock_direction = wxAUI_DOCK_LEFT; return *this; }
 218     wxPaneInfo& Right() { dock_direction = wxAUI_DOCK_RIGHT; return *this; }
 219     wxPaneInfo& Top() { dock_direction = wxAUI_DOCK_TOP; return *this; }
 220     wxPaneInfo& Bottom() { dock_direction = wxAUI_DOCK_BOTTOM; return *this; }
 221     wxPaneInfo& Center() { dock_direction = wxAUI_DOCK_CENTER; return *this; }
 222     wxPaneInfo& Centre() { dock_direction = wxAUI_DOCK_CENTRE; return *this; }
 223     wxPaneInfo& Direction(int direction) { dock_direction = direction; return *this; }
 224     wxPaneInfo& Layer(int layer) { dock_layer = layer; return *this; }
 225     wxPaneInfo& Row(int row) { dock_row = row; return *this; }
 226     wxPaneInfo& Position(int pos) { dock_pos = pos; return *this; }
 227     wxPaneInfo& BestSize(const wxSize& size) { best_size = size; return *this; }
 228     wxPaneInfo& MinSize(const wxSize& size) { min_size = size; return *this; }
 229     wxPaneInfo& MaxSize(const wxSize& size) { max_size = size; return *this; }
 230     wxPaneInfo& BestSize(int x, int y) { best_size.Set(x,y); return *this; }
 231     wxPaneInfo& MinSize(int x, int y) { min_size.Set(x,y); return *this; }
 232     wxPaneInfo& MaxSize(int x, int y) { max_size.Set(x,y); return *this; }
 233     wxPaneInfo& FloatingPosition(const wxPoint& pos) { floating_pos = pos; return *this; }
 234     wxPaneInfo& FloatingPosition(int x, int y) { floating_pos.x = x; floating_pos.y = y; return *this; }
 235     wxPaneInfo& FloatingSize(const wxSize& size) { floating_size = size; return *this; }
 236     wxPaneInfo& FloatingSize(int x, int y) { floating_size.Set(x,y); return *this; }
 237     wxPaneInfo& Fixed() { return SetFlag(optionResizable, false); }
 238     wxPaneInfo& Resizable(bool resizable = true) { return SetFlag(optionResizable, resizable); }
 239     wxPaneInfo& Dock() { return SetFlag(optionFloating, false); }
 240     wxPaneInfo& Float() { return SetFlag(optionFloating, true); }
 241     wxPaneInfo& Hide() { return SetFlag(optionHidden, true); }
 242     wxPaneInfo& Show(bool show = true) { return SetFlag(optionHidden, !show); }
 243     wxPaneInfo& CaptionVisible(bool visible = true) { return SetFlag(optionCaption, visible); }
 244     wxPaneInfo& PaneBorder(bool visible = true) { return SetFlag(optionPaneBorder, visible); }
 245     wxPaneInfo& Gripper(bool visible = true) { return SetFlag(optionGripper, visible); }
 246     wxPaneInfo& GripperTop(bool attop = true) { return SetFlag(optionGripperTop, attop); }
 247     wxPaneInfo& CloseButton(bool visible = true) { return SetFlag(buttonClose, visible); }
 248     wxPaneInfo& MaximizeButton(bool visible = true) { return SetFlag(buttonMaximize, visible); }
 249     wxPaneInfo& MinimizeButton(bool visible = true) { return SetFlag(buttonMinimize, visible); }
 250     wxPaneInfo& PinButton(bool visible = true) { return SetFlag(buttonPin, visible); }
 251     wxPaneInfo& DestroyOnClose(bool b = true) { return SetFlag(optionDestroyOnClose, b); }
 252     wxPaneInfo& TopDockable(bool b = true) { return SetFlag(optionTopDockable, b); }
 253     wxPaneInfo& BottomDockable(bool b = true) { return SetFlag(optionBottomDockable, b); }
 254     wxPaneInfo& LeftDockable(bool b = true) { return SetFlag(optionLeftDockable, b); }
 255     wxPaneInfo& RightDockable(bool b = true) { return SetFlag(optionRightDockable, b); }
 256     wxPaneInfo& Floatable(bool b = true) { return SetFlag(optionFloatable, b); }
 257     wxPaneInfo& Movable(bool b = true) { return SetFlag(optionMovable, b); }
 258     wxPaneInfo& Dockable(bool b = true)
 259     {
 260         return TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b);
 261     }
 262
 263     wxPaneInfo& DefaultPane()
 264     {
 265         state |= optionTopDockable | optionBottomDockable |
 266                  optionLeftDockable | optionRightDockable |
 267                  optionFloatable | optionMovable | optionResizable |
 268                  optionCaption | optionPaneBorder | buttonClose;
 269         return *this;
 270     }
 271
 272     wxPaneInfo& CentrePane() { return CenterPane(); }
 273     wxPaneInfo& CenterPane()
 274     {
 275         state = 0;
 276         return Center().PaneBorder().Resizable();
 277     }
 278
 279     wxPaneInfo& ToolbarPane()
 280     {
 281         DefaultPane();
 282         state |= (optionToolbar | optionGripper);
 283         state &= ~(optionResizable | optionCaption);
 284         if (dock_layer == 0)
 285             dock_layer = 10;
 286         return *this;
 287     }
 288
 289     wxPaneInfo& SetFlag(unsigned int flag, bool option_state)
 290     {
 291         if (option_state)
 292             state |= flag;
 293              else
 294             state &= ~flag;
 295         return *this;
 296     }
 297
 298     bool HasFlag(unsigned int flag) const
 299     {
 300         return (state & flag) ? true:false;
 301     }
 302
 303 #ifdef SWIG
 304     %typemap(out) wxPaneInfo& ;
 305 #endif
 306
 307 public:
 308
 309     enum wxPaneState
 310     {
 311         optionFloating        = 1 << 0,
 312         optionHidden          = 1 << 1,
 313         optionLeftDockable    = 1 << 2,
 314         optionRightDockable   = 1 << 3,
 315         optionTopDockable     = 1 << 4,
 316         optionBottomDockable  = 1 << 5,
 317         optionFloatable       = 1 << 6,
 318         optionMovable         = 1 << 7,
 319         optionResizable       = 1 << 8,
 320         optionPaneBorder      = 1 << 9,
 321         optionCaption         = 1 << 10,
 322         optionGripper         = 1 << 11,
 323         optionDestroyOnClose  = 1 << 12,
 324         optionToolbar         = 1 << 13,
 325         optionActive          = 1 << 14,
 326         optionGripperTop      = 1 << 15,
 327
 328         buttonClose           = 1 << 24,
 329         buttonMaximize        = 1 << 25,
 330         buttonMinimize        = 1 << 26,
 331         buttonPin             = 1 << 27,
 332         buttonCustom1         = 1 << 28,
 333         buttonCustom2         = 1 << 29,
 334         buttonCustom3         = 1 << 30,
 335         actionPane            = 1 << 31  // used internally
 336     };
 337
 338 public:
 339     wxString name;        // name of the pane
 340     wxString caption;     // caption displayed on the window
 341
 342     wxWindow* window;     // window that is in this pane
 343     wxFrame* frame;       // floating frame window that holds the pane
 344     unsigned int state;   // a combination of wxPaneState values
 345
 346     int dock_direction;   // dock direction (top, bottom, left, right, center)
 347     int dock_layer;       // layer number (0 = innermost layer)
 348     int dock_row;         // row number on the docking bar (0 = first row)
 349     int dock_pos;         // position inside the row (0 = first position)
 350
 351     wxSize best_size;     // size that the layout engine will prefer
 352     wxSize min_size;      // minimum size the pane window can tolerate
 353     wxSize max_size;      // maximum size the pane window can tolerate
 354
 355     wxPoint floating_pos; // position while floating
 356     wxSize floating_size; // size while floating
 357     int dock_proportion;  // proportion while docked
 358
 359     wxPaneButtonArray buttons; // buttons on the pane
 360
 361     wxRect rect;              // current rectangle (populated by wxAUI)
 362 };
 363
 364
 365
 366
 367
 368 class WXDLLIMPEXP_AUI wxFrameManager : public wxEvtHandler
 369 {
 370 friend class wxFloatingPane;
 371
 372 public:
 373
 374     wxFrameManager(wxWindow* managed_wnd = NULL,
 375                    unsigned int flags = wxAUI_MGR_DEFAULT);
 376     virtual ~wxFrameManager();
 377     void UnInit();
 378
 379     void SetFlags(unsigned int flags);
 380     unsigned int GetFlags() const;
 381
 382     void SetManagedWindow(wxWindow* managed_wnd);
 383     wxWindow* GetManagedWindow() const;
 384
 385 #ifdef SWIG
 386     %disownarg( wxDockArt* art_provider );
 387 #endif
 388     void SetArtProvider(wxDockArt* art_provider);
 389     wxDockArt* GetArtProvider() const;
 390
 391     wxPaneInfo& GetPane(wxWindow* window);
 392     wxPaneInfo& GetPane(const wxString& name);
 393     wxPaneInfoArray& GetAllPanes();
 394
 395     bool AddPane(wxWindow* window,
 396                  const wxPaneInfo& pane_info);
 397
 398     bool AddPane(wxWindow* window,
 399                  int direction = wxLEFT,
 400                  const wxString& caption = wxEmptyString);
 401
 402     bool InsertPane(wxWindow* window,
 403                  const wxPaneInfo& insert_location,
 404                  int insert_level = wxAUI_INSERT_PANE);
 405
 406     bool DetachPane(wxWindow* window);
 407
 408     wxString SavePerspective();
 409
 410     bool LoadPerspective(const wxString& perspective,
 411                  bool update = true);
 412
 413     void Update();
 414
 415 public:
 416
 417     // deprecated -- please use SetManagedWindow() and
 418     // and GetManagedWindow() instead
 419
 420     wxDEPRECATED( void SetFrame(wxFrame* frame) );
 421     wxDEPRECATED( wxFrame* GetFrame() const );
 422
 423 protected:
 424
 425     void DrawHintRect(wxWindow* pane_window,
 426                        const wxPoint& pt,
 427                        const wxPoint& offset);
 428
 429     void DoFrameLayout();
 430
 431     void LayoutAddPane(wxSizer* container,
 432                        wxDockInfo& dock,
 433                        wxPaneInfo& pane,
 434                        wxDockUIPartArray& uiparts,
 435                        bool spacer_only);
 436
 437     void LayoutAddDock(wxSizer* container,
 438                        wxDockInfo& dock,
 439                        wxDockUIPartArray& uiparts,
 440                        bool spacer_only);
 441
 442     wxSizer* LayoutAll(wxPaneInfoArray& panes,
 443                        wxDockInfoArray& docks,
 444                        wxDockUIPartArray& uiparts,
 445                        bool spacer_only = false);
 446
 447     virtual bool ProcessDockResult(wxPaneInfo& target,
 448                                    const wxPaneInfo& new_pos);
 449
 450     bool DoDrop(wxDockInfoArray& docks,
 451                 wxPaneInfoArray& panes,
 452                 wxPaneInfo& drop,
 453                 const wxPoint& pt,
 454                 const wxPoint& action_offset = wxPoint(0,0));
 455
 456     wxPaneInfo& LookupPane(wxWindow* window);
 457     wxPaneInfo& LookupPane(const wxString& name);
 458     wxDockUIPart* HitTest(int x, int y);
 459     wxDockUIPart* GetPanePart(wxWindow* pane);
 460     int GetDockPixelOffset(wxPaneInfo& test);
 461     void OnFloatingPaneMoveStart(wxWindow* window);
 462     void OnFloatingPaneMoving(wxWindow* window);
 463     void OnFloatingPaneMoved(wxWindow* window);
 464     void OnFloatingPaneActivated(wxWindow* window);
 465     void OnFloatingPaneClosed(wxWindow* window, wxCloseEvent& evt);
 466     void OnFloatingPaneResized(wxWindow* window, const wxSize& size);
 467     void Render(wxDC* dc);
 468     void Repaint(wxDC* dc = NULL);
 469     void ProcessMgrEvent(wxFrameManagerEvent& event);
 470     void UpdateButtonOnScreen(wxDockUIPart* button_ui_part,
 471                               const wxMouseEvent& event);
 472     void GetPanePositionsAndSizes(wxDockInfo& dock,
 473                               wxArrayInt& positions,
 474                               wxArrayInt& sizes);
 475     virtual void ShowHint(const wxRect& rect);
 476     virtual void HideHint();
 477
 478 public:
 479
 480     // public events (which can be invoked externally)
 481     void OnRender(wxFrameManagerEvent& evt);
 482     void OnPaneButton(wxFrameManagerEvent& evt);
 483
 484 protected:
 485
 486     // protected events
 487     void OnPaint(wxPaintEvent& evt);
 488     void OnEraseBackground(wxEraseEvent& evt);
 489     void OnSize(wxSizeEvent& evt);
 490     void OnSetCursor(wxSetCursorEvent& evt);
 491     void OnLeftDown(wxMouseEvent& evt);
 492     void OnLeftUp(wxMouseEvent& evt);
 493     void OnMotion(wxMouseEvent& evt);
 494     void OnLeaveWindow(wxMouseEvent& evt);
 495     void OnChildFocus(wxChildFocusEvent& evt);
 496     void OnHintFadeTimer(wxTimerEvent& evt);
 497
 498 protected:
 499
 500     enum
 501     {
 502         actionNone = 0,
 503         actionResize,
 504         actionClickButton,
 505         actionClickCaption,
 506         actionDragToolbarPane,
 507         actionDragFloatingPane
 508     };
 509
 510 protected:
 511
 512     wxWindow* m_frame;           // the window being managed
 513     wxDockArt* m_art;            // dock art object which does all drawing
 514     unsigned int m_flags;        // manager flags wxAUI_MGR_*
 515
 516     wxPaneInfoArray m_panes;     // array of panes structures
 517     wxDockInfoArray m_docks;     // array of docks structures
 518     wxDockUIPartArray m_uiparts; // array of UI parts (captions, buttons, etc)
 519
 520     int m_action;                // current mouse action
 521     wxPoint m_action_start;      // position where the action click started
 522     wxPoint m_action_offset;     // offset from upper left of the item clicked
 523     wxDockUIPart* m_action_part; // ptr to the part the action happened to
 524     wxWindow* m_action_window;   // action frame or window (NULL if none)
 525     wxRect m_action_hintrect;    // hint rectangle for the action
 526     wxDockUIPart* m_hover_button;// button uipart being hovered over
 527     wxRect m_last_hint;          // last hint rectangle
 528     wxPoint m_last_mouse_move;   // last mouse move position (see OnMotion)
 529
 530     wxFrame* m_hint_wnd;         // transparent hint window, if supported by platform
 531     wxTimer m_hint_fadetimer;    // transparent fade timer
 532     int m_hint_fadeamt;          // transparent fade amount
 533
 534 #ifndef SWIG
 535     DECLARE_EVENT_TABLE()
 536 #endif // SWIG
 537 };
 538
 539
 540
 541 // event declarations/classes
 542
 543 class WXDLLIMPEXP_AUI wxFrameManagerEvent : public wxEvent
 544 {
 545 public:
 546     wxFrameManagerEvent(wxEventType type=wxEVT_NULL) : wxEvent(0, type)
 547     {
 548         pane = NULL;
 549         button = 0;
 550         veto_flag = false;
 551         canveto_flag = true;
 552         dc = NULL;
 553     }
 554 #ifndef SWIG
 555     wxFrameManagerEvent(const wxFrameManagerEvent& c) : wxEvent(c)
 556     {
 557         pane = c.pane;
 558         button = c.button;
 559         veto_flag = c.veto_flag;
 560         canveto_flag = c.canveto_flag;
 561         dc = c.dc;
 562     }
 563 #endif
 564     wxEvent *Clone() const { return new wxFrameManagerEvent(*this); }
 565
 566     void SetPane(wxPaneInfo* p) { pane = p; }
 567     void SetButton(int b) { button = b; }
 568     void SetDC(wxDC* pdc) { dc = pdc; }
 569
 570     wxPaneInfo* GetPane() { return pane; }
 571     int GetButton() { return button; }
 572     wxDC* GetDC() { return dc; }
 573
 574     void Veto(bool veto = true) { veto_flag = veto; }
 575     bool GetVeto() const { return veto_flag; }
 576     void SetCanVeto(bool can_veto) { canveto_flag = can_veto; }
 577     bool CanVeto() const { return  canveto_flag && veto_flag; }
 578
 579 public:
 580     wxPaneInfo* pane;
 581     int button;
 582     bool veto_flag;
 583     bool canveto_flag;
 584     wxDC* dc;
 585
 586 #ifndef SWIG
 587 private:
 588     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFrameManagerEvent)
 589 #endif
 590 };
 591
 592
 593 class WXDLLIMPEXP_AUI wxDockInfo
 594 {
 595 public:
 596     wxDockInfo()
 597     {
 598         dock_direction = 0;
 599         dock_layer = 0;
 600         dock_row = 0;
 601         size = 0;
 602         min_size = 0;
 603         resizable = true;
 604         fixed = false;
 605         toolbar = false;
 606     }
 607
 608 #ifndef SWIG
 609     wxDockInfo(const wxDockInfo& c)
 610     {
 611         dock_direction = c.dock_direction;
 612         dock_layer = c.dock_layer;
 613         dock_row = c.dock_row;
 614         size = c.size;
 615         min_size = c.min_size;
 616         resizable = c.resizable;
 617         fixed = c.fixed;
 618         toolbar = c.toolbar;
 619         panes = c.panes;
 620         rect = c.rect;
 621     }
 622
 623     wxDockInfo& operator=(const wxDockInfo& c)
 624     {
 625         dock_direction = c.dock_direction;
 626         dock_layer = c.dock_layer;
 627         dock_row = c.dock_row;
 628         size = c.size;
 629         min_size = c.min_size;
 630         resizable = c.resizable;
 631         fixed = c.fixed;
 632         toolbar = c.toolbar;
 633         panes = c.panes;
 634         rect = c.rect;
 635         return *this;
 636     }
 637 #endif // SWIG
 638
 639     bool IsOk() const { return (dock_direction != 0) ? true : false; }
 640     bool IsHorizontal() const { return (dock_direction == wxAUI_DOCK_TOP ||
 641                              dock_direction == wxAUI_DOCK_BOTTOM) ? true:false; }
 642     bool IsVertical() const { return (dock_direction == wxAUI_DOCK_LEFT ||
 643                              dock_direction == wxAUI_DOCK_RIGHT ||
 644                              dock_direction == wxAUI_DOCK_CENTER) ? true:false; }
 645 public:
 646     wxPaneInfoPtrArray panes; // array of panes
 647     wxRect rect;              // current rectangle
 648     int dock_direction;       // dock direction (top, bottom, left, right, center)
 649     int dock_layer;           // layer number (0 = innermost layer)
 650     int dock_row;             // row number on the docking bar (0 = first row)
 651     int size;                 // size of the dock
 652     int min_size;             // minimum size of a dock (0 if there is no min)
 653     bool resizable;           // flag indicating whether the dock is resizable
 654     bool toolbar;             // flag indicating dock contains only toolbars
 655     bool fixed;               // flag indicating that the dock operates on
 656                               // absolute coordinates as opposed to proportional
 657 };
 658
 659
 660 class WXDLLIMPEXP_AUI wxDockUIPart
 661 {
 662 public:
 663     enum
 664     {
 665         typeCaption,
 666         typeGripper,
 667         typeDock,
 668         typeDockSizer,
 669         typePane,
 670         typePaneSizer,
 671         typeBackground,
 672         typePaneBorder,
 673         typePaneButton
 674     };
 675
 676     int type;                // ui part type (see enum above)
 677     int orientation;         // orientation (either wxHORIZONTAL or wxVERTICAL)
 678     wxDockInfo* dock;        // which dock the item is associated with
 679     wxPaneInfo* pane;        // which pane the item is associated with
 680     wxPaneButton* button;    // which pane button the item is associated with
 681     wxSizer* cont_sizer;     // the part's containing sizer
 682     wxSizerItem* sizer_item; // the sizer item of the part
 683     wxRect rect;             // client coord rectangle of the part itself
 684 };
 685
 686
 687 class WXDLLIMPEXP_AUI wxPaneButton
 688 {
 689 public:
 690     int button_id;        // id of the button (e.g. buttonClose)
 691 };
 692
 693
 694
 695 #ifndef SWIG
 696 // wx event machinery
 697
 698 BEGIN_DECLARE_EVENT_TYPES()
 699     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANEBUTTON, 0)
 700     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_PANECLOSE, 0)
 701     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_AUI_RENDER, 0)
 702 END_DECLARE_EVENT_TYPES()
 703
 704 typedef void (wxEvtHandler::*wxFrameManagerEventFunction)(wxFrameManagerEvent&);
 705
 706 #define wxFrameManagerEventHandler(func) \
 707     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxFrameManagerEventFunction, &func)
 708
 709 #define EVT_AUI_PANEBUTTON(func) \
 710    wx__DECLARE_EVT0(wxEVT_AUI_PANEBUTTON, wxFrameManagerEventHandler(func))
 711 #define EVT_AUI_PANECLOSE(func) \
 712    wx__DECLARE_EVT0(wxEVT_AUI_PANECLOSE, wxFrameManagerEventHandler(func))
 713 #define EVT_AUI_RENDER(func) \
 714    wx__DECLARE_EVT0(wxEVT_AUI_RENDER, wxFrameManagerEventHandler(func))
 715
 716 #else
 717
 718 %constant wxEventType wxEVT_AUI_PANEBUTTON;
 719 %constant wxEventType wxEVT_AUI_PANECLOSE;
 720 %constant wxEventType wxEVT_AUI_RENDER;
 721
 722 %pythoncode {
 723     EVT_AUI_PANEBUTTON = wx.PyEventBinder( wxEVT_AUI_PANEBUTTON )
 724     EVT_AUI_PANECLOSE = wx.PyEventBinder( wxEVT_AUI_PANECLOSE )
 725     EVT_AUI_RENDER = wx.PyEventBinder( wxEVT_AUI_RENDER )
 726 }
 727 #endif // SWIG
 728
 729 #endif // wxUSE_AUI
 730 #endif //_WX_FRAMEMANAGER_H_
 731