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