src/aui/framemanager.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/aui/framemanager.cpp
   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-2006, Kirix Corporation, All Rights Reserved
   9 // Licence:     wxWindows Library Licence, Version 3.1
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #include "wx/wxprec.h"
  21
  22 #ifdef __BORLANDC__
  23     #pragma hdrstop
  24 #endif
  25
  26 #if wxUSE_AUI
  27
  28 #include "wx/aui/framemanager.h"
  29 #include "wx/aui/dockart.h"
  30 #include "wx/aui/floatpane.h"
  31 #include "wx/aui/tabmdi.h"
  32
  33 #ifndef WX_PRECOMP
  34     #include "wx/panel.h"
  35     #include "wx/settings.h"
  36     #include "wx/app.h"
  37     #include "wx/dcclient.h"
  38     #include "wx/dcscreen.h"
  39     #include "wx/toolbar.h"
  40     #include "wx/mdi.h"
  41     #include "wx/image.h"
  42 #endif
  43
  44 WX_CHECK_BUILD_OPTIONS("wxAUI")
  45
  46 #include "wx/arrimpl.cpp"
  47 WX_DECLARE_OBJARRAY(wxRect, wxAuiRectArray);
  48 WX_DEFINE_OBJARRAY(wxAuiRectArray)
  49 WX_DEFINE_OBJARRAY(wxAuiDockUIPartArray)
  50 WX_DEFINE_OBJARRAY(wxAuiDockInfoArray)
  51 WX_DEFINE_OBJARRAY(wxAuiPaneButtonArray)
  52 WX_DEFINE_OBJARRAY(wxAuiPaneInfoArray)
  53
  54 wxAuiPaneInfo wxAuiNullPaneInfo;
  55 wxAuiDockInfo wxAuiNullDockInfo;
  56 DEFINE_EVENT_TYPE(wxEVT_AUI_PANE_BUTTON)
  57 DEFINE_EVENT_TYPE(wxEVT_AUI_PANE_CLOSE)
  58 DEFINE_EVENT_TYPE(wxEVT_AUI_PANE_MAXIMIZE)
  59 DEFINE_EVENT_TYPE(wxEVT_AUI_PANE_RESTORE)
  60 DEFINE_EVENT_TYPE(wxEVT_AUI_RENDER)
  61 DEFINE_EVENT_TYPE(wxEVT_AUI_FIND_MANAGER)
  62
  63 #ifdef __WXMAC__
  64     // a few defines to avoid nameclashes
  65     #define __MAC_OS_X_MEMORY_MANAGER_CLEAN__ 1
  66     #define __AIFF__
  67     #include "wx/mac/private.h"
  68 #endif
  69
  70 IMPLEMENT_DYNAMIC_CLASS(wxAuiManagerEvent, wxEvent)
  71 IMPLEMENT_CLASS(wxAuiManager, wxEvtHandler)
  72
  73
  74
  75 const int auiToolBarLayer = 10;
  76
  77
  78 class wxPseudoTransparentFrame : public wxFrame
  79 {
  80 public:
  81     wxPseudoTransparentFrame(wxWindow* parent = NULL,
  82                 wxWindowID id = wxID_ANY,
  83                 const wxString& title = wxEmptyString,
  84                 const wxPoint& pos = wxDefaultPosition,
  85                 const wxSize& size = wxDefaultSize,
  86                 long style = wxDEFAULT_FRAME_STYLE,
  87                 const wxString &name = wxT("frame"))
  88                     : wxFrame(parent, id, title, pos, size, style | wxFRAME_SHAPED, name)
  89     {
  90         SetBackgroundStyle(wxBG_STYLE_CUSTOM);
  91         m_Amount=0;
  92         m_MaxWidth=0;
  93         m_MaxHeight=0;
  94         m_lastWidth=0;
  95         m_lastHeight=0;
  96 #ifdef __WXGTK__
  97         m_CanSetShape = false; // have to wait for window create event on GTK
  98 #else
  99         m_CanSetShape = true;
 100 #endif
 101         m_Region = wxRegion(0, 0, 0, 0);
 102         SetTransparent(0);
 103     }
 104
 105     virtual bool SetTransparent(wxByte alpha)
 106     {
 107         if (m_CanSetShape)
 108         {
 109             int w=100; // some defaults
 110             int h=100;
 111             GetClientSize(&w, &h);
 112
 113             m_MaxWidth = w;
 114             m_MaxHeight = h;
 115             m_Amount = alpha;
 116             m_Region.Clear();
 117 //            m_Region.Union(0, 0, 1, m_MaxWidth);
 118             if (m_Amount)
 119             {
 120                 for (int y=0; y<m_MaxHeight; y++)
 121                 {
 122                     // Reverse the order of the bottom 4 bits
 123                     int j=((y&8)?1:0)|((y&4)?2:0)|((y&2)?4:0)|((y&1)?8:0);
 124                     if ((j*16+8)<m_Amount)
 125                         m_Region.Union(0, y, m_MaxWidth, 1);
 126                 }
 127             }
 128             SetShape(m_Region);
 129             Refresh();
 130         }
 131         return true;
 132     }
 133
 134     void OnPaint(wxPaintEvent& WXUNUSED(event))
 135     {
 136         wxPaintDC dc(this);
 137
 138         if (m_Region.IsEmpty())
 139             return;
 140
 141 #ifdef __WXMAC__
 142         dc.SetBrush(wxColour(128, 192, 255));
 143 #else
 144         dc.SetBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_ACTIVECAPTION));
 145 #endif
 146         dc.SetPen(*wxTRANSPARENT_PEN);
 147
 148         wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
 149
 150         while (upd)
 151         {
 152             wxRect rect(upd.GetRect());
 153             dc.DrawRectangle(rect.x, rect.y, rect.width, rect.height);
 154
 155             ++upd;
 156         }
 157     }
 158
 159 #ifdef __WXGTK__
 160     void OnWindowCreate(wxWindowCreateEvent& WXUNUSED(event))
 161     {
 162         m_CanSetShape=true;
 163         SetTransparent(0);
 164     }
 165 #endif
 166
 167     void OnSize(wxSizeEvent& event)
 168     {
 169         // We sometimes get surplus size events
 170         if ((event.GetSize().GetWidth() == m_lastWidth) &&
 171             (event.GetSize().GetHeight() == m_lastHeight))
 172         {
 173             event.Skip();
 174             return;
 175         }
 176         m_lastWidth = event.GetSize().GetWidth();
 177         m_lastHeight = event.GetSize().GetHeight();
 178
 179         SetTransparent(m_Amount);
 180         m_Region.Intersect(0, 0, event.GetSize().GetWidth(),
 181                            event.GetSize().GetHeight());
 182         SetShape(m_Region);
 183         Refresh();
 184         event.Skip();
 185     }
 186
 187 private:
 188     wxByte m_Amount;
 189     int m_MaxWidth;
 190     int m_MaxHeight;
 191     bool m_CanSetShape;
 192     int m_lastWidth,m_lastHeight;
 193
 194     wxRegion m_Region;
 195
 196     DECLARE_DYNAMIC_CLASS(wxPseudoTransparentFrame)
 197     DECLARE_EVENT_TABLE()
 198 };
 199
 200
 201 IMPLEMENT_DYNAMIC_CLASS(wxPseudoTransparentFrame, wxFrame)
 202
 203 BEGIN_EVENT_TABLE(wxPseudoTransparentFrame, wxFrame)
 204     EVT_PAINT(wxPseudoTransparentFrame::OnPaint)
 205     EVT_SIZE(wxPseudoTransparentFrame::OnSize)
 206 #ifdef __WXGTK__
 207     EVT_WINDOW_CREATE(wxPseudoTransparentFrame::OnWindowCreate)
 208 #endif
 209 END_EVENT_TABLE()
 210
 211
 212 // -- static utility functions --
 213
 214 static wxBitmap wxPaneCreateStippleBitmap()
 215 {
 216     unsigned char data[] = { 0,0,0,192,192,192, 192,192,192,0,0,0 };
 217     wxImage img(2,2,data,true);
 218     return wxBitmap(img);
 219 }
 220
 221 static void DrawResizeHint(wxDC& dc, const wxRect& rect)
 222 {
 223     wxBitmap stipple = wxPaneCreateStippleBitmap();
 224     wxBrush brush(stipple);
 225     dc.SetBrush(brush);
 226     dc.SetPen(*wxTRANSPARENT_PEN);
 227
 228     dc.SetLogicalFunction(wxXOR);
 229     dc.DrawRectangle(rect);
 230 }
 231
 232
 233
 234 // CopyDocksAndPanes() - this utility function creates copies of
 235 // the dock and pane info.  wxAuiDockInfo's usually contain pointers
 236 // to wxAuiPaneInfo classes, thus this function is necessary to reliably
 237 // reconstruct that relationship in the new dock info and pane info arrays
 238
 239 static void CopyDocksAndPanes(wxAuiDockInfoArray& dest_docks,
 240                               wxAuiPaneInfoArray& dest_panes,
 241                               const wxAuiDockInfoArray& src_docks,
 242                               const wxAuiPaneInfoArray& src_panes)
 243 {
 244     dest_docks = src_docks;
 245     dest_panes = src_panes;
 246     int i, j, k, dock_count, pc1, pc2;
 247     for (i = 0, dock_count = dest_docks.GetCount(); i < dock_count; ++i)
 248     {
 249         wxAuiDockInfo& dock = dest_docks.Item(i);
 250         for (j = 0, pc1 = dock.panes.GetCount(); j < pc1; ++j)
 251             for (k = 0, pc2 = src_panes.GetCount(); k < pc2; ++k)
 252                 if (dock.panes.Item(j) == &src_panes.Item(k))
 253                     dock.panes.Item(j) = &dest_panes.Item(k);
 254     }
 255 }
 256
 257 // GetMaxLayer() is an internal function which returns
 258 // the highest layer inside the specified dock
 259 static int GetMaxLayer(const wxAuiDockInfoArray& docks,
 260                        int dock_direction)
 261 {
 262     int i, dock_count, max_layer = 0;
 263     for (i = 0, dock_count = docks.GetCount(); i < dock_count; ++i)
 264     {
 265         wxAuiDockInfo& dock = docks.Item(i);
 266         if (dock.dock_direction == dock_direction &&
 267             dock.dock_layer > max_layer && !dock.fixed)
 268                 max_layer = dock.dock_layer;
 269     }
 270     return max_layer;
 271 }
 272
 273
 274 // GetMaxRow() is an internal function which returns
 275 // the highest layer inside the specified dock
 276 static int GetMaxRow(const wxAuiPaneInfoArray& panes, int direction, int layer)
 277 {
 278     int i, pane_count, max_row = 0;
 279     for (i = 0, pane_count = panes.GetCount(); i < pane_count; ++i)
 280     {
 281         wxAuiPaneInfo& pane = panes.Item(i);
 282         if (pane.dock_direction == direction &&
 283             pane.dock_layer == layer &&
 284             pane.dock_row > max_row)
 285                 max_row = pane.dock_row;
 286     }
 287     return max_row;
 288 }
 289
 290
 291
 292 // DoInsertDockLayer() is an internal function that inserts a new dock
 293 // layer by incrementing all existing dock layer values by one
 294 static void DoInsertDockLayer(wxAuiPaneInfoArray& panes,
 295                               int dock_direction,
 296                               int dock_layer)
 297 {
 298     int i, pane_count;
 299     for (i = 0, pane_count = panes.GetCount(); i < pane_count; ++i)
 300     {
 301         wxAuiPaneInfo& pane = panes.Item(i);
 302         if (!pane.IsFloating() &&
 303             pane.dock_direction == dock_direction &&
 304             pane.dock_layer >= dock_layer)
 305                 pane.dock_layer++;
 306     }
 307 }
 308
 309 // DoInsertDockLayer() is an internal function that inserts a new dock
 310 // row by incrementing all existing dock row values by one
 311 static void DoInsertDockRow(wxAuiPaneInfoArray& panes,
 312                             int dock_direction,
 313                             int dock_layer,
 314                             int dock_row)
 315 {
 316     int i, pane_count;
 317     for (i = 0, pane_count = panes.GetCount(); i < pane_count; ++i)
 318     {
 319         wxAuiPaneInfo& pane = panes.Item(i);
 320         if (!pane.IsFloating() &&
 321             pane.dock_direction == dock_direction &&
 322             pane.dock_layer == dock_layer &&
 323             pane.dock_row >= dock_row)
 324                 pane.dock_row++;
 325     }
 326 }
 327
 328 // DoInsertDockLayer() is an internal function that inserts a space for
 329 // another dock pane by incrementing all existing dock row values by one
 330 static void DoInsertPane(wxAuiPaneInfoArray& panes,
 331                          int dock_direction,
 332                          int dock_layer,
 333                          int dock_row,
 334                          int dock_pos)
 335 {
 336     int i, pane_count;
 337     for (i = 0, pane_count = panes.GetCount(); i < pane_count; ++i)
 338     {
 339         wxAuiPaneInfo& pane = panes.Item(i);
 340         if (!pane.IsFloating() &&
 341             pane.dock_direction == dock_direction &&
 342             pane.dock_layer == dock_layer &&
 343             pane.dock_row == dock_row &&
 344             pane.dock_pos >= dock_pos)
 345                 pane.dock_pos++;
 346     }
 347 }
 348
 349 // FindDocks() is an internal function that returns a list of docks which meet
 350 // the specified conditions in the parameters and returns a sorted array
 351 // (sorted by layer and then row)
 352 static void FindDocks(wxAuiDockInfoArray& docks,
 353                       int dock_direction,
 354                       int dock_layer,
 355                       int dock_row,
 356                       wxAuiDockInfoPtrArray& arr)
 357 {
 358     int begin_layer = dock_layer;
 359     int end_layer = dock_layer;
 360     int begin_row = dock_row;
 361     int end_row = dock_row;
 362     int dock_count = docks.GetCount();
 363     int layer, row, i, max_row = 0, max_layer = 0;
 364
 365     // discover the maximum dock layer and the max row
 366     for (i = 0; i < dock_count; ++i)
 367     {
 368         max_row = wxMax(max_row, docks.Item(i).dock_row);
 369         max_layer = wxMax(max_layer, docks.Item(i).dock_layer);
 370     }
 371
 372     // if no dock layer was specified, search all dock layers
 373     if (dock_layer == -1)
 374     {
 375         begin_layer = 0;
 376         end_layer = max_layer;
 377     }
 378
 379     // if no dock row was specified, search all dock row
 380     if (dock_row == -1)
 381     {
 382         begin_row = 0;
 383         end_row = max_row;
 384     }
 385
 386     arr.Clear();
 387
 388     for (layer = begin_layer; layer <= end_layer; ++layer)
 389         for (row = begin_row; row <= end_row; ++row)
 390             for (i = 0; i < dock_count; ++i)
 391             {
 392                 wxAuiDockInfo& d = docks.Item(i);
 393                 if (dock_direction == -1 || dock_direction == d.dock_direction)
 394                 {
 395                     if (d.dock_layer == layer && d.dock_row == row)
 396                         arr.Add(&d);
 397                 }
 398             }
 399 }
 400
 401 // FindPaneInDock() looks up a specified window pointer inside a dock.
 402 // If found, the corresponding wxAuiPaneInfo pointer is returned, otherwise NULL.
 403 static wxAuiPaneInfo* FindPaneInDock(const wxAuiDockInfo& dock, wxWindow* window)
 404 {
 405     int i, count = dock.panes.GetCount();
 406     for (i = 0; i < count; ++i)
 407     {
 408         wxAuiPaneInfo* p = dock.panes.Item(i);
 409         if (p->window == window)
 410             return p;
 411     }
 412     return NULL;
 413 }
 414
 415 // RemovePaneFromDocks() removes a pane window from all docks
 416 // with a possible exception specified by parameter "ex_cept"
 417 static void RemovePaneFromDocks(wxAuiDockInfoArray& docks,
 418                                 wxAuiPaneInfo& pane,
 419                                 wxAuiDockInfo* ex_cept  = NULL  )
 420 {
 421     int i, dock_count;
 422     for (i = 0, dock_count = docks.GetCount(); i < dock_count; ++i)
 423     {
 424         wxAuiDockInfo& d = docks.Item(i);
 425         if (&d == ex_cept)
 426             continue;
 427         wxAuiPaneInfo* pi = FindPaneInDock(d, pane.window);
 428         if (pi)
 429             d.panes.Remove(pi);
 430     }
 431 }
 432
 433 // RenumberDockRows() takes a dock and assigns sequential numbers
 434 // to existing rows.  Basically it takes out the gaps; so if a
 435 // dock has rows with numbers 0,2,5, they will become 0,1,2
 436 static void RenumberDockRows(wxAuiDockInfoPtrArray& docks)
 437 {
 438     int i, dock_count, j, pane_count;
 439     for (i = 0, dock_count = docks.GetCount(); i < dock_count; ++i)
 440     {
 441         wxAuiDockInfo& dock = *docks.Item(i);
 442         dock.dock_row = i;
 443         for (j = 0, pane_count = dock.panes.GetCount(); j < pane_count; ++j)
 444             dock.panes.Item(j)->dock_row = i;
 445     }
 446 }
 447
 448
 449 // SetActivePane() sets the active pane, as well as cycles through
 450 // every other pane and makes sure that all others' active flags
 451 // are turned off
 452 static void SetActivePane(wxAuiPaneInfoArray& panes, wxWindow* active_pane)
 453 {
 454     int i, pane_count;
 455     for (i = 0, pane_count = panes.GetCount(); i < pane_count; ++i)
 456     {
 457         wxAuiPaneInfo& pane = panes.Item(i);
 458         pane.state &= ~wxAuiPaneInfo::optionActive;
 459         if (pane.window == active_pane)
 460             pane.state |= wxAuiPaneInfo::optionActive;
 461     }
 462 }
 463
 464
 465 // this function is used to sort panes by dock position
 466 static int PaneSortFunc(wxAuiPaneInfo** p1, wxAuiPaneInfo** p2)
 467 {
 468     return ((*p1)->dock_pos < (*p2)->dock_pos) ? -1 : 1;
 469 }
 470
 471
 472 // -- wxAuiManager class implementation --
 473
 474
 475 BEGIN_EVENT_TABLE(wxAuiManager, wxEvtHandler)
 476     EVT_AUI_PANE_BUTTON(wxAuiManager::OnPaneButton)
 477     EVT_AUI_RENDER(wxAuiManager::OnRender)
 478     EVT_PAINT(wxAuiManager::OnPaint)
 479     EVT_ERASE_BACKGROUND(wxAuiManager::OnEraseBackground)
 480     EVT_SIZE(wxAuiManager::OnSize)
 481     EVT_SET_CURSOR(wxAuiManager::OnSetCursor)
 482     EVT_LEFT_DOWN(wxAuiManager::OnLeftDown)
 483     EVT_LEFT_UP(wxAuiManager::OnLeftUp)
 484     EVT_MOTION(wxAuiManager::OnMotion)
 485     EVT_LEAVE_WINDOW(wxAuiManager::OnLeaveWindow)
 486     EVT_CHILD_FOCUS(wxAuiManager::OnChildFocus)
 487     EVT_AUI_FIND_MANAGER(wxAuiManager::OnFindManager)
 488     EVT_TIMER(101, wxAuiManager::OnHintFadeTimer)
 489 END_EVENT_TABLE()
 490
 491
 492 wxAuiManager::wxAuiManager(wxWindow* managed_wnd, unsigned int flags)
 493 {
 494     m_action = actionNone;
 495     m_last_mouse_move = wxPoint();
 496     m_hover_button = NULL;
 497     m_art = new wxAuiDefaultDockArt;
 498     m_hint_wnd = NULL;
 499     m_flags = flags;
 500     m_skipping = false;
 501     m_has_maximized = false;
 502     m_frame = NULL;
 503     m_dock_constraint_x = 0.3;
 504     m_dock_constraint_y = 0.3;
 505     m_reserved = NULL;
 506
 507     if (managed_wnd)
 508     {
 509         SetManagedWindow(managed_wnd);
 510     }
 511 }
 512
 513 wxAuiManager::~wxAuiManager()
 514 {
 515     for ( size_t i = 0; i < m_panes.size(); i++ )
 516     {
 517         wxAuiPaneInfo& pinfo = m_panes[i];
 518         if (pinfo.window && !pinfo.window->GetParent())
 519             delete pinfo.window;
 520     }
 521
 522     delete m_art;
 523 }
 524
 525 // creates a floating frame for the windows
 526 wxAuiFloatingFrame* wxAuiManager::CreateFloatingFrame(wxWindow* parent,
 527                                                       const wxAuiPaneInfo& pane_info)
 528 {
 529     return new wxAuiFloatingFrame(parent, this, pane_info);
 530 }
 531
 532 bool wxAuiManager::CanDockPanel(const wxAuiPaneInfo & WXUNUSED(p))
 533 {
 534     // if a key modifier is pressed while dragging the frame,
 535     // don't dock the window
 536     return !(wxGetKeyState(WXK_CONTROL) || wxGetKeyState(WXK_ALT));
 537 }
 538
 539 // GetPane() looks up a wxAuiPaneInfo structure based
 540 // on the supplied window pointer.  Upon failure, GetPane()
 541 // returns an empty wxAuiPaneInfo, a condition which can be checked
 542 // by calling wxAuiPaneInfo::IsOk().
 543 //
 544 // The pane info's structure may then be modified.  Once a pane's
 545 // info is modified, wxAuiManager::Update() must be called to
 546 // realize the changes in the UI.
 547
 548 wxAuiPaneInfo& wxAuiManager::GetPane(wxWindow* window)
 549 {
 550     int i, pane_count;
 551     for (i = 0, pane_count = m_panes.GetCount(); i < pane_count; ++i)
 552     {
 553         wxAuiPaneInfo& p = m_panes.Item(i);
 554         if (p.window == window)
 555             return p;
 556     }
 557     return wxAuiNullPaneInfo;
 558 }
 559
 560 // this version of GetPane() looks up a pane based on a
 561 // 'pane name', see above comment for more info
 562 wxAuiPaneInfo& wxAuiManager::GetPane(const wxString& name)
 563 {
 564     int i, pane_count;
 565     for (i = 0, pane_count = m_panes.GetCount(); i < pane_count; ++i)
 566     {
 567         wxAuiPaneInfo& p = m_panes.Item(i);
 568         if (p.name == name)
 569             return p;
 570     }
 571     return wxAuiNullPaneInfo;
 572 }
 573
 574 // GetAllPanes() returns a reference to all the pane info structures
 575 wxAuiPaneInfoArray& wxAuiManager::GetAllPanes()
 576 {
 577     return m_panes;
 578 }
 579
 580 // HitTest() is an internal function which determines
 581 // which UI item the specified coordinates are over
 582 // (x,y) specify a position in client coordinates
 583 wxAuiDockUIPart* wxAuiManager::HitTest(int x, int y)
 584 {
 585     wxAuiDockUIPart* result = NULL;
 586
 587     int i, part_count;
 588     for (i = 0, part_count = m_uiparts.GetCount(); i < part_count; ++i)
 589     {
 590         wxAuiDockUIPart* item = &m_uiparts.Item(i);
 591
 592         // we are not interested in typeDock, because this space
 593         // isn't used to draw anything, just for measurements;
 594         // besides, the entire dock area is covered with other
 595         // rectangles, which we are interested in.
 596         if (item->type == wxAuiDockUIPart::typeDock)
 597             continue;
 598
 599         // if we already have a hit on a more specific item, we are not
 600         // interested in a pane hit.  If, however, we don't already have
 601         // a hit, returning a pane hit is necessary for some operations
 602         if ((item->type == wxAuiDockUIPart::typePane ||
 603             item->type == wxAuiDockUIPart::typePaneBorder) && result)
 604             continue;
 605
 606         // if the point is inside the rectangle, we have a hit
 607         if (item->rect.Contains(x,y))
 608             result = item;
 609     }
 610
 611     return result;
 612 }
 613
 614
 615 // SetFlags() and GetFlags() allow the owner to set various
 616 // options which are global to wxAuiManager
 617 void wxAuiManager::SetFlags(unsigned int flags)
 618 {
 619     // find out if we have to call UpdateHintWindowConfig()
 620     bool update_hint_wnd = false;
 621     unsigned int hint_mask = wxAUI_MGR_TRANSPARENT_HINT |
 622                              wxAUI_MGR_VENETIAN_BLINDS_HINT |
 623                              wxAUI_MGR_RECTANGLE_HINT;
 624     if ((flags & hint_mask) != (m_flags & hint_mask))
 625         update_hint_wnd = true;
 626
 627
 628     // set the new flags
 629     m_flags = flags;
 630
 631     if (update_hint_wnd)
 632     {
 633         UpdateHintWindowConfig();
 634     }
 635 }
 636
 637 unsigned int wxAuiManager::GetFlags() const
 638 {
 639     return m_flags;
 640 }
 641
 642
 643 // don't use these anymore as they are deprecated
 644 // use Set/GetManagedFrame() instead
 645 void wxAuiManager::SetFrame(wxFrame* frame)
 646 {
 647     SetManagedWindow((wxWindow*)frame);
 648 }
 649
 650 wxFrame* wxAuiManager::GetFrame() const
 651 {
 652     return (wxFrame*)m_frame;
 653 }
 654
 655
 656 // this function will return the aui manager for a given
 657 // window.  The |window| parameter should be any child window
 658 // or grand-child window (and so on) of the frame/window
 659 // managed by wxAuiManager.  The |window| parameter does not
 660 // need to be managed by the manager itself.
 661 wxAuiManager* wxAuiManager::GetManager(wxWindow* window)
 662 {
 663     wxAuiManagerEvent evt(wxEVT_AUI_FIND_MANAGER);
 664     evt.SetManager(NULL);
 665     evt.ResumePropagation(wxEVENT_PROPAGATE_MAX);
 666     if (!window->ProcessEvent(evt))
 667         return NULL;
 668
 669     return evt.GetManager();
 670 }
 671
 672
 673 void wxAuiManager::UpdateHintWindowConfig()
 674 {
 675     // find out if the the system can do transparent frames
 676     bool can_do_transparent = false;
 677
 678     wxWindow* w = m_frame;
 679     while (w)
 680     {
 681         if (w->IsKindOf(CLASSINFO(wxFrame)))
 682         {
 683             wxFrame* f = static_cast<wxFrame*>(w);
 684             can_do_transparent = f->CanSetTransparent();
 685             break;
 686         }
 687
 688         w = w->GetParent();
 689     }
 690
 691     // if there is an existing hint window, delete it
 692     if (m_hint_wnd)
 693     {
 694         m_hint_wnd->Destroy();
 695         m_hint_wnd = NULL;
 696     }
 697
 698     m_hint_fademax = 50;
 699     m_hint_wnd = NULL;
 700
 701     if ((m_flags & wxAUI_MGR_TRANSPARENT_HINT) && can_do_transparent)
 702     {
 703         // Make a window to use for a transparent hint
 704         #if defined(__WXMSW__) || defined(__WXGTK__)
 705             m_hint_wnd = new wxFrame(m_frame, wxID_ANY, wxEmptyString,
 706                                      wxDefaultPosition, wxSize(1,1),
 707                                          wxFRAME_TOOL_WINDOW |
 708                                          wxFRAME_FLOAT_ON_PARENT |
 709                                          wxFRAME_NO_TASKBAR |
 710                                          wxNO_BORDER);
 711
 712             m_hint_wnd->SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_ACTIVECAPTION));
 713         #elif defined(__WXMAC__)
 714             // Using a miniframe with float and tool styles keeps the parent
 715             // frame activated and highlighted as such...
 716             m_hint_wnd = new wxMiniFrame(m_frame, wxID_ANY, wxEmptyString,
 717                                          wxDefaultPosition, wxSize(1,1),
 718                                          wxFRAME_FLOAT_ON_PARENT
 719                                          | wxFRAME_TOOL_WINDOW );
 720
 721             // Can't set the bg colour of a Frame in wxMac
 722             wxPanel* p = new wxPanel(m_hint_wnd);
 723
 724             // The default wxSYS_COLOUR_ACTIVECAPTION colour is a light silver
 725             // color that is really hard to see, especially transparent.
 726             // Until a better system color is decided upon we'll just use
 727             // blue.
 728             p->SetBackgroundColour(*wxBLUE);
 729         #endif
 730
 731     }
 732     else
 733     {
 734         if ((m_flags & wxAUI_MGR_TRANSPARENT_HINT) != 0 ||
 735             (m_flags & wxAUI_MGR_VENETIAN_BLINDS_HINT) != 0)
 736         {
 737             // system can't support transparent fade, or the venetian
 738             // blinds effect was explicitly requested
 739             m_hint_wnd = new wxPseudoTransparentFrame(m_frame,
 740                                                       wxID_ANY,
 741                                                       wxEmptyString,
 742                                                       wxDefaultPosition,
 743                                                       wxSize(1,1),
 744                                                             wxFRAME_TOOL_WINDOW |
 745                                                             wxFRAME_FLOAT_ON_PARENT |
 746                                                             wxFRAME_NO_TASKBAR |
 747                                                             wxNO_BORDER);
 748             m_hint_fademax = 128;
 749         }
 750     }
 751 }
 752
 753
 754 // SetManagedWindow() is usually called once when the frame
 755 // manager class is being initialized.  "frame" specifies
 756 // the frame which should be managed by the frame mananger
 757 void wxAuiManager::SetManagedWindow(wxWindow* wnd)
 758 {
 759     wxASSERT_MSG(wnd, wxT("specified window must be non-NULL"));
 760
 761     m_frame = wnd;
 762     m_frame->PushEventHandler(this);
 763
 764 #if wxUSE_MDI
 765     // if the owner is going to manage an MDI parent frame,
 766     // we need to add the MDI client window as the default
 767     // center pane
 768
 769     if (m_frame->IsKindOf(CLASSINFO(wxMDIParentFrame)))
 770     {
 771         wxMDIParentFrame* mdi_frame = (wxMDIParentFrame*)m_frame;
 772         wxWindow* client_window = mdi_frame->GetClientWindow();
 773
 774         wxASSERT_MSG(client_window, wxT("Client window is NULL!"));
 775
 776         AddPane(client_window,
 777                 wxAuiPaneInfo().Name(wxT("mdiclient")).
 778                 CenterPane().PaneBorder(false));
 779     }
 780     else if (m_frame->IsKindOf(CLASSINFO(wxAuiMDIParentFrame)))
 781     {
 782         wxAuiMDIParentFrame* mdi_frame = (wxAuiMDIParentFrame*)m_frame;
 783         wxAuiMDIClientWindow* client_window = mdi_frame->GetClientWindow();
 784         wxASSERT_MSG(client_window, wxT("Client window is NULL!"));
 785
 786         AddPane(client_window,
 787                 wxAuiPaneInfo().Name(wxT("mdiclient")).
 788                 CenterPane().PaneBorder(false));
 789     }
 790
 791 #endif
 792
 793     UpdateHintWindowConfig();
 794 }
 795
 796
 797 // UnInit() must be called, usually in the destructor
 798 // of the frame class.   If it is not called, usually this
 799 // will result in a crash upon program exit
 800 void wxAuiManager::UnInit()
 801 {
 802     if (m_frame)
 803     {
 804         m_frame->RemoveEventHandler(this);
 805     }
 806 }
 807
 808 // GetManagedWindow() returns the window pointer being managed
 809 wxWindow* wxAuiManager::GetManagedWindow() const
 810 {
 811     return m_frame;
 812 }
 813
 814 wxAuiDockArt* wxAuiManager::GetArtProvider() const
 815 {
 816     return m_art;
 817 }
 818
 819 void wxAuiManager::ProcessMgrEvent(wxAuiManagerEvent& event)
 820 {
 821     // first, give the owner frame a chance to override
 822     if (m_frame)
 823     {
 824         if (m_frame->ProcessEvent(event))
 825             return;
 826     }
 827
 828     ProcessEvent(event);
 829 }
 830
 831 // SetArtProvider() instructs wxAuiManager to use the
 832 // specified art provider for all drawing calls.  This allows
 833 // plugable look-and-feel features.  The pointer that is
 834 // passed to this method subsequently belongs to wxAuiManager,
 835 // and is deleted in the frame manager destructor
 836 void wxAuiManager::SetArtProvider(wxAuiDockArt* art_provider)
 837 {
 838     // delete the last art provider, if any
 839     delete m_art;
 840
 841     // assign the new art provider
 842     m_art = art_provider;
 843 }
 844
 845
 846 bool wxAuiManager::AddPane(wxWindow* window, const wxAuiPaneInfo& pane_info)
 847 {
 848     // check if the pane has a valid window
 849     if (!window)
 850         return false;
 851
 852     // check if the window is already managed by us
 853     if (GetPane(pane_info.window).IsOk())
 854         return false;
 855
 856     // check if the pane name already exists, this could reveal a
 857     // bug in the library user's application
 858     bool already_exists = false;
 859     if (!pane_info.name.empty() && GetPane(pane_info.name).IsOk())
 860     {
 861         wxFAIL_MSG(wxT("A pane with that name already exists in the manager!"));
 862         already_exists = true;
 863     }
 864
 865     // if the new pane is docked then we should undo maximize
 866     if (pane_info.IsDocked())
 867         RestoreMaximizedPane();
 868
 869     m_panes.Add(pane_info);
 870
 871     wxAuiPaneInfo& pinfo = m_panes.Last();
 872
 873     // set the pane window
 874     pinfo.window = window;
 875
 876
 877     // if the pane's name identifier is blank, create a random string
 878     if (pinfo.name.empty() || already_exists)
 879     {
 880         pinfo.name.Printf(wxT("%08lx%08x%08x%08lx"),
 881              ((unsigned long)pinfo.window) & 0xffffffff,
 882              (unsigned int)time(NULL),
 883 #ifdef __WXWINCE__
 884              (unsigned int)GetTickCount(),
 885 #else
 886              (unsigned int)clock(),
 887 #endif
 888              (unsigned long)m_panes.GetCount());
 889     }
 890
 891     // set initial proportion (if not already set)
 892     if (pinfo.dock_proportion == 0)
 893         pinfo.dock_proportion = 100000;
 894
 895     if (pinfo.HasMaximizeButton())
 896     {
 897         wxAuiPaneButton button;
 898         button.button_id = wxAUI_BUTTON_MAXIMIZE_RESTORE;
 899         pinfo.buttons.Add(button);
 900     }
 901
 902     if (pinfo.HasPinButton())
 903     {
 904         wxAuiPaneButton button;
 905         button.button_id = wxAUI_BUTTON_PIN;
 906         pinfo.buttons.Add(button);
 907     }
 908
 909     if (pinfo.HasCloseButton())
 910     {
 911         wxAuiPaneButton button;
 912         button.button_id = wxAUI_BUTTON_CLOSE;
 913         pinfo.buttons.Add(button);
 914     }
 915
 916     if (pinfo.best_size == wxDefaultSize &&
 917         pinfo.window)
 918     {
 919         pinfo.best_size = pinfo.window->GetClientSize();
 920
 921         if (pinfo.window->IsKindOf(CLASSINFO(wxToolBar)))
 922         {
 923             // GetClientSize() doesn't get the best size for
 924             // a toolbar under some newer versions of wxWidgets,
 925             // so use GetBestSize()
 926             pinfo.best_size = pinfo.window->GetBestSize();
 927
 928             // for some reason, wxToolBar::GetBestSize() is returning
 929             // a size that is a pixel shy of the correct amount.
 930             // I believe this to be the correct action, until
 931             // wxToolBar::GetBestSize() is fixed.  Is this assumption
 932             // correct?
 933             // commented out by JACS 2007-9-08 after having added a pixel in wxMSW's wxToolBar::DoGetBestSize()
 934             // pinfo.best_size.y++;
 935         }
 936
 937         if (pinfo.min_size != wxDefaultSize)
 938         {
 939             if (pinfo.best_size.x < pinfo.min_size.x)
 940                 pinfo.best_size.x = pinfo.min_size.x;
 941             if (pinfo.best_size.y < pinfo.min_size.y)
 942                 pinfo.best_size.y = pinfo.min_size.y;
 943         }
 944     }
 945
 946     return true;
 947 }
 948
 949 bool wxAuiManager::AddPane(wxWindow* window,
 950                            int direction,
 951                            const wxString& caption)
 952 {
 953     wxAuiPaneInfo pinfo;
 954     pinfo.Caption(caption);
 955     switch (direction)
 956     {
 957         case wxTOP:    pinfo.Top(); break;
 958         case wxBOTTOM: pinfo.Bottom(); break;
 959         case wxLEFT:   pinfo.Left(); break;
 960         case wxRIGHT:  pinfo.Right(); break;
 961         case wxCENTER: pinfo.CenterPane(); break;
 962     }
 963     return AddPane(window, pinfo);
 964 }
 965
 966 bool wxAuiManager::AddPane(wxWindow* window,
 967                            const wxAuiPaneInfo& pane_info,
 968                            const wxPoint& drop_pos)
 969 {
 970     if (!AddPane(window, pane_info))
 971         return false;
 972
 973     wxAuiPaneInfo& pane = GetPane(window);
 974
 975     DoDrop(m_docks, m_panes, pane, drop_pos, wxPoint(0,0));
 976
 977     return true;
 978 }
 979
 980 bool wxAuiManager::InsertPane(wxWindow* window, const wxAuiPaneInfo& pane_info,
 981                                 int insert_level)
 982 {
 983     // shift the panes around, depending on the insert level
 984     switch (insert_level)
 985     {
 986         case wxAUI_INSERT_PANE:
 987             DoInsertPane(m_panes,
 988                  pane_info.dock_direction,
 989                  pane_info.dock_layer,
 990                  pane_info.dock_row,
 991                  pane_info.dock_pos);
 992             break;
 993         case wxAUI_INSERT_ROW:
 994             DoInsertDockRow(m_panes,
 995                  pane_info.dock_direction,
 996                  pane_info.dock_layer,
 997                  pane_info.dock_row);
 998             break;
 999         case wxAUI_INSERT_DOCK:
1000             DoInsertDockLayer(m_panes,
1001                  pane_info.dock_direction,
1002                  pane_info.dock_layer);
1003             break;
1004     }
1005
1006     // if the window already exists, we are basically just moving/inserting the
1007     // existing window.  If it doesn't exist, we need to add it and insert it
1008     wxAuiPaneInfo& existing_pane = GetPane(window);
1009     if (!existing_pane.IsOk())
1010     {
1011         return AddPane(window, pane_info);
1012     }
1013     else
1014     {
1015         if (pane_info.IsFloating())
1016         {
1017             existing_pane.Float();
1018             if (pane_info.floating_pos != wxDefaultPosition)
1019                 existing_pane.FloatingPosition(pane_info.floating_pos);
1020             if (pane_info.floating_size != wxDefaultSize)
1021                 existing_pane.FloatingSize(pane_info.floating_size);
1022         }
1023         else
1024         {
1025             // if the new pane is docked then we should undo maximize
1026             RestoreMaximizedPane();
1027
1028             existing_pane.Direction(pane_info.dock_direction);
1029             existing_pane.Layer(pane_info.dock_layer);
1030             existing_pane.Row(pane_info.dock_row);
1031             existing_pane.Position(pane_info.dock_pos);
1032         }
1033     }
1034
1035     return true;
1036 }
1037
1038
1039 // DetachPane() removes a pane from the frame manager.  This
1040 // method will not destroy the window that is removed.
1041 bool wxAuiManager::DetachPane(wxWindow* window)
1042 {
1043     int i, count;
1044     for (i = 0, count = m_panes.GetCount(); i < count; ++i)
1045     {
1046         wxAuiPaneInfo& p = m_panes.Item(i);
1047         if (p.window == window)
1048         {
1049             if (p.frame)
1050             {
1051                 // we have a floating frame which is being detached. We need to
1052                 // reparent it to m_frame and destroy the floating frame
1053
1054                 // reduce flicker
1055                 p.window->SetSize(1,1);
1056
1057                 if (p.frame->IsShown())
1058                     p.frame->Show(false);
1059
1060                 // reparent to m_frame and destroy the pane
1061                 if (m_action_window == p.frame)
1062                 {
1063                     m_action_window = NULL;
1064                 }
1065
1066                 p.window->Reparent(m_frame);
1067                 p.frame->SetSizer(NULL);
1068                 p.frame->Destroy();
1069                 p.frame = NULL;
1070             }
1071
1072             // make sure there are no references to this pane in our uiparts,
1073             // just in case the caller doesn't call Update() immediately after
1074             // the DetachPane() call.  This prevets obscure crashes which would
1075             // happen at window repaint if the caller forgets to call Update()
1076             int pi, part_count;
1077             for (pi = 0, part_count = (int)m_uiparts.GetCount(); pi < part_count; ++pi)
1078             {
1079                 wxAuiDockUIPart& part = m_uiparts.Item(pi);
1080                 if (part.pane == &p)
1081                 {
1082                     m_uiparts.RemoveAt(pi);
1083                     part_count--;
1084                     pi--;
1085                     continue;
1086                 }
1087             }
1088
1089             m_panes.RemoveAt(i);
1090             return true;
1091         }
1092     }
1093     return false;
1094 }
1095
1096 // ClosePane() destroys or hides the pane depending on its flags
1097 void wxAuiManager::ClosePane(wxAuiPaneInfo& pane_info)
1098 {
1099     // if we were maximized, restore
1100     if (pane_info.IsMaximized())
1101     {
1102         RestorePane(pane_info);
1103     }
1104
1105     // first, hide the window
1106     if (pane_info.window && pane_info.window->IsShown())
1107     {
1108         pane_info.window->Show(false);
1109     }
1110
1111     // make sure that we are the parent of this window
1112     if (pane_info.window && pane_info.window->GetParent() != m_frame)
1113     {
1114         pane_info.window->Reparent(m_frame);
1115     }
1116
1117     // if we have a frame, destroy it
1118     if (pane_info.frame)
1119     {
1120         pane_info.frame->Destroy();
1121         pane_info.frame = NULL;
1122     }
1123
1124     // now we need to either destroy or hide the pane
1125     if (pane_info.IsDestroyOnClose())
1126     {
1127         wxWindow * window = pane_info.window;
1128         DetachPane(window);
1129         if (window)
1130         {
1131             window->Destroy();
1132         }
1133     }
1134     else
1135     {
1136         pane_info.Hide();
1137     }
1138 }
1139
1140 void wxAuiManager::MaximizePane(wxAuiPaneInfo& pane_info)
1141 {
1142     int i, pane_count;
1143
1144     // un-maximize and hide all other panes
1145     for (i = 0, pane_count = m_panes.GetCount(); i < pane_count; ++i)
1146     {
1147         wxAuiPaneInfo& p = m_panes.Item(i);
1148         if (!p.IsToolbar())
1149         {
1150             p.Restore();
1151
1152             // save hidden state
1153             p.SetFlag(wxAuiPaneInfo::savedHiddenState,
1154                       p.HasFlag(wxAuiPaneInfo::optionHidden));
1155
1156             // hide the pane, because only the newly
1157             // maximized pane should show
1158             p.Hide();
1159         }
1160     }
1161
1162     // mark ourselves maximized
1163     pane_info.Maximize();
1164     pane_info.Show();
1165     m_has_maximized = true;
1166
1167     // last, show the window
1168     if (pane_info.window && !pane_info.window->IsShown())
1169     {
1170         pane_info.window->Show(true);
1171     }
1172 }
1173
1174 void wxAuiManager::RestorePane(wxAuiPaneInfo& pane_info)
1175 {
1176     int i, pane_count;
1177
1178     // restore all the panes
1179     for (i = 0, pane_count = m_panes.GetCount(); i < pane_count; ++i)
1180     {
1181         wxAuiPaneInfo& p = m_panes.Item(i);
1182         if (!p.IsToolbar())
1183         {
1184             p.SetFlag(wxAuiPaneInfo::optionHidden,
1185                       p.HasFlag(wxAuiPaneInfo::savedHiddenState));
1186         }
1187     }
1188
1189     // mark ourselves non-maximized
1190     pane_info.Restore();
1191     m_has_maximized = false;
1192
1193     // last, show the window
1194     if (pane_info.window && !pane_info.window->IsShown())
1195     {
1196         pane_info.window->Show(true);
1197     }
1198 }
1199
1200 void wxAuiManager::RestoreMaximizedPane()
1201 {
1202     int i, pane_count;
1203
1204     // restore all the panes
1205     for (i = 0, pane_count = m_panes.GetCount(); i < pane_count; ++i)
1206     {
1207         wxAuiPaneInfo& p = m_panes.Item(i);
1208         if (p.IsMaximized())
1209         {
1210             RestorePane(p);
1211             break;
1212         }
1213     }
1214 }
1215
1216 // EscapeDelimiters() changes ";" into "\;" and "|" into "\|"
1217 // in the input string.  This is an internal functions which is
1218 // used for saving perspectives
1219 static wxString EscapeDelimiters(const wxString& s)
1220 {
1221     wxString result;
1222     result.Alloc(s.length());
1223     const wxChar* ch = s.c_str();
1224     while (*ch)
1225     {
1226         if (*ch == wxT(';') || *ch == wxT('|'))
1227             result += wxT('\\');
1228         result += *ch;
1229         ++ch;
1230     }
1231     return result;
1232 }
1233
1234 wxString wxAuiManager::SavePaneInfo(wxAuiPaneInfo& pane)
1235 {
1236     wxString result = wxT("name=");
1237     result += EscapeDelimiters(pane.name);
1238     result += wxT(";");
1239
1240     result += wxT("caption=");
1241     result += EscapeDelimiters(pane.caption);
1242     result += wxT(";");
1243
1244     result += wxString::Format(wxT("state=%u;"), pane.state);
1245     result += wxString::Format(wxT("dir=%d;"), pane.dock_direction);
1246     result += wxString::Format(wxT("layer=%d;"), pane.dock_layer);
1247     result += wxString::Format(wxT("row=%d;"), pane.dock_row);
1248     result += wxString::Format(wxT("pos=%d;"), pane.dock_pos);
1249     result += wxString::Format(wxT("prop=%d;"), pane.dock_proportion);
1250     result += wxString::Format(wxT("bestw=%d;"), pane.best_size.x);
1251     result += wxString::Format(wxT("besth=%d;"), pane.best_size.y);
1252     result += wxString::Format(wxT("minw=%d;"), pane.min_size.x);
1253     result += wxString::Format(wxT("minh=%d;"), pane.min_size.y);
1254     result += wxString::Format(wxT("maxw=%d;"), pane.max_size.x);
1255     result += wxString::Format(wxT("maxh=%d;"), pane.max_size.y);
1256     result += wxString::Format(wxT("floatx=%d;"), pane.floating_pos.x);
1257     result += wxString::Format(wxT("floaty=%d;"), pane.floating_pos.y);
1258     result += wxString::Format(wxT("floatw=%d;"), pane.floating_size.x);
1259     result += wxString::Format(wxT("floath=%d"), pane.floating_size.y);
1260
1261     return result;
1262 }
1263
1264 // Load a "pane" with the pane infor settings in pane_part
1265 void wxAuiManager::LoadPaneInfo(wxString pane_part, wxAuiPaneInfo &pane)
1266 {
1267     // replace escaped characters so we can
1268     // split up the string easily
1269     pane_part.Replace(wxT("\\|"), wxT("\a"));
1270     pane_part.Replace(wxT("\\;"), wxT("\b"));
1271
1272     while(1)
1273     {
1274         wxString val_part = pane_part.BeforeFirst(wxT(';'));
1275         pane_part = pane_part.AfterFirst(wxT(';'));
1276         wxString val_name = val_part.BeforeFirst(wxT('='));
1277         wxString value = val_part.AfterFirst(wxT('='));
1278         val_name.MakeLower();
1279         val_name.Trim(true);
1280         val_name.Trim(false);
1281         value.Trim(true);
1282         value.Trim(false);
1283
1284         if (val_name.empty())
1285             break;
1286
1287         if (val_name == wxT("name"))
1288             pane.name = value;
1289         else if (val_name == wxT("caption"))
1290             pane.caption = value;
1291         else if (val_name == wxT("state"))
1292             pane.state = (unsigned int)wxAtoi(value.c_str());
1293         else if (val_name == wxT("dir"))
1294             pane.dock_direction = wxAtoi(value.c_str());
1295         else if (val_name == wxT("layer"))
1296             pane.dock_layer = wxAtoi(value.c_str());
1297         else if (val_name == wxT("row"))
1298             pane.dock_row = wxAtoi(value.c_str());
1299         else if (val_name == wxT("pos"))
1300             pane.dock_pos = wxAtoi(value.c_str());
1301         else if (val_name == wxT("prop"))
1302             pane.dock_proportion = wxAtoi(value.c_str());
1303         else if (val_name == wxT("bestw"))
1304             pane.best_size.x = wxAtoi(value.c_str());
1305         else if (val_name == wxT("besth"))
1306             pane.best_size.y = wxAtoi(value.c_str());
1307         else if (val_name == wxT("minw"))
1308             pane.min_size.x = wxAtoi(value.c_str());
1309         else if (val_name == wxT("minh"))
1310             pane.min_size.y = wxAtoi(value.c_str());
1311         else if (val_name == wxT("maxw"))
1312             pane.max_size.x = wxAtoi(value.c_str());
1313         else if (val_name == wxT("maxh"))
1314             pane.max_size.y = wxAtoi(value.c_str());
1315         else if (val_name == wxT("floatx"))
1316             pane.floating_pos.x = wxAtoi(value.c_str());
1317         else if (val_name == wxT("floaty"))
1318             pane.floating_pos.y = wxAtoi(value.c_str());
1319         else if (val_name == wxT("floatw"))
1320             pane.floating_size.x = wxAtoi(value.c_str());
1321         else if (val_name == wxT("floath"))
1322             pane.floating_size.y = wxAtoi(value.c_str());
1323         else {
1324             wxFAIL_MSG(wxT("Bad Perspective String"));
1325         }
1326     }
1327
1328     // replace escaped characters so we can
1329     // split up the string easily
1330     pane.name.Replace(wxT("\a"), wxT("|"));
1331     pane.name.Replace(wxT("\b"), wxT(";"));
1332     pane.caption.Replace(wxT("\a"), wxT("|"));
1333     pane.caption.Replace(wxT("\b"), wxT(";"));
1334     pane_part.Replace(wxT("\a"), wxT("|"));
1335     pane_part.Replace(wxT("\b"), wxT(";"));
1336
1337     return;
1338 }
1339
1340
1341 // SavePerspective() saves all pane information as a single string.
1342 // This string may later be fed into LoadPerspective() to restore
1343 // all pane settings.  This save and load mechanism allows an
1344 // exact pane configuration to be saved and restored at a later time
1345
1346 wxString wxAuiManager::SavePerspective()
1347 {
1348     wxString result;
1349     result.Alloc(500);
1350     result = wxT("layout2|");
1351
1352     int pane_i, pane_count = m_panes.GetCount();
1353     for (pane_i = 0; pane_i < pane_count; ++pane_i)
1354     {
1355         wxAuiPaneInfo& pane = m_panes.Item(pane_i);
1356         result += SavePaneInfo(pane)+wxT("|");
1357     }
1358
1359     int dock_i, dock_count = m_docks.GetCount();
1360     for (dock_i = 0; dock_i < dock_count; ++dock_i)
1361     {
1362         wxAuiDockInfo& dock = m_docks.Item(dock_i);
1363
1364         result += wxString::Format(wxT("dock_size(%d,%d,%d)=%d|"),
1365                                    dock.dock_direction, dock.dock_layer,
1366                                    dock.dock_row, dock.size);
1367     }
1368
1369     return result;
1370 }
1371
1372 // LoadPerspective() loads a layout which was saved with SavePerspective()
1373 // If the "update" flag parameter is true, the GUI will immediately be updated
1374
1375 bool wxAuiManager::LoadPerspective(const wxString& layout, bool update)
1376 {
1377     wxString input = layout;
1378     wxString part;
1379
1380     // check layout string version
1381     //    'layout1' = wxAUI 0.9.0 - wxAUI 0.9.2
1382     //    'layout2' = wxAUI 0.9.2 (wxWidgets 2.8)
1383     part = input.BeforeFirst(wxT('|'));
1384     input = input.AfterFirst(wxT('|'));
1385     part.Trim(true);
1386     part.Trim(false);
1387     if (part != wxT("layout2"))
1388         return false;
1389
1390     // mark all panes currently managed as docked and hidden
1391     int pane_i, pane_count = m_panes.GetCount();
1392     for (pane_i = 0; pane_i < pane_count; ++pane_i)
1393         m_panes.Item(pane_i).Dock().Hide();
1394
1395     // clear out the dock array; this will be reconstructed
1396     m_docks.Clear();
1397
1398     // replace escaped characters so we can
1399     // split up the string easily
1400     input.Replace(wxT("\\|"), wxT("\a"));
1401     input.Replace(wxT("\\;"), wxT("\b"));
1402
1403     while (1)
1404     {
1405         wxAuiPaneInfo pane;
1406
1407         wxString pane_part = input.BeforeFirst(wxT('|'));
1408         input = input.AfterFirst(wxT('|'));
1409         pane_part.Trim(true);
1410
1411         // if the string is empty, we're done parsing
1412         if (pane_part.empty())
1413             break;
1414
1415         if (pane_part.Left(9) == wxT("dock_size"))
1416         {
1417             wxString val_name = pane_part.BeforeFirst(wxT('='));
1418             wxString value = pane_part.AfterFirst(wxT('='));
1419
1420             long dir, layer, row, size;
1421             wxString piece = val_name.AfterFirst(wxT('('));
1422             piece = piece.BeforeLast(wxT(')'));
1423             piece.BeforeFirst(wxT(',')).ToLong(&dir);
1424             piece = piece.AfterFirst(wxT(','));
1425             piece.BeforeFirst(wxT(',')).ToLong(&layer);
1426             piece.AfterFirst(wxT(',')).ToLong(&row);
1427             value.ToLong(&size);
1428
1429             wxAuiDockInfo dock;
1430             dock.dock_direction = dir;
1431             dock.dock_layer = layer;
1432             dock.dock_row = row;
1433             dock.size = size;
1434             m_docks.Add(dock);
1435             continue;
1436         }
1437
1438         // Undo our escaping as LoadPaneInfo needs to take an unescaped
1439         // name so it can be called by external callers
1440         pane_part.Replace(wxT("\a"), wxT("|"));
1441         pane_part.Replace(wxT("\b"), wxT(";"));
1442
1443         LoadPaneInfo(pane_part, pane);
1444
1445         wxAuiPaneInfo& p = GetPane(pane.name);
1446         if (!p.IsOk())
1447         {
1448             // the pane window couldn't be found
1449             // in the existing layout -- skip it
1450             continue;
1451         }
1452
1453         p.SafeSet(pane);
1454     }
1455
1456     if (update)
1457         Update();
1458
1459     return true;
1460 }
1461
1462 void wxAuiManager::GetPanePositionsAndSizes(wxAuiDockInfo& dock,
1463                                             wxArrayInt& positions,
1464                                             wxArrayInt& sizes)
1465 {
1466     int caption_size = m_art->GetMetric(wxAUI_DOCKART_CAPTION_SIZE);
1467     int pane_border_size = m_art->GetMetric(wxAUI_DOCKART_PANE_BORDER_SIZE);
1468     int gripper_size = m_art->GetMetric(wxAUI_DOCKART_GRIPPER_SIZE);
1469
1470     positions.Empty();
1471     sizes.Empty();
1472
1473     int offset, action_pane = -1;
1474     int pane_i, pane_count = dock.panes.GetCount();
1475
1476     // find the pane marked as our action pane
1477     for (pane_i = 0; pane_i < pane_count; ++pane_i)
1478     {
1479         wxAuiPaneInfo& pane = *(dock.panes.Item(pane_i));
1480
1481         if (pane.state & wxAuiPaneInfo::actionPane)
1482         {
1483             wxASSERT_MSG(action_pane==-1, wxT("Too many fixed action panes"));
1484             action_pane = pane_i;
1485         }
1486     }
1487
1488     // set up each panes default position, and
1489     // determine the size (width or height, depending
1490     // on the dock's orientation) of each pane
1491     for (pane_i = 0; pane_i < pane_count; ++pane_i)
1492     {
1493         wxAuiPaneInfo& pane = *(dock.panes.Item(pane_i));
1494         positions.Add(pane.dock_pos);
1495         int size = 0;
1496
1497         if (pane.HasBorder())
1498             size += (pane_border_size*2);
1499
1500         if (dock.IsHorizontal())
1501         {
1502             if (pane.HasGripper() && !pane.HasGripperTop())
1503                 size += gripper_size;
1504             size += pane.best_size.x;
1505         }
1506         else
1507         {
1508             if (pane.HasGripper() && pane.HasGripperTop())
1509                 size += gripper_size;
1510
1511             if (pane.HasCaption())
1512                 size += caption_size;
1513             size += pane.best_size.y;
1514         }
1515
1516         sizes.Add(size);
1517     }
1518
1519     // if there is no action pane, just return the default
1520     // positions (as specified in pane.pane_pos)
1521     if (action_pane == -1)
1522         return;
1523
1524     offset = 0;
1525     for (pane_i = action_pane-1; pane_i >= 0; --pane_i)
1526     {
1527         int amount = positions[pane_i+1] - (positions[pane_i] + sizes[pane_i]);
1528
1529         if (amount >= 0)
1530             offset += amount;
1531         else
1532             positions[pane_i] -= -amount;
1533
1534         offset += sizes[pane_i];
1535     }
1536
1537     // if the dock mode is fixed, make sure none of the panes
1538     // overlap; we will bump panes that overlap
1539     offset = 0;
1540     for (pane_i = action_pane; pane_i < pane_count; ++pane_i)
1541     {
1542         int amount = positions[pane_i] - offset;
1543         if (amount >= 0)
1544             offset += amount;
1545         else
1546             positions[pane_i] += -amount;
1547
1548         offset += sizes[pane_i];
1549     }
1550 }
1551
1552
1553 void wxAuiManager::LayoutAddPane(wxSizer* cont,
1554                                  wxAuiDockInfo& dock,
1555                                  wxAuiPaneInfo& pane,
1556                                  wxAuiDockUIPartArray& uiparts,
1557                                  bool spacer_only)
1558 {
1559     wxAuiDockUIPart part;
1560     wxSizerItem* sizer_item;
1561
1562     int caption_size = m_art->GetMetric(wxAUI_DOCKART_CAPTION_SIZE);
1563     int gripper_size = m_art->GetMetric(wxAUI_DOCKART_GRIPPER_SIZE);
1564     int pane_border_size = m_art->GetMetric(wxAUI_DOCKART_PANE_BORDER_SIZE);
1565     int pane_button_size = m_art->GetMetric(wxAUI_DOCKART_PANE_BUTTON_SIZE);
1566
1567     // find out the orientation of the item (orientation for panes
1568     // is the same as the dock's orientation)
1569     int orientation;
1570     if (dock.IsHorizontal())
1571         orientation = wxHORIZONTAL;
1572     else
1573         orientation = wxVERTICAL;
1574
1575     // this variable will store the proportion
1576     // value that the pane will receive
1577     int pane_proportion = pane.dock_proportion;
1578
1579     wxBoxSizer* horz_pane_sizer = new wxBoxSizer(wxHORIZONTAL);
1580     wxBoxSizer* vert_pane_sizer = new wxBoxSizer(wxVERTICAL);
1581
1582     if (pane.HasGripper())
1583     {
1584         if (pane.HasGripperTop())
1585             sizer_item = vert_pane_sizer ->Add(1, gripper_size, 0, wxEXPAND);
1586         else
1587             sizer_item = horz_pane_sizer ->Add(gripper_size, 1, 0, wxEXPAND);
1588
1589         part.type = wxAuiDockUIPart::typeGripper;
1590         part.dock = &dock;
1591         part.pane = &pane;
1592         part.button = NULL;
1593         part.orientation = orientation;
1594         part.cont_sizer = horz_pane_sizer;
1595         part.sizer_item = sizer_item;
1596         uiparts.Add(part);
1597     }
1598
1599     if (pane.HasCaption())
1600     {
1601         // create the caption sizer
1602         wxBoxSizer* caption_sizer = new wxBoxSizer(wxHORIZONTAL);
1603
1604         sizer_item = caption_sizer->Add(1, caption_size, 1, wxEXPAND);
1605
1606         part.type = wxAuiDockUIPart::typeCaption;
1607         part.dock = &dock;
1608         part.pane = &pane;
1609         part.button = NULL;
1610         part.orientation = orientation;
1611         part.cont_sizer = vert_pane_sizer;
1612         part.sizer_item = sizer_item;
1613         int caption_part_idx = uiparts.GetCount();
1614         uiparts.Add(part);
1615
1616         // add pane buttons to the caption
1617         int i, button_count;
1618         for (i = 0, button_count = pane.buttons.GetCount();
1619              i < button_count; ++i)
1620         {
1621             wxAuiPaneButton& button = pane.buttons.Item(i);
1622
1623             sizer_item = caption_sizer->Add(pane_button_size,
1624                                             caption_size,
1625                                             0, wxEXPAND);
1626
1627             part.type = wxAuiDockUIPart::typePaneButton;
1628             part.dock = &dock;
1629             part.pane = &pane;
1630             part.button = &button;
1631             part.orientation = orientation;
1632             part.cont_sizer = caption_sizer;
1633             part.sizer_item = sizer_item;
1634             uiparts.Add(part);
1635         }
1636
1637         // if we have buttons, add a little space to the right
1638         // of them to ease visual crowding
1639         if (button_count >= 1)
1640         {
1641             caption_sizer->Add(3,1);
1642         }
1643
1644         // add the caption sizer
1645         sizer_item = vert_pane_sizer->Add(caption_sizer, 0, wxEXPAND);
1646
1647         uiparts.Item(caption_part_idx).sizer_item = sizer_item;
1648     }
1649
1650     // add the pane window itself
1651     if (spacer_only)
1652     {
1653         sizer_item = vert_pane_sizer->Add(1, 1, 1, wxEXPAND);
1654     }
1655     else
1656     {
1657         sizer_item = vert_pane_sizer->Add(pane.window, 1, wxEXPAND);
1658         // Don't do this because it breaks the pane size in floating windows
1659         // BIW: Right now commenting this out is causing problems with
1660         // an mdi client window as the center pane.
1661         vert_pane_sizer->SetItemMinSize(pane.window, 1, 1);
1662     }
1663
1664     part.type = wxAuiDockUIPart::typePane;
1665     part.dock = &dock;
1666     part.pane = &pane;
1667     part.button = NULL;
1668     part.orientation = orientation;
1669     part.cont_sizer = vert_pane_sizer;
1670     part.sizer_item = sizer_item;
1671     uiparts.Add(part);
1672
1673
1674     // determine if the pane should have a minimum size; if the pane is
1675     // non-resizable (fixed) then we must set a minimum size. Alternatively,
1676     // if the pane.min_size is set, we must use that value as well
1677
1678     wxSize min_size = pane.min_size;
1679     if (pane.IsFixed())
1680     {
1681         if (min_size == wxDefaultSize)
1682         {
1683             min_size = pane.best_size;
1684             pane_proportion = 0;
1685         }
1686     }
1687
1688     if (min_size != wxDefaultSize)
1689     {
1690         vert_pane_sizer->SetItemMinSize(
1691                         vert_pane_sizer->GetChildren().GetCount()-1,
1692                         min_size.x, min_size.y);
1693     }
1694
1695
1696     // add the verticle sizer (caption, pane window) to the
1697     // horizontal sizer (gripper, verticle sizer)
1698     horz_pane_sizer->Add(vert_pane_sizer, 1, wxEXPAND);
1699
1700     // finally, add the pane sizer to the dock sizer
1701
1702     if (pane.HasBorder())
1703     {
1704         // allowing space for the pane's border
1705         sizer_item = cont->Add(horz_pane_sizer, pane_proportion,
1706                                wxEXPAND | wxALL, pane_border_size);
1707
1708         part.type = wxAuiDockUIPart::typePaneBorder;
1709         part.dock = &dock;
1710         part.pane = &pane;
1711         part.button = NULL;
1712         part.orientation = orientation;
1713         part.cont_sizer = cont;
1714         part.sizer_item = sizer_item;
1715         uiparts.Add(part);
1716     }
1717     else
1718     {
1719         sizer_item = cont->Add(horz_pane_sizer, pane_proportion, wxEXPAND);
1720     }
1721 }
1722
1723 void wxAuiManager::LayoutAddDock(wxSizer* cont,
1724                                  wxAuiDockInfo& dock,
1725                                  wxAuiDockUIPartArray& uiparts,
1726                                  bool spacer_only)
1727 {
1728     wxSizerItem* sizer_item;
1729     wxAuiDockUIPart part;
1730
1731     int sash_size = m_art->GetMetric(wxAUI_DOCKART_SASH_SIZE);
1732     int orientation = dock.IsHorizontal() ? wxHORIZONTAL : wxVERTICAL;
1733
1734     // resizable bottom and right docks have a sash before them
1735     if (!m_has_maximized && !dock.fixed && (dock.dock_direction == wxAUI_DOCK_BOTTOM ||
1736                         dock.dock_direction == wxAUI_DOCK_RIGHT))
1737     {
1738         sizer_item = cont->Add(sash_size, sash_size, 0, wxEXPAND);
1739
1740         part.type = wxAuiDockUIPart::typeDockSizer;
1741         part.orientation = orientation;
1742         part.dock = &dock;
1743         part.pane = NULL;
1744         part.button = NULL;
1745         part.cont_sizer = cont;
1746         part.sizer_item = sizer_item;
1747         uiparts.Add(part);
1748     }
1749
1750     // create the sizer for the dock
1751     wxSizer* dock_sizer = new wxBoxSizer(orientation);
1752
1753     // add each pane to the dock
1754     bool has_maximized_pane = false;
1755     int pane_i, pane_count = dock.panes.GetCount();
1756
1757     if (dock.fixed)
1758     {
1759         wxArrayInt pane_positions, pane_sizes;
1760
1761         // figure out the real pane positions we will
1762         // use, without modifying the each pane's pane_pos member
1763         GetPanePositionsAndSizes(dock, pane_positions, pane_sizes);
1764
1765         int offset = 0;
1766         for (pane_i = 0; pane_i < pane_count; ++pane_i)
1767         {
1768             wxAuiPaneInfo& pane = *(dock.panes.Item(pane_i));
1769             int pane_pos = pane_positions.Item(pane_i);
1770
1771             if (pane.IsMaximized())
1772                 has_maximized_pane = true;
1773
1774
1775             int amount = pane_pos - offset;
1776             if (amount > 0)
1777             {
1778                 if (dock.IsVertical())
1779                     sizer_item = dock_sizer->Add(1, amount, 0, wxEXPAND);
1780                 else
1781                     sizer_item = dock_sizer->Add(amount, 1, 0, wxEXPAND);
1782
1783                 part.type = wxAuiDockUIPart::typeBackground;
1784                 part.dock = &dock;
1785                 part.pane = NULL;
1786                 part.button = NULL;
1787                 part.orientation = (orientation==wxHORIZONTAL) ? wxVERTICAL:wxHORIZONTAL;
1788                 part.cont_sizer = dock_sizer;
1789                 part.sizer_item = sizer_item;
1790                 uiparts.Add(part);
1791
1792                 offset += amount;
1793             }
1794
1795             LayoutAddPane(dock_sizer, dock, pane, uiparts, spacer_only);
1796
1797             offset += pane_sizes.Item(pane_i);
1798         }
1799
1800         // at the end add a very small stretchable background area
1801         sizer_item = dock_sizer->Add(0,0, 1, wxEXPAND);
1802
1803         part.type = wxAuiDockUIPart::typeBackground;
1804         part.dock = &dock;
1805         part.pane = NULL;
1806         part.button = NULL;
1807         part.orientation = orientation;
1808         part.cont_sizer = dock_sizer;
1809         part.sizer_item = sizer_item;
1810         uiparts.Add(part);
1811     }
1812     else
1813     {
1814         for (pane_i = 0; pane_i < pane_count; ++pane_i)
1815         {
1816             wxAuiPaneInfo& pane = *(dock.panes.Item(pane_i));
1817
1818             if (pane.IsMaximized())
1819                 has_maximized_pane = true;
1820
1821             // if this is not the first pane being added,
1822             // we need to add a pane sizer
1823             if (!m_has_maximized && pane_i > 0)
1824             {
1825                 sizer_item = dock_sizer->Add(sash_size, sash_size, 0, wxEXPAND);
1826
1827                 part.type = wxAuiDockUIPart::typePaneSizer;
1828                 part.dock = &dock;
1829                 part.pane = dock.panes.Item(pane_i-1);
1830                 part.button = NULL;
1831                 part.orientation = (orientation==wxHORIZONTAL) ? wxVERTICAL:wxHORIZONTAL;
1832                 part.cont_sizer = dock_sizer;
1833                 part.sizer_item = sizer_item;
1834                 uiparts.Add(part);
1835             }
1836
1837             LayoutAddPane(dock_sizer, dock, pane, uiparts, spacer_only);
1838         }
1839     }
1840
1841     if (dock.dock_direction == wxAUI_DOCK_CENTER || has_maximized_pane)
1842         sizer_item = cont->Add(dock_sizer, 1, wxEXPAND);
1843     else
1844         sizer_item = cont->Add(dock_sizer, 0, wxEXPAND);
1845
1846     part.type = wxAuiDockUIPart::typeDock;
1847     part.dock = &dock;
1848     part.pane = NULL;
1849     part.button = NULL;
1850     part.orientation = orientation;
1851     part.cont_sizer = cont;
1852     part.sizer_item = sizer_item;
1853     uiparts.Add(part);
1854
1855     if (dock.IsHorizontal())
1856         cont->SetItemMinSize(dock_sizer, 0, dock.size);
1857     else
1858         cont->SetItemMinSize(dock_sizer, dock.size, 0);
1859
1860     //  top and left docks have a sash after them
1861     if (!m_has_maximized &&
1862         !dock.fixed &&
1863           (dock.dock_direction == wxAUI_DOCK_TOP ||
1864            dock.dock_direction == wxAUI_DOCK_LEFT))
1865     {
1866         sizer_item = cont->Add(sash_size, sash_size, 0, wxEXPAND);
1867
1868         part.type = wxAuiDockUIPart::typeDockSizer;
1869         part.dock = &dock;
1870         part.pane = NULL;
1871         part.button = NULL;
1872         part.orientation = orientation;
1873         part.cont_sizer = cont;
1874         part.sizer_item = sizer_item;
1875         uiparts.Add(part);
1876     }
1877 }
1878
1879 wxSizer* wxAuiManager::LayoutAll(wxAuiPaneInfoArray& panes,
1880                                  wxAuiDockInfoArray& docks,
1881                                  wxAuiDockUIPartArray& uiparts,
1882                                  bool spacer_only)
1883 {
1884     wxBoxSizer* container = new wxBoxSizer(wxVERTICAL);
1885
1886     int pane_border_size = m_art->GetMetric(wxAUI_DOCKART_PANE_BORDER_SIZE);
1887     int caption_size = m_art->GetMetric(wxAUI_DOCKART_CAPTION_SIZE);
1888     wxSize cli_size = m_frame->GetClientSize();
1889     int i, dock_count, pane_count;
1890
1891
1892     // empty all docks out
1893     for (i = 0, dock_count = docks.GetCount(); i < dock_count; ++i)
1894     {
1895         wxAuiDockInfo& dock = docks.Item(i);
1896
1897         // empty out all panes, as they will be readded below
1898         dock.panes.Empty();
1899
1900         if (dock.fixed)
1901         {
1902             // always reset fixed docks' sizes, because
1903             // the contained windows may have been resized
1904             dock.size = 0;
1905         }
1906     }
1907
1908
1909     // iterate through all known panes, filing each
1910     // of them into the appropriate dock. If the
1911     // pane does not exist in the dock, add it
1912     for (i = 0, pane_count = panes.GetCount(); i < pane_count; ++i)
1913     {
1914         wxAuiPaneInfo& p = panes.Item(i);
1915
1916         // find any docks with the same dock direction, dock layer, and
1917         // dock row as the pane we are working on
1918         wxAuiDockInfo* dock;
1919         wxAuiDockInfoPtrArray arr;
1920         FindDocks(docks, p.dock_direction, p.dock_layer, p.dock_row, arr);
1921
1922         if (arr.GetCount() > 0)
1923         {
1924             // found the right dock
1925             dock = arr.Item(0);
1926         }
1927         else
1928         {
1929             // dock was not found, so we need to create a new one
1930             wxAuiDockInfo d;
1931             d.dock_direction = p.dock_direction;
1932             d.dock_layer = p.dock_layer;
1933             d.dock_row = p.dock_row;
1934             docks.Add(d);
1935             dock = &docks.Last();
1936         }
1937
1938
1939         if (p.IsDocked() && p.IsShown())
1940         {
1941             // remove the pane from any existing docks except this one
1942             RemovePaneFromDocks(docks, p, dock);
1943
1944             // pane needs to be added to the dock,
1945             // if it doesn't already exist
1946             if (!FindPaneInDock(*dock, p.window))
1947                 dock->panes.Add(&p);
1948         }
1949         else
1950         {
1951             // remove the pane from any existing docks
1952             RemovePaneFromDocks(docks, p);
1953         }
1954
1955     }
1956
1957     // remove any empty docks
1958     for (i = docks.GetCount()-1; i >= 0; --i)
1959     {
1960         if (docks.Item(i).panes.GetCount() == 0)
1961             docks.RemoveAt(i);
1962     }
1963
1964     // configure the docks further
1965     for (i = 0, dock_count = docks.GetCount(); i < dock_count; ++i)
1966     {
1967         wxAuiDockInfo& dock = docks.Item(i);
1968         int j, dock_pane_count = dock.panes.GetCount();
1969
1970         // sort the dock pane array by the pane's
1971         // dock position (dock_pos), in ascending order
1972         dock.panes.Sort(PaneSortFunc);
1973
1974         // for newly created docks, set up their initial size
1975         if (dock.size == 0)
1976         {
1977             int size = 0;
1978
1979             for (j = 0; j < dock_pane_count; ++j)
1980             {
1981                 wxAuiPaneInfo& pane = *dock.panes.Item(j);
1982                 wxSize pane_size = pane.best_size;
1983                 if (pane_size == wxDefaultSize)
1984                     pane_size = pane.min_size;
1985                 if (pane_size == wxDefaultSize)
1986                     pane_size = pane.window->GetSize();
1987
1988                 if (dock.IsHorizontal())
1989                     size = wxMax(pane_size.y, size);
1990                 else
1991                     size = wxMax(pane_size.x, size);
1992             }
1993
1994             // add space for the border (two times), but only
1995             // if at least one pane inside the dock has a pane border
1996             for (j = 0; j < dock_pane_count; ++j)
1997             {
1998                 if (dock.panes.Item(j)->HasBorder())
1999                 {
2000                     size += (pane_border_size*2);
2001                     break;
2002                 }
2003             }
2004
2005             // if pane is on the top or bottom, add the caption height,
2006             // but only if at least one pane inside the dock has a caption
2007             if (dock.IsHorizontal())
2008             {
2009                 for (j = 0; j < dock_pane_count; ++j)
2010                 {
2011                     if (dock.panes.Item(j)->HasCaption())
2012                     {
2013                         size += caption_size;
2014                         break;
2015                     }
2016                 }
2017             }
2018
2019
2020             // new dock's size may not be more than the dock constraint
2021             // parameter specifies.  See SetDockSizeConstraint()
2022
2023             int max_dock_x_size = (int)(m_dock_constraint_x * ((double)cli_size.x));
2024             int max_dock_y_size = (int)(m_dock_constraint_y * ((double)cli_size.y));
2025
2026             if (dock.IsHorizontal())
2027                 size = wxMin(size, max_dock_y_size);
2028             else
2029                 size = wxMin(size, max_dock_x_size);
2030
2031             // absolute minimum size for a dock is 10 pixels
2032             if (size < 10)
2033                 size = 10;
2034
2035             dock.size = size;
2036         }
2037
2038
2039         // determine the dock's minimum size
2040         bool plus_border = false;
2041         bool plus_caption = false;
2042         int dock_min_size = 0;
2043         for (j = 0; j < dock_pane_count; ++j)
2044         {
2045             wxAuiPaneInfo& pane = *dock.panes.Item(j);
2046             if (pane.min_size != wxDefaultSize)
2047             {
2048                 if (pane.HasBorder())
2049                     plus_border = true;
2050                 if (pane.HasCaption())
2051                     plus_caption = true;
2052                 if (dock.IsHorizontal())
2053                 {
2054                     if (pane.min_size.y > dock_min_size)
2055                         dock_min_size = pane.min_size.y;
2056                 }
2057                 else
2058                 {
2059                     if (pane.min_size.x > dock_min_size)
2060                         dock_min_size = pane.min_size.x;
2061                 }
2062             }
2063         }
2064
2065         if (plus_border)
2066             dock_min_size += (pane_border_size*2);
2067         if (plus_caption && dock.IsHorizontal())
2068             dock_min_size += (caption_size);
2069
2070         dock.min_size = dock_min_size;
2071
2072
2073         // if the pane's current size is less than it's
2074         // minimum, increase the dock's size to it's minimum
2075         if (dock.size < dock.min_size)
2076             dock.size = dock.min_size;
2077
2078
2079         // determine the dock's mode (fixed or proportional);
2080         // determine whether the dock has only toolbars
2081         bool action_pane_marked = false;
2082         dock.fixed = true;
2083         dock.toolbar = true;
2084         for (j = 0; j < dock_pane_count; ++j)
2085         {
2086             wxAuiPaneInfo& pane = *dock.panes.Item(j);
2087             if (!pane.IsFixed())
2088                 dock.fixed = false;
2089             if (!pane.IsToolbar())
2090                 dock.toolbar = false;
2091             if (pane.HasFlag(wxAuiPaneInfo::optionDockFixed))
2092                 dock.fixed = true;
2093             if (pane.state & wxAuiPaneInfo::actionPane)
2094                 action_pane_marked = true;
2095         }
2096
2097
2098         // if the dock mode is proportional and not fixed-pixel,
2099         // reassign the dock_pos to the sequential 0, 1, 2, 3;
2100         // e.g. remove gaps like 1, 2, 30, 500
2101         if (!dock.fixed)
2102         {
2103             for (j = 0; j < dock_pane_count; ++j)
2104             {
2105                 wxAuiPaneInfo& pane = *dock.panes.Item(j);
2106                 pane.dock_pos = j;
2107             }
2108         }
2109
2110         // if the dock mode is fixed, and none of the panes
2111         // are being moved right now, make sure the panes
2112         // do not overlap each other.  If they do, we will
2113         // adjust the positions of the panes
2114         if (dock.fixed && !action_pane_marked)
2115         {
2116             wxArrayInt pane_positions, pane_sizes;
2117             GetPanePositionsAndSizes(dock, pane_positions, pane_sizes);
2118
2119             int offset = 0;
2120             for (j = 0; j < dock_pane_count; ++j)
2121             {
2122                 wxAuiPaneInfo& pane = *(dock.panes.Item(j));
2123                 pane.dock_pos = pane_positions[j];
2124
2125                 int amount = pane.dock_pos - offset;
2126                 if (amount >= 0)
2127                     offset += amount;
2128                 else
2129                     pane.dock_pos += -amount;
2130
2131                 offset += pane_sizes[j];
2132             }
2133         }
2134     }
2135
2136     // discover the maximum dock layer
2137     int max_layer = 0;
2138     for (i = 0; i < dock_count; ++i)
2139         max_layer = wxMax(max_layer, docks.Item(i).dock_layer);
2140
2141
2142     // clear out uiparts
2143     uiparts.Empty();
2144
2145     // create a bunch of box sizers,
2146     // from the innermost level outwards.
2147     wxSizer* cont = NULL;
2148     wxSizer* middle = NULL;
2149     int layer = 0;
2150     int row, row_count;
2151
2152     for (layer = 0; layer <= max_layer; ++layer)
2153     {
2154         wxAuiDockInfoPtrArray arr;
2155
2156         // find any docks in this layer
2157         FindDocks(docks, -1, layer, -1, arr);
2158
2159         // if there aren't any, skip to the next layer
2160         if (arr.IsEmpty())
2161             continue;
2162
2163         wxSizer* old_cont = cont;
2164
2165         // create a container which will hold this layer's
2166         // docks (top, bottom, left, right)
2167         cont = new wxBoxSizer(wxVERTICAL);
2168
2169
2170         // find any top docks in this layer
2171         FindDocks(docks, wxAUI_DOCK_TOP, layer, -1, arr);
2172         RenumberDockRows(arr);
2173         if (!arr.IsEmpty())
2174         {
2175             for (row = 0, row_count = arr.GetCount(); row < row_count; ++row)
2176                 LayoutAddDock(cont, *arr.Item(row), uiparts, spacer_only);
2177         }
2178
2179
2180         // fill out the middle layer (which consists
2181         // of left docks, content area and right docks)
2182
2183         middle = new wxBoxSizer(wxHORIZONTAL);
2184
2185         // find any left docks in this layer
2186         FindDocks(docks, wxAUI_DOCK_LEFT, layer, -1, arr);
2187         RenumberDockRows(arr);
2188         if (!arr.IsEmpty())
2189         {
2190             for (row = 0, row_count = arr.GetCount(); row < row_count; ++row)
2191                 LayoutAddDock(middle, *arr.Item(row), uiparts, spacer_only);
2192         }
2193
2194         // add content dock (or previous layer's sizer
2195         // to the middle
2196         if (!old_cont)
2197         {
2198             // find any center docks
2199             FindDocks(docks, wxAUI_DOCK_CENTER, -1, -1, arr);
2200             if (!arr.IsEmpty())
2201             {
2202                 for (row = 0,row_count = arr.GetCount(); row<row_count; ++row)
2203                    LayoutAddDock(middle, *arr.Item(row), uiparts, spacer_only);
2204             }
2205             else if (!m_has_maximized)
2206             {
2207                 // there are no center docks, add a background area
2208                 wxSizerItem* sizer_item = middle->Add(1,1, 1, wxEXPAND);
2209                 wxAuiDockUIPart part;
2210                 part.type = wxAuiDockUIPart::typeBackground;
2211                 part.pane = NULL;
2212                 part.dock = NULL;
2213                 part.button = NULL;
2214                 part.cont_sizer = middle;
2215                 part.sizer_item = sizer_item;
2216                 uiparts.Add(part);
2217             }
2218         }
2219         else
2220         {
2221             middle->Add(old_cont, 1, wxEXPAND);
2222         }
2223
2224         // find any right docks in this layer
2225         FindDocks(docks, wxAUI_DOCK_RIGHT, layer, -1, arr);
2226         RenumberDockRows(arr);
2227         if (!arr.IsEmpty())
2228         {
2229             for (row = arr.GetCount()-1; row >= 0; --row)
2230                 LayoutAddDock(middle, *arr.Item(row), uiparts, spacer_only);
2231         }
2232
2233         cont->Add(middle, 1, wxEXPAND);
2234
2235
2236
2237         // find any bottom docks in this layer
2238         FindDocks(docks, wxAUI_DOCK_BOTTOM, layer, -1, arr);
2239         RenumberDockRows(arr);
2240         if (!arr.IsEmpty())
2241         {
2242             for (row = arr.GetCount()-1; row >= 0; --row)
2243                 LayoutAddDock(cont, *arr.Item(row), uiparts, spacer_only);
2244         }
2245
2246     }
2247
2248     if (!cont)
2249     {
2250         // no sizer available, because there are no docks,
2251         // therefore we will create a simple background area
2252         cont = new wxBoxSizer(wxVERTICAL);
2253         wxSizerItem* sizer_item = cont->Add(1,1, 1, wxEXPAND);
2254         wxAuiDockUIPart part;
2255         part.type = wxAuiDockUIPart::typeBackground;
2256         part.pane = NULL;
2257         part.dock = NULL;
2258         part.button = NULL;
2259         part.cont_sizer = middle;
2260         part.sizer_item = sizer_item;
2261         uiparts.Add(part);
2262     }
2263
2264     container->Add(cont, 1, wxEXPAND);
2265     return container;
2266 }
2267
2268
2269 // SetDockSizeConstraint() allows the dock constraints to be set.  For example,
2270 // specifying values of 0.5, 0.5 will mean that upon dock creation, a dock may
2271 // not be larger than half of the window's size
2272
2273 void wxAuiManager::SetDockSizeConstraint(double width_pct, double height_pct)
2274 {
2275     m_dock_constraint_x = wxMax(0.0, wxMin(1.0, width_pct));
2276     m_dock_constraint_y = wxMax(0.0, wxMin(1.0, height_pct));
2277 }
2278
2279 void wxAuiManager::GetDockSizeConstraint(double* width_pct, double* height_pct) const
2280 {
2281     if (width_pct)
2282         *width_pct = m_dock_constraint_x;
2283
2284     if (height_pct)
2285         *height_pct = m_dock_constraint_y;
2286 }
2287
2288
2289
2290 // Update() updates the layout.  Whenever changes are made to
2291 // one or more panes, this function should be called.  It is the
2292 // external entry point for running the layout engine.
2293
2294 void wxAuiManager::Update()
2295 {
2296     m_hover_button = NULL;
2297
2298     wxSizer* sizer;
2299     int i, pane_count = m_panes.GetCount();
2300
2301
2302     // destroy floating panes which have been
2303     // redocked or are becoming non-floating
2304     for (i = 0; i < pane_count; ++i)
2305     {
2306         wxAuiPaneInfo& p = m_panes.Item(i);
2307
2308         if (!p.IsFloating() && p.frame)
2309         {
2310             // because the pane is no longer in a floating, we need to
2311             // reparent it to m_frame and destroy the floating frame
2312
2313             // reduce flicker
2314             p.window->SetSize(1,1);
2315
2316
2317             // the following block is a workaround for bug #1531361
2318             // (see wxWidgets sourceforge page).  On wxGTK (only), when
2319             // a frame is shown/hidden, a move event unfortunately
2320             // also gets fired.  Because we may be dragging around
2321             // a pane, we need to cancel that action here to prevent
2322             // a spurious crash.
2323             if (m_action_window == p.frame)
2324             {
2325                 if (wxWindow::GetCapture() == m_frame)
2326                     m_frame->ReleaseMouse();
2327                 m_action = actionNone;
2328                 m_action_window = NULL;
2329             }
2330
2331             // hide the frame
2332             if (p.frame->IsShown())
2333                 p.frame->Show(false);
2334
2335             // reparent to m_frame and destroy the pane
2336             if (m_action_window == p.frame)
2337             {
2338                 m_action_window = NULL;
2339             }
2340
2341             p.window->Reparent(m_frame);
2342             p.frame->SetSizer(NULL);
2343             p.frame->Destroy();
2344             p.frame = NULL;
2345         }
2346     }
2347
2348
2349     // delete old sizer first
2350     m_frame->SetSizer(NULL);
2351
2352     // create a layout for all of the panes
2353     sizer = LayoutAll(m_panes, m_docks, m_uiparts, false);
2354
2355     // hide or show panes as necessary,
2356     // and float panes as necessary
2357     for (i = 0; i < pane_count; ++i)
2358     {
2359         wxAuiPaneInfo& p = m_panes.Item(i);
2360
2361         if (p.IsFloating())
2362         {
2363             if (p.frame == NULL)
2364             {
2365                 // we need to create a frame for this
2366                 // pane, which has recently been floated
2367                 wxAuiFloatingFrame* frame = CreateFloatingFrame(m_frame, p);
2368
2369                 // on MSW and Mac, if the owner desires transparent dragging, and
2370                 // the dragging is happening right now, then the floating
2371                 // window should have this style by default
2372                 if (m_action == actionDragFloatingPane &&
2373                     (m_flags & wxAUI_MGR_TRANSPARENT_DRAG))
2374                         frame->SetTransparent(150);
2375
2376                 frame->SetPaneWindow(p);
2377                 p.frame = frame;
2378
2379                 if (p.IsShown() && !frame->IsShown())
2380                     frame->Show();
2381             }
2382             else
2383             {
2384                 // frame already exists, make sure it's position
2385                 // and size reflect the information in wxAuiPaneInfo
2386                 if ((p.frame->GetPosition() != p.floating_pos) || (p.frame->GetSize() != p.floating_size))
2387                 {
2388                     p.frame->SetSize(p.floating_pos.x, p.floating_pos.y,
2389                                      p.floating_size.x, p.floating_size.y,
2390                                      wxSIZE_USE_EXISTING);
2391                 /*
2392                     p.frame->SetSize(p.floating_pos.x, p.floating_pos.y,
2393                                      wxDefaultCoord, wxDefaultCoord,
2394                                      wxSIZE_USE_EXISTING);
2395                     //p.frame->Move(p.floating_pos.x, p.floating_pos.y);
2396                 */
2397                 }
2398
2399                 if (p.frame->IsShown() != p.IsShown())
2400                     p.frame->Show(p.IsShown());
2401             }
2402         }
2403         else
2404         {
2405             if (p.window->IsShown() != p.IsShown())
2406                 p.window->Show(p.IsShown());
2407         }
2408
2409         // if "active panes" are no longer allowed, clear
2410         // any optionActive values from the pane states
2411         if ((m_flags & wxAUI_MGR_ALLOW_ACTIVE_PANE) == 0)
2412         {
2413             p.state &= ~wxAuiPaneInfo::optionActive;
2414         }
2415     }
2416
2417
2418     // keep track of the old window rectangles so we can
2419     // refresh those windows whose rect has changed
2420     wxAuiRectArray old_pane_rects;
2421     for (i = 0; i < pane_count; ++i)
2422     {
2423         wxRect r;
2424         wxAuiPaneInfo& p = m_panes.Item(i);
2425
2426         if (p.window && p.IsShown() && p.IsDocked())
2427             r = p.rect;
2428
2429         old_pane_rects.Add(r);
2430     }
2431
2432
2433
2434
2435     // apply the new sizer
2436     m_frame->SetSizer(sizer);
2437     m_frame->SetAutoLayout(false);
2438     DoFrameLayout();
2439
2440
2441
2442     // now that the frame layout is done, we need to check
2443     // the new pane rectangles against the old rectangles that
2444     // we saved a few lines above here.  If the rectangles have
2445     // changed, the corresponding panes must also be updated
2446     for (i = 0; i < pane_count; ++i)
2447     {
2448         wxAuiPaneInfo& p = m_panes.Item(i);
2449         if (p.window && p.window->IsShown() && p.IsDocked())
2450         {
2451             if (p.rect != old_pane_rects[i])
2452             {
2453                 p.window->Refresh();
2454                 p.window->Update();
2455             }
2456         }
2457     }
2458
2459
2460     Repaint();
2461
2462     // set frame's minimum size
2463
2464 /*
2465     // N.B. More work needs to be done on frame minimum sizes;
2466     // this is some intresting code that imposes the minimum size,
2467     // but we may want to include a more flexible mechanism or
2468     // options for multiple minimum-size modes, e.g. strict or lax
2469     wxSize min_size = sizer->GetMinSize();
2470     wxSize frame_size = m_frame->GetSize();
2471     wxSize client_size = m_frame->GetClientSize();
2472
2473     wxSize minframe_size(min_size.x+frame_size.x-client_size.x,
2474                          min_size.y+frame_size.y-client_size.y );
2475
2476     m_frame->SetMinSize(minframe_size);
2477
2478     if (frame_size.x < minframe_size.x ||
2479         frame_size.y < minframe_size.y)
2480             sizer->Fit(m_frame);
2481 */
2482 }
2483
2484
2485 // DoFrameLayout() is an internal function which invokes wxSizer::Layout
2486 // on the frame's main sizer, then measures all the various UI items
2487 // and updates their internal rectangles.  This should always be called
2488 // instead of calling m_frame->Layout() directly
2489
2490 void wxAuiManager::DoFrameLayout()
2491 {
2492     m_frame->Layout();
2493
2494     int i, part_count;
2495     for (i = 0, part_count = m_uiparts.GetCount(); i < part_count; ++i)
2496     {
2497         wxAuiDockUIPart& part = m_uiparts.Item(i);
2498
2499         // get the rectangle of the UI part
2500         // originally, this code looked like this:
2501         //    part.rect = wxRect(part.sizer_item->GetPosition(),
2502         //                       part.sizer_item->GetSize());
2503         // this worked quite well, with one exception: the mdi
2504         // client window had a "deferred" size variable
2505         // that returned the wrong size.  It looks like
2506         // a bug in wx, because the former size of the window
2507         // was being returned.  So, we will retrieve the part's
2508         // rectangle via other means
2509
2510
2511         part.rect = part.sizer_item->GetRect();
2512         int flag = part.sizer_item->GetFlag();
2513         int border = part.sizer_item->GetBorder();
2514         if (flag & wxTOP)
2515         {
2516             part.rect.y -= border;
2517             part.rect.height += border;
2518         }
2519         if (flag & wxLEFT)
2520         {
2521             part.rect.x -= border;
2522             part.rect.width += border;
2523         }
2524         if (flag & wxBOTTOM)
2525             part.rect.height += border;
2526         if (flag & wxRIGHT)
2527             part.rect.width += border;
2528
2529
2530         if (part.type == wxAuiDockUIPart::typeDock)
2531             part.dock->rect = part.rect;
2532         if (part.type == wxAuiDockUIPart::typePane)
2533             part.pane->rect = part.rect;
2534     }
2535 }
2536
2537 // GetPanePart() looks up the pane the pane border UI part (or the regular
2538 // pane part if there is no border). This allows the caller to get the exact
2539 // rectangle of the pane in question, including decorations like
2540 // caption and border (if any).
2541
2542 wxAuiDockUIPart* wxAuiManager::GetPanePart(wxWindow* wnd)
2543 {
2544     int i, part_count;
2545     for (i = 0, part_count = m_uiparts.GetCount(); i < part_count; ++i)
2546     {
2547         wxAuiDockUIPart& part = m_uiparts.Item(i);
2548         if (part.type == wxAuiDockUIPart::typePaneBorder &&
2549             part.pane && part.pane->window == wnd)
2550                 return &part;
2551     }
2552     for (i = 0, part_count = m_uiparts.GetCount(); i < part_count; ++i)
2553     {
2554         wxAuiDockUIPart& part = m_uiparts.Item(i);
2555         if (part.type == wxAuiDockUIPart::typePane &&
2556             part.pane && part.pane->window == wnd)
2557                 return &part;
2558     }
2559     return NULL;
2560 }
2561
2562
2563
2564 // GetDockPixelOffset() is an internal function which returns
2565 // a dock's offset in pixels from the left side of the window
2566 // (for horizontal docks) or from the top of the window (for
2567 // vertical docks).  This value is necessary for calculating
2568 // fixel-pane/toolbar offsets when they are dragged.
2569
2570 int wxAuiManager::GetDockPixelOffset(wxAuiPaneInfo& test)
2571 {
2572     // the only way to accurately calculate the dock's
2573     // offset is to actually run a theoretical layout
2574
2575     int i, part_count, dock_count;
2576     wxAuiDockInfoArray docks;
2577     wxAuiPaneInfoArray panes;
2578     wxAuiDockUIPartArray uiparts;
2579     CopyDocksAndPanes(docks, panes, m_docks, m_panes);
2580     panes.Add(test);
2581
2582     wxSizer* sizer = LayoutAll(panes, docks, uiparts, true);
2583     wxSize client_size = m_frame->GetClientSize();
2584     sizer->SetDimension(0, 0, client_size.x, client_size.y);
2585     sizer->Layout();
2586
2587     for (i = 0, part_count = uiparts.GetCount(); i < part_count; ++i)
2588     {
2589         wxAuiDockUIPart& part = uiparts.Item(i);
2590         part.rect = wxRect(part.sizer_item->GetPosition(),
2591                            part.sizer_item->GetSize());
2592         if (part.type == wxAuiDockUIPart::typeDock)
2593             part.dock->rect = part.rect;
2594     }
2595
2596     delete sizer;
2597
2598     for (i = 0, dock_count = docks.GetCount(); i < dock_count; ++i)
2599     {
2600         wxAuiDockInfo& dock = docks.Item(i);
2601         if (test.dock_direction == dock.dock_direction &&
2602             test.dock_layer==dock.dock_layer && test.dock_row==dock.dock_row)
2603         {
2604             if (dock.IsVertical())
2605                 return dock.rect.y;
2606             else
2607                 return dock.rect.x;
2608         }
2609     }
2610
2611     return 0;
2612 }
2613
2614
2615
2616 // ProcessDockResult() is a utility function used by DoDrop() - it checks
2617 // if a dock operation is allowed, the new dock position is copied into
2618 // the target info.  If the operation was allowed, the function returns true.
2619
2620 bool wxAuiManager::ProcessDockResult(wxAuiPaneInfo& target,
2621                                      const wxAuiPaneInfo& new_pos)
2622 {
2623     bool allowed = false;
2624     switch (new_pos.dock_direction)
2625     {
2626         case wxAUI_DOCK_TOP:    allowed = target.IsTopDockable();    break;
2627         case wxAUI_DOCK_BOTTOM: allowed = target.IsBottomDockable(); break;
2628         case wxAUI_DOCK_LEFT:   allowed = target.IsLeftDockable();   break;
2629         case wxAUI_DOCK_RIGHT:  allowed = target.IsRightDockable();  break;
2630     }
2631
2632     if (allowed)
2633         target = new_pos;
2634
2635     return allowed;
2636 }
2637
2638
2639 // DoDrop() is an important function.  It basically takes a mouse position,
2640 // and determines where the pane's new position would be.  If the pane is to be
2641 // dropped, it performs the drop operation using the specified dock and pane
2642 // arrays.  By specifying copied dock and pane arrays when calling, a "what-if"
2643 // scenario can be performed, giving precise coordinates for drop hints.
2644 // If, however, wxAuiManager:m_docks and wxAuiManager::m_panes are specified
2645 // as parameters, the changes will be made to the main state arrays
2646
2647 const int auiInsertRowPixels = 10;
2648 const int auiNewRowPixels = 40;
2649 const int auiLayerInsertPixels = 40;
2650 const int auiLayerInsertOffset = 5;
2651
2652 bool wxAuiManager::DoDrop(wxAuiDockInfoArray& docks,
2653                           wxAuiPaneInfoArray& panes,
2654                           wxAuiPaneInfo& target,
2655                           const wxPoint& pt,
2656                           const wxPoint& offset)
2657 {
2658     wxSize cli_size = m_frame->GetClientSize();
2659
2660     wxAuiPaneInfo drop = target;
2661
2662
2663     // The result should always be shown
2664     drop.Show();
2665
2666
2667     // Check to see if the pane has been dragged outside of the window
2668     // (or near to the outside of the window), if so, dock it along the edge
2669
2670
2671     int layer_insert_offset = auiLayerInsertOffset;
2672     if (drop.IsToolbar())
2673         layer_insert_offset = 0;
2674
2675
2676     if (pt.x < layer_insert_offset &&
2677         pt.x > layer_insert_offset-auiLayerInsertPixels)
2678     {
2679         int new_layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_LEFT),
2680                                 GetMaxLayer(docks, wxAUI_DOCK_BOTTOM)),
2681                                 GetMaxLayer(docks, wxAUI_DOCK_TOP)) + 1;
2682
2683         if (drop.IsToolbar())
2684             new_layer = auiToolBarLayer;
2685
2686         drop.Dock().Left().
2687              Layer(new_layer).
2688              Row(0).
2689              Position(pt.y - GetDockPixelOffset(drop) - offset.y);
2690         return ProcessDockResult(target, drop);
2691     }
2692     else if (pt.y < layer_insert_offset &&
2693              pt.y > layer_insert_offset-auiLayerInsertPixels)
2694     {
2695         int new_layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_TOP),
2696                                 GetMaxLayer(docks, wxAUI_DOCK_LEFT)),
2697                                 GetMaxLayer(docks, wxAUI_DOCK_RIGHT)) + 1;
2698
2699         if (drop.IsToolbar())
2700             new_layer = auiToolBarLayer;
2701
2702         drop.Dock().Top().
2703              Layer(new_layer).
2704              Row(0).
2705              Position(pt.x - GetDockPixelOffset(drop) - offset.x);
2706         return ProcessDockResult(target, drop);
2707     }
2708     else if (pt.x >= cli_size.x - layer_insert_offset &&
2709              pt.x < cli_size.x - layer_insert_offset + auiLayerInsertPixels)
2710     {
2711         int new_layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_RIGHT),
2712                                 GetMaxLayer(docks, wxAUI_DOCK_TOP)),
2713                                 GetMaxLayer(docks, wxAUI_DOCK_BOTTOM)) + 1;
2714
2715         if (drop.IsToolbar())
2716             new_layer = auiToolBarLayer;
2717
2718         drop.Dock().Right().
2719              Layer(new_layer).
2720              Row(0).
2721              Position(pt.y - GetDockPixelOffset(drop) - offset.y);
2722         return ProcessDockResult(target, drop);
2723     }
2724     else if (pt.y >= cli_size.y - layer_insert_offset &&
2725              pt.y < cli_size.y - layer_insert_offset + auiLayerInsertPixels)
2726     {
2727         int new_layer = wxMax( wxMax( GetMaxLayer(docks, wxAUI_DOCK_BOTTOM),
2728                                       GetMaxLayer(docks, wxAUI_DOCK_LEFT)),
2729                                       GetMaxLayer(docks, wxAUI_DOCK_RIGHT)) + 1;
2730
2731         if (drop.IsToolbar())
2732             new_layer = auiToolBarLayer;
2733
2734         drop.Dock().Bottom().
2735              Layer(new_layer).
2736              Row(0).
2737              Position(pt.x - GetDockPixelOffset(drop) - offset.x);
2738         return ProcessDockResult(target, drop);
2739     }
2740
2741
2742     wxAuiDockUIPart* part = HitTest(pt.x, pt.y);
2743
2744
2745     if (drop.IsToolbar())
2746     {
2747         if (!part || !part->dock)
2748             return false;
2749
2750         // calculate the offset from where the dock begins
2751         // to the point where the user dropped the pane
2752         int dock_drop_offset = 0;
2753         if (part->dock->IsHorizontal())
2754             dock_drop_offset = pt.x - part->dock->rect.x - offset.x;
2755         else
2756             dock_drop_offset = pt.y - part->dock->rect.y - offset.y;
2757
2758
2759         // toolbars may only be moved in and to fixed-pane docks,
2760         // otherwise we will try to float the pane.  Also, the pane
2761         // should float if being dragged over center pane windows
2762         if (!part->dock->fixed || part->dock->dock_direction == wxAUI_DOCK_CENTER)
2763         {
2764             if (m_last_rect.IsEmpty() || m_last_rect.Contains(pt.x, pt.y ))
2765             {
2766                 m_skipping = true;
2767             }
2768             else
2769             {
2770                 if ((m_flags & wxAUI_MGR_ALLOW_FLOATING) &&
2771                    (drop.IsFloatable() ||
2772                     (part->dock->dock_direction != wxAUI_DOCK_CENTER &&
2773                      part->dock->dock_direction != wxAUI_DOCK_NONE)))
2774                 {
2775                     drop.Float();
2776                 }
2777
2778                 m_skipping = false;
2779
2780                 return ProcessDockResult(target, drop);
2781             }
2782
2783             drop.Position(pt.x - GetDockPixelOffset(drop) - offset.x);
2784
2785             return ProcessDockResult(target, drop);
2786         }
2787
2788         m_skipping = false;
2789
2790         m_last_rect = part->dock->rect;
2791         m_last_rect.Inflate( 15, 15 );
2792
2793         drop.Dock().
2794              Direction(part->dock->dock_direction).
2795              Layer(part->dock->dock_layer).
2796              Row(part->dock->dock_row).
2797              Position(dock_drop_offset);
2798
2799         if ((
2800             ((pt.y < part->dock->rect.y + 1) && part->dock->IsHorizontal()) ||
2801             ((pt.x < part->dock->rect.x + 1) && part->dock->IsVertical())
2802             ) && part->dock->panes.GetCount() > 1)
2803         {
2804             if ((part->dock->dock_direction == wxAUI_DOCK_TOP) ||
2805                 (part->dock->dock_direction == wxAUI_DOCK_LEFT))
2806             {
2807                 int row = drop.dock_row;
2808                 DoInsertDockRow(panes, part->dock->dock_direction,
2809                                 part->dock->dock_layer,
2810                                 part->dock->dock_row);
2811                 drop.dock_row = row;
2812             }
2813             else
2814             {
2815                 DoInsertDockRow(panes, part->dock->dock_direction,
2816                                 part->dock->dock_layer,
2817                                 part->dock->dock_row+1);
2818                 drop.dock_row = part->dock->dock_row+1;
2819             }
2820         }
2821
2822         if ((
2823             ((pt.y > part->dock->rect.y + part->dock->rect.height - 2 ) && part->dock->IsHorizontal()) ||
2824             ((pt.x > part->dock->rect.x + part->dock->rect.width - 2 ) && part->dock->IsVertical())
2825             ) && part->dock->panes.GetCount() > 1)
2826         {
2827             if ((part->dock->dock_direction == wxAUI_DOCK_TOP) ||
2828                 (part->dock->dock_direction == wxAUI_DOCK_LEFT))
2829             {
2830                 DoInsertDockRow(panes, part->dock->dock_direction,
2831                                 part->dock->dock_layer,
2832                                 part->dock->dock_row+1);
2833                 drop.dock_row = part->dock->dock_row+1;
2834             }
2835             else
2836             {
2837                 int row = drop.dock_row;
2838                 DoInsertDockRow(panes, part->dock->dock_direction,
2839                                 part->dock->dock_layer,
2840                                 part->dock->dock_row);
2841                 drop.dock_row = row;
2842             }
2843         }
2844
2845         return ProcessDockResult(target, drop);
2846     }
2847
2848
2849
2850
2851     if (!part)
2852         return false;
2853
2854     if (part->type == wxAuiDockUIPart::typePaneBorder ||
2855         part->type == wxAuiDockUIPart::typeCaption ||
2856         part->type == wxAuiDockUIPart::typeGripper ||
2857         part->type == wxAuiDockUIPart::typePaneButton ||
2858         part->type == wxAuiDockUIPart::typePane ||
2859         part->type == wxAuiDockUIPart::typePaneSizer ||
2860         part->type == wxAuiDockUIPart::typeDockSizer ||
2861         part->type == wxAuiDockUIPart::typeBackground)
2862     {
2863         if (part->type == wxAuiDockUIPart::typeDockSizer)
2864         {
2865             if (part->dock->panes.GetCount() != 1)
2866                 return false;
2867             part = GetPanePart(part->dock->panes.Item(0)->window);
2868             if (!part)
2869                 return false;
2870         }
2871
2872
2873
2874         // If a normal frame is being dragged over a toolbar, insert it
2875         // along the edge under the toolbar, but over all other panes.
2876         // (this could be done much better, but somehow factoring this
2877         // calculation with the one at the beginning of this function)
2878         if (part->dock && part->dock->toolbar)
2879         {
2880             int layer = 0;
2881
2882             switch (part->dock->dock_direction)
2883             {
2884                 case wxAUI_DOCK_LEFT:
2885                     layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_LEFT),
2886                                       GetMaxLayer(docks, wxAUI_DOCK_BOTTOM)),
2887                                       GetMaxLayer(docks, wxAUI_DOCK_TOP));
2888                     break;
2889                 case wxAUI_DOCK_TOP:
2890                     layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_TOP),
2891                                       GetMaxLayer(docks, wxAUI_DOCK_LEFT)),
2892                                       GetMaxLayer(docks, wxAUI_DOCK_RIGHT));
2893                     break;
2894                 case wxAUI_DOCK_RIGHT:
2895                     layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_RIGHT),
2896                                       GetMaxLayer(docks, wxAUI_DOCK_TOP)),
2897                                       GetMaxLayer(docks, wxAUI_DOCK_BOTTOM));
2898                     break;
2899                 case wxAUI_DOCK_BOTTOM:
2900                     layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_BOTTOM),
2901                                       GetMaxLayer(docks, wxAUI_DOCK_LEFT)),
2902                                       GetMaxLayer(docks, wxAUI_DOCK_RIGHT));
2903                     break;
2904             }
2905
2906             DoInsertDockRow(panes, part->dock->dock_direction,
2907                             layer, 0);
2908             drop.Dock().
2909                  Direction(part->dock->dock_direction).
2910                  Layer(layer).Row(0).Position(0);
2911             return ProcessDockResult(target, drop);
2912         }
2913
2914
2915         if (!part->pane)
2916             return false;
2917
2918         part = GetPanePart(part->pane->window);
2919         if (!part)
2920             return false;
2921
2922         bool insert_dock_row = false;
2923         int insert_row = part->pane->dock_row;
2924         int insert_dir = part->pane->dock_direction;
2925         int insert_layer = part->pane->dock_layer;
2926
2927         switch (part->pane->dock_direction)
2928         {
2929             case wxAUI_DOCK_TOP:
2930                 if (pt.y >= part->rect.y &&
2931                     pt.y < part->rect.y+auiInsertRowPixels)
2932                         insert_dock_row = true;
2933                 break;
2934             case wxAUI_DOCK_BOTTOM:
2935                 if (pt.y > part->rect.y+part->rect.height-auiInsertRowPixels &&
2936                     pt.y <= part->rect.y + part->rect.height)
2937                         insert_dock_row = true;
2938                 break;
2939             case wxAUI_DOCK_LEFT:
2940                 if (pt.x >= part->rect.x &&
2941                     pt.x < part->rect.x+auiInsertRowPixels)
2942                         insert_dock_row = true;
2943                 break;
2944             case wxAUI_DOCK_RIGHT:
2945                 if (pt.x > part->rect.x+part->rect.width-auiInsertRowPixels &&
2946                     pt.x <= part->rect.x+part->rect.width)
2947                         insert_dock_row = true;
2948                 break;
2949             case wxAUI_DOCK_CENTER:
2950             {
2951                 // "new row pixels" will be set to the default, but
2952                 // must never exceed 20% of the window size
2953                 int new_row_pixels_x = auiNewRowPixels;
2954                 int new_row_pixels_y = auiNewRowPixels;
2955
2956                 if (new_row_pixels_x > (part->rect.width*20)/100)
2957                     new_row_pixels_x = (part->rect.width*20)/100;
2958
2959                 if (new_row_pixels_y > (part->rect.height*20)/100)
2960                     new_row_pixels_y = (part->rect.height*20)/100;
2961
2962
2963                 // determine if the mouse pointer is in a location that
2964                 // will cause a new row to be inserted.  The hot spot positions
2965                 // are along the borders of the center pane
2966
2967                 insert_layer = 0;
2968                 insert_dock_row = true;
2969                 const wxRect& pr = part->rect;
2970                 if (pt.x >= pr.x && pt.x < pr.x + new_row_pixels_x)
2971                     insert_dir = wxAUI_DOCK_LEFT;
2972                 else if (pt.y >= pr.y && pt.y < pr.y + new_row_pixels_y)
2973                     insert_dir = wxAUI_DOCK_TOP;
2974                 else if (pt.x >= pr.x + pr.width - new_row_pixels_x &&
2975                          pt.x < pr.x + pr.width)
2976                     insert_dir = wxAUI_DOCK_RIGHT;
2977                 else if (pt.y >= pr.y+ pr.height - new_row_pixels_y &&
2978                          pt.y < pr.y + pr.height)
2979                     insert_dir = wxAUI_DOCK_BOTTOM;
2980                 else
2981                     return false;
2982
2983                 insert_row = GetMaxRow(panes, insert_dir, insert_layer) + 1;
2984             }
2985         }
2986
2987         if (insert_dock_row)
2988         {
2989             DoInsertDockRow(panes, insert_dir, insert_layer, insert_row);
2990             drop.Dock().Direction(insert_dir).
2991                         Layer(insert_layer).
2992                         Row(insert_row).
2993                         Position(0);
2994             return ProcessDockResult(target, drop);
2995         }
2996
2997         // determine the mouse offset and the pane size, both in the
2998         // direction of the dock itself, and perpendicular to the dock
2999
3000         int offset, size;
3001
3002         if (part->orientation == wxVERTICAL)
3003         {
3004             offset = pt.y - part->rect.y;
3005             size = part->rect.GetHeight();
3006         }
3007         else
3008         {
3009             offset = pt.x - part->rect.x;
3010             size = part->rect.GetWidth();
3011         }
3012
3013         int drop_position = part->pane->dock_pos;
3014
3015         // if we are in the top/left part of the pane,
3016         // insert the pane before the pane being hovered over
3017         if (offset <= size/2)
3018         {
3019             drop_position = part->pane->dock_pos;
3020             DoInsertPane(panes,
3021                          part->pane->dock_direction,
3022                          part->pane->dock_layer,
3023                          part->pane->dock_row,
3024                          part->pane->dock_pos);
3025         }
3026
3027         // if we are in the bottom/right part of the pane,
3028         // insert the pane before the pane being hovered over
3029         if (offset > size/2)
3030         {
3031             drop_position = part->pane->dock_pos+1;
3032             DoInsertPane(panes,
3033                          part->pane->dock_direction,
3034                          part->pane->dock_layer,
3035                          part->pane->dock_row,
3036                          part->pane->dock_pos+1);
3037         }
3038
3039         drop.Dock().
3040              Direction(part->dock->dock_direction).
3041              Layer(part->dock->dock_layer).
3042              Row(part->dock->dock_row).
3043              Position(drop_position);
3044         return ProcessDockResult(target, drop);
3045     }
3046
3047     return false;
3048 }
3049
3050
3051 void wxAuiManager::OnHintFadeTimer(wxTimerEvent& WXUNUSED(event))
3052 {
3053     if (!m_hint_wnd || m_hint_fadeamt >= m_hint_fademax)
3054     {
3055         m_hint_fadetimer.Stop();
3056         return;
3057     }
3058
3059     m_hint_fadeamt += 4;
3060     m_hint_wnd->SetTransparent(m_hint_fadeamt);
3061 }
3062
3063 void wxAuiManager::ShowHint(const wxRect& rect)
3064 {
3065     if (m_hint_wnd)
3066     {
3067         // if the hint rect is the same as last time, don't do anything
3068         if (m_last_hint == rect)
3069             return;
3070         m_last_hint = rect;
3071
3072         m_hint_fadeamt = m_hint_fademax;
3073
3074         if ((m_flags & wxAUI_MGR_HINT_FADE)
3075             && !((m_hint_wnd->IsKindOf(CLASSINFO(wxPseudoTransparentFrame))) &&
3076                  (m_flags & wxAUI_MGR_NO_VENETIAN_BLINDS_FADE))
3077             )
3078             m_hint_fadeamt = 0;
3079
3080         m_hint_wnd->SetSize(rect);
3081         m_hint_wnd->SetTransparent(m_hint_fadeamt);
3082
3083         if (!m_hint_wnd->IsShown())
3084             m_hint_wnd->Show();
3085
3086         // if we are dragging a floating pane, set the focus
3087         // back to that floating pane (otherwise it becomes unfocused)
3088         if (m_action == actionDragFloatingPane && m_action_window)
3089             m_action_window->SetFocus();
3090
3091         m_hint_wnd->Raise();
3092
3093
3094         if (m_hint_fadeamt != m_hint_fademax) //  Only fade if we need to
3095         {
3096             // start fade in timer
3097             m_hint_fadetimer.SetOwner(this, 101);
3098             m_hint_fadetimer.Start(5);
3099         }
3100     }
3101     else  // Not using a transparent hint window...
3102     {
3103         if (!(m_flags & wxAUI_MGR_RECTANGLE_HINT))
3104             return;
3105
3106         if (m_last_hint != rect)
3107         {
3108             // remove the last hint rectangle
3109             m_last_hint = rect;
3110             m_frame->Refresh();
3111             m_frame->Update();
3112         }
3113
3114         wxScreenDC screendc;
3115         wxRegion clip(1, 1, 10000, 10000);
3116
3117         // clip all floating windows, so we don't draw over them
3118         int i, pane_count;
3119         for (i = 0, pane_count = m_panes.GetCount(); i < pane_count; ++i)
3120         {
3121             wxAuiPaneInfo& pane = m_panes.Item(i);
3122
3123             if (pane.IsFloating() &&
3124                 pane.frame->IsShown())
3125             {
3126                 wxRect rect = pane.frame->GetRect();
3127 #ifdef __WXGTK__
3128                 // wxGTK returns the client size, not the whole frame size
3129                 rect.width += 15;
3130                 rect.height += 35;
3131                 rect.Inflate(5);
3132 #endif
3133
3134                 clip.Subtract(rect);
3135             }
3136         }
3137
3138         // As we can only hide the hint by redrawing the managed window, we
3139         // need to clip the region to the managed window too or we get
3140         // nasty redrawn problems.
3141         clip.Intersect(m_frame->GetRect());
3142
3143         screendc.SetClippingRegion(clip);
3144
3145         wxBitmap stipple = wxPaneCreateStippleBitmap();
3146         wxBrush brush(stipple);
3147         screendc.SetBrush(brush);
3148         screendc.SetPen(*wxTRANSPARENT_PEN);
3149
3150         screendc.DrawRectangle(rect.x, rect.y, 5, rect.height);
3151         screendc.DrawRectangle(rect.x+5, rect.y, rect.width-10, 5);
3152         screendc.DrawRectangle(rect.x+rect.width-5, rect.y, 5, rect.height);
3153         screendc.DrawRectangle(rect.x+5, rect.y+rect.height-5, rect.width-10, 5);
3154     }
3155 }
3156
3157 void wxAuiManager::HideHint()
3158 {
3159     // hides a transparent window hint, if there is one
3160     if (m_hint_wnd)
3161     {
3162         if (m_hint_wnd->IsShown())
3163             m_hint_wnd->Show(false);
3164         m_hint_wnd->SetTransparent(0);
3165         m_hint_fadetimer.Stop();
3166         m_last_hint = wxRect();
3167         return;
3168     }
3169
3170     // hides a painted hint by redrawing the frame window
3171     if (!m_last_hint.IsEmpty())
3172     {
3173         m_frame->Refresh();
3174         m_frame->Update();
3175         m_last_hint = wxRect();
3176     }
3177 }
3178
3179
3180
3181 void wxAuiManager::StartPaneDrag(wxWindow* pane_window,
3182                                  const wxPoint& offset)
3183 {
3184     wxAuiPaneInfo& pane = GetPane(pane_window);
3185     if (!pane.IsOk())
3186         return;
3187
3188     if (pane.IsToolbar())
3189     {
3190         m_action = actionDragToolbarPane;
3191     }
3192     else
3193     {
3194         m_action = actionDragFloatingPane;
3195     }
3196
3197     m_action_window = pane_window;
3198     m_action_offset = offset;
3199     m_frame->CaptureMouse();
3200 }
3201
3202
3203 // CalculateHintRect() calculates the drop hint rectangle.  The method
3204 // first calls DoDrop() to determine the exact position the pane would
3205 // be at were if dropped.  If the pane would indeed become docked at the
3206 // specified drop point, the the rectangle hint will be returned in
3207 // screen coordinates.  Otherwise, an empty rectangle is returned.
3208 // |pane_window| is the window pointer of the pane being dragged, |pt| is
3209 // the mouse position, in client coordinates.  |offset| describes the offset
3210 // that the mouse is from the upper-left corner of the item being dragged
3211
3212 wxRect wxAuiManager::CalculateHintRect(wxWindow* pane_window,
3213                                        const wxPoint& pt,
3214                                        const wxPoint& offset)
3215 {
3216     wxRect rect;
3217
3218     // we need to paint a hint rectangle; to find out the exact hint rectangle,
3219     // we will create a new temporary layout and then measure the resulting
3220     // rectangle; we will create a copy of the docking structures (m_dock)
3221     // so that we don't modify the real thing on screen
3222
3223     int i, pane_count, part_count;
3224     wxAuiDockInfoArray docks;
3225     wxAuiPaneInfoArray panes;
3226     wxAuiDockUIPartArray uiparts;
3227     wxAuiPaneInfo hint = GetPane(pane_window);
3228     hint.name = wxT("__HINT__");
3229     hint.PaneBorder(true);
3230     hint.Show();
3231
3232     if (!hint.IsOk())
3233         return rect;
3234
3235     CopyDocksAndPanes(docks, panes, m_docks, m_panes);
3236
3237     // remove any pane already there which bears the same window;
3238     // this happens when you are moving a pane around in a dock
3239     for (i = 0, pane_count = panes.GetCount(); i < pane_count; ++i)
3240     {
3241         if (panes.Item(i).window == pane_window)
3242         {
3243             RemovePaneFromDocks(docks, panes.Item(i));
3244             panes.RemoveAt(i);
3245             break;
3246         }
3247     }
3248
3249     // find out where the new pane would be
3250     if (!DoDrop(docks, panes, hint, pt, offset))
3251     {
3252         return rect;
3253     }
3254
3255     panes.Add(hint);
3256
3257     wxSizer* sizer = LayoutAll(panes, docks, uiparts, true);
3258     wxSize client_size = m_frame->GetClientSize();
3259     sizer->SetDimension(0, 0, client_size.x, client_size.y);
3260     sizer->Layout();
3261
3262     for (i = 0, part_count = uiparts.GetCount();
3263          i < part_count; ++i)
3264     {
3265         wxAuiDockUIPart& part = uiparts.Item(i);
3266
3267         if (part.type == wxAuiDockUIPart::typePaneBorder &&
3268             part.pane && part.pane->name == wxT("__HINT__"))
3269         {
3270             rect = wxRect(part.sizer_item->GetPosition(),
3271                           part.sizer_item->GetSize());
3272             break;
3273         }
3274     }
3275
3276     delete sizer;
3277
3278     if (rect.IsEmpty())
3279     {
3280         return rect;
3281     }
3282
3283     // actually show the hint rectangle on the screen
3284     m_frame->ClientToScreen(&rect.x, &rect.y);
3285
3286     if ( m_frame->GetLayoutDirection() == wxLayout_RightToLeft )
3287     {
3288         // Mirror rectangle in RTL mode
3289         rect.x -= rect.GetWidth();
3290     }
3291
3292     return rect;
3293 }
3294
3295 // DrawHintRect() calculates the hint rectangle by calling
3296 // CalculateHintRect().  If there is a rectangle, it shows it
3297 // by calling ShowHint(), otherwise it hides any hint
3298 // rectangle currently shown
3299 void wxAuiManager::DrawHintRect(wxWindow* pane_window,
3300                                 const wxPoint& pt,
3301                                 const wxPoint& offset)
3302 {
3303     wxRect rect = CalculateHintRect(pane_window, pt, offset);
3304
3305     if (rect.IsEmpty())
3306     {
3307         HideHint();
3308     }
3309     else
3310     {
3311         ShowHint(rect);
3312     }
3313 }
3314
3315 void wxAuiManager::OnFloatingPaneMoveStart(wxWindow* wnd)
3316 {
3317     // try to find the pane
3318     wxAuiPaneInfo& pane = GetPane(wnd);
3319     wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
3320
3321     if (m_flags & wxAUI_MGR_TRANSPARENT_DRAG)
3322         pane.frame->SetTransparent(150);
3323 }
3324
3325 void wxAuiManager::OnFloatingPaneMoving(wxWindow* wnd, wxDirection dir)
3326 {
3327     // try to find the pane
3328     wxAuiPaneInfo& pane = GetPane(wnd);
3329     wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
3330
3331     wxPoint pt = ::wxGetMousePosition();
3332
3333 #if 0
3334     // Adapt pt to direction
3335     if (dir == wxNORTH)
3336     {
3337         // move to pane's upper border
3338         wxPoint pos( 0,0 );
3339         pos = wnd->ClientToScreen( pos );
3340         pt.y = pos.y;
3341         // and some more pixels for the title bar
3342         pt.y -= 5;
3343     }
3344     else if (dir == wxWEST)
3345     {
3346         // move to pane's left border
3347         wxPoint pos( 0,0 );
3348         pos = wnd->ClientToScreen( pos );
3349         pt.x = pos.x;
3350     }
3351     else if (dir == wxEAST)
3352     {
3353         // move to pane's right border
3354         wxPoint pos( wnd->GetSize().x, 0 );
3355         pos = wnd->ClientToScreen( pos );
3356         pt.x = pos.x;
3357     }
3358     else if (dir == wxSOUTH)
3359     {
3360         // move to pane's bottom border
3361         wxPoint pos( 0, wnd->GetSize().y );
3362         pos = wnd->ClientToScreen( pos );
3363         pt.y = pos.y;
3364     }
3365 #else
3366     wxUnusedVar(dir);
3367 #endif
3368
3369     wxPoint client_pt = m_frame->ScreenToClient(pt);
3370
3371     // calculate the offset from the upper left-hand corner
3372     // of the frame to the mouse pointer
3373     wxPoint frame_pos = pane.frame->GetPosition();
3374     wxPoint action_offset(pt.x-frame_pos.x, pt.y-frame_pos.y);
3375
3376     // no hint for toolbar floating windows
3377     if (pane.IsToolbar() && m_action == actionDragFloatingPane)
3378     {
3379         wxAuiDockInfoArray docks;
3380         wxAuiPaneInfoArray panes;
3381         wxAuiDockUIPartArray uiparts;
3382         wxAuiPaneInfo hint = pane;
3383
3384         CopyDocksAndPanes(docks, panes, m_docks, m_panes);
3385
3386         // find out where the new pane would be
3387         if (!DoDrop(docks, panes, hint, client_pt))
3388             return;
3389         if (hint.IsFloating())
3390             return;
3391
3392         pane = hint;
3393         m_action = actionDragToolbarPane;
3394         m_action_window = pane.window;
3395
3396         Update();
3397
3398         return;
3399     }
3400
3401
3402     // if a key modifier is pressed while dragging the frame,
3403     // don't dock the window
3404     if (!CanDockPanel(pane))
3405     {
3406         HideHint();
3407         return;
3408     }
3409
3410
3411     DrawHintRect(wnd, client_pt, action_offset);
3412
3413 #ifdef __WXGTK__
3414     // this cleans up some screen artifacts that are caused on GTK because
3415     // we aren't getting the exact size of the window (see comment
3416     // in DrawHintRect)
3417     //Refresh();
3418 #endif
3419
3420
3421     // reduces flicker
3422     m_frame->Update();
3423 }
3424
3425 void wxAuiManager::OnFloatingPaneMoved(wxWindow* wnd, wxDirection dir)
3426 {
3427     // try to find the pane
3428     wxAuiPaneInfo& pane = GetPane(wnd);
3429     wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
3430
3431     wxPoint pt = ::wxGetMousePosition();
3432
3433 #if 0
3434     // Adapt pt to direction
3435     if (dir == wxNORTH)
3436     {
3437         // move to pane's upper border
3438         wxPoint pos( 0,0 );
3439         pos = wnd->ClientToScreen( pos );
3440         pt.y = pos.y;
3441         // and some more pixels for the title bar
3442         pt.y -= 10;
3443     }
3444     else if (dir == wxWEST)
3445     {
3446         // move to pane's left border
3447         wxPoint pos( 0,0 );
3448         pos = wnd->ClientToScreen( pos );
3449         pt.x = pos.x;
3450     }
3451     else if (dir == wxEAST)
3452     {
3453         // move to pane's right border
3454         wxPoint pos( wnd->GetSize().x, 0 );
3455         pos = wnd->ClientToScreen( pos );
3456         pt.x = pos.x;
3457     }
3458     else if (dir == wxSOUTH)
3459     {
3460         // move to pane's bottom border
3461         wxPoint pos( 0, wnd->GetSize().y );
3462         pos = wnd->ClientToScreen( pos );
3463         pt.y = pos.y;
3464     }
3465 #else
3466     wxUnusedVar(dir);
3467 #endif
3468
3469     wxPoint client_pt = m_frame->ScreenToClient(pt);
3470
3471     // calculate the offset from the upper left-hand corner
3472     // of the frame to the mouse pointer
3473     wxPoint frame_pos = pane.frame->GetPosition();
3474     wxPoint action_offset(pt.x-frame_pos.x, pt.y-frame_pos.y);
3475
3476
3477     // if a key modifier is pressed while dragging the frame,
3478     // don't dock the window
3479     if (CanDockPanel(pane))
3480     {
3481         // do the drop calculation
3482         DoDrop(m_docks, m_panes, pane, client_pt, action_offset);
3483     }
3484
3485     // if the pane is still floating, update it's floating
3486     // position (that we store)
3487     if (pane.IsFloating())
3488     {
3489         pane.floating_pos = pane.frame->GetPosition();
3490
3491         if (m_flags & wxAUI_MGR_TRANSPARENT_DRAG)
3492             pane.frame->SetTransparent(255);
3493     }
3494     else if (m_has_maximized)
3495     {
3496         RestoreMaximizedPane();
3497     }
3498
3499     Update();
3500
3501     HideHint();
3502 }
3503
3504 void wxAuiManager::OnFloatingPaneResized(wxWindow* wnd, const wxSize& size)
3505 {
3506     // try to find the pane
3507     wxAuiPaneInfo& pane = GetPane(wnd);
3508     wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
3509
3510     pane.floating_size = size;
3511 }
3512
3513
3514 void wxAuiManager::OnFloatingPaneClosed(wxWindow* wnd, wxCloseEvent& evt)
3515 {
3516     // try to find the pane
3517     wxAuiPaneInfo& pane = GetPane(wnd);
3518     wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
3519
3520
3521     // fire pane close event
3522     wxAuiManagerEvent e(wxEVT_AUI_PANE_CLOSE);
3523     e.SetPane(&pane);
3524     e.SetCanVeto(evt.CanVeto());
3525     ProcessMgrEvent(e);
3526
3527     if (e.GetVeto())
3528     {
3529         evt.Veto();
3530         return;
3531     }
3532     else
3533     {
3534         // close the pane, but check that it
3535         // still exists in our pane array first
3536         // (the event handler above might have removed it)
3537
3538         wxAuiPaneInfo& check = GetPane(wnd);
3539         if (check.IsOk())
3540         {
3541             ClosePane(pane);
3542         }
3543     }
3544 }
3545
3546
3547
3548 void wxAuiManager::OnFloatingPaneActivated(wxWindow* wnd)
3549 {
3550     if ((GetFlags() & wxAUI_MGR_ALLOW_ACTIVE_PANE) && GetPane(wnd).IsOk())
3551     {
3552         SetActivePane(m_panes, wnd);
3553         Repaint();
3554     }
3555 }
3556
3557 // OnRender() draws all of the pane captions, sashes,
3558 // backgrounds, captions, grippers, pane borders and buttons.
3559 // It renders the entire user interface.
3560
3561 void wxAuiManager::OnRender(wxAuiManagerEvent& evt)
3562 {
3563     // if the frame is about to be deleted, don't bother
3564     if (!m_frame || wxPendingDelete.Member(m_frame))
3565         return;
3566
3567     wxDC* dc = evt.GetDC();
3568
3569 #ifdef __WXMAC__
3570     dc->Clear() ;
3571 #endif
3572     int i, part_count;
3573     for (i = 0, part_count = m_uiparts.GetCount();
3574          i < part_count; ++i)
3575     {
3576         wxAuiDockUIPart& part = m_uiparts.Item(i);
3577
3578         // don't draw hidden pane items or items that aren't windows
3579         if (part.sizer_item && ((!part.sizer_item->IsWindow() && !part.sizer_item->IsSpacer() && !part.sizer_item->IsSizer()) || !part.sizer_item->IsShown()))
3580             continue;
3581
3582         switch (part.type)
3583         {
3584             case wxAuiDockUIPart::typeDockSizer:
3585             case wxAuiDockUIPart::typePaneSizer:
3586                 m_art->DrawSash(*dc, m_frame, part.orientation, part.rect);
3587                 break;
3588             case wxAuiDockUIPart::typeBackground:
3589                 m_art->DrawBackground(*dc, m_frame, part.orientation, part.rect);
3590                 break;
3591             case wxAuiDockUIPart::typeCaption:
3592                 m_art->DrawCaption(*dc, m_frame, part.pane->caption, part.rect, *part.pane);
3593                 break;
3594             case wxAuiDockUIPart::typeGripper:
3595                 m_art->DrawGripper(*dc, m_frame, part.rect, *part.pane);
3596                 break;
3597             case wxAuiDockUIPart::typePaneBorder:
3598                 m_art->DrawBorder(*dc, m_frame, part.rect, *part.pane);
3599                 break;
3600             case wxAuiDockUIPart::typePaneButton:
3601                 m_art->DrawPaneButton(*dc, m_frame, part.button->button_id,
3602                         wxAUI_BUTTON_STATE_NORMAL, part.rect, *part.pane);
3603                 break;
3604         }
3605     }
3606 }
3607
3608
3609 // Render() fire a render event, which is normally handled by
3610 // wxAuiManager::OnRender().  This allows the render function to
3611 // be overridden via the render event.  This can be useful for paintin
3612 // custom graphics in the main window. Default behavior can be
3613 // invoked in the overridden function by calling OnRender()
3614
3615 void wxAuiManager::Render(wxDC* dc)
3616 {
3617     wxAuiManagerEvent e(wxEVT_AUI_RENDER);
3618     e.SetManager(this);
3619     e.SetDC(dc);
3620     ProcessMgrEvent(e);
3621 }
3622
3623 void wxAuiManager::Repaint(wxDC* dc)
3624 {
3625 #ifdef __WXMAC__
3626     if ( dc == NULL )
3627     {
3628         m_frame->Refresh() ;
3629         m_frame->Update() ;
3630         return ;
3631     }
3632 #endif
3633     int w, h;
3634     m_frame->GetClientSize(&w, &h);
3635
3636     // figure out which dc to use; if one
3637     // has been specified, use it, otherwise
3638     // make a client dc
3639     wxClientDC* client_dc = NULL;
3640     if (!dc)
3641     {
3642         client_dc = new wxClientDC(m_frame);
3643         dc = client_dc;
3644     }
3645
3646     // if the frame has a toolbar, the client area
3647     // origin will not be (0,0).
3648     wxPoint pt = m_frame->GetClientAreaOrigin();
3649     if (pt.x != 0 || pt.y != 0)
3650         dc->SetDeviceOrigin(pt.x, pt.y);
3651
3652     // render all the items
3653     Render(dc);
3654
3655     // if we created a client_dc, delete it
3656     if (client_dc)
3657         delete client_dc;
3658 }
3659
3660 void wxAuiManager::OnPaint(wxPaintEvent& WXUNUSED(event))
3661 {
3662     wxPaintDC dc(m_frame);
3663     Repaint(&dc);
3664 }
3665
3666 void wxAuiManager::OnEraseBackground(wxEraseEvent& event)
3667 {
3668 #ifdef __WXMAC__
3669     event.Skip() ;
3670 #else
3671     wxUnusedVar(event);
3672 #endif
3673 }
3674
3675 void wxAuiManager::OnSize(wxSizeEvent& event)
3676 {
3677     if (m_frame)
3678     {
3679         DoFrameLayout();
3680         Repaint();
3681
3682 #if wxUSE_MDI
3683         if (m_frame->IsKindOf(CLASSINFO(wxMDIParentFrame)))
3684         {
3685             // for MDI parent frames, this event must not
3686             // be "skipped".  In other words, the parent frame
3687             // must not be allowed to resize the client window
3688             // after we are finished processing sizing changes
3689             return;
3690         }
3691 #endif
3692     }
3693     event.Skip();
3694 }
3695
3696 void wxAuiManager::OnFindManager(wxAuiManagerEvent& evt)
3697 {
3698     // get the window we are managing, if none, return NULL
3699     wxWindow* window = GetManagedWindow();
3700     if (!window)
3701     {
3702         evt.SetManager(NULL);
3703         return;
3704     }
3705
3706     // if we are managing a child frame, get the 'real' manager
3707     if (window->IsKindOf(CLASSINFO(wxAuiFloatingFrame)))
3708     {
3709         wxAuiFloatingFrame* float_frame = static_cast<wxAuiFloatingFrame*>(window);
3710         evt.SetManager(float_frame->GetOwnerManager());
3711         return;
3712     }
3713
3714     // return pointer to ourself
3715     evt.SetManager(this);
3716 }
3717
3718 void wxAuiManager::OnSetCursor(wxSetCursorEvent& event)
3719 {
3720     // determine cursor
3721     wxAuiDockUIPart* part = HitTest(event.GetX(), event.GetY());
3722     wxCursor cursor = wxNullCursor;
3723
3724     if (part)
3725     {
3726         if (part->type == wxAuiDockUIPart::typeDockSizer ||
3727             part->type == wxAuiDockUIPart::typePaneSizer)
3728         {
3729             // a dock may not be resized if it has a single
3730             // pane which is not resizable
3731             if (part->type == wxAuiDockUIPart::typeDockSizer && part->dock &&
3732                 part->dock->panes.GetCount() == 1 &&
3733                 part->dock->panes.Item(0)->IsFixed())
3734                     return;
3735
3736             // panes that may not be resized do not get a sizing cursor
3737             if (part->pane && part->pane->IsFixed())
3738                 return;
3739
3740             if (part->orientation == wxVERTICAL)
3741                 cursor = wxCursor(wxCURSOR_SIZEWE);
3742             else
3743                 cursor = wxCursor(wxCURSOR_SIZENS);
3744         }
3745         else if (part->type == wxAuiDockUIPart::typeGripper)
3746         {
3747             cursor = wxCursor(wxCURSOR_SIZING);
3748         }
3749     }
3750
3751     event.SetCursor(cursor);
3752 }
3753
3754
3755
3756 void wxAuiManager::UpdateButtonOnScreen(wxAuiDockUIPart* button_ui_part,
3757                                         const wxMouseEvent& event)
3758 {
3759     wxAuiDockUIPart* hit_test = HitTest(event.GetX(), event.GetY());
3760     if (!hit_test || !button_ui_part)
3761         return;
3762
3763     int state = wxAUI_BUTTON_STATE_NORMAL;
3764
3765     if (hit_test == button_ui_part)
3766     {
3767         if (event.LeftDown())
3768             state = wxAUI_BUTTON_STATE_PRESSED;
3769         else
3770             state = wxAUI_BUTTON_STATE_HOVER;
3771     }
3772     else
3773     {
3774         if (event.LeftDown())
3775             state = wxAUI_BUTTON_STATE_HOVER;
3776     }
3777
3778     // now repaint the button with hover state
3779     wxClientDC cdc(m_frame);
3780
3781     // if the frame has a toolbar, the client area
3782     // origin will not be (0,0).
3783     wxPoint pt = m_frame->GetClientAreaOrigin();
3784     if (pt.x != 0 || pt.y != 0)
3785         cdc.SetDeviceOrigin(pt.x, pt.y);
3786
3787     if (hit_test->pane)
3788     {
3789         m_art->DrawPaneButton(cdc, m_frame,
3790                   button_ui_part->button->button_id,
3791                   state,
3792                   button_ui_part->rect,
3793                   *hit_test->pane);
3794     }
3795 }
3796
3797 void wxAuiManager::OnLeftDown(wxMouseEvent& event)
3798 {
3799     wxAuiDockUIPart* part = HitTest(event.GetX(), event.GetY());
3800     if (part)
3801     {
3802         if (part->type == wxAuiDockUIPart::typeDockSizer ||
3803             part->type == wxAuiDockUIPart::typePaneSizer)
3804         {
3805             // Removing this restriction so that a centre pane can be resized
3806             //if (part->dock && part->dock->dock_direction == wxAUI_DOCK_CENTER)
3807             //    return;
3808
3809             // a dock may not be resized if it has a single
3810             // pane which is not resizable
3811             if (part->type == wxAuiDockUIPart::typeDockSizer && part->dock &&
3812                 part->dock->panes.GetCount() == 1 &&
3813                 part->dock->panes.Item(0)->IsFixed())
3814                     return;
3815
3816             // panes that may not be resized should be ignored here
3817             if (part->pane && part->pane->IsFixed())
3818                 return;
3819
3820             m_action = actionResize;
3821             m_action_part = part;
3822             m_action_hintrect = wxRect();
3823             m_action_start = wxPoint(event.m_x, event.m_y);
3824             m_action_offset = wxPoint(event.m_x - part->rect.x,
3825                                       event.m_y - part->rect.y);
3826             m_frame->CaptureMouse();
3827         }
3828         else if (part->type == wxAuiDockUIPart::typePaneButton)
3829         {
3830             m_action = actionClickButton;
3831             m_action_part = part;
3832             m_action_start = wxPoint(event.m_x, event.m_y);
3833             m_frame->CaptureMouse();
3834
3835             UpdateButtonOnScreen(part, event);
3836         }
3837         else if (part->type == wxAuiDockUIPart::typeCaption ||
3838                   part->type == wxAuiDockUIPart::typeGripper)
3839         {
3840             // if we are managing a wxAuiFloatingFrame window, then
3841             // we are an embedded wxAuiManager inside the wxAuiFloatingFrame.
3842             // We want to initiate a toolbar drag in our owner manager
3843             wxWindow* managed_wnd = GetManagedWindow();
3844
3845             if (part->pane &&
3846                 part->pane->window &&
3847                 managed_wnd &&
3848                 managed_wnd->IsKindOf(CLASSINFO(wxAuiFloatingFrame)))
3849             {
3850                 wxAuiFloatingFrame* floating_frame = (wxAuiFloatingFrame*)managed_wnd;
3851                 wxAuiManager* owner_mgr = floating_frame->GetOwnerManager();
3852                 owner_mgr->StartPaneDrag(part->pane->window,
3853                                              wxPoint(event.m_x - part->rect.x,
3854                                                      event.m_y - part->rect.y));
3855                 return;
3856             }
3857
3858
3859
3860             if (GetFlags() & wxAUI_MGR_ALLOW_ACTIVE_PANE)
3861             {
3862                 // set the caption as active
3863                 SetActivePane(m_panes, part->pane->window);
3864                 Repaint();
3865             }
3866
3867             if (part->dock && part->dock->dock_direction == wxAUI_DOCK_CENTER)
3868                 return;
3869
3870             m_action = actionClickCaption;
3871             m_action_part = part;
3872             m_action_start = wxPoint(event.m_x, event.m_y);
3873             m_action_offset = wxPoint(event.m_x - part->rect.x,
3874                                       event.m_y - part->rect.y);
3875             m_frame->CaptureMouse();
3876         }
3877 #ifdef __WXMAC__
3878         else
3879         {
3880             event.Skip();
3881         }
3882 #endif
3883     }
3884 #ifdef __WXMAC__
3885     else
3886     {
3887         event.Skip();
3888     }
3889 #else
3890     event.Skip();
3891 #endif
3892 }
3893
3894
3895 void wxAuiManager::OnLeftUp(wxMouseEvent& event)
3896 {
3897     if (m_action == actionResize)
3898     {
3899         m_frame->ReleaseMouse();
3900
3901         // get rid of the hint rectangle
3902         wxScreenDC dc;
3903         DrawResizeHint(dc, m_action_hintrect);
3904
3905         // resize the dock or the pane
3906         if (m_action_part && m_action_part->type==wxAuiDockUIPart::typeDockSizer)
3907         {
3908             wxRect& rect = m_action_part->dock->rect;
3909
3910             wxPoint new_pos(event.m_x - m_action_offset.x,
3911                             event.m_y - m_action_offset.y);
3912
3913             switch (m_action_part->dock->dock_direction)
3914             {
3915                 case wxAUI_DOCK_LEFT:
3916                     m_action_part->dock->size = new_pos.x - rect.x;
3917                     break;
3918                 case wxAUI_DOCK_TOP:
3919                     m_action_part->dock->size = new_pos.y - rect.y;
3920                     break;
3921                 case wxAUI_DOCK_RIGHT:
3922                     m_action_part->dock->size = rect.x + rect.width -
3923                                   new_pos.x - m_action_part->rect.GetWidth();
3924                     break;
3925                 case wxAUI_DOCK_BOTTOM:
3926                     m_action_part->dock->size = rect.y + rect.height -
3927                                   new_pos.y - m_action_part->rect.GetHeight();
3928                     break;
3929             }
3930
3931             Update();
3932             Repaint(NULL);
3933         }
3934         else if (m_action_part &&
3935                  m_action_part->type == wxAuiDockUIPart::typePaneSizer)
3936         {
3937             wxAuiDockInfo& dock = *m_action_part->dock;
3938             wxAuiPaneInfo& pane = *m_action_part->pane;
3939
3940             int total_proportion = 0;
3941             int dock_pixels = 0;
3942             int new_pixsize = 0;
3943
3944             int caption_size = m_art->GetMetric(wxAUI_DOCKART_CAPTION_SIZE);
3945             int pane_border_size = m_art->GetMetric(wxAUI_DOCKART_PANE_BORDER_SIZE);
3946             int sash_size = m_art->GetMetric(wxAUI_DOCKART_SASH_SIZE);
3947
3948             wxPoint new_pos(event.m_x - m_action_offset.x,
3949                             event.m_y - m_action_offset.y);
3950
3951             // determine the pane rectangle by getting the pane part
3952             wxAuiDockUIPart* pane_part = GetPanePart(pane.window);
3953             wxASSERT_MSG(pane_part,
3954                        wxT("Pane border part not found -- shouldn't happen"));
3955
3956             // determine the new pixel size that the user wants;
3957             // this will help us recalculate the pane's proportion
3958             if (dock.IsHorizontal())
3959                 new_pixsize = new_pos.x - pane_part->rect.x;
3960             else
3961                 new_pixsize = new_pos.y - pane_part->rect.y;
3962
3963             // determine the size of the dock, based on orientation
3964             if (dock.IsHorizontal())
3965                 dock_pixels = dock.rect.GetWidth();
3966             else
3967                 dock_pixels = dock.rect.GetHeight();
3968
3969             // determine the total proportion of all resizable panes,
3970             // and the total size of the dock minus the size of all
3971             // the fixed panes
3972             int i, dock_pane_count = dock.panes.GetCount();
3973             int pane_position = -1;
3974             for (i = 0; i < dock_pane_count; ++i)
3975             {
3976                 wxAuiPaneInfo& p = *dock.panes.Item(i);
3977                 if (p.window == pane.window)
3978                     pane_position = i;
3979
3980                 // while we're at it, subtract the pane sash
3981                 // width from the dock width, because this would
3982                 // skew our proportion calculations
3983                 if (i > 0)
3984                     dock_pixels -= sash_size;
3985
3986                 // also, the whole size (including decorations) of
3987                 // all fixed panes must also be subtracted, because they
3988                 // are not part of the proportion calculation
3989                 if (p.IsFixed())
3990                 {
3991                     if (dock.IsHorizontal())
3992                         dock_pixels -= p.best_size.x;
3993                     else
3994                         dock_pixels -= p.best_size.y;
3995                 }
3996                 else
3997                 {
3998                     total_proportion += p.dock_proportion;
3999                 }
4000             }
4001
4002             // find a pane in our dock to 'steal' space from or to 'give'
4003             // space to -- this is essentially what is done when a pane is
4004             // resized; the pane should usually be the first non-fixed pane
4005             // to the right of the action pane
4006             int borrow_pane = -1;
4007             for (i = pane_position+1; i < dock_pane_count; ++i)
4008             {
4009                 wxAuiPaneInfo& p = *dock.panes.Item(i);
4010                 if (!p.IsFixed())
4011                 {
4012                     borrow_pane = i;
4013                     break;
4014                 }
4015             }
4016
4017
4018             // demand that the pane being resized is found in this dock
4019             // (this assert really never should be raised)
4020             wxASSERT_MSG(pane_position != -1, wxT("Pane not found in dock"));
4021
4022             // prevent division by zero
4023             if (dock_pixels == 0 || total_proportion == 0 || borrow_pane == -1)
4024             {
4025                 m_action = actionNone;
4026                 return;
4027             }
4028
4029             // calculate the new proportion of the pane
4030             int new_proportion = (new_pixsize*total_proportion)/dock_pixels;
4031
4032             // default minimum size
4033             int min_size = 0;
4034
4035             // check against the pane's minimum size, if specified. please note
4036             // that this is not enough to ensure that the minimum size will
4037             // not be violated, because the whole frame might later be shrunk,
4038             // causing the size of the pane to violate it's minimum size
4039             if (pane.min_size.IsFullySpecified())
4040             {
4041                 min_size = 0;
4042
4043                 if (pane.HasBorder())
4044                     min_size += (pane_border_size*2);
4045
4046                 // calculate minimum size with decorations (border,caption)
4047                 if (pane_part->orientation == wxVERTICAL)
4048                 {
4049                     min_size += pane.min_size.y;
4050                     if (pane.HasCaption())
4051                         min_size += caption_size;
4052                 }
4053                 else
4054                 {
4055                     min_size += pane.min_size.x;
4056                 }
4057             }
4058
4059
4060             // for some reason, an arithmatic error somewhere is causing
4061             // the proportion calculations to always be off by 1 pixel;
4062             // for now we will add the 1 pixel on, but we really should
4063             // determine what's causing this.
4064             min_size++;
4065
4066             int min_proportion = (min_size*total_proportion)/dock_pixels;
4067
4068             if (new_proportion < min_proportion)
4069                 new_proportion = min_proportion;
4070
4071
4072
4073             int prop_diff = new_proportion - pane.dock_proportion;
4074
4075             // borrow the space from our neighbor pane to the
4076             // right or bottom (depending on orientation)
4077             dock.panes.Item(borrow_pane)->dock_proportion -= prop_diff;
4078             pane.dock_proportion = new_proportion;
4079
4080             // repaint
4081             Update();
4082             Repaint(NULL);
4083         }
4084     }
4085     else if (m_action == actionClickButton)
4086     {
4087         m_hover_button = NULL;
4088         m_frame->ReleaseMouse();
4089         UpdateButtonOnScreen(m_action_part, event);
4090
4091         // make sure we're still over the item that was originally clicked
4092         if (m_action_part == HitTest(event.GetX(), event.GetY()))
4093         {
4094             // fire button-click event
4095             wxAuiManagerEvent e(wxEVT_AUI_PANE_BUTTON);
4096             e.SetManager(this);
4097             e.SetPane(m_action_part->pane);
4098             e.SetButton(m_action_part->button->button_id);
4099             ProcessMgrEvent(e);
4100         }
4101     }
4102     else if (m_action == actionClickCaption)
4103     {
4104         m_frame->ReleaseMouse();
4105     }
4106     else if (m_action == actionDragFloatingPane)
4107     {
4108         m_frame->ReleaseMouse();
4109     }
4110     else if (m_action == actionDragToolbarPane)
4111     {
4112         m_frame->ReleaseMouse();
4113
4114         wxAuiPaneInfo& pane = GetPane(m_action_window);
4115         wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
4116
4117         // save the new positions
4118         wxAuiDockInfoPtrArray docks;
4119         FindDocks(m_docks, pane.dock_direction,
4120                   pane.dock_layer, pane.dock_row, docks);
4121         if (docks.GetCount() == 1)
4122         {
4123             wxAuiDockInfo& dock = *docks.Item(0);
4124
4125             wxArrayInt pane_positions, pane_sizes;
4126             GetPanePositionsAndSizes(dock, pane_positions, pane_sizes);
4127
4128             int i, dock_pane_count = dock.panes.GetCount();
4129             for (i = 0; i < dock_pane_count; ++i)
4130                 dock.panes.Item(i)->dock_pos = pane_positions[i];
4131         }
4132
4133         pane.state &= ~wxAuiPaneInfo::actionPane;
4134         Update();
4135     }
4136     else
4137     {
4138         event.Skip();
4139     }
4140
4141     m_action = actionNone;
4142     m_last_mouse_move = wxPoint(); // see comment in OnMotion()
4143 }
4144
4145
4146 void wxAuiManager::OnMotion(wxMouseEvent& event)
4147 {
4148     // sometimes when Update() is called from inside this method,
4149     // a spurious mouse move event is generated; this check will make
4150     // sure that only real mouse moves will get anywhere in this method;
4151     // this appears to be a bug somewhere, and I don't know where the
4152     // mouse move event is being generated.  only verified on MSW
4153
4154     wxPoint mouse_pos = event.GetPosition();
4155     if (m_last_mouse_move == mouse_pos)
4156         return;
4157     m_last_mouse_move = mouse_pos;
4158
4159
4160     if (m_action == actionResize)
4161     {
4162         wxPoint pos = m_action_part->rect.GetPosition();
4163         if (m_action_part->orientation == wxHORIZONTAL)
4164             pos.y = wxMax(0, event.m_y - m_action_offset.y);
4165         else
4166             pos.x = wxMax(0, event.m_x - m_action_offset.x);
4167
4168         wxRect rect(m_frame->ClientToScreen(pos),
4169                     m_action_part->rect.GetSize());
4170
4171         wxScreenDC dc;
4172         if (!m_action_hintrect.IsEmpty())
4173             DrawResizeHint(dc, m_action_hintrect);
4174         DrawResizeHint(dc, rect);
4175         m_action_hintrect = rect;
4176     }
4177     else if (m_action == actionClickCaption)
4178     {
4179         int drag_x_threshold = wxSystemSettings::GetMetric(wxSYS_DRAG_X);
4180         int drag_y_threshold = wxSystemSettings::GetMetric(wxSYS_DRAG_Y);
4181
4182         // caption has been clicked.  we need to check if the mouse
4183         // is now being dragged. if it is, we need to change the
4184         // mouse action to 'drag'
4185         if (abs(event.m_x - m_action_start.x) > drag_x_threshold ||
4186             abs(event.m_y - m_action_start.y) > drag_y_threshold)
4187         {
4188             wxAuiPaneInfo* pane_info = m_action_part->pane;
4189
4190             if (!pane_info->IsToolbar())
4191             {
4192                 if ((m_flags & wxAUI_MGR_ALLOW_FLOATING) &&
4193                     pane_info->IsFloatable())
4194                 {
4195                     m_action = actionDragFloatingPane;
4196
4197                     // set initial float position
4198                     wxPoint pt = m_frame->ClientToScreen(event.GetPosition());
4199                     pane_info->floating_pos = wxPoint(pt.x - m_action_offset.x,
4200                                                       pt.y - m_action_offset.y);
4201
4202                     // float the window
4203                     if (pane_info->IsMaximized())
4204                         RestorePane(*pane_info);
4205                     pane_info->Float();
4206                     Update();
4207
4208                     m_action_window = pane_info->frame;
4209
4210                     // action offset is used here to make it feel "natural" to the user
4211                     // to drag a docked pane and suddenly have it become a floating frame.
4212                     // Sometimes, however, the offset where the user clicked on the docked
4213                     // caption is bigger than the width of the floating frame itself, so
4214                     // in that case we need to set the action offset to a sensible value
4215                     wxSize frame_size = m_action_window->GetSize();
4216                     if (frame_size.x <= m_action_offset.x)
4217                         m_action_offset.x = 30;
4218                 }
4219             }
4220             else
4221             {
4222                 m_action = actionDragToolbarPane;
4223                 m_action_window = pane_info->window;
4224             }
4225         }
4226     }
4227     else if (m_action == actionDragFloatingPane)
4228     {
4229         if (m_action_window)
4230         {
4231             wxPoint pt = m_frame->ClientToScreen(event.GetPosition());
4232             m_action_window->Move(pt.x - m_action_offset.x,
4233                                 pt.y - m_action_offset.y);
4234         }
4235     }
4236     else if (m_action == actionDragToolbarPane)
4237     {
4238         wxAuiPaneInfo& pane = GetPane(m_action_window);
4239         wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
4240
4241         pane.state |= wxAuiPaneInfo::actionPane;
4242
4243         wxPoint pt = event.GetPosition();
4244         DoDrop(m_docks, m_panes, pane, pt, m_action_offset);
4245
4246         // if DoDrop() decided to float the pane, set up
4247         // the floating pane's initial position
4248         if (pane.IsFloating())
4249         {
4250             wxPoint pt = m_frame->ClientToScreen(event.GetPosition());
4251             pane.floating_pos = wxPoint(pt.x - m_action_offset.x,
4252                                         pt.y - m_action_offset.y);
4253         }
4254
4255         // this will do the actiual move operation;
4256         // in the case that the pane has been floated,
4257         // this call will create the floating pane
4258         // and do the reparenting
4259         Update();
4260
4261         // if the pane has been floated, change the mouse
4262         // action actionDragFloatingPane so that subsequent
4263         // EVT_MOTION() events will move the floating pane
4264         if (pane.IsFloating())
4265         {
4266             pane.state &= ~wxAuiPaneInfo::actionPane;
4267             m_action = actionDragFloatingPane;
4268             m_action_window = pane.frame;
4269         }
4270     }
4271     else
4272     {
4273         wxAuiDockUIPart* part = HitTest(event.GetX(), event.GetY());
4274         if (part && part->type == wxAuiDockUIPart::typePaneButton)
4275         {
4276             if (part != m_hover_button)
4277             {
4278                 // make the old button normal
4279                 if (m_hover_button)
4280                 {
4281                     UpdateButtonOnScreen(m_hover_button, event);
4282                     Repaint();
4283                 }
4284
4285                 // mouse is over a button, so repaint the
4286                 // button in hover mode
4287                 UpdateButtonOnScreen(part, event);
4288                 m_hover_button = part;
4289
4290             }
4291         }
4292         else
4293         {
4294             if (m_hover_button)
4295             {
4296                 m_hover_button = NULL;
4297                 Repaint();
4298             }
4299             else
4300             {
4301                 event.Skip();
4302             }
4303         }
4304     }
4305 }
4306
4307 void wxAuiManager::OnLeaveWindow(wxMouseEvent& WXUNUSED(event))
4308 {
4309     if (m_hover_button)
4310     {
4311         m_hover_button = NULL;
4312         Repaint();
4313     }
4314 }
4315
4316 void wxAuiManager::OnChildFocus(wxChildFocusEvent& event)
4317 {
4318     // when a child pane has it's focus set, we should change the
4319     // pane's active state to reflect this. (this is only true if
4320     // active panes are allowed by the owner)
4321     if (GetFlags() & wxAUI_MGR_ALLOW_ACTIVE_PANE)
4322     {
4323         wxAuiPaneInfo& pane = GetPane(event.GetWindow());
4324         if (pane.IsOk() && (pane.state & wxAuiPaneInfo::optionActive) == 0)
4325         {
4326             SetActivePane(m_panes, event.GetWindow());
4327             m_frame->Refresh();
4328         }
4329     }
4330
4331     event.Skip();
4332 }
4333
4334
4335 // OnPaneButton() is an event handler that is called
4336 // when a pane button has been pressed.
4337 void wxAuiManager::OnPaneButton(wxAuiManagerEvent& evt)
4338 {
4339     wxASSERT_MSG(evt.pane, wxT("Pane Info passed to wxAuiManager::OnPaneButton must be non-null"));
4340
4341     wxAuiPaneInfo& pane = *(evt.pane);
4342
4343     if (evt.button == wxAUI_BUTTON_CLOSE)
4344     {
4345         // fire pane close event
4346         wxAuiManagerEvent e(wxEVT_AUI_PANE_CLOSE);
4347         e.SetManager(this);
4348         e.SetPane(evt.pane);
4349         ProcessMgrEvent(e);
4350
4351         if (!e.GetVeto())
4352         {
4353             // close the pane, but check that it
4354             // still exists in our pane array first
4355             // (the event handler above might have removed it)
4356
4357             wxAuiPaneInfo& check = GetPane(pane.window);
4358             if (check.IsOk())
4359             {
4360                 ClosePane(pane);
4361             }
4362
4363             Update();
4364         }
4365     }
4366     else if (evt.button == wxAUI_BUTTON_MAXIMIZE_RESTORE && !pane.IsMaximized())
4367     {
4368         // fire pane close event
4369         wxAuiManagerEvent e(wxEVT_AUI_PANE_MAXIMIZE);
4370         e.SetManager(this);
4371         e.SetPane(evt.pane);
4372         ProcessMgrEvent(e);
4373
4374         if (!e.GetVeto())
4375         {
4376             MaximizePane(pane);
4377             Update();
4378         }
4379     }
4380     else if (evt.button == wxAUI_BUTTON_MAXIMIZE_RESTORE && pane.IsMaximized())
4381     {
4382         // fire pane close event
4383         wxAuiManagerEvent e(wxEVT_AUI_PANE_RESTORE);
4384         e.SetManager(this);
4385         e.SetPane(evt.pane);
4386         ProcessMgrEvent(e);
4387
4388         if (!e.GetVeto())
4389         {
4390             RestorePane(pane);
4391             Update();
4392         }
4393     }
4394     else if (evt.button == wxAUI_BUTTON_PIN)
4395     {
4396         if ((m_flags & wxAUI_MGR_ALLOW_FLOATING) &&
4397             pane.IsFloatable())
4398                 pane.Float();
4399         Update();
4400     }
4401 }
4402
4403 #endif // wxUSE_AUI