1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/aui/framemanager.cpp
3 // Purpose: wxaui: wx advanced user interface - docking window manager
4 // Author: Benjamin I. Williams
8 // Copyright: (C) Copyright 2005-2006, Kirix Corporation, All Rights Reserved
9 // Licence: wxWindows Library Licence, Version 3.1
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #include "wx/wxprec.h"
28 #include "wx/aui/framemanager.h"
29 #include "wx/aui/dockart.h"
30 #include "wx/aui/floatpane.h"
33 #include "wx/settings.h"
35 #include "wx/dcclient.h"
36 #include "wx/dcscreen.h"
37 #include "wx/toolbar.h"
42 WX_CHECK_BUILD_OPTIONS("wxAUI")
44 #include "wx/arrimpl.cpp"
45 WX_DECLARE_OBJARRAY(wxRect
, wxAuiRectArray
);
46 WX_DEFINE_OBJARRAY(wxAuiRectArray
)
47 WX_DEFINE_OBJARRAY(wxDockUIPartArray
)
48 WX_DEFINE_OBJARRAY(wxDockInfoArray
)
49 WX_DEFINE_OBJARRAY(wxPaneButtonArray
)
50 WX_DEFINE_OBJARRAY(wxPaneInfoArray
)
52 wxPaneInfo wxNullPaneInfo
;
53 wxDockInfo wxNullDockInfo
;
54 DEFINE_EVENT_TYPE(wxEVT_AUI_PANEBUTTON
)
55 DEFINE_EVENT_TYPE(wxEVT_AUI_PANECLOSE
)
56 DEFINE_EVENT_TYPE(wxEVT_AUI_RENDER
)
59 // a few defines to avoid nameclashes
60 #define __MAC_OS_X_MEMORY_MANAGER_CLEAN__ 1
62 #include "wx/mac/private.h"
65 IMPLEMENT_DYNAMIC_CLASS(wxFrameManagerEvent
, wxEvent
)
67 class wxPseudoTransparentFrame
: public wxFrame
70 wxPseudoTransparentFrame(wxWindow
* parent
= NULL
,
72 const wxString
& title
= wxT(""),
73 const wxPoint
& pos
= wxDefaultPosition
,
74 const wxSize
& size
= wxDefaultSize
,
75 long style
= wxDEFAULT_FRAME_STYLE
,
76 const wxString
&name
= wxT("frame"))
77 : wxFrame(parent
, id
, title
, pos
, size
, style
| wxFRAME_SHAPED
, name
)
79 SetBackgroundStyle(wxBG_STYLE_CUSTOM
);
84 m_CanSetShape
= false; // have to wait for window create event on GTK
91 virtual bool SetTransparent(wxByte alpha
)
95 int w
=100; // some defaults
97 GetClientSize(&w
, &h
);
98 if ((alpha
!= m_Amount
) || (m_MaxWidth
<w
) | (m_MaxHeight
<h
))
100 // Make the region at least double the height and width so we don't have
101 // to rebuild if the size changes.
106 // m_Region.Union(0, 0, 1, m_MaxWidth);
109 for (int y
=0; y
<m_MaxHeight
; y
++)
111 // Reverse the order of the bottom 4 bits
112 int j
=((y
&8)?1:0)|((y
&4)?2:0)|((y
&2)?4:0)|((y
&1)?8:0);
113 if ((j
*16+8)<m_Amount
)
114 m_Region
.Union(0, y
, m_MaxWidth
, 1);
124 void OnPaint(wxPaintEvent
& event
)
128 dc
.SetBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_ACTIVECAPTION
));
129 dc
.SetPen(*wxTRANSPARENT_PEN
);
131 wxRegionIterator
upd(GetUpdateRegion()); // get the update rect list
135 wxRect
rect(upd
.GetRect());
136 dc
.DrawRectangle(rect
.x
, rect
.y
, rect
.width
, rect
.height
);
143 void OnWindowCreate(wxWindowCreateEvent
& WXUNUSED(event
)) {m_CanSetShape
=true; SetTransparent(0);}
154 DECLARE_DYNAMIC_CLASS(wxPseudoTransparentFrame
);
155 DECLARE_EVENT_TABLE();
159 IMPLEMENT_DYNAMIC_CLASS( wxPseudoTransparentFrame
, wxFrame
)
161 BEGIN_EVENT_TABLE(wxPseudoTransparentFrame
, wxFrame
)
162 EVT_PAINT(wxPseudoTransparentFrame::OnPaint
)
164 EVT_WINDOW_CREATE(wxPseudoTransparentFrame::OnWindowCreate
)
169 // -- static utility functions --
171 static wxBitmap
wxPaneCreateStippleBitmap()
173 unsigned char data
[] = { 0,0,0,192,192,192, 192,192,192,0,0,0 };
174 wxImage
img(2,2,data
,true);
175 return wxBitmap(img
);
178 static void DrawResizeHint(wxDC
& dc
, const wxRect
& rect
)
180 wxBitmap stipple
= wxPaneCreateStippleBitmap();
181 wxBrush
brush(stipple
);
183 dc
.SetPen(*wxTRANSPARENT_PEN
);
185 dc
.SetLogicalFunction(wxXOR
);
186 dc
.DrawRectangle(rect
);
191 // CopyDocksAndPanes() - this utility function creates copies of
192 // the dock and pane info. wxDockInfo's usually contain pointers
193 // to wxPaneInfo classes, thus this function is necessary to reliably
194 // reconstruct that relationship in the new dock info and pane info arrays
196 static void CopyDocksAndPanes(wxDockInfoArray
& dest_docks
,
197 wxPaneInfoArray
& dest_panes
,
198 const wxDockInfoArray
& src_docks
,
199 const wxPaneInfoArray
& src_panes
)
201 dest_docks
= src_docks
;
202 dest_panes
= src_panes
;
203 int i
, j
, k
, dock_count
, pc1
, pc2
;
204 for (i
= 0, dock_count
= dest_docks
.GetCount(); i
< dock_count
; ++i
)
206 wxDockInfo
& dock
= dest_docks
.Item(i
);
207 for (j
= 0, pc1
= dock
.panes
.GetCount(); j
< pc1
; ++j
)
208 for (k
= 0, pc2
= src_panes
.GetCount(); k
< pc2
; ++k
)
209 if (dock
.panes
.Item(j
) == &src_panes
.Item(k
))
210 dock
.panes
.Item(j
) = &dest_panes
.Item(k
);
214 // GetMaxLayer() is an internal function which returns
215 // the highest layer inside the specified dock
216 static int GetMaxLayer(const wxDockInfoArray
& docks
, int dock_direction
)
218 int i
, dock_count
, max_layer
= 0;
219 for (i
= 0, dock_count
= docks
.GetCount(); i
< dock_count
; ++i
)
221 wxDockInfo
& dock
= docks
.Item(i
);
222 if (dock
.dock_direction
== dock_direction
&&
223 dock
.dock_layer
> max_layer
&& !dock
.fixed
)
224 max_layer
= dock
.dock_layer
;
230 // GetMaxRow() is an internal function which returns
231 // the highest layer inside the specified dock
232 static int GetMaxRow(const wxPaneInfoArray
& panes
, int direction
, int layer
)
234 int i
, pane_count
, max_row
= 0;
235 for (i
= 0, pane_count
= panes
.GetCount(); i
< pane_count
; ++i
)
237 wxPaneInfo
& pane
= panes
.Item(i
);
238 if (pane
.dock_direction
== direction
&&
239 pane
.dock_layer
== layer
&&
240 pane
.dock_row
> max_row
)
241 max_row
= pane
.dock_row
;
248 // DoInsertDockLayer() is an internal function that inserts a new dock
249 // layer by incrementing all existing dock layer values by one
250 static void DoInsertDockLayer(wxPaneInfoArray
& panes
,
255 for (i
= 0, pane_count
= panes
.GetCount(); i
< pane_count
; ++i
)
257 wxPaneInfo
& pane
= panes
.Item(i
);
258 if (!pane
.IsFloating() &&
259 pane
.dock_direction
== dock_direction
&&
260 pane
.dock_layer
>= dock_layer
)
265 // DoInsertDockLayer() is an internal function that inserts a new dock
266 // row by incrementing all existing dock row values by one
267 static void DoInsertDockRow(wxPaneInfoArray
& panes
,
273 for (i
= 0, pane_count
= panes
.GetCount(); i
< pane_count
; ++i
)
275 wxPaneInfo
& pane
= panes
.Item(i
);
276 if (!pane
.IsFloating() &&
277 pane
.dock_direction
== dock_direction
&&
278 pane
.dock_layer
== dock_layer
&&
279 pane
.dock_row
>= dock_row
)
284 // DoInsertDockLayer() is an internal function that inserts a space for
285 // another dock pane by incrementing all existing dock row values by one
286 static void DoInsertPane(wxPaneInfoArray
& panes
,
293 for (i
= 0, pane_count
= panes
.GetCount(); i
< pane_count
; ++i
)
295 wxPaneInfo
& pane
= panes
.Item(i
);
296 if (!pane
.IsFloating() &&
297 pane
.dock_direction
== dock_direction
&&
298 pane
.dock_layer
== dock_layer
&&
299 pane
.dock_row
== dock_row
&&
300 pane
.dock_pos
>= dock_pos
)
305 // FindDocks() is an internal function that returns a list of docks which meet
306 // the specified conditions in the parameters and returns a sorted array
307 // (sorted by layer and then row)
308 static void FindDocks(wxDockInfoArray
& docks
,
312 wxDockInfoPtrArray
& arr
)
314 int begin_layer
= dock_layer
;
315 int end_layer
= dock_layer
;
316 int begin_row
= dock_row
;
317 int end_row
= dock_row
;
318 int dock_count
= docks
.GetCount();
319 int layer
, row
, i
, max_row
= 0, max_layer
= 0;
321 // discover the maximum dock layer and the max row
322 for (i
= 0; i
< dock_count
; ++i
)
324 max_row
= wxMax(max_row
, docks
.Item(i
).dock_row
);
325 max_layer
= wxMax(max_layer
, docks
.Item(i
).dock_layer
);
328 // if no dock layer was specified, search all dock layers
329 if (dock_layer
== -1)
332 end_layer
= max_layer
;
335 // if no dock row was specified, search all dock row
344 for (layer
= begin_layer
; layer
<= end_layer
; ++layer
)
345 for (row
= begin_row
; row
<= end_row
; ++row
)
346 for (i
= 0; i
< dock_count
; ++i
)
348 wxDockInfo
& d
= docks
.Item(i
);
349 if (dock_direction
== -1 || dock_direction
== d
.dock_direction
)
351 if (d
.dock_layer
== layer
&& d
.dock_row
== row
)
357 // FindPaneInDock() looks up a specified window pointer inside a dock.
358 // If found, the corresponding wxPaneInfo pointer is returned, otherwise NULL.
359 static wxPaneInfo
* FindPaneInDock(const wxDockInfo
& dock
, wxWindow
* window
)
361 int i
, count
= dock
.panes
.GetCount();
362 for (i
= 0; i
< count
; ++i
)
364 wxPaneInfo
* p
= dock
.panes
.Item(i
);
365 if (p
->window
== window
)
371 // RemovePaneFromDocks() removes a pane window from all docks
372 // with a possible exception specified by parameter "except"
373 static void RemovePaneFromDocks(wxDockInfoArray
& docks
,
375 wxDockInfo
* except
= NULL
)
378 for (i
= 0, dock_count
= docks
.GetCount(); i
< dock_count
; ++i
)
380 wxDockInfo
& d
= docks
.Item(i
);
383 wxPaneInfo
* pi
= FindPaneInDock(d
, pane
.window
);
389 // RenumberDockRows() takes a dock and assigns sequential numbers
390 // to existing rows. Basically it takes out the gaps; so if a
391 // dock has rows with numbers 0,2,5, they will become 0,1,2
392 static void RenumberDockRows(wxDockInfoPtrArray
& docks
)
394 int i
, dock_count
, j
, pane_count
;
395 for (i
= 0, dock_count
= docks
.GetCount(); i
< dock_count
; ++i
)
397 wxDockInfo
& dock
= *docks
.Item(i
);
399 for (j
= 0, pane_count
= dock
.panes
.GetCount(); j
< pane_count
; ++j
)
400 dock
.panes
.Item(j
)->dock_row
= i
;
405 // SetActivePane() sets the active pane, as well as cycles through
406 // every other pane and makes sure that all others' active flags
408 static void SetActivePane(wxPaneInfoArray
& panes
, wxWindow
* active_pane
)
411 for (i
= 0, pane_count
= panes
.GetCount(); i
< pane_count
; ++i
)
413 wxPaneInfo
& pane
= panes
.Item(i
);
414 pane
.state
&= ~wxPaneInfo::optionActive
;
415 if (pane
.window
== active_pane
)
416 pane
.state
|= wxPaneInfo::optionActive
;
421 // this function is used to sort panes by dock position
422 static int PaneSortFunc(wxPaneInfo
** p1
, wxPaneInfo
** p2
)
424 return ((*p1
)->dock_pos
< (*p2
)->dock_pos
) ? -1 : 1;
428 // -- wxFrameManager class implementation --
431 BEGIN_EVENT_TABLE(wxFrameManager
, wxEvtHandler
)
432 EVT_AUI_PANEBUTTON(wxFrameManager::OnPaneButton
)
433 EVT_AUI_RENDER(wxFrameManager::OnRender
)
434 EVT_PAINT(wxFrameManager::OnPaint
)
435 EVT_ERASE_BACKGROUND(wxFrameManager::OnEraseBackground
)
436 EVT_SIZE(wxFrameManager::OnSize
)
437 EVT_SET_CURSOR(wxFrameManager::OnSetCursor
)
438 EVT_LEFT_DOWN(wxFrameManager::OnLeftDown
)
439 EVT_LEFT_UP(wxFrameManager::OnLeftUp
)
440 EVT_MOTION(wxFrameManager::OnMotion
)
441 EVT_LEAVE_WINDOW(wxFrameManager::OnLeaveWindow
)
442 EVT_CHILD_FOCUS(wxFrameManager::OnChildFocus
)
443 EVT_TIMER(101, wxFrameManager::OnHintFadeTimer
)
447 wxFrameManager::wxFrameManager(wxWindow
* managed_wnd
, unsigned int flags
)
449 m_action
= actionNone
;
450 m_last_mouse_move
= wxPoint();
451 m_hover_button
= NULL
;
452 m_art
= new wxDefaultDockArt
;
458 SetManagedWindow(managed_wnd
);
462 wxFrameManager::~wxFrameManager()
467 // GetPane() looks up a wxPaneInfo structure based
468 // on the supplied window pointer. Upon failure, GetPane()
469 // returns an empty wxPaneInfo, a condition which can be checked
470 // by calling wxPaneInfo::IsOk().
472 // The pane info's structure may then be modified. Once a pane's
473 // info is modified, wxFrameManager::Update() must be called to
474 // realize the changes in the UI.
476 wxPaneInfo
& wxFrameManager::GetPane(wxWindow
* window
)
479 for (i
= 0, pane_count
= m_panes
.GetCount(); i
< pane_count
; ++i
)
481 wxPaneInfo
& p
= m_panes
.Item(i
);
482 if (p
.window
== window
)
485 return wxNullPaneInfo
;
488 // this version of GetPane() looks up a pane based on a
489 // 'pane name', see above comment for more info
490 wxPaneInfo
& wxFrameManager::GetPane(const wxString
& name
)
493 for (i
= 0, pane_count
= m_panes
.GetCount(); i
< pane_count
; ++i
)
495 wxPaneInfo
& p
= m_panes
.Item(i
);
499 return wxNullPaneInfo
;
502 // GetAllPanes() returns a reference to all the pane info structures
503 wxPaneInfoArray
& wxFrameManager::GetAllPanes()
508 // HitTest() is an internal function which determines
509 // which UI item the specified coordinates are over
510 // (x,y) specify a position in client coordinates
511 wxDockUIPart
* wxFrameManager::HitTest(int x
, int y
)
513 wxDockUIPart
* result
= NULL
;
516 for (i
= 0, part_count
= m_uiparts
.GetCount(); i
< part_count
; ++i
)
518 wxDockUIPart
* item
= &m_uiparts
.Item(i
);
520 // we are not interested in typeDock, because this space
521 // isn't used to draw anything, just for measurements;
522 // besides, the entire dock area is covered with other
523 // rectangles, which we are interested in.
524 if (item
->type
== wxDockUIPart::typeDock
)
527 // if we already have a hit on a more specific item, we are not
528 // interested in a pane hit. If, however, we don't already have
529 // a hit, returning a pane hit is necessary for some operations
530 if ((item
->type
== wxDockUIPart::typePane
||
531 item
->type
== wxDockUIPart::typePaneBorder
) && result
)
534 // if the point is inside the rectangle, we have a hit
535 if (item
->rect
.Inside(x
,y
))
543 // SetFlags() and GetFlags() allow the owner to set various
544 // options which are global to wxFrameManager
545 void wxFrameManager::SetFlags(unsigned int flags
)
550 unsigned int wxFrameManager::GetFlags() const
556 // don't use these anymore as they are deprecated
557 // use Set/GetManagedFrame() instead
558 void wxFrameManager::SetFrame(wxFrame
* frame
)
560 SetManagedWindow((wxWindow
*)frame
);
563 wxFrame
* wxFrameManager::GetFrame() const
565 return (wxFrame
*)m_frame
;
571 // SetManagedWindow() is usually called once when the frame
572 // manager class is being initialized. "frame" specifies
573 // the frame which should be managed by the frame mananger
574 void wxFrameManager::SetManagedWindow(wxWindow
* frame
)
576 wxASSERT_MSG(frame
, wxT("specified frame must be non-NULL"));
579 m_frame
->PushEventHandler(this);
582 // if the owner is going to manage an MDI parent frame,
583 // we need to add the MDI client window as the default
586 if (frame
->IsKindOf(CLASSINFO(wxMDIParentFrame
)))
588 wxMDIParentFrame
* mdi_frame
= (wxMDIParentFrame
*)frame
;
589 wxWindow
* client_window
= mdi_frame
->GetClientWindow();
591 wxASSERT_MSG(client_window
, wxT("Client window is NULL!"));
593 AddPane(client_window
,
594 wxPaneInfo().Name(wxT("mdiclient")).
595 CenterPane().PaneBorder(false));
599 // Make a window to use for a transparent hint
600 #if defined(__WXMSW__) || defined(__WXGTK__)
601 m_hint_wnd
= new wxFrame(m_frame
, -1, wxEmptyString
, wxDefaultPosition
, wxSize(1,1),
602 wxFRAME_TOOL_WINDOW
|
603 wxFRAME_FLOAT_ON_PARENT
|
607 m_hint_wnd
->SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_ACTIVECAPTION
));
609 #elif defined(__WXMAC__)
610 // Using a miniframe with float and tool styles keeps the parent
611 // frame activated and highlighted as such...
612 m_hint_wnd
= new wxMiniFrame(m_frame
, -1, wxEmptyString
, wxDefaultPosition
, wxSize(1,1),
613 wxFRAME_FLOAT_ON_PARENT
614 | wxFRAME_TOOL_WINDOW
617 // Can't set the bg colour of a Frame in wxMac
618 wxPanel
* p
= new wxPanel(m_hint_wnd
);
620 // The default wxSYS_COLOUR_ACTIVECAPTION colour is a light silver
621 // color that is really hard to see, especially transparent.
622 // Until a better system color is decided upon we'll just use
624 p
->SetBackgroundColour(*wxBLUE
);
629 if (m_hint_wnd
&& !m_hint_wnd
->CanSetTransparent())
633 m_hint_wnd
->Destroy();
636 // If we can convert it to a PseudoTransparent window, do so
637 m_hint_wnd
= new wxPseudoTransparentFrame (m_frame
, -1, wxEmptyString
, wxDefaultPosition
, wxSize(1,1),
638 wxFRAME_TOOL_WINDOW
|
639 wxFRAME_FLOAT_ON_PARENT
|
643 m_hint_fademax
= 128;
648 // UnInit() must be called, usually in the destructor
649 // of the frame class. If it is not called, usually this
650 // will result in a crash upon program exit
651 void wxFrameManager::UnInit()
653 m_frame
->RemoveEventHandler(this);
656 // GetManagedWindow() returns the window pointer being managed
657 wxWindow
* wxFrameManager::GetManagedWindow() const
662 wxDockArt
* wxFrameManager::GetArtProvider() const
667 void wxFrameManager::ProcessMgrEvent(wxFrameManagerEvent
& event
)
669 // first, give the owner frame a chance to override
672 if (m_frame
->ProcessEvent(event
))
679 // SetArtProvider() instructs wxFrameManager to use the
680 // specified art provider for all drawing calls. This allows
681 // plugable look-and-feel features. The pointer that is
682 // passed to this method subsequently belongs to wxFrameManager,
683 // and is deleted in the frame manager destructor
684 void wxFrameManager::SetArtProvider(wxDockArt
* art_provider
)
686 // delete the last art provider, if any
689 // assign the new art provider
690 m_art
= art_provider
;
694 bool wxFrameManager::AddPane(wxWindow
* window
, const wxPaneInfo
& pane_info
)
696 // check if the pane has a valid window
700 // check if the pane already exists
701 if (GetPane(pane_info
.window
).IsOk())
704 m_panes
.Add(pane_info
);
706 wxPaneInfo
& pinfo
= m_panes
.Last();
708 // set the pane window
709 pinfo
.window
= window
;
711 // if the pane's name identifier is blank, create a random string
712 if (pinfo
.name
.empty())
714 pinfo
.name
.Printf(wxT("%08lx%08x%08x%08lx"),
715 ((unsigned long)pinfo
.window
) & 0xffffffff,
716 (unsigned int)time(NULL
),
718 (unsigned int)GetTickCount(),
720 (unsigned int)clock(),
722 (unsigned long)m_panes
.GetCount());
725 // set initial proportion (if not already set)
726 if (pinfo
.dock_proportion
== 0)
727 pinfo
.dock_proportion
= 100000;
729 if (pinfo
.HasCloseButton() &&
730 pinfo
.buttons
.size() == 0)
733 button
.button_id
= wxPaneInfo::buttonClose
;
734 pinfo
.buttons
.Add(button
);
737 if (pinfo
.best_size
== wxDefaultSize
&&
740 pinfo
.best_size
= pinfo
.window
->GetClientSize();
742 if (pinfo
.window
->IsKindOf(CLASSINFO(wxToolBar
)))
744 // GetClientSize() doesn't get the best size for
745 // a toolbar under some newer versions of wxWidgets,
746 // so use GetBestSize()
747 pinfo
.best_size
= pinfo
.window
->GetBestSize();
749 // for some reason, wxToolBar::GetBestSize() is returning
750 // a size that is a pixel shy of the correct amount.
751 // I believe this to be the correct action, until
752 // wxToolBar::GetBestSize() is fixed. Is this assumption
757 if (pinfo
.min_size
!= wxDefaultSize
)
759 if (pinfo
.best_size
.x
< pinfo
.min_size
.x
)
760 pinfo
.best_size
.x
= pinfo
.min_size
.x
;
761 if (pinfo
.best_size
.y
< pinfo
.min_size
.y
)
762 pinfo
.best_size
.y
= pinfo
.min_size
.y
;
769 bool wxFrameManager::AddPane(wxWindow
* window
,
771 const wxString
& caption
)
774 pinfo
.Caption(caption
);
777 case wxTOP
: pinfo
.Top(); break;
778 case wxBOTTOM
: pinfo
.Bottom(); break;
779 case wxLEFT
: pinfo
.Left(); break;
780 case wxRIGHT
: pinfo
.Right(); break;
781 case wxCENTER
: pinfo
.CenterPane(); break;
783 return AddPane(window
, pinfo
);
786 bool wxFrameManager::AddPane(wxWindow
* window
,
787 const wxPaneInfo
& pane_info
,
788 const wxPoint
& drop_pos
)
790 if (!AddPane(window
, pane_info
))
793 wxPaneInfo
& pane
= GetPane(window
);
795 DoDrop(m_docks
, m_panes
, pane
, drop_pos
, wxPoint(0,0));
800 bool wxFrameManager::InsertPane(wxWindow
* window
, const wxPaneInfo
& pane_info
,
803 // shift the panes around, depending on the insert level
804 switch (insert_level
)
806 case wxAUI_INSERT_PANE
:
807 DoInsertPane(m_panes
,
808 pane_info
.dock_direction
,
809 pane_info
.dock_layer
,
813 case wxAUI_INSERT_ROW
:
814 DoInsertDockRow(m_panes
,
815 pane_info
.dock_direction
,
816 pane_info
.dock_layer
,
819 case wxAUI_INSERT_DOCK
:
820 DoInsertDockLayer(m_panes
,
821 pane_info
.dock_direction
,
822 pane_info
.dock_layer
);
826 // if the window already exists, we are basically just moving/inserting the
827 // existing window. If it doesn't exist, we need to add it and insert it
828 wxPaneInfo
& existing_pane
= GetPane(window
);
829 if (!existing_pane
.IsOk())
831 return AddPane(window
, pane_info
);
835 if (pane_info
.IsFloating())
837 existing_pane
.Float();
838 if (pane_info
.floating_pos
!= wxDefaultPosition
)
839 existing_pane
.FloatingPosition(pane_info
.floating_pos
);
840 if (pane_info
.floating_size
!= wxDefaultSize
)
841 existing_pane
.FloatingSize(pane_info
.floating_size
);
845 existing_pane
.Direction(pane_info
.dock_direction
);
846 existing_pane
.Layer(pane_info
.dock_layer
);
847 existing_pane
.Row(pane_info
.dock_row
);
848 existing_pane
.Position(pane_info
.dock_pos
);
856 // DetachPane() removes a pane from the frame manager. This
857 // method will not destroy the window that is removed.
858 bool wxFrameManager::DetachPane(wxWindow
* window
)
861 for (i
= 0, count
= m_panes
.GetCount(); i
< count
; ++i
)
863 wxPaneInfo
& p
= m_panes
.Item(i
);
864 if (p
.window
== window
)
868 // we have a floating frame which is being detached. We need to
869 // reparent it to m_frame and destroy the floating frame
872 p
.window
->SetSize(1,1);
873 p
.frame
->Show(false);
875 // reparent to m_frame and destroy the pane
876 p
.window
->Reparent(m_frame
);
877 p
.frame
->SetSizer(NULL
);
882 // make sure there are no references to this pane in our uiparts,
883 // just in case the caller doesn't call Update() immediately after
884 // the DetachPane() call. This prevets obscure crashes which would
885 // happen at window repaint if the caller forgets to call Update()
887 for (pi
= 0, part_count
= (int)m_uiparts
.GetCount(); pi
< part_count
; ++pi
)
889 wxDockUIPart
& part
= m_uiparts
.Item(pi
);
892 m_uiparts
.RemoveAt(pi
);
907 // EscapeDelimiters() changes ";" into "\;" and "|" into "\|"
908 // in the input string. This is an internal functions which is
909 // used for saving perspectives
910 static wxString
EscapeDelimiters(const wxString
& s
)
913 result
.Alloc(s
.length());
914 const wxChar
* ch
= s
.c_str();
917 if (*ch
== wxT(';') || *ch
== wxT('|'))
926 // SavePerspective() saves all pane information as a single string.
927 // This string may later be fed into LoadPerspective() to restore
928 // all pane settings. This save and load mechanism allows an
929 // exact pane configuration to be saved and restored at a later time
931 wxString
wxFrameManager::SavePerspective()
935 result
= wxT("layout1|");
937 int pane_i
, pane_count
= m_panes
.GetCount();
938 for (pane_i
= 0; pane_i
< pane_count
; ++pane_i
)
940 wxPaneInfo
& pane
= m_panes
.Item(pane_i
);
942 result
+= wxT("name=");
943 result
+= EscapeDelimiters(pane
.name
);
946 result
+= wxT("caption=");
947 result
+= EscapeDelimiters(pane
.caption
);
950 result
+= wxString::Format(wxT("state=%u;"), pane
.state
);
951 result
+= wxString::Format(wxT("dir=%d;"), pane
.dock_direction
);
952 result
+= wxString::Format(wxT("layer=%d;"), pane
.dock_layer
);
953 result
+= wxString::Format(wxT("row=%d;"), pane
.dock_row
);
954 result
+= wxString::Format(wxT("pos=%d;"), pane
.dock_pos
);
955 result
+= wxString::Format(wxT("prop=%d;"), pane
.dock_proportion
);
956 result
+= wxString::Format(wxT("bestw=%d;"), pane
.best_size
.x
);
957 result
+= wxString::Format(wxT("besth=%d;"), pane
.best_size
.y
);
958 result
+= wxString::Format(wxT("minw=%d;"), pane
.min_size
.x
);
959 result
+= wxString::Format(wxT("minh=%d;"), pane
.min_size
.y
);
960 result
+= wxString::Format(wxT("maxw=%d;"), pane
.max_size
.x
);
961 result
+= wxString::Format(wxT("maxh=%d;"), pane
.max_size
.y
);
962 result
+= wxString::Format(wxT("floatx=%d;"), pane
.floating_pos
.x
);
963 result
+= wxString::Format(wxT("floaty=%d;"), pane
.floating_pos
.y
);
964 result
+= wxString::Format(wxT("floatw=%d;"), pane
.floating_size
.x
);
965 result
+= wxString::Format(wxT("floath=%d"), pane
.floating_size
.y
);
969 int dock_i
, dock_count
= m_docks
.GetCount();
970 for (dock_i
= 0; dock_i
< dock_count
; ++dock_i
)
972 wxDockInfo
& dock
= m_docks
.Item(dock_i
);
974 result
+= wxString::Format(wxT("dock_size(%d,%d,%d)=%d|"),
975 dock
.dock_direction
, dock
.dock_layer
,
976 dock
.dock_row
, dock
.size
);
982 // LoadPerspective() loads a layout which was saved with SavePerspective()
983 // If the "update" flag parameter is true, the GUI will immediately be updated
985 bool wxFrameManager::LoadPerspective(const wxString
& layout
, bool update
)
987 wxString input
= layout
;
990 // check layout string version
991 part
= input
.BeforeFirst(wxT('|'));
992 input
= input
.AfterFirst(wxT('|'));
995 if (part
!= wxT("layout1"))
999 // mark all panes currently managed as docked and hidden
1000 int pane_i
, pane_count
= m_panes
.GetCount();
1001 for (pane_i
= 0; pane_i
< pane_count
; ++pane_i
)
1002 m_panes
.Item(pane_i
).Dock().Hide();
1004 // clear out the dock array; this will be reconstructed
1007 // replace escaped characters so we can
1008 // split up the string easily
1009 input
.Replace(wxT("\\|"), wxT("\a"));
1010 input
.Replace(wxT("\\;"), wxT("\b"));
1016 wxString pane_part
= input
.BeforeFirst(wxT('|'));
1017 input
= input
.AfterFirst(wxT('|'));
1018 pane_part
.Trim(true);
1020 // if the string is empty, we're done parsing
1021 if (pane_part
.empty())
1025 if (pane_part
.Left(9) == wxT("dock_size"))
1027 wxString val_name
= pane_part
.BeforeFirst(wxT('='));
1028 wxString value
= pane_part
.AfterFirst(wxT('='));
1030 long dir
, layer
, row
, size
;
1031 wxString piece
= val_name
.AfterFirst(wxT('('));
1032 piece
= piece
.BeforeLast(wxT(')'));
1033 piece
.BeforeFirst(wxT(',')).ToLong(&dir
);
1034 piece
= piece
.AfterFirst(wxT(','));
1035 piece
.BeforeFirst(wxT(',')).ToLong(&layer
);
1036 piece
.AfterFirst(wxT(',')).ToLong(&row
);
1037 value
.ToLong(&size
);
1040 dock
.dock_direction
= dir
;
1041 dock
.dock_layer
= layer
;
1042 dock
.dock_row
= row
;
1050 wxString val_part
= pane_part
.BeforeFirst(wxT(';'));
1051 pane_part
= pane_part
.AfterFirst(wxT(';'));
1052 wxString val_name
= val_part
.BeforeFirst(wxT('='));
1053 wxString value
= val_part
.AfterFirst(wxT('='));
1054 val_name
.MakeLower();
1055 val_name
.Trim(true);
1056 val_name
.Trim(false);
1060 if (val_name
.empty())
1063 if (val_name
== wxT("name"))
1065 else if (val_name
== wxT("caption"))
1066 pane
.caption
= value
;
1067 else if (val_name
== wxT("state"))
1068 pane
.state
= (unsigned int)wxAtoi(value
.c_str());
1069 else if (val_name
== wxT("dir"))
1070 pane
.dock_direction
= wxAtoi(value
.c_str());
1071 else if (val_name
== wxT("layer"))
1072 pane
.dock_layer
= wxAtoi(value
.c_str());
1073 else if (val_name
== wxT("row"))
1074 pane
.dock_row
= wxAtoi(value
.c_str());
1075 else if (val_name
== wxT("pos"))
1076 pane
.dock_pos
= wxAtoi(value
.c_str());
1077 else if (val_name
== wxT("prop"))
1078 pane
.dock_proportion
= wxAtoi(value
.c_str());
1079 else if (val_name
== wxT("bestw"))
1080 pane
.best_size
.x
= wxAtoi(value
.c_str());
1081 else if (val_name
== wxT("besth"))
1082 pane
.best_size
.y
= wxAtoi(value
.c_str());
1083 else if (val_name
== wxT("minw"))
1084 pane
.min_size
.x
= wxAtoi(value
.c_str());
1085 else if (val_name
== wxT("minh"))
1086 pane
.min_size
.y
= wxAtoi(value
.c_str());
1087 else if (val_name
== wxT("maxw"))
1088 pane
.max_size
.x
= wxAtoi(value
.c_str());
1089 else if (val_name
== wxT("maxh"))
1090 pane
.max_size
.y
= wxAtoi(value
.c_str());
1091 else if (val_name
== wxT("floatx"))
1092 pane
.floating_pos
.x
= wxAtoi(value
.c_str());
1093 else if (val_name
== wxT("floaty"))
1094 pane
.floating_pos
.y
= wxAtoi(value
.c_str());
1095 else if (val_name
== wxT("floatw"))
1096 pane
.floating_size
.x
= wxAtoi(value
.c_str());
1097 else if (val_name
== wxT("floath"))
1098 pane
.floating_size
.y
= wxAtoi(value
.c_str());
1100 wxFAIL_MSG(wxT("Bad Perspective String"));
1104 // replace escaped characters so we can
1105 // split up the string easily
1106 pane
.name
.Replace(wxT("\a"), wxT("|"));
1107 pane
.name
.Replace(wxT("\b"), wxT(";"));
1108 pane
.caption
.Replace(wxT("\a"), wxT("|"));
1109 pane
.caption
.Replace(wxT("\b"), wxT(";"));
1111 wxPaneInfo
& p
= GetPane(pane
.name
);
1114 // the pane window couldn't be found
1115 // in the existing layout
1119 pane
.window
= p
.window
;
1120 pane
.frame
= p
.frame
;
1121 pane
.buttons
= p
.buttons
;
1132 void wxFrameManager::GetPanePositionsAndSizes(wxDockInfo
& dock
,
1133 wxArrayInt
& positions
,
1136 int caption_size
= m_art
->GetMetric(wxAUI_ART_CAPTION_SIZE
);
1137 int pane_border_size
= m_art
->GetMetric(wxAUI_ART_PANE_BORDER_SIZE
);
1138 int gripper_size
= m_art
->GetMetric(wxAUI_ART_GRIPPER_SIZE
);
1143 int offset
, action_pane
= -1;
1144 int pane_i
, pane_count
= dock
.panes
.GetCount();
1146 // find the pane marked as our action pane
1147 for (pane_i
= 0; pane_i
< pane_count
; ++pane_i
)
1149 wxPaneInfo
& pane
= *(dock
.panes
.Item(pane_i
));
1151 if (pane
.state
& wxPaneInfo::actionPane
)
1153 wxASSERT_MSG(action_pane
==-1, wxT("Too many fixed action panes"));
1154 action_pane
= pane_i
;
1158 // set up each panes default position, and
1159 // determine the size (width or height, depending
1160 // on the dock's orientation) of each pane
1161 for (pane_i
= 0; pane_i
< pane_count
; ++pane_i
)
1163 wxPaneInfo
& pane
= *(dock
.panes
.Item(pane_i
));
1164 positions
.Add(pane
.dock_pos
);
1167 if (pane
.HasBorder())
1168 size
+= (pane_border_size
*2);
1170 if (dock
.IsHorizontal())
1172 if (pane
.HasGripper() && !pane
.HasGripperTop())
1173 size
+= gripper_size
;
1174 size
+= pane
.best_size
.x
;
1178 if (pane
.HasGripper() && pane
.HasGripperTop())
1179 size
+= gripper_size
;
1181 if (pane
.HasCaption())
1182 size
+= caption_size
;
1183 size
+= pane
.best_size
.y
;
1189 // if there is no action pane, just return the default
1190 // positions (as specified in pane.pane_pos)
1191 if (action_pane
== -1)
1195 for (pane_i
= action_pane
-1; pane_i
>= 0; --pane_i
)
1197 int amount
= positions
[pane_i
+1] - (positions
[pane_i
] + sizes
[pane_i
]);
1202 positions
[pane_i
] -= -amount
;
1204 offset
+= sizes
[pane_i
];
1207 // if the dock mode is fixed, make sure none of the panes
1208 // overlap; we will bump panes that overlap
1210 for (pane_i
= action_pane
; pane_i
< pane_count
; ++pane_i
)
1212 int amount
= positions
[pane_i
] - offset
;
1216 positions
[pane_i
] += -amount
;
1218 offset
+= sizes
[pane_i
];
1223 void wxFrameManager::LayoutAddPane(wxSizer
* cont
,
1226 wxDockUIPartArray
& uiparts
,
1230 wxSizerItem
* sizer_item
;
1232 int caption_size
= m_art
->GetMetric(wxAUI_ART_CAPTION_SIZE
);
1233 int gripper_size
= m_art
->GetMetric(wxAUI_ART_GRIPPER_SIZE
);
1234 int pane_border_size
= m_art
->GetMetric(wxAUI_ART_PANE_BORDER_SIZE
);
1235 int pane_button_size
= m_art
->GetMetric(wxAUI_ART_PANE_BUTTON_SIZE
);
1237 // find out the orientation of the item (orientation for panes
1238 // is the same as the dock's orientation)
1240 if (dock
.IsHorizontal())
1241 orientation
= wxHORIZONTAL
;
1243 orientation
= wxVERTICAL
;
1245 // this variable will store the proportion
1246 // value that the pane will receive
1247 int pane_proportion
= pane
.dock_proportion
;
1249 wxBoxSizer
* horz_pane_sizer
= new wxBoxSizer(wxHORIZONTAL
);
1250 wxBoxSizer
* vert_pane_sizer
= new wxBoxSizer(wxVERTICAL
);
1252 if (pane
.HasGripper())
1254 if (pane
.HasGripperTop())
1255 sizer_item
= vert_pane_sizer
->Add(1, gripper_size
, 0, wxEXPAND
);
1257 sizer_item
= horz_pane_sizer
->Add(gripper_size
, 1, 0, wxEXPAND
);
1259 part
.type
= wxDockUIPart::typeGripper
;
1263 part
.orientation
= orientation
;
1264 part
.cont_sizer
= horz_pane_sizer
;
1265 part
.sizer_item
= sizer_item
;
1269 if (pane
.HasCaption())
1271 // create the caption sizer
1272 wxBoxSizer
* caption_sizer
= new wxBoxSizer(wxHORIZONTAL
);
1274 sizer_item
= caption_sizer
->Add(1, caption_size
, 1, wxEXPAND
);
1276 part
.type
= wxDockUIPart::typeCaption
;
1280 part
.orientation
= orientation
;
1281 part
.cont_sizer
= vert_pane_sizer
;
1282 part
.sizer_item
= sizer_item
;
1283 int caption_part_idx
= uiparts
.GetCount();
1286 // add pane buttons to the caption
1287 int i
, button_count
;
1288 for (i
= 0, button_count
= pane
.buttons
.GetCount();
1289 i
< button_count
; ++i
)
1291 wxPaneButton
& button
= pane
.buttons
.Item(i
);
1293 sizer_item
= caption_sizer
->Add(pane_button_size
,
1297 part
.type
= wxDockUIPart::typePaneButton
;
1300 part
.button
= &button
;
1301 part
.orientation
= orientation
;
1302 part
.cont_sizer
= caption_sizer
;
1303 part
.sizer_item
= sizer_item
;
1307 // add the caption sizer
1308 sizer_item
= vert_pane_sizer
->Add(caption_sizer
, 0, wxEXPAND
);
1310 uiparts
.Item(caption_part_idx
).sizer_item
= sizer_item
;
1313 // add the pane window itself
1316 sizer_item
= vert_pane_sizer
->Add(1, 1, 1, wxEXPAND
);
1320 sizer_item
= vert_pane_sizer
->Add(pane
.window
, 1, wxEXPAND
);
1321 // Don't do this because it breaks the pane size in floating windows
1322 // BIW: Right now commenting this out is causing problems with
1323 // an mdi client window as the center pane.
1324 vert_pane_sizer
->SetItemMinSize(pane
.window
, 1, 1);
1327 part
.type
= wxDockUIPart::typePane
;
1331 part
.orientation
= orientation
;
1332 part
.cont_sizer
= vert_pane_sizer
;
1333 part
.sizer_item
= sizer_item
;
1337 // determine if the pane should have a minimum size; if the pane is
1338 // non-resizable (fixed) then we must set a minimum size. Alternitavely,
1339 // if the pane.min_size is set, we must use that value as well
1341 wxSize min_size
= pane
.min_size
;
1344 if (min_size
== wxDefaultSize
)
1346 min_size
= pane
.best_size
;
1347 pane_proportion
= 0;
1351 if (min_size
!= wxDefaultSize
)
1353 vert_pane_sizer
->SetItemMinSize(
1354 vert_pane_sizer
->GetChildren().GetCount()-1,
1355 min_size
.x
, min_size
.y
);
1359 // add the verticle sizer (caption, pane window) to the
1360 // horizontal sizer (gripper, verticle sizer)
1361 horz_pane_sizer
->Add(vert_pane_sizer
, 1, wxEXPAND
);
1363 // finally, add the pane sizer to the dock sizer
1365 if (pane
.HasBorder())
1367 // allowing space for the pane's border
1368 sizer_item
= cont
->Add(horz_pane_sizer
, pane_proportion
,
1369 wxEXPAND
| wxALL
, pane_border_size
);
1371 part
.type
= wxDockUIPart::typePaneBorder
;
1375 part
.orientation
= orientation
;
1376 part
.cont_sizer
= cont
;
1377 part
.sizer_item
= sizer_item
;
1382 sizer_item
= cont
->Add(horz_pane_sizer
, pane_proportion
, wxEXPAND
);
1386 void wxFrameManager::LayoutAddDock(wxSizer
* cont
,
1388 wxDockUIPartArray
& uiparts
,
1391 wxSizerItem
* sizer_item
;
1394 int sash_size
= m_art
->GetMetric(wxAUI_ART_SASH_SIZE
);
1395 int orientation
= dock
.IsHorizontal() ? wxHORIZONTAL
: wxVERTICAL
;
1397 // resizable bottom and right docks have a sash before them
1398 if (!dock
.fixed
&& (dock
.dock_direction
== wxAUI_DOCK_BOTTOM
||
1399 dock
.dock_direction
== wxAUI_DOCK_RIGHT
))
1401 sizer_item
= cont
->Add(sash_size
, sash_size
, 0, wxEXPAND
);
1403 part
.type
= wxDockUIPart::typeDockSizer
;
1404 part
.orientation
= orientation
;
1408 part
.cont_sizer
= cont
;
1409 part
.sizer_item
= sizer_item
;
1413 // create the sizer for the dock
1414 wxSizer
* dock_sizer
= new wxBoxSizer(orientation
);
1416 // add each pane to the dock
1417 int pane_i
, pane_count
= dock
.panes
.GetCount();
1421 wxArrayInt pane_positions
, pane_sizes
;
1423 // figure out the real pane positions we will
1424 // use, without modifying the each pane's pane_pos member
1425 GetPanePositionsAndSizes(dock
, pane_positions
, pane_sizes
);
1428 for (pane_i
= 0; pane_i
< pane_count
; ++pane_i
)
1430 wxPaneInfo
& pane
= *(dock
.panes
.Item(pane_i
));
1431 int pane_pos
= pane_positions
.Item(pane_i
);
1433 int amount
= pane_pos
- offset
;
1436 if (dock
.IsVertical())
1437 sizer_item
= dock_sizer
->Add(1, amount
, 0, wxEXPAND
);
1439 sizer_item
= dock_sizer
->Add(amount
, 1, 0, wxEXPAND
);
1441 part
.type
= wxDockUIPart::typeBackground
;
1445 part
.orientation
= (orientation
==wxHORIZONTAL
) ? wxVERTICAL
:wxHORIZONTAL
;
1446 part
.cont_sizer
= dock_sizer
;
1447 part
.sizer_item
= sizer_item
;
1453 LayoutAddPane(dock_sizer
, dock
, pane
, uiparts
, spacer_only
);
1455 offset
+= pane_sizes
.Item(pane_i
);
1458 // at the end add a very small stretchable background area
1459 sizer_item
= dock_sizer
->Add(1,1, 1, wxEXPAND
);
1461 part
.type
= wxDockUIPart::typeBackground
;
1465 part
.orientation
= orientation
;
1466 part
.cont_sizer
= dock_sizer
;
1467 part
.sizer_item
= sizer_item
;
1472 for (pane_i
= 0; pane_i
< pane_count
; ++pane_i
)
1474 wxPaneInfo
& pane
= *(dock
.panes
.Item(pane_i
));
1476 // if this is not the first pane being added,
1477 // we need to add a pane sizer
1480 sizer_item
= dock_sizer
->Add(sash_size
, sash_size
, 0, wxEXPAND
);
1482 part
.type
= wxDockUIPart::typePaneSizer
;
1484 part
.pane
= dock
.panes
.Item(pane_i
-1);
1486 part
.orientation
= (orientation
==wxHORIZONTAL
) ? wxVERTICAL
:wxHORIZONTAL
;
1487 part
.cont_sizer
= dock_sizer
;
1488 part
.sizer_item
= sizer_item
;
1492 LayoutAddPane(dock_sizer
, dock
, pane
, uiparts
, spacer_only
);
1496 if (dock
.dock_direction
== wxAUI_DOCK_CENTER
)
1497 sizer_item
= cont
->Add(dock_sizer
, 1, wxEXPAND
);
1499 sizer_item
= cont
->Add(dock_sizer
, 0, wxEXPAND
);
1501 part
.type
= wxDockUIPart::typeDock
;
1505 part
.orientation
= orientation
;
1506 part
.cont_sizer
= cont
;
1507 part
.sizer_item
= sizer_item
;
1510 if (dock
.IsHorizontal())
1511 cont
->SetItemMinSize(dock_sizer
, 0, dock
.size
);
1513 cont
->SetItemMinSize(dock_sizer
, dock
.size
, 0);
1515 // top and left docks have a sash after them
1516 if (!dock
.fixed
&& (dock
.dock_direction
== wxAUI_DOCK_TOP
||
1517 dock
.dock_direction
== wxAUI_DOCK_LEFT
))
1519 sizer_item
= cont
->Add(sash_size
, sash_size
, 0, wxEXPAND
);
1521 part
.type
= wxDockUIPart::typeDockSizer
;
1525 part
.orientation
= orientation
;
1526 part
.cont_sizer
= cont
;
1527 part
.sizer_item
= sizer_item
;
1532 wxSizer
* wxFrameManager::LayoutAll(wxPaneInfoArray
& panes
,
1533 wxDockInfoArray
& docks
,
1534 wxDockUIPartArray
& uiparts
,
1537 wxBoxSizer
* container
= new wxBoxSizer(wxVERTICAL
);
1539 int pane_border_size
= m_art
->GetMetric(wxAUI_ART_PANE_BORDER_SIZE
);
1540 int caption_size
= m_art
->GetMetric(wxAUI_ART_CAPTION_SIZE
);
1541 wxSize cli_size
= m_frame
->GetClientSize();
1542 int i
, dock_count
, pane_count
;
1545 // empty all docks out
1546 for (i
= 0, dock_count
= docks
.GetCount(); i
< dock_count
; ++i
)
1547 docks
.Item(i
).panes
.Empty();
1549 // iterate through all known panes, filing each
1550 // of them into the appropriate dock. If the
1551 // pane does not exist in the dock, add it
1552 for (i
= 0, pane_count
= panes
.GetCount(); i
< pane_count
; ++i
)
1554 wxPaneInfo
& p
= panes
.Item(i
);
1556 // find any docks in this layer
1558 wxDockInfoPtrArray arr
;
1559 FindDocks(docks
, p
.dock_direction
, p
.dock_layer
, p
.dock_row
, arr
);
1561 if (arr
.GetCount() > 0)
1567 // dock was not found, so we need to create a new one
1569 d
.dock_direction
= p
.dock_direction
;
1570 d
.dock_layer
= p
.dock_layer
;
1571 d
.dock_row
= p
.dock_row
;
1573 dock
= &docks
.Last();
1577 if (p
.IsDocked() && p
.IsShown())
1579 // remove the pane from any existing docks except this one
1580 RemovePaneFromDocks(docks
, p
, dock
);
1582 // pane needs to be added to the dock,
1583 // if it doesn't already exist
1584 if (!FindPaneInDock(*dock
, p
.window
))
1585 dock
->panes
.Add(&p
);
1589 // remove the pane from any existing docks
1590 RemovePaneFromDocks(docks
, p
);
1595 // remove any empty docks
1596 for (i
= docks
.GetCount()-1; i
>= 0; --i
)
1598 if (docks
.Item(i
).panes
.GetCount() == 0)
1602 // configure the docks further
1603 for (i
= 0, dock_count
= docks
.GetCount(); i
< dock_count
; ++i
)
1605 wxDockInfo
& dock
= docks
.Item(i
);
1606 int j
, dock_pane_count
= dock
.panes
.GetCount();
1608 // sort the dock pane array by the pane's
1609 // dock position (dock_pos), in ascending order
1610 dock
.panes
.Sort(PaneSortFunc
);
1612 // for newly created docks, set up their initial size
1617 for (j
= 0; j
< dock_pane_count
; ++j
)
1619 wxPaneInfo
& pane
= *dock
.panes
.Item(j
);
1620 wxSize pane_size
= pane
.best_size
;
1621 if (pane_size
== wxDefaultSize
)
1622 pane_size
= pane
.min_size
;
1623 if (pane_size
== wxDefaultSize
)
1624 pane_size
= pane
.window
->GetSize();
1626 if (dock
.IsHorizontal())
1627 size
= wxMax(pane_size
.y
, size
);
1629 size
= wxMax(pane_size
.x
, size
);
1632 // add space for the border (two times), but only
1633 // if at least one pane inside the dock has a pane border
1634 for (j
= 0; j
< dock_pane_count
; ++j
)
1636 if (dock
.panes
.Item(j
)->HasBorder())
1638 size
+= (pane_border_size
*2);
1643 // if pane is on the top or bottom, add the caption height,
1644 // but only if at least one pane inside the dock has a caption
1645 if (dock
.IsHorizontal())
1647 for (j
= 0; j
< dock_pane_count
; ++j
)
1649 if (dock
.panes
.Item(j
)->HasCaption())
1651 size
+= caption_size
;
1657 // new dock's size may not be more than 1/3 of the frame size
1658 if (dock
.IsHorizontal())
1659 size
= wxMin(size
, cli_size
.y
/3);
1661 size
= wxMin(size
, cli_size
.x
/3);
1669 // determine the dock's minimum size
1670 bool plus_border
= false;
1671 bool plus_caption
= false;
1672 int dock_min_size
= 0;
1673 for (j
= 0; j
< dock_pane_count
; ++j
)
1675 wxPaneInfo
& pane
= *dock
.panes
.Item(j
);
1676 if (pane
.min_size
!= wxDefaultSize
)
1678 if (pane
.HasBorder())
1680 if (pane
.HasCaption())
1681 plus_caption
= true;
1682 if (dock
.IsHorizontal())
1684 if (pane
.min_size
.y
> dock_min_size
)
1685 dock_min_size
= pane
.min_size
.y
;
1689 if (pane
.min_size
.x
> dock_min_size
)
1690 dock_min_size
= pane
.min_size
.x
;
1696 dock_min_size
+= (pane_border_size
*2);
1697 if (plus_caption
&& dock
.IsHorizontal())
1698 dock_min_size
+= (caption_size
);
1700 dock
.min_size
= dock_min_size
;
1703 // if the pane's current size is less than it's
1704 // minimum, increase the dock's size to it's minimum
1705 if (dock
.size
< dock
.min_size
)
1706 dock
.size
= dock
.min_size
;
1709 // determine the dock's mode (fixed or proportional);
1710 // determine whether the dock has only toolbars
1711 bool action_pane_marked
= false;
1713 dock
.toolbar
= true;
1714 for (j
= 0; j
< dock_pane_count
; ++j
)
1716 wxPaneInfo
& pane
= *dock
.panes
.Item(j
);
1717 if (!pane
.IsFixed())
1719 if (!pane
.IsToolbar())
1720 dock
.toolbar
= false;
1721 if (pane
.state
& wxPaneInfo::actionPane
)
1722 action_pane_marked
= true;
1726 // if the dock mode is proportional and not fixed-pixel,
1727 // reassign the dock_pos to the sequential 0, 1, 2, 3;
1728 // e.g. remove gaps like 1, 2, 30, 500
1731 for (j
= 0; j
< dock_pane_count
; ++j
)
1733 wxPaneInfo
& pane
= *dock
.panes
.Item(j
);
1738 // if the dock mode is fixed, and none of the panes
1739 // are being moved right now, make sure the panes
1740 // do not overlap each other. If they do, we will
1741 // adjust the panes' positions
1742 if (dock
.fixed
&& !action_pane_marked
)
1744 wxArrayInt pane_positions
, pane_sizes
;
1745 GetPanePositionsAndSizes(dock
, pane_positions
, pane_sizes
);
1748 for (j
= 0; j
< dock_pane_count
; ++j
)
1750 wxPaneInfo
& pane
= *(dock
.panes
.Item(j
));
1751 pane
.dock_pos
= pane_positions
[j
];
1753 int amount
= pane
.dock_pos
- offset
;
1757 pane
.dock_pos
+= -amount
;
1759 offset
+= pane_sizes
[j
];
1764 // discover the maximum dock layer
1766 for (i
= 0; i
< dock_count
; ++i
)
1767 max_layer
= wxMax(max_layer
, docks
.Item(i
).dock_layer
);
1770 // clear out uiparts
1773 // create a bunch of box sizers,
1774 // from the innermost level outwards.
1775 wxSizer
* cont
= NULL
;
1776 wxSizer
* middle
= NULL
;
1780 for (layer
= 0; layer
<= max_layer
; ++layer
)
1782 wxDockInfoPtrArray arr
;
1784 // find any docks in this layer
1785 FindDocks(docks
, -1, layer
, -1, arr
);
1787 // if there aren't any, skip to the next layer
1791 wxSizer
* old_cont
= cont
;
1793 // create a container which will hold this layer's
1794 // docks (top, bottom, left, right)
1795 cont
= new wxBoxSizer(wxVERTICAL
);
1798 // find any top docks in this layer
1799 FindDocks(docks
, wxAUI_DOCK_TOP
, layer
, -1, arr
);
1800 RenumberDockRows(arr
);
1803 for (row
= 0, row_count
= arr
.GetCount(); row
< row_count
; ++row
)
1804 LayoutAddDock(cont
, *arr
.Item(row
), uiparts
, spacer_only
);
1808 // fill out the middle layer (which consists
1809 // of left docks, content area and right docks)
1811 middle
= new wxBoxSizer(wxHORIZONTAL
);
1813 // find any left docks in this layer
1814 FindDocks(docks
, wxAUI_DOCK_LEFT
, layer
, -1, arr
);
1815 RenumberDockRows(arr
);
1818 for (row
= 0, row_count
= arr
.GetCount(); row
< row_count
; ++row
)
1819 LayoutAddDock(middle
, *arr
.Item(row
), uiparts
, spacer_only
);
1822 // add content dock (or previous layer's sizer
1826 // find any center docks
1827 FindDocks(docks
, wxAUI_DOCK_CENTER
, -1, -1, arr
);
1830 for (row
= 0,row_count
= arr
.GetCount(); row
<row_count
; ++row
)
1831 LayoutAddDock(middle
, *arr
.Item(row
), uiparts
, spacer_only
);
1835 // there are no center docks, add a background area
1836 wxSizerItem
* sizer_item
= middle
->Add(1,1, 1, wxEXPAND
);
1838 part
.type
= wxDockUIPart::typeBackground
;
1842 part
.cont_sizer
= middle
;
1843 part
.sizer_item
= sizer_item
;
1849 middle
->Add(old_cont
, 1, wxEXPAND
);
1852 // find any right docks in this layer
1853 FindDocks(docks
, wxAUI_DOCK_RIGHT
, layer
, -1, arr
);
1854 RenumberDockRows(arr
);
1857 for (row
= arr
.GetCount()-1; row
>= 0; --row
)
1858 LayoutAddDock(middle
, *arr
.Item(row
), uiparts
, spacer_only
);
1861 cont
->Add(middle
, 1, wxEXPAND
);
1865 // find any bottom docks in this layer
1866 FindDocks(docks
, wxAUI_DOCK_BOTTOM
, layer
, -1, arr
);
1867 RenumberDockRows(arr
);
1870 for (row
= arr
.GetCount()-1; row
>= 0; --row
)
1871 LayoutAddDock(cont
, *arr
.Item(row
), uiparts
, spacer_only
);
1878 // no sizer available, because there are no docks,
1879 // therefore we will create a simple background area
1880 cont
= new wxBoxSizer(wxVERTICAL
);
1881 wxSizerItem
* sizer_item
= cont
->Add(1,1, 1, wxEXPAND
);
1883 part
.type
= wxDockUIPart::typeBackground
;
1887 part
.cont_sizer
= middle
;
1888 part
.sizer_item
= sizer_item
;
1892 container
->Add(cont
, 1, wxEXPAND
);
1897 // Update() updates the layout. Whenever changes are made to
1898 // one or more panes, this function should be called. It is the
1899 // external entry point for running the layout engine.
1901 void wxFrameManager::Update()
1904 int i
, pane_count
= m_panes
.GetCount();
1906 // delete old sizer first
1907 m_frame
->SetSizer(NULL
);
1909 // destroy floating panes which have been
1910 // redocked or are becoming non-floating
1911 for (i
= 0; i
< pane_count
; ++i
)
1913 wxPaneInfo
& p
= m_panes
.Item(i
);
1915 if (!p
.IsFloating() && p
.frame
)
1917 // because the pane is no longer in a floating, we need to
1918 // reparent it to m_frame and destroy the floating frame
1921 p
.window
->SetSize(1,1);
1922 p
.frame
->Show(false);
1924 // reparent to m_frame and destroy the pane
1925 p
.window
->Reparent(m_frame
);
1926 p
.frame
->SetSizer(NULL
);
1933 // create a layout for all of the panes
1934 sizer
= LayoutAll(m_panes
, m_docks
, m_uiparts
, false);
1936 // hide or show panes as necessary,
1937 // and float panes as necessary
1938 for (i
= 0; i
< pane_count
; ++i
)
1940 wxPaneInfo
& p
= m_panes
.Item(i
);
1944 if (p
.frame
== NULL
)
1946 // we need to create a frame for this
1947 // pane, which has recently been floated
1948 wxFloatingPane
* frame
= new wxFloatingPane(m_frame
,
1952 // on MSW and Mac, if the owner desires transparent dragging, and
1953 // the dragging is happening right now, then the floating
1954 // window should have this style by default
1955 if (m_action
== actionDragFloatingPane
&&
1956 (m_flags
& wxAUI_MGR_TRANSPARENT_DRAG
))
1957 frame
->SetTransparent(150);
1959 frame
->SetPaneWindow(p
);
1969 // frame already exists, make sure it's position
1970 // and size reflect the information in wxPaneInfo
1971 if (p
.frame
->GetPosition() != p
.floating_pos
)
1973 p
.frame
->SetSize(p
.floating_pos
.x
, p
.floating_pos
.y
,
1974 wxDefaultCoord
, wxDefaultCoord
,
1975 wxSIZE_USE_EXISTING
);
1976 //p.frame->Move(p.floating_pos.x, p.floating_pos.y);
1979 p
.frame
->Show(p
.IsShown());
1984 p
.window
->Show(p
.IsShown());
1987 // if "active panes" are no longer allowed, clear
1988 // any optionActive values from the pane states
1989 if ((m_flags
& wxAUI_MGR_ALLOW_ACTIVE_PANE
) == 0)
1991 p
.state
&= ~wxPaneInfo::optionActive
;
1996 // keep track of the old window rectangles so we can
1997 // refresh those windows whose rect has changed
1998 wxAuiRectArray old_pane_rects
;
1999 for (i
= 0; i
< pane_count
; ++i
)
2002 wxPaneInfo
& p
= m_panes
.Item(i
);
2004 if (p
.window
&& p
.IsShown() && p
.IsDocked())
2007 old_pane_rects
.Add(r
);
2013 // apply the new sizer
2014 m_frame
->SetSizer(sizer
);
2015 m_frame
->SetAutoLayout(false);
2020 // now that the frame layout is done, we need to check
2021 // the new pane rectangles against the old rectangles that
2022 // we saved a few lines above here. If the rectangles have
2023 // changed, the corresponding panes must also be updated
2024 for (i
= 0; i
< pane_count
; ++i
)
2026 wxPaneInfo
& p
= m_panes
.Item(i
);
2027 if (p
.window
&& p
.window
->IsShown() && p
.IsDocked())
2029 if (p
.rect
!= old_pane_rects
[i
])
2031 p
.window
->Refresh();
2040 // set frame's minimum size
2043 // N.B. More work needs to be done on frame minimum sizes;
2044 // this is some intresting code that imposes the minimum size,
2045 // but we may want to include a more flexible mechanism or
2046 // options for multiple minimum-size modes, e.g. strict or lax
2047 wxSize min_size = sizer->GetMinSize();
2048 wxSize frame_size = m_frame->GetSize();
2049 wxSize client_size = m_frame->GetClientSize();
2051 wxSize minframe_size(min_size.x+frame_size.x-client_size.x,
2052 min_size.y+frame_size.y-client_size.y );
2054 m_frame->SetMinSize(minframe_size);
2056 if (frame_size.x < minframe_size.x ||
2057 frame_size.y < minframe_size.y)
2058 sizer->Fit(m_frame);
2063 // DoFrameLayout() is an internal function which invokes wxSizer::Layout
2064 // on the frame's main sizer, then measures all the various UI items
2065 // and updates their internal rectangles. This should always be called
2066 // instead of calling m_frame->Layout() directly
2068 void wxFrameManager::DoFrameLayout()
2073 for (i
= 0, part_count
= m_uiparts
.GetCount(); i
< part_count
; ++i
)
2075 wxDockUIPart
& part
= m_uiparts
.Item(i
);
2077 // get the rectangle of the UI part
2078 // originally, this code looked like this:
2079 // part.rect = wxRect(part.sizer_item->GetPosition(),
2080 // part.sizer_item->GetSize());
2081 // this worked quite well, with one exception: the mdi
2082 // client window had a "deferred" size variable
2083 // that returned the wrong size. It looks like
2084 // a bug in wx, because the former size of the window
2085 // was being returned. So, we will retrieve the part's
2086 // rectangle via other means
2089 part
.rect
= part
.sizer_item
->GetRect();
2090 int flag
= part
.sizer_item
->GetFlag();
2091 int border
= part
.sizer_item
->GetBorder();
2094 part
.rect
.y
-= border
;
2095 part
.rect
.height
+= border
;
2099 part
.rect
.x
-= border
;
2100 part
.rect
.width
+= border
;
2102 if (flag
& wxBOTTOM
)
2103 part
.rect
.height
+= border
;
2105 part
.rect
.width
+= border
;
2108 if (part
.type
== wxDockUIPart::typeDock
)
2109 part
.dock
->rect
= part
.rect
;
2110 if (part
.type
== wxDockUIPart::typePane
)
2111 part
.pane
->rect
= part
.rect
;
2115 // GetPanePart() looks up the pane the pane border UI part (or the regular
2116 // pane part if there is no border). This allows the caller to get the exact
2117 // rectangle of the pane in question, including decorations like
2118 // caption and border (if any).
2120 wxDockUIPart
* wxFrameManager::GetPanePart(wxWindow
* wnd
)
2123 for (i
= 0, part_count
= m_uiparts
.GetCount(); i
< part_count
; ++i
)
2125 wxDockUIPart
& part
= m_uiparts
.Item(i
);
2126 if (part
.type
== wxDockUIPart::typePaneBorder
&&
2127 part
.pane
&& part
.pane
->window
== wnd
)
2130 for (i
= 0, part_count
= m_uiparts
.GetCount(); i
< part_count
; ++i
)
2132 wxDockUIPart
& part
= m_uiparts
.Item(i
);
2133 if (part
.type
== wxDockUIPart::typePane
&&
2134 part
.pane
&& part
.pane
->window
== wnd
)
2142 // GetDockPixelOffset() is an internal function which returns
2143 // a dock's offset in pixels from the left side of the window
2144 // (for horizontal docks) or from the top of the window (for
2145 // vertical docks). This value is necessary for calculating
2146 // fixel-pane/toolbar offsets when they are dragged.
2148 int wxFrameManager::GetDockPixelOffset(wxPaneInfo
& test
)
2150 // the only way to accurately calculate the dock's
2151 // offset is to actually run a theoretical layout
2153 int i
, part_count
, dock_count
;
2154 wxDockInfoArray docks
;
2155 wxPaneInfoArray panes
;
2156 wxDockUIPartArray uiparts
;
2157 CopyDocksAndPanes(docks
, panes
, m_docks
, m_panes
);
2160 wxSizer
* sizer
= LayoutAll(panes
, docks
, uiparts
, true);
2161 wxSize client_size
= m_frame
->GetClientSize();
2162 sizer
->SetDimension(0, 0, client_size
.x
, client_size
.y
);
2165 for (i
= 0, part_count
= uiparts
.GetCount(); i
< part_count
; ++i
)
2167 wxDockUIPart
& part
= uiparts
.Item(i
);
2168 part
.rect
= wxRect(part
.sizer_item
->GetPosition(),
2169 part
.sizer_item
->GetSize());
2170 if (part
.type
== wxDockUIPart::typeDock
)
2171 part
.dock
->rect
= part
.rect
;
2176 for (i
= 0, dock_count
= docks
.GetCount(); i
< dock_count
; ++i
)
2178 wxDockInfo
& dock
= docks
.Item(i
);
2179 if (test
.dock_direction
== dock
.dock_direction
&&
2180 test
.dock_layer
==dock
.dock_layer
&& test
.dock_row
==dock
.dock_row
)
2182 if (dock
.IsVertical())
2194 // ProcessDockResult() is a utility function used by DoDrop() - it checks
2195 // if a dock operation is allowed, the new dock position is copied into
2196 // the target info. If the operation was allowed, the function returns true.
2198 bool wxFrameManager::ProcessDockResult(wxPaneInfo
& target
,
2199 const wxPaneInfo
& new_pos
)
2201 bool allowed
= false;
2202 switch (new_pos
.dock_direction
)
2204 case wxAUI_DOCK_TOP
: allowed
= target
.IsTopDockable(); break;
2205 case wxAUI_DOCK_BOTTOM
: allowed
= target
.IsBottomDockable(); break;
2206 case wxAUI_DOCK_LEFT
: allowed
= target
.IsLeftDockable(); break;
2207 case wxAUI_DOCK_RIGHT
: allowed
= target
.IsRightDockable(); break;
2217 // DoDrop() is an important function. It basically takes a mouse position,
2218 // and determines where the pane's new position would be. If the pane is to be
2219 // dropped, it performs the drop operation using the specified dock and pane
2220 // arrays. By specifying copied dock and pane arrays when calling, a "what-if"
2221 // scenario can be performed, giving precise coordinates for drop hints.
2222 // If, however, wxFrameManager:m_docks and wxFrameManager::m_panes are specified
2223 // as parameters, the changes will be made to the main state arrays
2225 const int auiInsertRowPixels
= 10;
2226 const int auiNewRowPixels
= 40;
2227 const int auiLayerInsertPixels
= 40;
2228 const int auiLayerInsertOffset
= 5;
2230 bool wxFrameManager::DoDrop(wxDockInfoArray
& docks
,
2231 wxPaneInfoArray
& panes
,
2234 const wxPoint
& offset
)
2236 wxSize cli_size
= m_frame
->GetClientSize();
2238 wxPaneInfo drop
= target
;
2241 // The result should always be shown
2245 // Check to see if the pane has been dragged outside of the window
2246 // (or near to the outside of the window), if so, dock it along the edge
2249 int layer_insert_offset
= auiLayerInsertOffset
;
2250 if (target
.IsToolbar())
2251 layer_insert_offset
= 0;
2253 if (pt
.x
< layer_insert_offset
&&
2254 pt
.x
> layer_insert_offset
-auiLayerInsertPixels
)
2256 int new_layer
= wxMax(wxMax(GetMaxLayer(docks
, wxAUI_DOCK_LEFT
),
2257 GetMaxLayer(docks
, wxAUI_DOCK_BOTTOM
)),
2258 GetMaxLayer(docks
, wxAUI_DOCK_TOP
)) + 1;
2262 Position(pt
.y
- GetDockPixelOffset(drop
) - offset
.y
);
2263 return ProcessDockResult(target
, drop
);
2265 else if (pt
.y
< layer_insert_offset
&&
2266 pt
.y
> layer_insert_offset
-auiLayerInsertPixels
)
2268 int new_layer
= wxMax(wxMax(GetMaxLayer(docks
, wxAUI_DOCK_TOP
),
2269 GetMaxLayer(docks
, wxAUI_DOCK_LEFT
)),
2270 GetMaxLayer(docks
, wxAUI_DOCK_RIGHT
)) + 1;
2274 Position(pt
.x
- GetDockPixelOffset(drop
) - offset
.x
);
2275 return ProcessDockResult(target
, drop
);
2277 else if (pt
.x
>= cli_size
.x
- layer_insert_offset
&&
2278 pt
.x
< cli_size
.x
- layer_insert_offset
+ auiLayerInsertPixels
)
2280 int new_layer
= wxMax(wxMax(GetMaxLayer(docks
, wxAUI_DOCK_RIGHT
),
2281 GetMaxLayer(docks
, wxAUI_DOCK_TOP
)),
2282 GetMaxLayer(docks
, wxAUI_DOCK_BOTTOM
)) + 1;
2283 drop
.Dock().Right().
2286 Position(pt
.y
- GetDockPixelOffset(drop
) - offset
.y
);
2287 return ProcessDockResult(target
, drop
);
2289 else if (pt
.y
>= cli_size
.y
- layer_insert_offset
&&
2290 pt
.y
< cli_size
.y
- layer_insert_offset
+ auiLayerInsertPixels
)
2292 int new_layer
= wxMax(wxMax(GetMaxLayer(docks
, wxAUI_DOCK_BOTTOM
),
2293 GetMaxLayer(docks
, wxAUI_DOCK_LEFT
)),
2294 GetMaxLayer(docks
, wxAUI_DOCK_RIGHT
)) + 1;
2295 drop
.Dock().Bottom().
2298 Position(pt
.x
- GetDockPixelOffset(drop
) - offset
.x
);
2299 return ProcessDockResult(target
, drop
);
2303 wxDockUIPart
* part
= HitTest(pt
.x
, pt
.y
);
2306 if (drop
.IsToolbar())
2308 if (!part
|| !part
->dock
)
2312 // calculate the offset from where the dock begins
2313 // to the point where the user dropped the pane
2314 int dock_drop_offset
= 0;
2315 if (part
->dock
->IsHorizontal())
2316 dock_drop_offset
= pt
.x
- part
->dock
->rect
.x
- offset
.x
;
2318 dock_drop_offset
= pt
.y
- part
->dock
->rect
.y
- offset
.y
;
2321 // toolbars may only be moved in and to fixed-pane docks,
2322 // otherwise we will try to float the pane. Also, the pane
2323 // should float if being dragged over center pane windows
2324 if (!part
->dock
->fixed
|| part
->dock
->dock_direction
== wxAUI_DOCK_CENTER
)
2326 if ((m_flags
& wxAUI_MGR_ALLOW_FLOATING
) &&
2327 (drop
.IsFloatable() ||
2328 (part
->dock
->dock_direction
!= wxAUI_DOCK_CENTER
&&
2329 part
->dock
->dock_direction
!= wxAUI_DOCK_NONE
)))
2334 return ProcessDockResult(target
, drop
);
2338 Direction(part
->dock
->dock_direction
).
2339 Layer(part
->dock
->dock_layer
).
2340 Row(part
->dock
->dock_row
).
2341 Position(dock_drop_offset
);
2344 ((pt
.y
< part
->dock
->rect
.y
+ 2) && part
->dock
->IsHorizontal()) ||
2345 ((pt
.x
< part
->dock
->rect
.x
+ 2) && part
->dock
->IsVertical())
2346 ) && part
->dock
->panes
.GetCount() > 1)
2348 int row
= drop
.dock_row
;
2349 DoInsertDockRow(panes
, part
->dock
->dock_direction
,
2350 part
->dock
->dock_layer
,
2351 part
->dock
->dock_row
);
2352 drop
.dock_row
= row
;
2356 ((pt
.y
> part
->dock
->rect
.y
+ part
->dock
->rect
.height
- 2 ) && part
->dock
->IsHorizontal()) ||
2357 ((pt
.x
> part
->dock
->rect
.x
+ part
->dock
->rect
.width
- 2 ) && part
->dock
->IsVertical())
2358 ) && part
->dock
->panes
.GetCount() > 1)
2360 DoInsertDockRow(panes
, part
->dock
->dock_direction
,
2361 part
->dock
->dock_layer
,
2362 part
->dock
->dock_row
+1);
2363 drop
.dock_row
= part
->dock
->dock_row
+1;
2366 return ProcessDockResult(target
, drop
);
2375 if (part
->type
== wxDockUIPart::typePaneBorder
||
2376 part
->type
== wxDockUIPart::typeCaption
||
2377 part
->type
== wxDockUIPart::typeGripper
||
2378 part
->type
== wxDockUIPart::typePaneButton
||
2379 part
->type
== wxDockUIPart::typePane
||
2380 part
->type
== wxDockUIPart::typePaneSizer
||
2381 part
->type
== wxDockUIPart::typeDockSizer
||
2382 part
->type
== wxDockUIPart::typeBackground
)
2384 if (part
->type
== wxDockUIPart::typeDockSizer
)
2386 if (part
->dock
->panes
.GetCount() != 1)
2388 part
= GetPanePart(part
->dock
->panes
.Item(0)->window
);
2395 // If a normal frame is being dragged over a toolbar, insert it
2396 // along the edge under the toolbar, but over all other panes.
2397 // (this could be done much better, but somehow factoring this
2398 // calculation with the one at the beginning of this function)
2399 if (part
->dock
&& part
->dock
->toolbar
)
2403 switch (part
->dock
->dock_direction
)
2405 case wxAUI_DOCK_LEFT
:
2406 layer
= wxMax(wxMax(GetMaxLayer(docks
, wxAUI_DOCK_LEFT
),
2407 GetMaxLayer(docks
, wxAUI_DOCK_BOTTOM
)),
2408 GetMaxLayer(docks
, wxAUI_DOCK_TOP
));
2410 case wxAUI_DOCK_TOP
:
2411 layer
= wxMax(wxMax(GetMaxLayer(docks
, wxAUI_DOCK_TOP
),
2412 GetMaxLayer(docks
, wxAUI_DOCK_LEFT
)),
2413 GetMaxLayer(docks
, wxAUI_DOCK_RIGHT
));
2415 case wxAUI_DOCK_RIGHT
:
2416 layer
= wxMax(wxMax(GetMaxLayer(docks
, wxAUI_DOCK_RIGHT
),
2417 GetMaxLayer(docks
, wxAUI_DOCK_TOP
)),
2418 GetMaxLayer(docks
, wxAUI_DOCK_BOTTOM
));
2420 case wxAUI_DOCK_BOTTOM
:
2421 layer
= wxMax(wxMax(GetMaxLayer(docks
, wxAUI_DOCK_BOTTOM
),
2422 GetMaxLayer(docks
, wxAUI_DOCK_LEFT
)),
2423 GetMaxLayer(docks
, wxAUI_DOCK_RIGHT
));
2427 DoInsertDockRow(panes
, part
->dock
->dock_direction
,
2430 Direction(part
->dock
->dock_direction
).
2431 Layer(layer
).Row(0).Position(0);
2432 return ProcessDockResult(target
, drop
);
2439 part
= GetPanePart(part
->pane
->window
);
2443 bool insert_dock_row
= false;
2444 int insert_row
= part
->pane
->dock_row
;
2445 int insert_dir
= part
->pane
->dock_direction
;
2446 int insert_layer
= part
->pane
->dock_layer
;
2448 switch (part
->pane
->dock_direction
)
2450 case wxAUI_DOCK_TOP
:
2451 if (pt
.y
>= part
->rect
.y
&&
2452 pt
.y
< part
->rect
.y
+auiInsertRowPixels
)
2453 insert_dock_row
= true;
2455 case wxAUI_DOCK_BOTTOM
:
2456 if (pt
.y
> part
->rect
.y
+part
->rect
.height
-auiInsertRowPixels
&&
2457 pt
.y
<= part
->rect
.y
+ part
->rect
.height
)
2458 insert_dock_row
= true;
2460 case wxAUI_DOCK_LEFT
:
2461 if (pt
.x
>= part
->rect
.x
&&
2462 pt
.x
< part
->rect
.x
+auiInsertRowPixels
)
2463 insert_dock_row
= true;
2465 case wxAUI_DOCK_RIGHT
:
2466 if (pt
.x
> part
->rect
.x
+part
->rect
.width
-auiInsertRowPixels
&&
2467 pt
.x
<= part
->rect
.x
+part
->rect
.width
)
2468 insert_dock_row
= true;
2470 case wxAUI_DOCK_CENTER
:
2472 // "new row pixels" will be set to the default, but
2473 // must never exceed 20% of the window size
2474 int new_row_pixels_x
= auiNewRowPixels
;
2475 int new_row_pixels_y
= auiNewRowPixels
;
2477 if (new_row_pixels_x
> (part
->rect
.width
*20)/100)
2478 new_row_pixels_x
= (part
->rect
.width
*20)/100;
2480 if (new_row_pixels_y
> (part
->rect
.height
*20)/100)
2481 new_row_pixels_y
= (part
->rect
.height
*20)/100;
2484 // determine if the mouse pointer is in a location that
2485 // will cause a new row to be inserted. The hot spot positions
2486 // are along the borders of the center pane
2489 insert_dock_row
= true;
2490 if (pt
.x
>= part
->rect
.x
&&
2491 pt
.x
< part
->rect
.x
+new_row_pixels_x
)
2492 insert_dir
= wxAUI_DOCK_LEFT
;
2494 if (pt
.y
>= part
->rect
.y
&&
2495 pt
.y
< part
->rect
.y
+new_row_pixels_y
)
2496 insert_dir
= wxAUI_DOCK_TOP
;
2498 if (pt
.x
>= part
->rect
.x
+ part
->rect
.width
-new_row_pixels_x
&&
2499 pt
.x
< part
->rect
.x
+ part
->rect
.width
)
2500 insert_dir
= wxAUI_DOCK_RIGHT
;
2502 if (pt
.y
>= part
->rect
.y
+ part
->rect
.height
-new_row_pixels_y
&&
2503 pt
.y
< part
->rect
.y
+ part
->rect
.height
)
2504 insert_dir
= wxAUI_DOCK_BOTTOM
;
2508 insert_row
= GetMaxRow(panes
, insert_dir
, insert_layer
) + 1;
2512 if (insert_dock_row
)
2514 DoInsertDockRow(panes
, insert_dir
, insert_layer
, insert_row
);
2515 drop
.Dock().Direction(insert_dir
).
2516 Layer(insert_layer
).
2519 return ProcessDockResult(target
, drop
);
2522 // determine the mouse offset and the pane size, both in the
2523 // direction of the dock itself, and perpendicular to the dock
2527 if (part
->orientation
== wxVERTICAL
)
2529 offset
= pt
.y
- part
->rect
.y
;
2530 size
= part
->rect
.GetHeight();
2534 offset
= pt
.x
- part
->rect
.x
;
2535 size
= part
->rect
.GetWidth();
2538 int drop_position
= part
->pane
->dock_pos
;
2540 // if we are in the top/left part of the pane,
2541 // insert the pane before the pane being hovered over
2542 if (offset
<= size
/2)
2544 drop_position
= part
->pane
->dock_pos
;
2546 part
->pane
->dock_direction
,
2547 part
->pane
->dock_layer
,
2548 part
->pane
->dock_row
,
2549 part
->pane
->dock_pos
);
2552 // if we are in the bottom/right part of the pane,
2553 // insert the pane before the pane being hovered over
2554 if (offset
> size
/2)
2556 drop_position
= part
->pane
->dock_pos
+1;
2558 part
->pane
->dock_direction
,
2559 part
->pane
->dock_layer
,
2560 part
->pane
->dock_row
,
2561 part
->pane
->dock_pos
+1);
2565 Direction(part
->dock
->dock_direction
).
2566 Layer(part
->dock
->dock_layer
).
2567 Row(part
->dock
->dock_row
).
2568 Position(drop_position
);
2569 return ProcessDockResult(target
, drop
);
2576 void wxFrameManager::OnHintFadeTimer(wxTimerEvent
& WXUNUSED(event
))
2578 if (!m_hint_wnd
|| m_hint_fadeamt
>= m_hint_fademax
)
2580 m_hint_fadetimer
.Stop();
2584 m_hint_fadeamt
+= 4;
2585 m_hint_wnd
->SetTransparent(m_hint_fadeamt
);
2588 void wxFrameManager::ShowHint(const wxRect
& rect
)
2590 if ((m_flags
& wxAUI_MGR_TRANSPARENT_HINT
) != 0
2592 // Finally, don't use a venetian blind effect if it's been specifically disabled
2593 && !((m_hint_wnd
->IsKindOf(CLASSINFO(wxPseudoTransparentFrame
))) &&
2594 (m_flags
& wxAUI_MGR_DISABLE_VENETIAN_BLINDS
))
2597 if (m_last_hint
== rect
)
2601 m_hint_fadeamt
= m_hint_fademax
;
2602 if ((m_flags
& wxAUI_MGR_TRANSPARENT_HINT_FADE
)
2603 && !((m_hint_wnd
->IsKindOf(CLASSINFO(wxPseudoTransparentFrame
))) &&
2604 (m_flags
& wxAUI_MGR_DISABLE_VENETIAN_BLINDS_FADE
))
2608 if (! m_hint_wnd
->IsShown())
2611 // if we are dragging a floating pane, set the focus
2612 // back to that floating pane (otherwise it becomes unfocused)
2613 if (m_action
== actionDragFloatingPane
&& m_action_window
)
2614 m_action_window
->SetFocus();
2616 m_hint_wnd
->SetTransparent(m_hint_fadeamt
);
2617 m_hint_wnd
->SetSize(rect
);
2618 m_hint_wnd
->Raise();
2621 if (m_hint_fadeamt
!= m_hint_fademax
) // Only fade if we need to
2623 // start fade in timer
2624 m_hint_fadetimer
.SetOwner(this, 101);
2625 m_hint_fadetimer
.Start(5);
2629 else // Not using a transparent hint window...
2632 if (m_last_hint
!= rect
)
2634 // remove the last hint rectangle
2640 wxScreenDC screendc
;
2641 wxRegion
clip(1, 1, 10000, 10000);
2643 // clip all floating windows, so we don't draw over them
2645 for (i
= 0, pane_count
= m_panes
.GetCount(); i
< pane_count
; ++i
)
2647 wxPaneInfo
& pane
= m_panes
.Item(i
);
2649 if (pane
.IsFloating() &&
2650 pane
.frame
->IsShown())
2652 wxRect rect
= pane
.frame
->GetRect();
2654 // wxGTK returns the client size, not the whole frame size
2660 clip
.Subtract(rect
);
2664 // As we can only hide the hint by redrawing the managed window, we
2665 // need to clip the region to the managed window too or we get
2666 // nasty redrawn problems.
2667 clip
.Intersect(m_frame
->GetRect());
2669 screendc
.SetClippingRegion(clip
);
2671 wxBitmap stipple
= wxPaneCreateStippleBitmap();
2672 wxBrush
brush(stipple
);
2673 screendc
.SetBrush(brush
);
2674 screendc
.SetPen(*wxTRANSPARENT_PEN
);
2676 screendc
.DrawRectangle(rect
.x
, rect
.y
, 5, rect
.height
);
2677 screendc
.DrawRectangle(rect
.x
+5, rect
.y
, rect
.width
-10, 5);
2678 screendc
.DrawRectangle(rect
.x
+rect
.width
-5, rect
.y
, 5, rect
.height
);
2679 screendc
.DrawRectangle(rect
.x
+5, rect
.y
+rect
.height
-5, rect
.width
-10, 5);
2683 void wxFrameManager::HideHint()
2685 // hides a transparent window hint, if there is one
2688 m_hint_wnd
->Show(false);
2689 m_hint_wnd
->SetTransparent(0);
2690 m_hint_fadetimer
.Stop();
2691 m_last_hint
= wxRect();
2695 // hides a painted hint by redrawing the frame window
2696 if (!m_last_hint
.IsEmpty())
2700 m_last_hint
= wxRect();
2706 // DrawHintRect() draws a drop hint rectangle. First calls DoDrop() to
2707 // determine the exact position the pane would be at were if dropped. If
2708 // the pame would indeed become docked at the specified drop point,
2709 // DrawHintRect() then calls ShowHint() to indicate this drop rectangle.
2710 // "pane_window" is the window pointer of the pane being dragged, pt is
2711 // the mouse position, in client coordinates
2712 void wxFrameManager::DrawHintRect(wxWindow
* pane_window
,
2714 const wxPoint
& offset
)
2718 // we need to paint a hint rectangle; to find out the exact hint rectangle,
2719 // we will create a new temporary layout and then measure the resulting
2720 // rectangle; we will create a copy of the docking structures (m_dock)
2721 // so that we don't modify the real thing on screen
2723 int i
, pane_count
, part_count
;
2724 wxDockInfoArray docks
;
2725 wxPaneInfoArray panes
;
2726 wxDockUIPartArray uiparts
;
2727 wxPaneInfo hint
= GetPane(pane_window
);
2728 hint
.name
= wxT("__HINT__");
2734 CopyDocksAndPanes(docks
, panes
, m_docks
, m_panes
);
2736 // remove any pane already there which bears the same window;
2737 // this happens when you are moving a pane around in a dock
2738 for (i
= 0, pane_count
= panes
.GetCount(); i
< pane_count
; ++i
)
2740 if (panes
.Item(i
).window
== pane_window
)
2742 RemovePaneFromDocks(docks
, panes
.Item(i
));
2748 // find out where the new pane would be
2749 if (!DoDrop(docks
, panes
, hint
, pt
, offset
))
2757 wxSizer
* sizer
= LayoutAll(panes
, docks
, uiparts
, true);
2758 wxSize client_size
= m_frame
->GetClientSize();
2759 sizer
->SetDimension(0, 0, client_size
.x
, client_size
.y
);
2762 for (i
= 0, part_count
= uiparts
.GetCount();
2763 i
< part_count
; ++i
)
2765 wxDockUIPart
& part
= uiparts
.Item(i
);
2767 if (part
.type
== wxDockUIPart::typePaneBorder
&&
2768 part
.pane
&& part
.pane
->name
== wxT("__HINT__"))
2770 rect
= wxRect(part
.sizer_item
->GetPosition(),
2771 part
.sizer_item
->GetSize());
2784 // actually show the hint rectangle on the screen
2785 m_frame
->ClientToScreen(&rect
.x
, &rect
.y
);
2789 void wxFrameManager::OnFloatingPaneMoveStart(wxWindow
* wnd
)
2791 // try to find the pane
2792 wxPaneInfo
& pane
= GetPane(wnd
);
2793 wxASSERT_MSG(pane
.IsOk(), wxT("Pane window not found"));
2795 if (m_flags
& wxAUI_MGR_TRANSPARENT_DRAG
)
2796 pane
.frame
->SetTransparent(150);
2799 void wxFrameManager::OnFloatingPaneMoving(wxWindow
* wnd
)
2801 // try to find the pane
2802 wxPaneInfo
& pane
= GetPane(wnd
);
2803 wxASSERT_MSG(pane
.IsOk(), wxT("Pane window not found"));
2805 wxPoint pt
= ::wxGetMousePosition();
2806 wxPoint client_pt
= m_frame
->ScreenToClient(pt
);
2808 // calculate the offset from the upper left-hand corner
2809 // of the frame to the mouse pointer
2810 wxPoint frame_pos
= pane
.frame
->GetPosition();
2811 wxPoint
action_offset(pt
.x
-frame_pos
.x
, pt
.y
-frame_pos
.y
);
2813 // no hint for toolbar floating windows
2814 if (pane
.IsToolbar() && m_action
== actionDragFloatingPane
)
2816 if (m_action
== actionDragFloatingPane
)
2818 wxDockInfoArray docks
;
2819 wxPaneInfoArray panes
;
2820 wxDockUIPartArray uiparts
;
2821 wxPaneInfo hint
= pane
;
2823 CopyDocksAndPanes(docks
, panes
, m_docks
, m_panes
);
2825 // find out where the new pane would be
2826 if (!DoDrop(docks
, panes
, hint
, client_pt
))
2828 if (hint
.IsFloating())
2832 m_action
= actionDragToolbarPane
;
2833 m_action_window
= pane
.window
;
2842 // if a key modifier is pressed while dragging the frame,
2843 // don't dock the window
2844 if (wxGetKeyState(WXK_CONTROL
) || wxGetKeyState(WXK_ALT
))
2851 DrawHintRect(wnd
, client_pt
, action_offset
);
2854 // this cleans up some screen artifacts that are caused on GTK because
2855 // we aren't getting the exact size of the window (see comment
2865 void wxFrameManager::OnFloatingPaneMoved(wxWindow
* wnd
)
2867 // try to find the pane
2868 wxPaneInfo
& pane
= GetPane(wnd
);
2869 wxASSERT_MSG(pane
.IsOk(), wxT("Pane window not found"));
2871 wxPoint pt
= ::wxGetMousePosition();
2872 wxPoint client_pt
= m_frame
->ScreenToClient(pt
);
2874 // calculate the offset from the upper left-hand corner
2875 // of the frame to the mouse pointer
2876 wxPoint frame_pos
= pane
.frame
->GetPosition();
2877 wxPoint
action_offset(pt
.x
-frame_pos
.x
, pt
.y
-frame_pos
.y
);
2880 // if a key modifier is pressed while dragging the frame,
2881 // don't dock the window
2882 if (!wxGetKeyState(WXK_CONTROL
) && !wxGetKeyState(WXK_ALT
))
2884 // do the drop calculation
2885 DoDrop(m_docks
, m_panes
, pane
, client_pt
, action_offset
);
2888 // if the pane is still floating, update it's floating
2889 // position (that we store)
2890 if (pane
.IsFloating())
2892 pane
.floating_pos
= pane
.frame
->GetPosition();
2894 if (m_flags
& wxAUI_MGR_TRANSPARENT_DRAG
)
2895 pane
.frame
->SetTransparent(255);
2903 void wxFrameManager::OnFloatingPaneResized(wxWindow
* wnd
, const wxSize
& size
)
2905 // try to find the pane
2906 wxPaneInfo
& pane
= GetPane(wnd
);
2907 wxASSERT_MSG(pane
.IsOk(), wxT("Pane window not found"));
2909 pane
.floating_size
= size
;
2913 void wxFrameManager::OnFloatingPaneClosed(wxWindow
* wnd
, wxCloseEvent
& evt
)
2915 // try to find the pane
2916 wxPaneInfo
& pane
= GetPane(wnd
);
2917 wxASSERT_MSG(pane
.IsOk(), wxT("Pane window not found"));
2920 // fire pane close event
2921 wxFrameManagerEvent
e(wxEVT_AUI_PANECLOSE
);
2923 e
.SetCanVeto(evt
.CanVeto());
2933 // reparent the pane window back to us and
2934 // prepare the frame window for destruction
2935 pane
.window
->Show(false);
2936 pane
.window
->Reparent(m_frame
);
2944 void wxFrameManager::OnFloatingPaneActivated(wxWindow
* wnd
)
2946 if (GetFlags() & wxAUI_MGR_ALLOW_ACTIVE_PANE
)
2948 // try to find the pane
2949 wxASSERT_MSG(GetPane(wnd
).IsOk(), wxT("Pane window not found"));
2951 SetActivePane(m_panes
, wnd
);
2956 // OnRender() draws all of the pane captions, sashes,
2957 // backgrounds, captions, grippers, pane borders and buttons.
2958 // It renders the entire user interface.
2960 void wxFrameManager::OnRender(wxFrameManagerEvent
& evt
)
2962 wxDC
* dc
= evt
.GetDC();
2968 for (i
= 0, part_count
= m_uiparts
.GetCount();
2969 i
< part_count
; ++i
)
2971 wxDockUIPart
& part
= m_uiparts
.Item(i
);
2973 // don't draw hidden pane items
2974 if (part
.sizer_item
&& !part
.sizer_item
->IsShown())
2979 case wxDockUIPart::typeDockSizer
:
2980 case wxDockUIPart::typePaneSizer
:
2981 m_art
->DrawSash(*dc
, part
.orientation
, part
.rect
);
2983 case wxDockUIPart::typeBackground
:
2984 m_art
->DrawBackground(*dc
, part
.orientation
, part
.rect
);
2986 case wxDockUIPart::typeCaption
:
2987 m_art
->DrawCaption(*dc
, part
.pane
->caption
, part
.rect
, *part
.pane
);
2989 case wxDockUIPart::typeGripper
:
2990 m_art
->DrawGripper(*dc
, part
.rect
, *part
.pane
);
2992 case wxDockUIPart::typePaneBorder
:
2993 m_art
->DrawBorder(*dc
, part
.rect
, *part
.pane
);
2995 case wxDockUIPart::typePaneButton
:
2996 m_art
->DrawPaneButton(*dc
, part
.button
->button_id
,
2997 wxAUI_BUTTON_STATE_NORMAL
, part
.rect
, *part
.pane
);
3004 // Render() fire a render event, which is normally handled by
3005 // wxFrameManager::OnRender(). This allows the render function to
3006 // be overridden via the render event. This can be useful for paintin
3007 // custom graphics in the main window. Default behavior can be
3008 // invoked in the overridden function by calling OnRender()
3010 void wxFrameManager::Render(wxDC
* dc
)
3012 wxFrameManagerEvent
e(wxEVT_AUI_RENDER
);
3017 void wxFrameManager::Repaint(wxDC
* dc
)
3022 m_frame
->Refresh() ;
3028 m_frame
->GetClientSize(&w
, &h
);
3030 // figure out which dc to use; if one
3031 // has been specified, use it, otherwise
3033 wxClientDC
* client_dc
= NULL
;
3036 client_dc
= new wxClientDC(m_frame
);
3040 // if the frame has a toolbar, the client area
3041 // origin will not be (0,0).
3042 wxPoint pt
= m_frame
->GetClientAreaOrigin();
3043 if (pt
.x
!= 0 || pt
.y
!= 0)
3044 dc
->SetDeviceOrigin(pt
.x
, pt
.y
);
3046 // render all the items
3049 // if we created a client_dc, delete it
3054 void wxFrameManager::OnPaint(wxPaintEvent
& WXUNUSED(event
))
3056 wxPaintDC
dc(m_frame
);
3060 void wxFrameManager::OnEraseBackground(wxEraseEvent
& event
)
3069 void wxFrameManager::OnSize(wxSizeEvent
& WXUNUSED(event
))
3079 void wxFrameManager::OnSetCursor(wxSetCursorEvent
& event
)
3082 wxDockUIPart
* part
= HitTest(event
.GetX(), event
.GetY());
3083 wxCursor cursor
= wxNullCursor
;
3087 if (part
->type
== wxDockUIPart::typeDockSizer
||
3088 part
->type
== wxDockUIPart::typePaneSizer
)
3090 // a dock may not be resized if it has a single
3091 // pane which is not resizable
3092 if (part
->type
== wxDockUIPart::typeDockSizer
&& part
->dock
&&
3093 part
->dock
->panes
.GetCount() == 1 &&
3094 part
->dock
->panes
.Item(0)->IsFixed())
3097 // panes that may not be resized do not get a sizing cursor
3098 if (part
->pane
&& part
->pane
->IsFixed())
3101 if (part
->orientation
== wxVERTICAL
)
3102 cursor
= wxCursor(wxCURSOR_SIZEWE
);
3104 cursor
= wxCursor(wxCURSOR_SIZENS
);
3106 else if (part
->type
== wxDockUIPart::typeGripper
)
3108 cursor
= wxCursor(wxCURSOR_SIZING
);
3112 event
.SetCursor(cursor
);
3117 void wxFrameManager::UpdateButtonOnScreen(wxDockUIPart
* button_ui_part
,
3118 const wxMouseEvent
& event
)
3120 wxDockUIPart
* hit_test
= HitTest(event
.GetX(), event
.GetY());
3122 int state
= wxAUI_BUTTON_STATE_NORMAL
;
3124 if (hit_test
== button_ui_part
)
3126 if (event
.LeftDown())
3127 state
= wxAUI_BUTTON_STATE_PRESSED
;
3129 state
= wxAUI_BUTTON_STATE_HOVER
;
3133 if (event
.LeftDown())
3134 state
= wxAUI_BUTTON_STATE_HOVER
;
3137 // now repaint the button with hover state
3138 wxClientDC
cdc(m_frame
);
3140 // if the frame has a toolbar, the client area
3141 // origin will not be (0,0).
3142 wxPoint pt
= m_frame
->GetClientAreaOrigin();
3143 if (pt
.x
!= 0 || pt
.y
!= 0)
3144 cdc
.SetDeviceOrigin(pt
.x
, pt
.y
);
3146 m_art
->DrawPaneButton(cdc
,
3147 button_ui_part
->button
->button_id
,
3149 button_ui_part
->rect
,
3153 void wxFrameManager::OnLeftDown(wxMouseEvent
& event
)
3155 wxDockUIPart
* part
= HitTest(event
.GetX(), event
.GetY());
3158 if (part
->dock
&& part
->dock
->dock_direction
== wxAUI_DOCK_CENTER
)
3161 if (part
->type
== wxDockUIPart::typeDockSizer
||
3162 part
->type
== wxDockUIPart::typePaneSizer
)
3164 // a dock may not be resized if it has a single
3165 // pane which is not resizable
3166 if (part
->type
== wxDockUIPart::typeDockSizer
&& part
->dock
&&
3167 part
->dock
->panes
.GetCount() == 1 &&
3168 part
->dock
->panes
.Item(0)->IsFixed())
3171 // panes that may not be resized should be ignored here
3172 if (part
->pane
&& part
->pane
->IsFixed())
3175 m_action
= actionResize
;
3176 m_action_part
= part
;
3177 m_action_hintrect
= wxRect();
3178 m_action_start
= wxPoint(event
.m_x
, event
.m_y
);
3179 m_action_offset
= wxPoint(event
.m_x
- part
->rect
.x
,
3180 event
.m_y
- part
->rect
.y
);
3181 m_frame
->CaptureMouse();
3183 else if (part
->type
== wxDockUIPart::typePaneButton
)
3185 m_action
= actionClickButton
;
3186 m_action_part
= part
;
3187 m_action_start
= wxPoint(event
.m_x
, event
.m_y
);
3188 m_frame
->CaptureMouse();
3190 UpdateButtonOnScreen(part
, event
);
3192 else if (part
->type
== wxDockUIPart::typeCaption
||
3193 part
->type
== wxDockUIPart::typeGripper
)
3195 if (GetFlags() & wxAUI_MGR_ALLOW_ACTIVE_PANE
)
3197 // set the caption as active
3198 SetActivePane(m_panes
, part
->pane
->window
);
3202 m_action
= actionClickCaption
;
3203 m_action_part
= part
;
3204 m_action_start
= wxPoint(event
.m_x
, event
.m_y
);
3205 m_action_offset
= wxPoint(event
.m_x
- part
->rect
.x
,
3206 event
.m_y
- part
->rect
.y
);
3207 m_frame
->CaptureMouse();
3227 void wxFrameManager::OnLeftUp(wxMouseEvent
& event
)
3229 if (m_action
== actionResize
)
3231 m_frame
->ReleaseMouse();
3233 // get rid of the hint rectangle
3235 DrawResizeHint(dc
, m_action_hintrect
);
3237 // resize the dock or the pane
3238 if (m_action_part
&& m_action_part
->type
==wxDockUIPart::typeDockSizer
)
3240 wxRect
& rect
= m_action_part
->dock
->rect
;
3242 wxPoint
new_pos(event
.m_x
- m_action_offset
.x
,
3243 event
.m_y
- m_action_offset
.y
);
3245 switch (m_action_part
->dock
->dock_direction
)
3247 case wxAUI_DOCK_LEFT
:
3248 m_action_part
->dock
->size
= new_pos
.x
- rect
.x
;
3250 case wxAUI_DOCK_TOP
:
3251 m_action_part
->dock
->size
= new_pos
.y
- rect
.y
;
3253 case wxAUI_DOCK_RIGHT
:
3254 m_action_part
->dock
->size
= rect
.x
+ rect
.width
-
3255 new_pos
.x
- m_action_part
->rect
.GetWidth();
3257 case wxAUI_DOCK_BOTTOM
:
3258 m_action_part
->dock
->size
= rect
.y
+ rect
.height
-
3259 new_pos
.y
- m_action_part
->rect
.GetHeight();
3266 else if (m_action_part
&&
3267 m_action_part
->type
== wxDockUIPart::typePaneSizer
)
3269 wxDockInfo
& dock
= *m_action_part
->dock
;
3270 wxPaneInfo
& pane
= *m_action_part
->pane
;
3272 int total_proportion
= 0;
3273 int dock_pixels
= 0;
3274 int new_pixsize
= 0;
3276 int caption_size
= m_art
->GetMetric(wxAUI_ART_CAPTION_SIZE
);
3277 int pane_border_size
= m_art
->GetMetric(wxAUI_ART_PANE_BORDER_SIZE
);
3278 int sash_size
= m_art
->GetMetric(wxAUI_ART_SASH_SIZE
);
3280 wxPoint
new_pos(event
.m_x
- m_action_offset
.x
,
3281 event
.m_y
- m_action_offset
.y
);
3283 // determine the pane rectangle by getting the pane part
3284 wxDockUIPart
* pane_part
= GetPanePart(pane
.window
);
3285 wxASSERT_MSG(pane_part
,
3286 wxT("Pane border part not found -- shouldn't happen"));
3288 // determine the new pixel size that the user wants;
3289 // this will help us recalculate the pane's proportion
3290 if (dock
.IsHorizontal())
3291 new_pixsize
= new_pos
.x
- pane_part
->rect
.x
;
3293 new_pixsize
= new_pos
.y
- pane_part
->rect
.y
;
3295 // determine the size of the dock, based on orientation
3296 if (dock
.IsHorizontal())
3297 dock_pixels
= dock
.rect
.GetWidth();
3299 dock_pixels
= dock
.rect
.GetHeight();
3301 // determine the total proportion of all resizable panes,
3302 // and the total size of the dock minus the size of all
3304 int i
, dock_pane_count
= dock
.panes
.GetCount();
3305 int pane_position
= -1;
3306 for (i
= 0; i
< dock_pane_count
; ++i
)
3308 wxPaneInfo
& p
= *dock
.panes
.Item(i
);
3309 if (p
.window
== pane
.window
)
3312 // while we're at it, subtract the pane sash
3313 // width from the dock width, because this would
3314 // skew our proportion calculations
3316 dock_pixels
-= sash_size
;
3318 // also, the whole size (including decorations) of
3319 // all fixed panes must also be subtracted, because they
3320 // are not part of the proportion calculation
3323 if (dock
.IsHorizontal())
3324 dock_pixels
-= p
.best_size
.x
;
3326 dock_pixels
-= p
.best_size
.y
;
3330 total_proportion
+= p
.dock_proportion
;
3334 // find a pane in our dock to 'steal' space from or to 'give'
3335 // space to -- this is essentially what is done when a pane is
3336 // resized; the pane should usually be the first non-fixed pane
3337 // to the right of the action pane
3338 int borrow_pane
= -1;
3339 for (i
= pane_position
+1; i
< dock_pane_count
; ++i
)
3341 wxPaneInfo
& p
= *dock
.panes
.Item(i
);
3350 // demand that the pane being resized is found in this dock
3351 // (this assert really never should be raised)
3352 wxASSERT_MSG(pane_position
!= -1, wxT("Pane not found in dock"));
3354 // prevent division by zero
3355 if (dock_pixels
== 0 || total_proportion
== 0 || borrow_pane
== -1)
3357 m_action
= actionNone
;
3361 // calculate the new proportion of the pane
3362 int new_proportion
= (new_pixsize
*total_proportion
)/dock_pixels
;
3364 // default minimum size
3367 // check against the pane's minimum size, if specified. please note
3368 // that this is not enough to ensure that the minimum size will
3369 // not be violated, because the whole frame might later be shrunk,
3370 // causing the size of the pane to violate it's minimum size
3371 if (pane
.min_size
.IsFullySpecified())
3375 if (pane
.HasBorder())
3376 min_size
+= (pane_border_size
*2);
3378 // calculate minimum size with decorations (border,caption)
3379 if (pane_part
->orientation
== wxVERTICAL
)
3381 min_size
+= pane
.min_size
.y
;
3382 if (pane
.HasCaption())
3383 min_size
+= caption_size
;
3387 min_size
+= pane
.min_size
.x
;
3392 // for some reason, an arithmatic error somewhere is causing
3393 // the proportion calculations to always be off by 1 pixel;
3394 // for now we will add the 1 pixel on, but we really should
3395 // determine what's causing this.
3398 int min_proportion
= (min_size
*total_proportion
)/dock_pixels
;
3400 if (new_proportion
< min_proportion
)
3401 new_proportion
= min_proportion
;
3405 int prop_diff
= new_proportion
- pane
.dock_proportion
;
3407 // borrow the space from our neighbor pane to the
3408 // right or bottom (depending on orientation)
3409 dock
.panes
.Item(borrow_pane
)->dock_proportion
-= prop_diff
;
3410 pane
.dock_proportion
= new_proportion
;
3417 else if (m_action
== actionClickButton
)
3419 m_hover_button
= NULL
;
3420 m_frame
->ReleaseMouse();
3421 UpdateButtonOnScreen(m_action_part
, event
);
3423 // make sure we're still over the item that was originally clicked
3424 if (m_action_part
== HitTest(event
.GetX(), event
.GetY()))
3426 // fire button-click event
3427 wxFrameManagerEvent
e(wxEVT_AUI_PANEBUTTON
);
3428 e
.SetPane(m_action_part
->pane
);
3429 e
.SetButton(m_action_part
->button
->button_id
);
3433 else if (m_action
== actionClickCaption
)
3435 m_frame
->ReleaseMouse();
3437 else if (m_action
== actionDragFloatingPane
)
3439 m_frame
->ReleaseMouse();
3441 else if (m_action
== actionDragToolbarPane
)
3443 m_frame
->ReleaseMouse();
3445 wxPaneInfo
& pane
= GetPane(m_action_window
);
3446 wxASSERT_MSG(pane
.IsOk(), wxT("Pane window not found"));
3448 // save the new positions
3449 wxDockInfoPtrArray docks
;
3450 FindDocks(m_docks
, pane
.dock_direction
,
3451 pane
.dock_layer
, pane
.dock_row
, docks
);
3452 if (docks
.GetCount() == 1)
3454 wxDockInfo
& dock
= *docks
.Item(0);
3456 wxArrayInt pane_positions
, pane_sizes
;
3457 GetPanePositionsAndSizes(dock
, pane_positions
, pane_sizes
);
3459 int i
, dock_pane_count
= dock
.panes
.GetCount();
3460 for (i
= 0; i
< dock_pane_count
; ++i
)
3461 dock
.panes
.Item(i
)->dock_pos
= pane_positions
[i
];
3464 pane
.state
&= ~wxPaneInfo::actionPane
;
3472 m_action
= actionNone
;
3473 m_last_mouse_move
= wxPoint(); // see comment in OnMotion()
3477 void wxFrameManager::OnMotion(wxMouseEvent
& event
)
3479 // sometimes when Update() is called from inside this method,
3480 // a spurious mouse move event is generated; this check will make
3481 // sure that only real mouse moves will get anywhere in this method;
3482 // this appears to be a bug somewhere, and I don't know where the
3483 // mouse move event is being generated. only verified on MSW
3485 wxPoint mouse_pos
= event
.GetPosition();
3486 if (m_last_mouse_move
== mouse_pos
)
3488 m_last_mouse_move
= mouse_pos
;
3491 if (m_action
== actionResize
)
3493 wxPoint pos
= m_action_part
->rect
.GetPosition();
3494 if (m_action_part
->orientation
== wxHORIZONTAL
)
3495 pos
.y
= wxMax(0, event
.m_y
- m_action_offset
.y
);
3497 pos
.x
= wxMax(0, event
.m_x
- m_action_offset
.x
);
3499 wxRect
rect(m_frame
->ClientToScreen(pos
),
3500 m_action_part
->rect
.GetSize());
3503 if (!m_action_hintrect
.IsEmpty())
3504 DrawResizeHint(dc
, m_action_hintrect
);
3505 DrawResizeHint(dc
, rect
);
3506 m_action_hintrect
= rect
;
3508 else if (m_action
== actionClickCaption
)
3510 int drag_x_threshold
= wxSystemSettings::GetMetric(wxSYS_DRAG_X
);
3511 int drag_y_threshold
= wxSystemSettings::GetMetric(wxSYS_DRAG_Y
);
3513 // caption has been clicked. we need to check if the mouse
3514 // is now being dragged. if it is, we need to change the
3515 // mouse action to 'drag'
3516 if (abs(event
.m_x
- m_action_start
.x
) > drag_x_threshold
||
3517 abs(event
.m_y
- m_action_start
.y
) > drag_y_threshold
)
3519 wxPaneInfo
* pane_info
= m_action_part
->pane
;
3521 if (!pane_info
->IsToolbar())
3523 if ((m_flags
& wxAUI_MGR_ALLOW_FLOATING
) &&
3524 pane_info
->IsFloatable())
3526 m_action
= actionDragFloatingPane
;
3528 // set initial float position
3529 wxPoint pt
= m_frame
->ClientToScreen(event
.GetPosition());
3530 pane_info
->floating_pos
= wxPoint(pt
.x
- m_action_offset
.x
,
3531 pt
.y
- m_action_offset
.y
);
3536 m_action_window
= pane_info
->frame
;
3538 // action offset is used here to make it feel "natural" to the user
3539 // to drag a docked pane and suddenly have it become a floating frame.
3540 // Sometimes, however, the offset where the user clicked on the docked
3541 // caption is bigger than the width of the floating frame itself, so
3542 // in that case we need to set the action offset to a sensible value
3543 wxSize frame_size
= m_action_window
->GetSize();
3544 if (frame_size
.x
<= m_action_offset
.x
)
3545 m_action_offset
.x
= 30;
3550 m_action
= actionDragToolbarPane
;
3551 m_action_window
= pane_info
->window
;
3555 else if (m_action
== actionDragFloatingPane
)
3557 wxPoint pt
= m_frame
->ClientToScreen(event
.GetPosition());
3558 m_action_window
->Move(pt
.x
- m_action_offset
.x
,
3559 pt
.y
- m_action_offset
.y
);
3561 else if (m_action
== actionDragToolbarPane
)
3563 wxPaneInfo
& pane
= GetPane(m_action_window
);
3564 wxASSERT_MSG(pane
.IsOk(), wxT("Pane window not found"));
3566 pane
.state
|= wxPaneInfo::actionPane
;
3568 wxPoint pt
= event
.GetPosition();
3569 DoDrop(m_docks
, m_panes
, pane
, pt
, m_action_offset
);
3571 // if DoDrop() decided to float the pane, set up
3572 // the floating pane's initial position
3573 if (pane
.IsFloating())
3575 wxPoint pt
= m_frame
->ClientToScreen(event
.GetPosition());
3576 pane
.floating_pos
= wxPoint(pt
.x
- m_action_offset
.x
,
3577 pt
.y
- m_action_offset
.y
);
3580 // this will do the actiual move operation;
3581 // in the case that the pane has been floated,
3582 // this call will create the floating pane
3583 // and do the reparenting
3586 // if the pane has been floated, change the mouse
3587 // action actionDragFloatingPane so that subsequent
3588 // EVT_MOTION() events will move the floating pane
3589 if (pane
.IsFloating())
3591 pane
.state
&= ~wxPaneInfo::actionPane
;
3592 m_action
= actionDragFloatingPane
;
3593 m_action_window
= pane
.frame
;
3598 wxDockUIPart
* part
= HitTest(event
.GetX(), event
.GetY());
3599 if (part
&& part
->type
== wxDockUIPart::typePaneButton
)
3601 if (part
!= m_hover_button
)
3603 // make the old button normal
3605 UpdateButtonOnScreen(m_hover_button
, event
);
3607 // mouse is over a button, so repaint the
3608 // button in hover mode
3609 UpdateButtonOnScreen(part
, event
);
3610 m_hover_button
= part
;
3617 m_hover_button
= NULL
;
3628 void wxFrameManager::OnLeaveWindow(wxMouseEvent
& WXUNUSED(event
))
3632 m_hover_button
= NULL
;
3637 void wxFrameManager::OnChildFocus(wxChildFocusEvent
& event
)
3639 // when a child pane has it's focus set, we should change the
3640 // pane's active state to reflect this. (this is only true if
3641 // active panes are allowed by the owner)
3642 if (GetFlags() & wxAUI_MGR_ALLOW_ACTIVE_PANE
)
3644 if (GetPane(event
.GetWindow()).IsOk())
3646 SetActivePane(m_panes
, event
.GetWindow());
3655 // OnPaneButton() is an event handler that is called
3656 // when a pane button has been pressed.
3657 void wxFrameManager::OnPaneButton(wxFrameManagerEvent
& evt
)
3659 wxASSERT_MSG(evt
.pane
, wxT("Pane Info passed to wxFrameManager::OnPaneButton must be non-null"));
3661 wxPaneInfo
& pane
= *(evt
.pane
);
3663 if (evt
.button
== wxPaneInfo::buttonClose
)
3665 // fire pane close event
3666 wxFrameManagerEvent
e(wxEVT_AUI_PANECLOSE
);
3667 e
.SetPane(evt
.pane
);
3676 else if (evt
.button
== wxPaneInfo::buttonPin
)
3678 if ((m_flags
& wxAUI_MGR_ALLOW_FLOATING
) &&