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