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