]> git.saurik.com Git - wxWidgets.git/blame_incremental - src/aui/framemanager.cpp
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
put frame extents XGetWindowProperty code in one place
[wxWidgets.git] / src / aui / framemanager.cpp
... / ...
CommitLineData
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
44WX_CHECK_BUILD_OPTIONS("wxAUI")
45
46#include "wx/arrimpl.cpp"
47WX_DECLARE_OBJARRAY(wxRect, wxAuiRectArray);
48WX_DEFINE_OBJARRAY(wxAuiRectArray)
49WX_DEFINE_OBJARRAY(wxAuiDockUIPartArray)
50WX_DEFINE_OBJARRAY(wxAuiDockInfoArray)
51WX_DEFINE_OBJARRAY(wxAuiPaneButtonArray)
52WX_DEFINE_OBJARRAY(wxAuiPaneInfoArray)
53
54wxAuiPaneInfo wxAuiNullPaneInfo;
55wxAuiDockInfo wxAuiNullDockInfo;
56DEFINE_EVENT_TYPE(wxEVT_AUI_PANE_BUTTON)
57DEFINE_EVENT_TYPE(wxEVT_AUI_PANE_CLOSE)
58DEFINE_EVENT_TYPE(wxEVT_AUI_PANE_MAXIMIZE)
59DEFINE_EVENT_TYPE(wxEVT_AUI_PANE_RESTORE)
60DEFINE_EVENT_TYPE(wxEVT_AUI_RENDER)
61DEFINE_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
76IMPLEMENT_DYNAMIC_CLASS(wxAuiManagerEvent, wxEvent)
77IMPLEMENT_CLASS(wxAuiManager, wxEvtHandler)
78
79
80
81const int auiToolBarLayer = 10;
82
83#ifndef __WXGTK20__
84
85
86class wxPseudoTransparentFrame : public wxFrame
87{
88public:
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
195private:
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
209IMPLEMENT_DYNAMIC_CLASS(wxPseudoTransparentFrame, wxFrame)
210
211BEGIN_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
217END_EVENT_TABLE()
218
219
220#else
221 // __WXGTK20__
222
223#include <gtk/gtk.h>
224
225static void
226gtk_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
242class wxPseudoTransparentFrame: public wxFrame
243{
244public:
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
275private:
276 DECLARE_DYNAMIC_CLASS(wxPseudoTransparentFrame)
277};
278
279IMPLEMENT_DYNAMIC_CLASS(wxPseudoTransparentFrame, wxFrame)
280
281#endif
282 // __WXGTK20__
283
284
285
286// -- static utility functions --
287
288static 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
295static 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
318static 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
338static 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
355static 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
373static 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
390static 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
409static 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)
431static 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.
482static 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"
496static 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
518static 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
537static 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
551static 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
560BEGIN_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)
574END_EVENT_TABLE()
575
576
577wxAuiManager::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
598wxAuiManager::~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
628wxAuiFloatingFrame* 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
636bool 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)
644void 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)
659void 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
683wxAuiPaneInfo& 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
697wxAuiPaneInfo& 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
710wxAuiPaneInfoArray& 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
718wxAuiDockUIPart* 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
752void 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
772unsigned 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
780void wxAuiManager::SetFrame(wxFrame* frame)
781{
782 SetManagedWindow((wxWindow*)frame);
783}
784
785wxFrame* 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.
796wxAuiManager* 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
808void 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
893void 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
936void wxAuiManager::UnInit()
937{
938 if (m_frame)
939 {
940 m_frame->RemoveEventHandler(this);
941 }
942}
943
944// GetManagedWindow() returns the window pointer being managed
945wxWindow* wxAuiManager::GetManagedWindow() const
946{
947 return m_frame;
948}
949
950wxAuiDockArt* wxAuiManager::GetArtProvider() const
951{
952 return m_art;
953}
954
955void 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
972void 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
982bool 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 wxPtrToUInt(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
1085bool 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
1102bool 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
1116bool 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.
1177bool 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
1233void 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
1276void 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
1310void 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
1336void 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
1355static 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
1370wxString 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
1401void 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
1482wxString 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
1511bool 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
1598void 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
1689void 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
1859void 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
2015wxSizer* 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 if (middle->GetChildren().GetCount() > 0)
2367 cont->Add(middle, 1, wxEXPAND);
2368
2369
2370
2371 // find any bottom docks in this layer
2372 FindDocks(docks, wxAUI_DOCK_BOTTOM, layer, -1, arr);
2373 if (!arr.IsEmpty())
2374 {
2375 for (row = arr.GetCount()-1; row >= 0; --row)
2376 LayoutAddDock(cont, *arr.Item(row), uiparts, spacer_only);
2377 }
2378
2379 }
2380
2381 if (!cont)
2382 {
2383 // no sizer available, because there are no docks,
2384 // therefore we will create a simple background area
2385 cont = new wxBoxSizer(wxVERTICAL);
2386 wxSizerItem* sizer_item = cont->Add(1,1, 1, wxEXPAND);
2387 wxAuiDockUIPart part;
2388 part.type = wxAuiDockUIPart::typeBackground;
2389 part.pane = NULL;
2390 part.dock = NULL;
2391 part.button = NULL;
2392 part.cont_sizer = middle;
2393 part.sizer_item = sizer_item;
2394 uiparts.Add(part);
2395 }
2396
2397 container->Add(cont, 1, wxEXPAND);
2398 return container;
2399}
2400
2401
2402// SetDockSizeConstraint() allows the dock constraints to be set. For example,
2403// specifying values of 0.5, 0.5 will mean that upon dock creation, a dock may
2404// not be larger than half of the window's size
2405
2406void wxAuiManager::SetDockSizeConstraint(double width_pct, double height_pct)
2407{
2408 m_dock_constraint_x = wxMax(0.0, wxMin(1.0, width_pct));
2409 m_dock_constraint_y = wxMax(0.0, wxMin(1.0, height_pct));
2410}
2411
2412void wxAuiManager::GetDockSizeConstraint(double* width_pct, double* height_pct) const
2413{
2414 if (width_pct)
2415 *width_pct = m_dock_constraint_x;
2416
2417 if (height_pct)
2418 *height_pct = m_dock_constraint_y;
2419}
2420
2421
2422
2423// Update() updates the layout. Whenever changes are made to
2424// one or more panes, this function should be called. It is the
2425// external entry point for running the layout engine.
2426
2427void wxAuiManager::Update()
2428{
2429 m_hover_button = NULL;
2430
2431 wxSizer* sizer;
2432 int i, pane_count = m_panes.GetCount();
2433
2434
2435 // destroy floating panes which have been
2436 // redocked or are becoming non-floating
2437 for (i = 0; i < pane_count; ++i)
2438 {
2439 wxAuiPaneInfo& p = m_panes.Item(i);
2440
2441 if (!p.IsFloating() && p.frame)
2442 {
2443 // because the pane is no longer in a floating, we need to
2444 // reparent it to m_frame and destroy the floating frame
2445
2446 // reduce flicker
2447 p.window->SetSize(1,1);
2448
2449
2450 // the following block is a workaround for bug #1531361
2451 // (see wxWidgets sourceforge page). On wxGTK (only), when
2452 // a frame is shown/hidden, a move event unfortunately
2453 // also gets fired. Because we may be dragging around
2454 // a pane, we need to cancel that action here to prevent
2455 // a spurious crash.
2456 if (m_action_window == p.frame)
2457 {
2458 if (wxWindow::GetCapture() == m_frame)
2459 m_frame->ReleaseMouse();
2460 m_action = actionNone;
2461 m_action_window = NULL;
2462 }
2463
2464 // hide the frame
2465 if (p.frame->IsShown())
2466 p.frame->Show(false);
2467
2468 // reparent to m_frame and destroy the pane
2469 if (m_action_window == p.frame)
2470 {
2471 m_action_window = NULL;
2472 }
2473
2474 p.window->Reparent(m_frame);
2475 p.frame->SetSizer(NULL);
2476 p.frame->Destroy();
2477 p.frame = NULL;
2478 }
2479 }
2480
2481
2482 // delete old sizer first
2483 m_frame->SetSizer(NULL);
2484
2485 // create a layout for all of the panes
2486 sizer = LayoutAll(m_panes, m_docks, m_uiparts, false);
2487
2488 // hide or show panes as necessary,
2489 // and float panes as necessary
2490 for (i = 0; i < pane_count; ++i)
2491 {
2492 wxAuiPaneInfo& p = m_panes.Item(i);
2493
2494 if (p.IsFloating())
2495 {
2496 if (p.frame == NULL)
2497 {
2498 // we need to create a frame for this
2499 // pane, which has recently been floated
2500 wxAuiFloatingFrame* frame = CreateFloatingFrame(m_frame, p);
2501
2502 // on MSW and Mac, if the owner desires transparent dragging, and
2503 // the dragging is happening right now, then the floating
2504 // window should have this style by default
2505 if (m_action == actionDragFloatingPane &&
2506 (m_flags & wxAUI_MGR_TRANSPARENT_DRAG))
2507 frame->SetTransparent(150);
2508
2509 frame->SetPaneWindow(p);
2510 p.frame = frame;
2511
2512 if (p.IsShown() && !frame->IsShown())
2513 frame->Show();
2514 }
2515 else
2516 {
2517 // frame already exists, make sure it's position
2518 // and size reflect the information in wxAuiPaneInfo
2519 if ((p.frame->GetPosition() != p.floating_pos) || (p.frame->GetSize() != p.floating_size))
2520 {
2521 p.frame->SetSize(p.floating_pos.x, p.floating_pos.y,
2522 p.floating_size.x, p.floating_size.y,
2523 wxSIZE_USE_EXISTING);
2524 /*
2525 p.frame->SetSize(p.floating_pos.x, p.floating_pos.y,
2526 wxDefaultCoord, wxDefaultCoord,
2527 wxSIZE_USE_EXISTING);
2528 //p.frame->Move(p.floating_pos.x, p.floating_pos.y);
2529 */
2530 }
2531
2532 if (p.frame->IsShown() != p.IsShown())
2533 p.frame->Show(p.IsShown());
2534 }
2535 }
2536 else
2537 {
2538 if (p.window->IsShown() != p.IsShown())
2539 p.window->Show(p.IsShown());
2540 }
2541
2542 // if "active panes" are no longer allowed, clear
2543 // any optionActive values from the pane states
2544 if ((m_flags & wxAUI_MGR_ALLOW_ACTIVE_PANE) == 0)
2545 {
2546 p.state &= ~wxAuiPaneInfo::optionActive;
2547 }
2548 }
2549
2550
2551 // keep track of the old window rectangles so we can
2552 // refresh those windows whose rect has changed
2553 wxAuiRectArray old_pane_rects;
2554 for (i = 0; i < pane_count; ++i)
2555 {
2556 wxRect r;
2557 wxAuiPaneInfo& p = m_panes.Item(i);
2558
2559 if (p.window && p.IsShown() && p.IsDocked())
2560 r = p.rect;
2561
2562 old_pane_rects.Add(r);
2563 }
2564
2565
2566
2567
2568 // apply the new sizer
2569 m_frame->SetSizer(sizer);
2570 m_frame->SetAutoLayout(false);
2571 DoFrameLayout();
2572
2573
2574
2575 // now that the frame layout is done, we need to check
2576 // the new pane rectangles against the old rectangles that
2577 // we saved a few lines above here. If the rectangles have
2578 // changed, the corresponding panes must also be updated
2579 for (i = 0; i < pane_count; ++i)
2580 {
2581 wxAuiPaneInfo& p = m_panes.Item(i);
2582 if (p.window && p.window->IsShown() && p.IsDocked())
2583 {
2584 if (p.rect != old_pane_rects[i])
2585 {
2586 p.window->Refresh();
2587 p.window->Update();
2588 }
2589 }
2590 }
2591
2592
2593 Repaint();
2594
2595 // set frame's minimum size
2596
2597/*
2598 // N.B. More work needs to be done on frame minimum sizes;
2599 // this is some intresting code that imposes the minimum size,
2600 // but we may want to include a more flexible mechanism or
2601 // options for multiple minimum-size modes, e.g. strict or lax
2602 wxSize min_size = sizer->GetMinSize();
2603 wxSize frame_size = m_frame->GetSize();
2604 wxSize client_size = m_frame->GetClientSize();
2605
2606 wxSize minframe_size(min_size.x+frame_size.x-client_size.x,
2607 min_size.y+frame_size.y-client_size.y );
2608
2609 m_frame->SetMinSize(minframe_size);
2610
2611 if (frame_size.x < minframe_size.x ||
2612 frame_size.y < minframe_size.y)
2613 sizer->Fit(m_frame);
2614*/
2615}
2616
2617
2618// DoFrameLayout() is an internal function which invokes wxSizer::Layout
2619// on the frame's main sizer, then measures all the various UI items
2620// and updates their internal rectangles. This should always be called
2621// instead of calling m_frame->Layout() directly
2622
2623void wxAuiManager::DoFrameLayout()
2624{
2625 m_frame->Layout();
2626
2627 int i, part_count;
2628 for (i = 0, part_count = m_uiparts.GetCount(); i < part_count; ++i)
2629 {
2630 wxAuiDockUIPart& part = m_uiparts.Item(i);
2631
2632 // get the rectangle of the UI part
2633 // originally, this code looked like this:
2634 // part.rect = wxRect(part.sizer_item->GetPosition(),
2635 // part.sizer_item->GetSize());
2636 // this worked quite well, with one exception: the mdi
2637 // client window had a "deferred" size variable
2638 // that returned the wrong size. It looks like
2639 // a bug in wx, because the former size of the window
2640 // was being returned. So, we will retrieve the part's
2641 // rectangle via other means
2642
2643
2644 part.rect = part.sizer_item->GetRect();
2645 int flag = part.sizer_item->GetFlag();
2646 int border = part.sizer_item->GetBorder();
2647 if (flag & wxTOP)
2648 {
2649 part.rect.y -= border;
2650 part.rect.height += border;
2651 }
2652 if (flag & wxLEFT)
2653 {
2654 part.rect.x -= border;
2655 part.rect.width += border;
2656 }
2657 if (flag & wxBOTTOM)
2658 part.rect.height += border;
2659 if (flag & wxRIGHT)
2660 part.rect.width += border;
2661
2662
2663 if (part.type == wxAuiDockUIPart::typeDock)
2664 part.dock->rect = part.rect;
2665 if (part.type == wxAuiDockUIPart::typePane)
2666 part.pane->rect = part.rect;
2667 }
2668}
2669
2670// GetPanePart() looks up the pane the pane border UI part (or the regular
2671// pane part if there is no border). This allows the caller to get the exact
2672// rectangle of the pane in question, including decorations like
2673// caption and border (if any).
2674
2675wxAuiDockUIPart* wxAuiManager::GetPanePart(wxWindow* wnd)
2676{
2677 int i, part_count;
2678 for (i = 0, part_count = m_uiparts.GetCount(); i < part_count; ++i)
2679 {
2680 wxAuiDockUIPart& part = m_uiparts.Item(i);
2681 if (part.type == wxAuiDockUIPart::typePaneBorder &&
2682 part.pane && part.pane->window == wnd)
2683 return &part;
2684 }
2685 for (i = 0, part_count = m_uiparts.GetCount(); i < part_count; ++i)
2686 {
2687 wxAuiDockUIPart& part = m_uiparts.Item(i);
2688 if (part.type == wxAuiDockUIPart::typePane &&
2689 part.pane && part.pane->window == wnd)
2690 return &part;
2691 }
2692 return NULL;
2693}
2694
2695
2696
2697// GetDockPixelOffset() is an internal function which returns
2698// a dock's offset in pixels from the left side of the window
2699// (for horizontal docks) or from the top of the window (for
2700// vertical docks). This value is necessary for calculating
2701// fixel-pane/toolbar offsets when they are dragged.
2702
2703int wxAuiManager::GetDockPixelOffset(wxAuiPaneInfo& test)
2704{
2705 // the only way to accurately calculate the dock's
2706 // offset is to actually run a theoretical layout
2707
2708 int i, part_count, dock_count;
2709 wxAuiDockInfoArray docks;
2710 wxAuiPaneInfoArray panes;
2711 wxAuiDockUIPartArray uiparts;
2712 CopyDocksAndPanes(docks, panes, m_docks, m_panes);
2713 panes.Add(test);
2714
2715 wxSizer* sizer = LayoutAll(panes, docks, uiparts, true);
2716 wxSize client_size = m_frame->GetClientSize();
2717 sizer->SetDimension(0, 0, client_size.x, client_size.y);
2718 sizer->Layout();
2719
2720 for (i = 0, part_count = uiparts.GetCount(); i < part_count; ++i)
2721 {
2722 wxAuiDockUIPart& part = uiparts.Item(i);
2723 part.rect = wxRect(part.sizer_item->GetPosition(),
2724 part.sizer_item->GetSize());
2725 if (part.type == wxAuiDockUIPart::typeDock)
2726 part.dock->rect = part.rect;
2727 }
2728
2729 delete sizer;
2730
2731 for (i = 0, dock_count = docks.GetCount(); i < dock_count; ++i)
2732 {
2733 wxAuiDockInfo& dock = docks.Item(i);
2734 if (test.dock_direction == dock.dock_direction &&
2735 test.dock_layer==dock.dock_layer && test.dock_row==dock.dock_row)
2736 {
2737 if (dock.IsVertical())
2738 return dock.rect.y;
2739 else
2740 return dock.rect.x;
2741 }
2742 }
2743
2744 return 0;
2745}
2746
2747
2748
2749// ProcessDockResult() is a utility function used by DoDrop() - it checks
2750// if a dock operation is allowed, the new dock position is copied into
2751// the target info. If the operation was allowed, the function returns true.
2752
2753bool wxAuiManager::ProcessDockResult(wxAuiPaneInfo& target,
2754 const wxAuiPaneInfo& new_pos)
2755{
2756 bool allowed = false;
2757 switch (new_pos.dock_direction)
2758 {
2759 case wxAUI_DOCK_TOP: allowed = target.IsTopDockable(); break;
2760 case wxAUI_DOCK_BOTTOM: allowed = target.IsBottomDockable(); break;
2761 case wxAUI_DOCK_LEFT: allowed = target.IsLeftDockable(); break;
2762 case wxAUI_DOCK_RIGHT: allowed = target.IsRightDockable(); break;
2763 }
2764
2765 if (allowed)
2766 target = new_pos;
2767
2768 return allowed;
2769}
2770
2771
2772// DoDrop() is an important function. It basically takes a mouse position,
2773// and determines where the pane's new position would be. If the pane is to be
2774// dropped, it performs the drop operation using the specified dock and pane
2775// arrays. By specifying copied dock and pane arrays when calling, a "what-if"
2776// scenario can be performed, giving precise coordinates for drop hints.
2777// If, however, wxAuiManager:m_docks and wxAuiManager::m_panes are specified
2778// as parameters, the changes will be made to the main state arrays
2779
2780const int auiInsertRowPixels = 10;
2781const int auiNewRowPixels = 40;
2782const int auiLayerInsertPixels = 40;
2783const int auiLayerInsertOffset = 5;
2784
2785bool wxAuiManager::DoDrop(wxAuiDockInfoArray& docks,
2786 wxAuiPaneInfoArray& panes,
2787 wxAuiPaneInfo& target,
2788 const wxPoint& pt,
2789 const wxPoint& offset)
2790{
2791 wxSize cli_size = m_frame->GetClientSize();
2792
2793 wxAuiPaneInfo drop = target;
2794
2795
2796 // The result should always be shown
2797 drop.Show();
2798
2799
2800 // Check to see if the pane has been dragged outside of the window
2801 // (or near to the outside of the window), if so, dock it along the edge
2802
2803
2804 int layer_insert_offset = auiLayerInsertOffset;
2805 if (drop.IsToolbar())
2806 layer_insert_offset = 0;
2807
2808
2809 if (pt.x < layer_insert_offset &&
2810 pt.x > layer_insert_offset-auiLayerInsertPixels)
2811 {
2812 int new_layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_LEFT),
2813 GetMaxLayer(docks, wxAUI_DOCK_BOTTOM)),
2814 GetMaxLayer(docks, wxAUI_DOCK_TOP)) + 1;
2815
2816 if (drop.IsToolbar())
2817 new_layer = auiToolBarLayer;
2818
2819 drop.Dock().Left().
2820 Layer(new_layer).
2821 Row(0).
2822 Position(pt.y - GetDockPixelOffset(drop) - offset.y);
2823 return ProcessDockResult(target, drop);
2824 }
2825 else if (pt.y < layer_insert_offset &&
2826 pt.y > layer_insert_offset-auiLayerInsertPixels)
2827 {
2828 int new_layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_TOP),
2829 GetMaxLayer(docks, wxAUI_DOCK_LEFT)),
2830 GetMaxLayer(docks, wxAUI_DOCK_RIGHT)) + 1;
2831
2832 if (drop.IsToolbar())
2833 new_layer = auiToolBarLayer;
2834
2835 drop.Dock().Top().
2836 Layer(new_layer).
2837 Row(0).
2838 Position(pt.x - GetDockPixelOffset(drop) - offset.x);
2839 return ProcessDockResult(target, drop);
2840 }
2841 else if (pt.x >= cli_size.x - layer_insert_offset &&
2842 pt.x < cli_size.x - layer_insert_offset + auiLayerInsertPixels)
2843 {
2844 int new_layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_RIGHT),
2845 GetMaxLayer(docks, wxAUI_DOCK_TOP)),
2846 GetMaxLayer(docks, wxAUI_DOCK_BOTTOM)) + 1;
2847
2848 if (drop.IsToolbar())
2849 new_layer = auiToolBarLayer;
2850
2851 drop.Dock().Right().
2852 Layer(new_layer).
2853 Row(0).
2854 Position(pt.y - GetDockPixelOffset(drop) - offset.y);
2855 return ProcessDockResult(target, drop);
2856 }
2857 else if (pt.y >= cli_size.y - layer_insert_offset &&
2858 pt.y < cli_size.y - layer_insert_offset + auiLayerInsertPixels)
2859 {
2860 int new_layer = wxMax( wxMax( GetMaxLayer(docks, wxAUI_DOCK_BOTTOM),
2861 GetMaxLayer(docks, wxAUI_DOCK_LEFT)),
2862 GetMaxLayer(docks, wxAUI_DOCK_RIGHT)) + 1;
2863
2864 if (drop.IsToolbar())
2865 new_layer = auiToolBarLayer;
2866
2867 drop.Dock().Bottom().
2868 Layer(new_layer).
2869 Row(0).
2870 Position(pt.x - GetDockPixelOffset(drop) - offset.x);
2871 return ProcessDockResult(target, drop);
2872 }
2873
2874
2875 wxAuiDockUIPart* part = HitTest(pt.x, pt.y);
2876
2877
2878 if (drop.IsToolbar())
2879 {
2880 if (!part || !part->dock)
2881 return false;
2882
2883 // calculate the offset from where the dock begins
2884 // to the point where the user dropped the pane
2885 int dock_drop_offset = 0;
2886 if (part->dock->IsHorizontal())
2887 dock_drop_offset = pt.x - part->dock->rect.x - offset.x;
2888 else
2889 dock_drop_offset = pt.y - part->dock->rect.y - offset.y;
2890
2891
2892 // toolbars may only be moved in and to fixed-pane docks,
2893 // otherwise we will try to float the pane. Also, the pane
2894 // should float if being dragged over center pane windows
2895 if (!part->dock->fixed || part->dock->dock_direction == wxAUI_DOCK_CENTER)
2896 {
2897 if (m_last_rect.IsEmpty() || m_last_rect.Contains(pt.x, pt.y ))
2898 {
2899 m_skipping = true;
2900 }
2901 else
2902 {
2903 if ((m_flags & wxAUI_MGR_ALLOW_FLOATING) &&
2904 (drop.IsFloatable() ||
2905 (part->dock->dock_direction != wxAUI_DOCK_CENTER &&
2906 part->dock->dock_direction != wxAUI_DOCK_NONE)))
2907 {
2908 drop.Float();
2909 }
2910
2911 m_skipping = false;
2912
2913 return ProcessDockResult(target, drop);
2914 }
2915
2916 drop.Position(pt.x - GetDockPixelOffset(drop) - offset.x);
2917
2918 return ProcessDockResult(target, drop);
2919 }
2920
2921 m_skipping = false;
2922
2923 m_last_rect = part->dock->rect;
2924 m_last_rect.Inflate( 15, 15 );
2925
2926 drop.Dock().
2927 Direction(part->dock->dock_direction).
2928 Layer(part->dock->dock_layer).
2929 Row(part->dock->dock_row).
2930 Position(dock_drop_offset);
2931
2932 if ((
2933 ((pt.y < part->dock->rect.y + 1) && part->dock->IsHorizontal()) ||
2934 ((pt.x < part->dock->rect.x + 1) && part->dock->IsVertical())
2935 ) && part->dock->panes.GetCount() > 1)
2936 {
2937 if ((part->dock->dock_direction == wxAUI_DOCK_TOP) ||
2938 (part->dock->dock_direction == wxAUI_DOCK_LEFT))
2939 {
2940 int row = drop.dock_row;
2941 DoInsertDockRow(panes, part->dock->dock_direction,
2942 part->dock->dock_layer,
2943 part->dock->dock_row);
2944 drop.dock_row = row;
2945 }
2946 else
2947 {
2948 DoInsertDockRow(panes, part->dock->dock_direction,
2949 part->dock->dock_layer,
2950 part->dock->dock_row+1);
2951 drop.dock_row = part->dock->dock_row+1;
2952 }
2953 }
2954
2955 if ((
2956 ((pt.y > part->dock->rect.y + part->dock->rect.height - 2 ) && part->dock->IsHorizontal()) ||
2957 ((pt.x > part->dock->rect.x + part->dock->rect.width - 2 ) && part->dock->IsVertical())
2958 ) && part->dock->panes.GetCount() > 1)
2959 {
2960 if ((part->dock->dock_direction == wxAUI_DOCK_TOP) ||
2961 (part->dock->dock_direction == wxAUI_DOCK_LEFT))
2962 {
2963 DoInsertDockRow(panes, part->dock->dock_direction,
2964 part->dock->dock_layer,
2965 part->dock->dock_row+1);
2966 drop.dock_row = part->dock->dock_row+1;
2967 }
2968 else
2969 {
2970 int row = drop.dock_row;
2971 DoInsertDockRow(panes, part->dock->dock_direction,
2972 part->dock->dock_layer,
2973 part->dock->dock_row);
2974 drop.dock_row = row;
2975 }
2976 }
2977
2978 return ProcessDockResult(target, drop);
2979 }
2980
2981
2982
2983
2984 if (!part)
2985 return false;
2986
2987 if (part->type == wxAuiDockUIPart::typePaneBorder ||
2988 part->type == wxAuiDockUIPart::typeCaption ||
2989 part->type == wxAuiDockUIPart::typeGripper ||
2990 part->type == wxAuiDockUIPart::typePaneButton ||
2991 part->type == wxAuiDockUIPart::typePane ||
2992 part->type == wxAuiDockUIPart::typePaneSizer ||
2993 part->type == wxAuiDockUIPart::typeDockSizer ||
2994 part->type == wxAuiDockUIPart::typeBackground)
2995 {
2996 if (part->type == wxAuiDockUIPart::typeDockSizer)
2997 {
2998 if (part->dock->panes.GetCount() != 1)
2999 return false;
3000 part = GetPanePart(part->dock->panes.Item(0)->window);
3001 if (!part)
3002 return false;
3003 }
3004
3005
3006
3007 // If a normal frame is being dragged over a toolbar, insert it
3008 // along the edge under the toolbar, but over all other panes.
3009 // (this could be done much better, but somehow factoring this
3010 // calculation with the one at the beginning of this function)
3011 if (part->dock && part->dock->toolbar)
3012 {
3013 int layer = 0;
3014
3015 switch (part->dock->dock_direction)
3016 {
3017 case wxAUI_DOCK_LEFT:
3018 layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_LEFT),
3019 GetMaxLayer(docks, wxAUI_DOCK_BOTTOM)),
3020 GetMaxLayer(docks, wxAUI_DOCK_TOP));
3021 break;
3022 case wxAUI_DOCK_TOP:
3023 layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_TOP),
3024 GetMaxLayer(docks, wxAUI_DOCK_LEFT)),
3025 GetMaxLayer(docks, wxAUI_DOCK_RIGHT));
3026 break;
3027 case wxAUI_DOCK_RIGHT:
3028 layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_RIGHT),
3029 GetMaxLayer(docks, wxAUI_DOCK_TOP)),
3030 GetMaxLayer(docks, wxAUI_DOCK_BOTTOM));
3031 break;
3032 case wxAUI_DOCK_BOTTOM:
3033 layer = wxMax(wxMax(GetMaxLayer(docks, wxAUI_DOCK_BOTTOM),
3034 GetMaxLayer(docks, wxAUI_DOCK_LEFT)),
3035 GetMaxLayer(docks, wxAUI_DOCK_RIGHT));
3036 break;
3037 }
3038
3039 DoInsertDockRow(panes, part->dock->dock_direction,
3040 layer, 0);
3041 drop.Dock().
3042 Direction(part->dock->dock_direction).
3043 Layer(layer).Row(0).Position(0);
3044 return ProcessDockResult(target, drop);
3045 }
3046
3047
3048 if (!part->pane)
3049 return false;
3050
3051 part = GetPanePart(part->pane->window);
3052 if (!part)
3053 return false;
3054
3055 bool insert_dock_row = false;
3056 int insert_row = part->pane->dock_row;
3057 int insert_dir = part->pane->dock_direction;
3058 int insert_layer = part->pane->dock_layer;
3059
3060 switch (part->pane->dock_direction)
3061 {
3062 case wxAUI_DOCK_TOP:
3063 if (pt.y >= part->rect.y &&
3064 pt.y < part->rect.y+auiInsertRowPixels)
3065 insert_dock_row = true;
3066 break;
3067 case wxAUI_DOCK_BOTTOM:
3068 if (pt.y > part->rect.y+part->rect.height-auiInsertRowPixels &&
3069 pt.y <= part->rect.y + part->rect.height)
3070 insert_dock_row = true;
3071 break;
3072 case wxAUI_DOCK_LEFT:
3073 if (pt.x >= part->rect.x &&
3074 pt.x < part->rect.x+auiInsertRowPixels)
3075 insert_dock_row = true;
3076 break;
3077 case wxAUI_DOCK_RIGHT:
3078 if (pt.x > part->rect.x+part->rect.width-auiInsertRowPixels &&
3079 pt.x <= part->rect.x+part->rect.width)
3080 insert_dock_row = true;
3081 break;
3082 case wxAUI_DOCK_CENTER:
3083 {
3084 // "new row pixels" will be set to the default, but
3085 // must never exceed 20% of the window size
3086 int new_row_pixels_x = auiNewRowPixels;
3087 int new_row_pixels_y = auiNewRowPixels;
3088
3089 if (new_row_pixels_x > (part->rect.width*20)/100)
3090 new_row_pixels_x = (part->rect.width*20)/100;
3091
3092 if (new_row_pixels_y > (part->rect.height*20)/100)
3093 new_row_pixels_y = (part->rect.height*20)/100;
3094
3095
3096 // determine if the mouse pointer is in a location that
3097 // will cause a new row to be inserted. The hot spot positions
3098 // are along the borders of the center pane
3099
3100 insert_layer = 0;
3101 insert_dock_row = true;
3102 const wxRect& pr = part->rect;
3103 if (pt.x >= pr.x && pt.x < pr.x + new_row_pixels_x)
3104 insert_dir = wxAUI_DOCK_LEFT;
3105 else if (pt.y >= pr.y && pt.y < pr.y + new_row_pixels_y)
3106 insert_dir = wxAUI_DOCK_TOP;
3107 else if (pt.x >= pr.x + pr.width - new_row_pixels_x &&
3108 pt.x < pr.x + pr.width)
3109 insert_dir = wxAUI_DOCK_RIGHT;
3110 else if (pt.y >= pr.y+ pr.height - new_row_pixels_y &&
3111 pt.y < pr.y + pr.height)
3112 insert_dir = wxAUI_DOCK_BOTTOM;
3113 else
3114 return false;
3115
3116 insert_row = GetMaxRow(panes, insert_dir, insert_layer) + 1;
3117 }
3118 }
3119
3120 if (insert_dock_row)
3121 {
3122 DoInsertDockRow(panes, insert_dir, insert_layer, insert_row);
3123 drop.Dock().Direction(insert_dir).
3124 Layer(insert_layer).
3125 Row(insert_row).
3126 Position(0);
3127 return ProcessDockResult(target, drop);
3128 }
3129
3130 // determine the mouse offset and the pane size, both in the
3131 // direction of the dock itself, and perpendicular to the dock
3132
3133 int offset, size;
3134
3135 if (part->orientation == wxVERTICAL)
3136 {
3137 offset = pt.y - part->rect.y;
3138 size = part->rect.GetHeight();
3139 }
3140 else
3141 {
3142 offset = pt.x - part->rect.x;
3143 size = part->rect.GetWidth();
3144 }
3145
3146 int drop_position = part->pane->dock_pos;
3147
3148 // if we are in the top/left part of the pane,
3149 // insert the pane before the pane being hovered over
3150 if (offset <= size/2)
3151 {
3152 drop_position = part->pane->dock_pos;
3153 DoInsertPane(panes,
3154 part->pane->dock_direction,
3155 part->pane->dock_layer,
3156 part->pane->dock_row,
3157 part->pane->dock_pos);
3158 }
3159
3160 // if we are in the bottom/right part of the pane,
3161 // insert the pane before the pane being hovered over
3162 if (offset > size/2)
3163 {
3164 drop_position = part->pane->dock_pos+1;
3165 DoInsertPane(panes,
3166 part->pane->dock_direction,
3167 part->pane->dock_layer,
3168 part->pane->dock_row,
3169 part->pane->dock_pos+1);
3170 }
3171
3172 drop.Dock().
3173 Direction(part->dock->dock_direction).
3174 Layer(part->dock->dock_layer).
3175 Row(part->dock->dock_row).
3176 Position(drop_position);
3177 return ProcessDockResult(target, drop);
3178 }
3179
3180 return false;
3181}
3182
3183
3184void wxAuiManager::OnHintFadeTimer(wxTimerEvent& WXUNUSED(event))
3185{
3186 if (!m_hint_wnd || m_hint_fadeamt >= m_hint_fademax)
3187 {
3188 m_hint_fadetimer.Stop();
3189 return;
3190 }
3191
3192 m_hint_fadeamt += 4;
3193 m_hint_wnd->SetTransparent(m_hint_fadeamt);
3194}
3195
3196void wxAuiManager::ShowHint(const wxRect& rect)
3197{
3198 if (m_hint_wnd)
3199 {
3200 // if the hint rect is the same as last time, don't do anything
3201 if (m_last_hint == rect)
3202 return;
3203 m_last_hint = rect;
3204
3205 m_hint_fadeamt = m_hint_fademax;
3206
3207 if ((m_flags & wxAUI_MGR_HINT_FADE)
3208 && !((m_hint_wnd->IsKindOf(CLASSINFO(wxPseudoTransparentFrame))) &&
3209 (m_flags & wxAUI_MGR_NO_VENETIAN_BLINDS_FADE))
3210 )
3211 m_hint_fadeamt = 0;
3212
3213 m_hint_wnd->SetSize(rect);
3214 m_hint_wnd->SetTransparent(m_hint_fadeamt);
3215
3216 if (!m_hint_wnd->IsShown())
3217 m_hint_wnd->Show();
3218
3219 // if we are dragging a floating pane, set the focus
3220 // back to that floating pane (otherwise it becomes unfocused)
3221 if (m_action == actionDragFloatingPane && m_action_window)
3222 m_action_window->SetFocus();
3223
3224 m_hint_wnd->Raise();
3225
3226
3227 if (m_hint_fadeamt != m_hint_fademax) // Only fade if we need to
3228 {
3229 // start fade in timer
3230 m_hint_fadetimer.SetOwner(this, 101);
3231 m_hint_fadetimer.Start(5);
3232 }
3233 }
3234 else // Not using a transparent hint window...
3235 {
3236 if (!(m_flags & wxAUI_MGR_RECTANGLE_HINT))
3237 return;
3238
3239 if (m_last_hint != rect)
3240 {
3241 // remove the last hint rectangle
3242 m_last_hint = rect;
3243 m_frame->Refresh();
3244 m_frame->Update();
3245 }
3246
3247 wxScreenDC screendc;
3248 wxRegion clip(1, 1, 10000, 10000);
3249
3250 // clip all floating windows, so we don't draw over them
3251 int i, pane_count;
3252 for (i = 0, pane_count = m_panes.GetCount(); i < pane_count; ++i)
3253 {
3254 wxAuiPaneInfo& pane = m_panes.Item(i);
3255
3256 if (pane.IsFloating() &&
3257 pane.frame->IsShown())
3258 {
3259 wxRect rect = pane.frame->GetRect();
3260#ifdef __WXGTK__
3261 // wxGTK returns the client size, not the whole frame size
3262 rect.width += 15;
3263 rect.height += 35;
3264 rect.Inflate(5);
3265#endif
3266
3267 clip.Subtract(rect);
3268 }
3269 }
3270
3271 // As we can only hide the hint by redrawing the managed window, we
3272 // need to clip the region to the managed window too or we get
3273 // nasty redrawn problems.
3274 clip.Intersect(m_frame->GetRect());
3275
3276 screendc.SetClippingRegion(clip);
3277
3278 wxBitmap stipple = wxPaneCreateStippleBitmap();
3279 wxBrush brush(stipple);
3280 screendc.SetBrush(brush);
3281 screendc.SetPen(*wxTRANSPARENT_PEN);
3282
3283 screendc.DrawRectangle(rect.x, rect.y, 5, rect.height);
3284 screendc.DrawRectangle(rect.x+5, rect.y, rect.width-10, 5);
3285 screendc.DrawRectangle(rect.x+rect.width-5, rect.y, 5, rect.height);
3286 screendc.DrawRectangle(rect.x+5, rect.y+rect.height-5, rect.width-10, 5);
3287 }
3288}
3289
3290void wxAuiManager::HideHint()
3291{
3292 // hides a transparent window hint, if there is one
3293 if (m_hint_wnd)
3294 {
3295 if (m_hint_wnd->IsShown())
3296 m_hint_wnd->Show(false);
3297 m_hint_wnd->SetTransparent(0);
3298 m_hint_fadetimer.Stop();
3299 m_last_hint = wxRect();
3300 return;
3301 }
3302
3303 // hides a painted hint by redrawing the frame window
3304 if (!m_last_hint.IsEmpty())
3305 {
3306 m_frame->Refresh();
3307 m_frame->Update();
3308 m_last_hint = wxRect();
3309 }
3310}
3311
3312
3313
3314void wxAuiManager::StartPaneDrag(wxWindow* pane_window,
3315 const wxPoint& offset)
3316{
3317 wxAuiPaneInfo& pane = GetPane(pane_window);
3318 if (!pane.IsOk())
3319 return;
3320
3321 if (pane.IsToolbar())
3322 {
3323 m_action = actionDragToolbarPane;
3324 }
3325 else
3326 {
3327 m_action = actionDragFloatingPane;
3328 }
3329
3330 m_action_window = pane_window;
3331 m_action_offset = offset;
3332 m_frame->CaptureMouse();
3333}
3334
3335
3336// CalculateHintRect() calculates the drop hint rectangle. The method
3337// first calls DoDrop() to determine the exact position the pane would
3338// be at were if dropped. If the pane would indeed become docked at the
3339// specified drop point, the the rectangle hint will be returned in
3340// screen coordinates. Otherwise, an empty rectangle is returned.
3341// |pane_window| is the window pointer of the pane being dragged, |pt| is
3342// the mouse position, in client coordinates. |offset| describes the offset
3343// that the mouse is from the upper-left corner of the item being dragged
3344
3345wxRect wxAuiManager::CalculateHintRect(wxWindow* pane_window,
3346 const wxPoint& pt,
3347 const wxPoint& offset)
3348{
3349 wxRect rect;
3350
3351 // we need to paint a hint rectangle; to find out the exact hint rectangle,
3352 // we will create a new temporary layout and then measure the resulting
3353 // rectangle; we will create a copy of the docking structures (m_dock)
3354 // so that we don't modify the real thing on screen
3355
3356 int i, pane_count, part_count;
3357 wxAuiDockInfoArray docks;
3358 wxAuiPaneInfoArray panes;
3359 wxAuiDockUIPartArray uiparts;
3360 wxAuiPaneInfo hint = GetPane(pane_window);
3361 hint.name = wxT("__HINT__");
3362 hint.PaneBorder(true);
3363 hint.Show();
3364
3365 if (!hint.IsOk())
3366 return rect;
3367
3368 CopyDocksAndPanes(docks, panes, m_docks, m_panes);
3369
3370 // remove any pane already there which bears the same window;
3371 // this happens when you are moving a pane around in a dock
3372 for (i = 0, pane_count = panes.GetCount(); i < pane_count; ++i)
3373 {
3374 if (panes.Item(i).window == pane_window)
3375 {
3376 RemovePaneFromDocks(docks, panes.Item(i));
3377 panes.RemoveAt(i);
3378 break;
3379 }
3380 }
3381
3382 // find out where the new pane would be
3383 if (!DoDrop(docks, panes, hint, pt, offset))
3384 {
3385 return rect;
3386 }
3387
3388 panes.Add(hint);
3389
3390 wxSizer* sizer = LayoutAll(panes, docks, uiparts, true);
3391 wxSize client_size = m_frame->GetClientSize();
3392 sizer->SetDimension(0, 0, client_size.x, client_size.y);
3393 sizer->Layout();
3394
3395 for (i = 0, part_count = uiparts.GetCount();
3396 i < part_count; ++i)
3397 {
3398 wxAuiDockUIPart& part = uiparts.Item(i);
3399
3400 if (part.type == wxAuiDockUIPart::typePaneBorder &&
3401 part.pane && part.pane->name == wxT("__HINT__"))
3402 {
3403 rect = wxRect(part.sizer_item->GetPosition(),
3404 part.sizer_item->GetSize());
3405 break;
3406 }
3407 }
3408
3409 delete sizer;
3410
3411 if (rect.IsEmpty())
3412 {
3413 return rect;
3414 }
3415
3416 // actually show the hint rectangle on the screen
3417 m_frame->ClientToScreen(&rect.x, &rect.y);
3418
3419 if ( m_frame->GetLayoutDirection() == wxLayout_RightToLeft )
3420 {
3421 // Mirror rectangle in RTL mode
3422 rect.x -= rect.GetWidth();
3423 }
3424
3425 return rect;
3426}
3427
3428// DrawHintRect() calculates the hint rectangle by calling
3429// CalculateHintRect(). If there is a rectangle, it shows it
3430// by calling ShowHint(), otherwise it hides any hint
3431// rectangle currently shown
3432void wxAuiManager::DrawHintRect(wxWindow* pane_window,
3433 const wxPoint& pt,
3434 const wxPoint& offset)
3435{
3436 wxRect rect = CalculateHintRect(pane_window, pt, offset);
3437
3438 if (rect.IsEmpty())
3439 {
3440 HideHint();
3441 }
3442 else
3443 {
3444 ShowHint(rect);
3445 }
3446}
3447
3448void wxAuiManager::OnFloatingPaneMoveStart(wxWindow* wnd)
3449{
3450 // try to find the pane
3451 wxAuiPaneInfo& pane = GetPane(wnd);
3452 wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
3453
3454 if (m_flags & wxAUI_MGR_TRANSPARENT_DRAG)
3455 pane.frame->SetTransparent(150);
3456}
3457
3458void wxAuiManager::OnFloatingPaneMoving(wxWindow* wnd, wxDirection dir)
3459{
3460 // try to find the pane
3461 wxAuiPaneInfo& pane = GetPane(wnd);
3462 wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
3463
3464 wxPoint pt = ::wxGetMousePosition();
3465
3466#if 0
3467 // Adapt pt to direction
3468 if (dir == wxNORTH)
3469 {
3470 // move to pane's upper border
3471 wxPoint pos( 0,0 );
3472 pos = wnd->ClientToScreen( pos );
3473 pt.y = pos.y;
3474 // and some more pixels for the title bar
3475 pt.y -= 5;
3476 }
3477 else if (dir == wxWEST)
3478 {
3479 // move to pane's left border
3480 wxPoint pos( 0,0 );
3481 pos = wnd->ClientToScreen( pos );
3482 pt.x = pos.x;
3483 }
3484 else if (dir == wxEAST)
3485 {
3486 // move to pane's right border
3487 wxPoint pos( wnd->GetSize().x, 0 );
3488 pos = wnd->ClientToScreen( pos );
3489 pt.x = pos.x;
3490 }
3491 else if (dir == wxSOUTH)
3492 {
3493 // move to pane's bottom border
3494 wxPoint pos( 0, wnd->GetSize().y );
3495 pos = wnd->ClientToScreen( pos );
3496 pt.y = pos.y;
3497 }
3498#else
3499 wxUnusedVar(dir);
3500#endif
3501
3502 wxPoint client_pt = m_frame->ScreenToClient(pt);
3503
3504 // calculate the offset from the upper left-hand corner
3505 // of the frame to the mouse pointer
3506 wxPoint frame_pos = pane.frame->GetPosition();
3507 wxPoint action_offset(pt.x-frame_pos.x, pt.y-frame_pos.y);
3508
3509 // no hint for toolbar floating windows
3510 if (pane.IsToolbar() && m_action == actionDragFloatingPane)
3511 {
3512 wxAuiDockInfoArray docks;
3513 wxAuiPaneInfoArray panes;
3514 wxAuiDockUIPartArray uiparts;
3515 wxAuiPaneInfo hint = pane;
3516
3517 CopyDocksAndPanes(docks, panes, m_docks, m_panes);
3518
3519 // find out where the new pane would be
3520 if (!DoDrop(docks, panes, hint, client_pt))
3521 return;
3522 if (hint.IsFloating())
3523 return;
3524
3525 pane = hint;
3526 m_action = actionDragToolbarPane;
3527 m_action_window = pane.window;
3528
3529 Update();
3530
3531 return;
3532 }
3533
3534
3535 // if a key modifier is pressed while dragging the frame,
3536 // don't dock the window
3537 if (!CanDockPanel(pane))
3538 {
3539 HideHint();
3540 return;
3541 }
3542
3543
3544 DrawHintRect(wnd, client_pt, action_offset);
3545
3546#ifdef __WXGTK__
3547 // this cleans up some screen artifacts that are caused on GTK because
3548 // we aren't getting the exact size of the window (see comment
3549 // in DrawHintRect)
3550 //Refresh();
3551#endif
3552
3553
3554 // reduces flicker
3555 m_frame->Update();
3556}
3557
3558void wxAuiManager::OnFloatingPaneMoved(wxWindow* wnd, wxDirection dir)
3559{
3560 // try to find the pane
3561 wxAuiPaneInfo& pane = GetPane(wnd);
3562 wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
3563
3564 wxPoint pt = ::wxGetMousePosition();
3565
3566#if 0
3567 // Adapt pt to direction
3568 if (dir == wxNORTH)
3569 {
3570 // move to pane's upper border
3571 wxPoint pos( 0,0 );
3572 pos = wnd->ClientToScreen( pos );
3573 pt.y = pos.y;
3574 // and some more pixels for the title bar
3575 pt.y -= 10;
3576 }
3577 else if (dir == wxWEST)
3578 {
3579 // move to pane's left border
3580 wxPoint pos( 0,0 );
3581 pos = wnd->ClientToScreen( pos );
3582 pt.x = pos.x;
3583 }
3584 else if (dir == wxEAST)
3585 {
3586 // move to pane's right border
3587 wxPoint pos( wnd->GetSize().x, 0 );
3588 pos = wnd->ClientToScreen( pos );
3589 pt.x = pos.x;
3590 }
3591 else if (dir == wxSOUTH)
3592 {
3593 // move to pane's bottom border
3594 wxPoint pos( 0, wnd->GetSize().y );
3595 pos = wnd->ClientToScreen( pos );
3596 pt.y = pos.y;
3597 }
3598#else
3599 wxUnusedVar(dir);
3600#endif
3601
3602 wxPoint client_pt = m_frame->ScreenToClient(pt);
3603
3604 // calculate the offset from the upper left-hand corner
3605 // of the frame to the mouse pointer
3606 wxPoint frame_pos = pane.frame->GetPosition();
3607 wxPoint action_offset(pt.x-frame_pos.x, pt.y-frame_pos.y);
3608
3609
3610 // if a key modifier is pressed while dragging the frame,
3611 // don't dock the window
3612 if (CanDockPanel(pane))
3613 {
3614 // do the drop calculation
3615 DoDrop(m_docks, m_panes, pane, client_pt, action_offset);
3616 }
3617
3618 // if the pane is still floating, update it's floating
3619 // position (that we store)
3620 if (pane.IsFloating())
3621 {
3622 pane.floating_pos = pane.frame->GetPosition();
3623
3624 if (m_flags & wxAUI_MGR_TRANSPARENT_DRAG)
3625 pane.frame->SetTransparent(255);
3626 }
3627 else if (m_has_maximized)
3628 {
3629 RestoreMaximizedPane();
3630 }
3631
3632 Update();
3633
3634 HideHint();
3635}
3636
3637void wxAuiManager::OnFloatingPaneResized(wxWindow* wnd, const wxSize& size)
3638{
3639 // try to find the pane
3640 wxAuiPaneInfo& pane = GetPane(wnd);
3641 wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
3642
3643 pane.floating_size = size;
3644}
3645
3646
3647void wxAuiManager::OnFloatingPaneClosed(wxWindow* wnd, wxCloseEvent& evt)
3648{
3649 // try to find the pane
3650 wxAuiPaneInfo& pane = GetPane(wnd);
3651 wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
3652
3653
3654 // fire pane close event
3655 wxAuiManagerEvent e(wxEVT_AUI_PANE_CLOSE);
3656 e.SetPane(&pane);
3657 e.SetCanVeto(evt.CanVeto());
3658 ProcessMgrEvent(e);
3659
3660 if (e.GetVeto())
3661 {
3662 evt.Veto();
3663 return;
3664 }
3665 else
3666 {
3667 // close the pane, but check that it
3668 // still exists in our pane array first
3669 // (the event handler above might have removed it)
3670
3671 wxAuiPaneInfo& check = GetPane(wnd);
3672 if (check.IsOk())
3673 {
3674 ClosePane(pane);
3675 }
3676 }
3677}
3678
3679
3680
3681void wxAuiManager::OnFloatingPaneActivated(wxWindow* wnd)
3682{
3683 if ((GetFlags() & wxAUI_MGR_ALLOW_ACTIVE_PANE) && GetPane(wnd).IsOk())
3684 {
3685 SetActivePane(m_panes, wnd);
3686 Repaint();
3687 }
3688}
3689
3690// OnRender() draws all of the pane captions, sashes,
3691// backgrounds, captions, grippers, pane borders and buttons.
3692// It renders the entire user interface.
3693
3694void wxAuiManager::OnRender(wxAuiManagerEvent& evt)
3695{
3696 // if the frame is about to be deleted, don't bother
3697 if (!m_frame || wxPendingDelete.Member(m_frame))
3698 return;
3699
3700 wxDC* dc = evt.GetDC();
3701
3702#ifdef __WXMAC__
3703 dc->Clear() ;
3704#endif
3705 int i, part_count;
3706 for (i = 0, part_count = m_uiparts.GetCount();
3707 i < part_count; ++i)
3708 {
3709 wxAuiDockUIPart& part = m_uiparts.Item(i);
3710
3711 // don't draw hidden pane items or items that aren't windows
3712 if (part.sizer_item && ((!part.sizer_item->IsWindow() && !part.sizer_item->IsSpacer() && !part.sizer_item->IsSizer()) || !part.sizer_item->IsShown()))
3713 continue;
3714
3715 switch (part.type)
3716 {
3717 case wxAuiDockUIPart::typeDockSizer:
3718 case wxAuiDockUIPart::typePaneSizer:
3719 m_art->DrawSash(*dc, m_frame, part.orientation, part.rect);
3720 break;
3721 case wxAuiDockUIPart::typeBackground:
3722 m_art->DrawBackground(*dc, m_frame, part.orientation, part.rect);
3723 break;
3724 case wxAuiDockUIPart::typeCaption:
3725 m_art->DrawCaption(*dc, m_frame, part.pane->caption, part.rect, *part.pane);
3726 break;
3727 case wxAuiDockUIPart::typeGripper:
3728 m_art->DrawGripper(*dc, m_frame, part.rect, *part.pane);
3729 break;
3730 case wxAuiDockUIPart::typePaneBorder:
3731 m_art->DrawBorder(*dc, m_frame, part.rect, *part.pane);
3732 break;
3733 case wxAuiDockUIPart::typePaneButton:
3734 m_art->DrawPaneButton(*dc, m_frame, part.button->button_id,
3735 wxAUI_BUTTON_STATE_NORMAL, part.rect, *part.pane);
3736 break;
3737 }
3738 }
3739}
3740
3741
3742// Render() fire a render event, which is normally handled by
3743// wxAuiManager::OnRender(). This allows the render function to
3744// be overridden via the render event. This can be useful for paintin
3745// custom graphics in the main window. Default behavior can be
3746// invoked in the overridden function by calling OnRender()
3747
3748void wxAuiManager::Render(wxDC* dc)
3749{
3750 wxAuiManagerEvent e(wxEVT_AUI_RENDER);
3751 e.SetManager(this);
3752 e.SetDC(dc);
3753 ProcessMgrEvent(e);
3754}
3755
3756void wxAuiManager::Repaint(wxDC* dc)
3757{
3758#ifdef __WXMAC__
3759 if ( dc == NULL )
3760 {
3761 m_frame->Refresh() ;
3762 m_frame->Update() ;
3763 return ;
3764 }
3765#endif
3766 int w, h;
3767 m_frame->GetClientSize(&w, &h);
3768
3769 // figure out which dc to use; if one
3770 // has been specified, use it, otherwise
3771 // make a client dc
3772 wxClientDC* client_dc = NULL;
3773 if (!dc)
3774 {
3775 client_dc = new wxClientDC(m_frame);
3776 dc = client_dc;
3777 }
3778
3779 // if the frame has a toolbar, the client area
3780 // origin will not be (0,0).
3781 wxPoint pt = m_frame->GetClientAreaOrigin();
3782 if (pt.x != 0 || pt.y != 0)
3783 dc->SetDeviceOrigin(pt.x, pt.y);
3784
3785 // render all the items
3786 Render(dc);
3787
3788 // if we created a client_dc, delete it
3789 if (client_dc)
3790 delete client_dc;
3791}
3792
3793void wxAuiManager::OnPaint(wxPaintEvent& WXUNUSED(event))
3794{
3795 wxPaintDC dc(m_frame);
3796 Repaint(&dc);
3797}
3798
3799void wxAuiManager::OnEraseBackground(wxEraseEvent& event)
3800{
3801#ifdef __WXMAC__
3802 event.Skip() ;
3803#else
3804 wxUnusedVar(event);
3805#endif
3806}
3807
3808void wxAuiManager::OnSize(wxSizeEvent& event)
3809{
3810 if (m_frame)
3811 {
3812 DoFrameLayout();
3813 Repaint();
3814
3815#if wxUSE_MDI
3816 if (m_frame->IsKindOf(CLASSINFO(wxMDIParentFrame)))
3817 {
3818 // for MDI parent frames, this event must not
3819 // be "skipped". In other words, the parent frame
3820 // must not be allowed to resize the client window
3821 // after we are finished processing sizing changes
3822 return;
3823 }
3824#endif
3825 }
3826 event.Skip();
3827}
3828
3829void wxAuiManager::OnFindManager(wxAuiManagerEvent& evt)
3830{
3831 // get the window we are managing, if none, return NULL
3832 wxWindow* window = GetManagedWindow();
3833 if (!window)
3834 {
3835 evt.SetManager(NULL);
3836 return;
3837 }
3838
3839 // if we are managing a child frame, get the 'real' manager
3840 if (window->IsKindOf(CLASSINFO(wxAuiFloatingFrame)))
3841 {
3842 wxAuiFloatingFrame* float_frame = static_cast<wxAuiFloatingFrame*>(window);
3843 evt.SetManager(float_frame->GetOwnerManager());
3844 return;
3845 }
3846
3847 // return pointer to ourself
3848 evt.SetManager(this);
3849}
3850
3851void wxAuiManager::OnSetCursor(wxSetCursorEvent& event)
3852{
3853 // determine cursor
3854 wxAuiDockUIPart* part = HitTest(event.GetX(), event.GetY());
3855 wxCursor cursor = wxNullCursor;
3856
3857 if (part)
3858 {
3859 if (part->type == wxAuiDockUIPart::typeDockSizer ||
3860 part->type == wxAuiDockUIPart::typePaneSizer)
3861 {
3862 // a dock may not be resized if it has a single
3863 // pane which is not resizable
3864 if (part->type == wxAuiDockUIPart::typeDockSizer && part->dock &&
3865 part->dock->panes.GetCount() == 1 &&
3866 part->dock->panes.Item(0)->IsFixed())
3867 return;
3868
3869 // panes that may not be resized do not get a sizing cursor
3870 if (part->pane && part->pane->IsFixed())
3871 return;
3872
3873 if (part->orientation == wxVERTICAL)
3874 cursor = wxCursor(wxCURSOR_SIZEWE);
3875 else
3876 cursor = wxCursor(wxCURSOR_SIZENS);
3877 }
3878 else if (part->type == wxAuiDockUIPart::typeGripper)
3879 {
3880 cursor = wxCursor(wxCURSOR_SIZING);
3881 }
3882 }
3883
3884 event.SetCursor(cursor);
3885}
3886
3887
3888
3889void wxAuiManager::UpdateButtonOnScreen(wxAuiDockUIPart* button_ui_part,
3890 const wxMouseEvent& event)
3891{
3892 wxAuiDockUIPart* hit_test = HitTest(event.GetX(), event.GetY());
3893 if (!hit_test || !button_ui_part)
3894 return;
3895
3896 int state = wxAUI_BUTTON_STATE_NORMAL;
3897
3898 if (hit_test == button_ui_part)
3899 {
3900 if (event.LeftDown())
3901 state = wxAUI_BUTTON_STATE_PRESSED;
3902 else
3903 state = wxAUI_BUTTON_STATE_HOVER;
3904 }
3905 else
3906 {
3907 if (event.LeftDown())
3908 state = wxAUI_BUTTON_STATE_HOVER;
3909 }
3910
3911 // now repaint the button with hover state
3912 wxClientDC cdc(m_frame);
3913
3914 // if the frame has a toolbar, the client area
3915 // origin will not be (0,0).
3916 wxPoint pt = m_frame->GetClientAreaOrigin();
3917 if (pt.x != 0 || pt.y != 0)
3918 cdc.SetDeviceOrigin(pt.x, pt.y);
3919
3920 if (hit_test->pane)
3921 {
3922 m_art->DrawPaneButton(cdc, m_frame,
3923 button_ui_part->button->button_id,
3924 state,
3925 button_ui_part->rect,
3926 *hit_test->pane);
3927 }
3928}
3929
3930void wxAuiManager::OnLeftDown(wxMouseEvent& event)
3931{
3932 wxAuiDockUIPart* part = HitTest(event.GetX(), event.GetY());
3933 if (part)
3934 {
3935 if (part->type == wxAuiDockUIPart::typeDockSizer ||
3936 part->type == wxAuiDockUIPart::typePaneSizer)
3937 {
3938 // Removing this restriction so that a centre pane can be resized
3939 //if (part->dock && part->dock->dock_direction == wxAUI_DOCK_CENTER)
3940 // return;
3941
3942 // a dock may not be resized if it has a single
3943 // pane which is not resizable
3944 if (part->type == wxAuiDockUIPart::typeDockSizer && part->dock &&
3945 part->dock->panes.GetCount() == 1 &&
3946 part->dock->panes.Item(0)->IsFixed())
3947 return;
3948
3949 // panes that may not be resized should be ignored here
3950 if (part->pane && part->pane->IsFixed())
3951 return;
3952
3953 m_action = actionResize;
3954 m_action_part = part;
3955 m_action_hintrect = wxRect();
3956 m_action_start = wxPoint(event.m_x, event.m_y);
3957 m_action_offset = wxPoint(event.m_x - part->rect.x,
3958 event.m_y - part->rect.y);
3959 m_frame->CaptureMouse();
3960 }
3961 else if (part->type == wxAuiDockUIPart::typePaneButton)
3962 {
3963 m_action = actionClickButton;
3964 m_action_part = part;
3965 m_action_start = wxPoint(event.m_x, event.m_y);
3966 m_frame->CaptureMouse();
3967
3968 UpdateButtonOnScreen(part, event);
3969 }
3970 else if (part->type == wxAuiDockUIPart::typeCaption ||
3971 part->type == wxAuiDockUIPart::typeGripper)
3972 {
3973 // if we are managing a wxAuiFloatingFrame window, then
3974 // we are an embedded wxAuiManager inside the wxAuiFloatingFrame.
3975 // We want to initiate a toolbar drag in our owner manager
3976 wxWindow* managed_wnd = GetManagedWindow();
3977
3978 if (part->pane &&
3979 part->pane->window &&
3980 managed_wnd &&
3981 managed_wnd->IsKindOf(CLASSINFO(wxAuiFloatingFrame)))
3982 {
3983 wxAuiFloatingFrame* floating_frame = (wxAuiFloatingFrame*)managed_wnd;
3984 wxAuiManager* owner_mgr = floating_frame->GetOwnerManager();
3985 owner_mgr->StartPaneDrag(part->pane->window,
3986 wxPoint(event.m_x - part->rect.x,
3987 event.m_y - part->rect.y));
3988 return;
3989 }
3990
3991
3992
3993 if (GetFlags() & wxAUI_MGR_ALLOW_ACTIVE_PANE)
3994 {
3995 // set the caption as active
3996 SetActivePane(m_panes, part->pane->window);
3997 Repaint();
3998 }
3999
4000 if (part->dock && part->dock->dock_direction == wxAUI_DOCK_CENTER)
4001 return;
4002
4003 m_action = actionClickCaption;
4004 m_action_part = part;
4005 m_action_start = wxPoint(event.m_x, event.m_y);
4006 m_action_offset = wxPoint(event.m_x - part->rect.x,
4007 event.m_y - part->rect.y);
4008 m_frame->CaptureMouse();
4009 }
4010#ifdef __WXMAC__
4011 else
4012 {
4013 event.Skip();
4014 }
4015#endif
4016 }
4017#ifdef __WXMAC__
4018 else
4019 {
4020 event.Skip();
4021 }
4022#else
4023 event.Skip();
4024#endif
4025}
4026
4027
4028void wxAuiManager::OnLeftUp(wxMouseEvent& event)
4029{
4030 if (m_action == actionResize)
4031 {
4032 m_frame->ReleaseMouse();
4033
4034 // get rid of the hint rectangle
4035 wxScreenDC dc;
4036 DrawResizeHint(dc, m_action_hintrect);
4037
4038 // resize the dock or the pane
4039 if (m_action_part && m_action_part->type==wxAuiDockUIPart::typeDockSizer)
4040 {
4041 wxRect& rect = m_action_part->dock->rect;
4042
4043 wxPoint new_pos(event.m_x - m_action_offset.x,
4044 event.m_y - m_action_offset.y);
4045
4046 switch (m_action_part->dock->dock_direction)
4047 {
4048 case wxAUI_DOCK_LEFT:
4049 m_action_part->dock->size = new_pos.x - rect.x;
4050 break;
4051 case wxAUI_DOCK_TOP:
4052 m_action_part->dock->size = new_pos.y - rect.y;
4053 break;
4054 case wxAUI_DOCK_RIGHT:
4055 m_action_part->dock->size = rect.x + rect.width -
4056 new_pos.x - m_action_part->rect.GetWidth();
4057 break;
4058 case wxAUI_DOCK_BOTTOM:
4059 m_action_part->dock->size = rect.y + rect.height -
4060 new_pos.y - m_action_part->rect.GetHeight();
4061 break;
4062 }
4063
4064 Update();
4065 Repaint(NULL);
4066 }
4067 else if (m_action_part &&
4068 m_action_part->type == wxAuiDockUIPart::typePaneSizer)
4069 {
4070 wxAuiDockInfo& dock = *m_action_part->dock;
4071 wxAuiPaneInfo& pane = *m_action_part->pane;
4072
4073 int total_proportion = 0;
4074 int dock_pixels = 0;
4075 int new_pixsize = 0;
4076
4077 int caption_size = m_art->GetMetric(wxAUI_DOCKART_CAPTION_SIZE);
4078 int pane_border_size = m_art->GetMetric(wxAUI_DOCKART_PANE_BORDER_SIZE);
4079 int sash_size = m_art->GetMetric(wxAUI_DOCKART_SASH_SIZE);
4080
4081 wxPoint new_pos(event.m_x - m_action_offset.x,
4082 event.m_y - m_action_offset.y);
4083
4084 // determine the pane rectangle by getting the pane part
4085 wxAuiDockUIPart* pane_part = GetPanePart(pane.window);
4086 wxASSERT_MSG(pane_part,
4087 wxT("Pane border part not found -- shouldn't happen"));
4088
4089 // determine the new pixel size that the user wants;
4090 // this will help us recalculate the pane's proportion
4091 if (dock.IsHorizontal())
4092 new_pixsize = new_pos.x - pane_part->rect.x;
4093 else
4094 new_pixsize = new_pos.y - pane_part->rect.y;
4095
4096 // determine the size of the dock, based on orientation
4097 if (dock.IsHorizontal())
4098 dock_pixels = dock.rect.GetWidth();
4099 else
4100 dock_pixels = dock.rect.GetHeight();
4101
4102 // determine the total proportion of all resizable panes,
4103 // and the total size of the dock minus the size of all
4104 // the fixed panes
4105 int i, dock_pane_count = dock.panes.GetCount();
4106 int pane_position = -1;
4107 for (i = 0; i < dock_pane_count; ++i)
4108 {
4109 wxAuiPaneInfo& p = *dock.panes.Item(i);
4110 if (p.window == pane.window)
4111 pane_position = i;
4112
4113 // while we're at it, subtract the pane sash
4114 // width from the dock width, because this would
4115 // skew our proportion calculations
4116 if (i > 0)
4117 dock_pixels -= sash_size;
4118
4119 // also, the whole size (including decorations) of
4120 // all fixed panes must also be subtracted, because they
4121 // are not part of the proportion calculation
4122 if (p.IsFixed())
4123 {
4124 if (dock.IsHorizontal())
4125 dock_pixels -= p.best_size.x;
4126 else
4127 dock_pixels -= p.best_size.y;
4128 }
4129 else
4130 {
4131 total_proportion += p.dock_proportion;
4132 }
4133 }
4134
4135 // find a pane in our dock to 'steal' space from or to 'give'
4136 // space to -- this is essentially what is done when a pane is
4137 // resized; the pane should usually be the first non-fixed pane
4138 // to the right of the action pane
4139 int borrow_pane = -1;
4140 for (i = pane_position+1; i < dock_pane_count; ++i)
4141 {
4142 wxAuiPaneInfo& p = *dock.panes.Item(i);
4143 if (!p.IsFixed())
4144 {
4145 borrow_pane = i;
4146 break;
4147 }
4148 }
4149
4150
4151 // demand that the pane being resized is found in this dock
4152 // (this assert really never should be raised)
4153 wxASSERT_MSG(pane_position != -1, wxT("Pane not found in dock"));
4154
4155 // prevent division by zero
4156 if (dock_pixels == 0 || total_proportion == 0 || borrow_pane == -1)
4157 {
4158 m_action = actionNone;
4159 return;
4160 }
4161
4162 // calculate the new proportion of the pane
4163 int new_proportion = (new_pixsize*total_proportion)/dock_pixels;
4164
4165 // default minimum size
4166 int min_size = 0;
4167
4168 // check against the pane's minimum size, if specified. please note
4169 // that this is not enough to ensure that the minimum size will
4170 // not be violated, because the whole frame might later be shrunk,
4171 // causing the size of the pane to violate it's minimum size
4172 if (pane.min_size.IsFullySpecified())
4173 {
4174 min_size = 0;
4175
4176 if (pane.HasBorder())
4177 min_size += (pane_border_size*2);
4178
4179 // calculate minimum size with decorations (border,caption)
4180 if (pane_part->orientation == wxVERTICAL)
4181 {
4182 min_size += pane.min_size.y;
4183 if (pane.HasCaption())
4184 min_size += caption_size;
4185 }
4186 else
4187 {
4188 min_size += pane.min_size.x;
4189 }
4190 }
4191
4192
4193 // for some reason, an arithmatic error somewhere is causing
4194 // the proportion calculations to always be off by 1 pixel;
4195 // for now we will add the 1 pixel on, but we really should
4196 // determine what's causing this.
4197 min_size++;
4198
4199 int min_proportion = (min_size*total_proportion)/dock_pixels;
4200
4201 if (new_proportion < min_proportion)
4202 new_proportion = min_proportion;
4203
4204
4205
4206 int prop_diff = new_proportion - pane.dock_proportion;
4207
4208 // borrow the space from our neighbor pane to the
4209 // right or bottom (depending on orientation)
4210 dock.panes.Item(borrow_pane)->dock_proportion -= prop_diff;
4211 pane.dock_proportion = new_proportion;
4212
4213 // repaint
4214 Update();
4215 Repaint(NULL);
4216 }
4217 }
4218 else if (m_action == actionClickButton)
4219 {
4220 m_hover_button = NULL;
4221 m_frame->ReleaseMouse();
4222 UpdateButtonOnScreen(m_action_part, event);
4223
4224 // make sure we're still over the item that was originally clicked
4225 if (m_action_part == HitTest(event.GetX(), event.GetY()))
4226 {
4227 // fire button-click event
4228 wxAuiManagerEvent e(wxEVT_AUI_PANE_BUTTON);
4229 e.SetManager(this);
4230 e.SetPane(m_action_part->pane);
4231 e.SetButton(m_action_part->button->button_id);
4232 ProcessMgrEvent(e);
4233 }
4234 }
4235 else if (m_action == actionClickCaption)
4236 {
4237 m_frame->ReleaseMouse();
4238 }
4239 else if (m_action == actionDragFloatingPane)
4240 {
4241 m_frame->ReleaseMouse();
4242 }
4243 else if (m_action == actionDragToolbarPane)
4244 {
4245 m_frame->ReleaseMouse();
4246
4247 wxAuiPaneInfo& pane = GetPane(m_action_window);
4248 wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
4249
4250 // save the new positions
4251 wxAuiDockInfoPtrArray docks;
4252 FindDocks(m_docks, pane.dock_direction,
4253 pane.dock_layer, pane.dock_row, docks);
4254 if (docks.GetCount() == 1)
4255 {
4256 wxAuiDockInfo& dock = *docks.Item(0);
4257
4258 wxArrayInt pane_positions, pane_sizes;
4259 GetPanePositionsAndSizes(dock, pane_positions, pane_sizes);
4260
4261 int i, dock_pane_count = dock.panes.GetCount();
4262 for (i = 0; i < dock_pane_count; ++i)
4263 dock.panes.Item(i)->dock_pos = pane_positions[i];
4264 }
4265
4266 pane.state &= ~wxAuiPaneInfo::actionPane;
4267 Update();
4268 }
4269 else
4270 {
4271 event.Skip();
4272 }
4273
4274 m_action = actionNone;
4275 m_last_mouse_move = wxPoint(); // see comment in OnMotion()
4276}
4277
4278
4279void wxAuiManager::OnMotion(wxMouseEvent& event)
4280{
4281 // sometimes when Update() is called from inside this method,
4282 // a spurious mouse move event is generated; this check will make
4283 // sure that only real mouse moves will get anywhere in this method;
4284 // this appears to be a bug somewhere, and I don't know where the
4285 // mouse move event is being generated. only verified on MSW
4286
4287 wxPoint mouse_pos = event.GetPosition();
4288 if (m_last_mouse_move == mouse_pos)
4289 return;
4290 m_last_mouse_move = mouse_pos;
4291
4292
4293 if (m_action == actionResize)
4294 {
4295 wxPoint pos = m_action_part->rect.GetPosition();
4296 if (m_action_part->orientation == wxHORIZONTAL)
4297 pos.y = wxMax(0, event.m_y - m_action_offset.y);
4298 else
4299 pos.x = wxMax(0, event.m_x - m_action_offset.x);
4300
4301 wxRect rect(m_frame->ClientToScreen(pos),
4302 m_action_part->rect.GetSize());
4303
4304 wxScreenDC dc;
4305 if (!m_action_hintrect.IsEmpty())
4306 DrawResizeHint(dc, m_action_hintrect);
4307 DrawResizeHint(dc, rect);
4308 m_action_hintrect = rect;
4309 }
4310 else if (m_action == actionClickCaption)
4311 {
4312 int drag_x_threshold = wxSystemSettings::GetMetric(wxSYS_DRAG_X);
4313 int drag_y_threshold = wxSystemSettings::GetMetric(wxSYS_DRAG_Y);
4314
4315 // caption has been clicked. we need to check if the mouse
4316 // is now being dragged. if it is, we need to change the
4317 // mouse action to 'drag'
4318 if (abs(event.m_x - m_action_start.x) > drag_x_threshold ||
4319 abs(event.m_y - m_action_start.y) > drag_y_threshold)
4320 {
4321 wxAuiPaneInfo* pane_info = m_action_part->pane;
4322
4323 if (!pane_info->IsToolbar())
4324 {
4325 if ((m_flags & wxAUI_MGR_ALLOW_FLOATING) &&
4326 pane_info->IsFloatable())
4327 {
4328 m_action = actionDragFloatingPane;
4329
4330 // set initial float position
4331 wxPoint pt = m_frame->ClientToScreen(event.GetPosition());
4332 pane_info->floating_pos = wxPoint(pt.x - m_action_offset.x,
4333 pt.y - m_action_offset.y);
4334
4335 // float the window
4336 if (pane_info->IsMaximized())
4337 RestorePane(*pane_info);
4338 pane_info->Float();
4339 Update();
4340
4341 m_action_window = pane_info->frame;
4342
4343 // action offset is used here to make it feel "natural" to the user
4344 // to drag a docked pane and suddenly have it become a floating frame.
4345 // Sometimes, however, the offset where the user clicked on the docked
4346 // caption is bigger than the width of the floating frame itself, so
4347 // in that case we need to set the action offset to a sensible value
4348 wxSize frame_size = m_action_window->GetSize();
4349 if (frame_size.x <= m_action_offset.x)
4350 m_action_offset.x = 30;
4351 }
4352 }
4353 else
4354 {
4355 m_action = actionDragToolbarPane;
4356 m_action_window = pane_info->window;
4357 }
4358 }
4359 }
4360 else if (m_action == actionDragFloatingPane)
4361 {
4362 if (m_action_window)
4363 {
4364 wxPoint pt = m_frame->ClientToScreen(event.GetPosition());
4365 m_action_window->Move(pt.x - m_action_offset.x,
4366 pt.y - m_action_offset.y);
4367 }
4368 }
4369 else if (m_action == actionDragToolbarPane)
4370 {
4371 wxAuiPaneInfo& pane = GetPane(m_action_window);
4372 wxASSERT_MSG(pane.IsOk(), wxT("Pane window not found"));
4373
4374 pane.state |= wxAuiPaneInfo::actionPane;
4375
4376 wxPoint pt = event.GetPosition();
4377 DoDrop(m_docks, m_panes, pane, pt, m_action_offset);
4378
4379 // if DoDrop() decided to float the pane, set up
4380 // the floating pane's initial position
4381 if (pane.IsFloating())
4382 {
4383 wxPoint pt = m_frame->ClientToScreen(event.GetPosition());
4384 pane.floating_pos = wxPoint(pt.x - m_action_offset.x,
4385 pt.y - m_action_offset.y);
4386 }
4387
4388 // this will do the actiual move operation;
4389 // in the case that the pane has been floated,
4390 // this call will create the floating pane
4391 // and do the reparenting
4392 Update();
4393
4394 // if the pane has been floated, change the mouse
4395 // action actionDragFloatingPane so that subsequent
4396 // EVT_MOTION() events will move the floating pane
4397 if (pane.IsFloating())
4398 {
4399 pane.state &= ~wxAuiPaneInfo::actionPane;
4400 m_action = actionDragFloatingPane;
4401 m_action_window = pane.frame;
4402 }
4403 }
4404 else
4405 {
4406 wxAuiDockUIPart* part = HitTest(event.GetX(), event.GetY());
4407 if (part && part->type == wxAuiDockUIPart::typePaneButton)
4408 {
4409 if (part != m_hover_button)
4410 {
4411 // make the old button normal
4412 if (m_hover_button)
4413 {
4414 UpdateButtonOnScreen(m_hover_button, event);
4415 Repaint();
4416 }
4417
4418 // mouse is over a button, so repaint the
4419 // button in hover mode
4420 UpdateButtonOnScreen(part, event);
4421 m_hover_button = part;
4422
4423 }
4424 }
4425 else
4426 {
4427 if (m_hover_button)
4428 {
4429 m_hover_button = NULL;
4430 Repaint();
4431 }
4432 else
4433 {
4434 event.Skip();
4435 }
4436 }
4437 }
4438}
4439
4440void wxAuiManager::OnLeaveWindow(wxMouseEvent& WXUNUSED(event))
4441{
4442 if (m_hover_button)
4443 {
4444 m_hover_button = NULL;
4445 Repaint();
4446 }
4447}
4448
4449void wxAuiManager::OnChildFocus(wxChildFocusEvent& event)
4450{
4451 // when a child pane has it's focus set, we should change the
4452 // pane's active state to reflect this. (this is only true if
4453 // active panes are allowed by the owner)
4454 if (GetFlags() & wxAUI_MGR_ALLOW_ACTIVE_PANE)
4455 {
4456 wxAuiPaneInfo& pane = GetPane(event.GetWindow());
4457 if (pane.IsOk() && (pane.state & wxAuiPaneInfo::optionActive) == 0)
4458 {
4459 SetActivePane(m_panes, event.GetWindow());
4460 m_frame->Refresh();
4461 }
4462 }
4463
4464 event.Skip();
4465}
4466
4467
4468// OnPaneButton() is an event handler that is called
4469// when a pane button has been pressed.
4470void wxAuiManager::OnPaneButton(wxAuiManagerEvent& evt)
4471{
4472 wxASSERT_MSG(evt.pane, wxT("Pane Info passed to wxAuiManager::OnPaneButton must be non-null"));
4473
4474 wxAuiPaneInfo& pane = *(evt.pane);
4475
4476 if (evt.button == wxAUI_BUTTON_CLOSE)
4477 {
4478 // fire pane close event
4479 wxAuiManagerEvent e(wxEVT_AUI_PANE_CLOSE);
4480 e.SetManager(this);
4481 e.SetPane(evt.pane);
4482 ProcessMgrEvent(e);
4483
4484 if (!e.GetVeto())
4485 {
4486 // close the pane, but check that it
4487 // still exists in our pane array first
4488 // (the event handler above might have removed it)
4489
4490 wxAuiPaneInfo& check = GetPane(pane.window);
4491 if (check.IsOk())
4492 {
4493 ClosePane(pane);
4494 }
4495
4496 Update();
4497 }
4498 }
4499 else if (evt.button == wxAUI_BUTTON_MAXIMIZE_RESTORE && !pane.IsMaximized())
4500 {
4501 // fire pane close event
4502 wxAuiManagerEvent e(wxEVT_AUI_PANE_MAXIMIZE);
4503 e.SetManager(this);
4504 e.SetPane(evt.pane);
4505 ProcessMgrEvent(e);
4506
4507 if (!e.GetVeto())
4508 {
4509 MaximizePane(pane);
4510 Update();
4511 }
4512 }
4513 else if (evt.button == wxAUI_BUTTON_MAXIMIZE_RESTORE && pane.IsMaximized())
4514 {
4515 // fire pane close event
4516 wxAuiManagerEvent e(wxEVT_AUI_PANE_RESTORE);
4517 e.SetManager(this);
4518 e.SetPane(evt.pane);
4519 ProcessMgrEvent(e);
4520
4521 if (!e.GetVeto())
4522 {
4523 RestorePane(pane);
4524 Update();
4525 }
4526 }
4527 else if (evt.button == wxAUI_BUTTON_PIN)
4528 {
4529 if ((m_flags & wxAUI_MGR_ALLOW_FLOATING) &&
4530 pane.IsFloatable())
4531 pane.Float();
4532 Update();
4533 }
4534}
4535
4536#endif // wxUSE_AUI
wxWidgets (Impactor)