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