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