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