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