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