1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/aui/tabmdi.cpp
3 // Purpose: Generic MDI (Multiple Document Interface) classes
4 // Author: Hans Van Leemputten
5 // Modified by: Benjamin I. Williams / Kirix Corporation
8 // Copyright: (c) Hans Van Leemputten
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ===========================================================================
14 // ===========================================================================
16 // ---------------------------------------------------------------------------
18 // ---------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
30 #include "wx/aui/tabmdi.h"
37 #include "wx/settings.h"
40 #include "wx/stockitem.h"
50 //-----------------------------------------------------------------------------
51 // wxAuiMDIParentFrame
52 //-----------------------------------------------------------------------------
54 IMPLEMENT_DYNAMIC_CLASS(wxAuiMDIParentFrame
, wxFrame
)
56 BEGIN_EVENT_TABLE(wxAuiMDIParentFrame
, wxFrame
)
58 EVT_MENU (wxID_ANY
, wxAuiMDIParentFrame
::DoHandleMenu
)
62 wxAuiMDIParentFrame
::wxAuiMDIParentFrame()
67 wxAuiMDIParentFrame
::wxAuiMDIParentFrame(wxWindow
*parent
,
69 const wxString
& title
,
76 (void)Create(parent
, id
, title
, pos
, size
, style
, name
);
79 wxAuiMDIParentFrame
::~wxAuiMDIParentFrame()
81 // Make sure the client window is destructed before the menu bars are!
82 wxDELETE(m_pClientWindow
);
85 RemoveWindowMenu(GetMenuBar());
90 bool wxAuiMDIParentFrame
::Create(wxWindow
*parent
,
92 const wxString
& title
,
99 // this style can be used to prevent a window from having the standard MDI
101 if (!(style
& wxFRAME_NO_WINDOW_MENU
))
103 m_pWindowMenu
= new wxMenu
;
104 m_pWindowMenu
->Append(wxWINDOWCLOSE
, _("Cl&ose"));
105 m_pWindowMenu
->Append(wxWINDOWCLOSEALL
, _("Close All"));
106 m_pWindowMenu
->AppendSeparator();
107 m_pWindowMenu
->Append(wxWINDOWNEXT
, _("&Next"));
108 m_pWindowMenu
->Append(wxWINDOWPREV
, _("&Previous"));
110 #endif // wxUSE_MENUS
112 wxFrame
::Create(parent
, id
, title
, pos
, size
, style
, name
);
118 void wxAuiMDIParentFrame
::SetArtProvider(wxAuiTabArt
* provider
)
122 m_pClientWindow
->SetArtProvider(provider
);
126 wxAuiTabArt
* wxAuiMDIParentFrame
::GetArtProvider()
128 if (!m_pClientWindow
)
131 return m_pClientWindow
->GetArtProvider();
134 wxAuiNotebook
* wxAuiMDIParentFrame
::GetNotebook() const
136 return static_cast<wxAuiNotebook
*>(m_pClientWindow
);
142 void wxAuiMDIParentFrame
::SetWindowMenu(wxMenu
* pMenu
)
144 // Replace the window menu from the currently loaded menu bar.
145 wxMenuBar
*pMenuBar
= GetMenuBar();
149 RemoveWindowMenu(pMenuBar
);
150 wxDELETE(m_pWindowMenu
);
155 m_pWindowMenu
= pMenu
;
156 AddWindowMenu(pMenuBar
);
160 void wxAuiMDIParentFrame
::SetMenuBar(wxMenuBar
* pMenuBar
)
162 // Remove the Window menu from the old menu bar
163 RemoveWindowMenu(GetMenuBar());
165 // Add the Window menu to the new menu bar.
166 AddWindowMenu(pMenuBar
);
168 wxFrame
::SetMenuBar(pMenuBar
);
169 m_pMyMenuBar
= GetMenuBar();
171 #endif // wxUSE_MENUS
173 void wxAuiMDIParentFrame
::SetChildMenuBar(wxAuiMDIChildFrame
* pChild
)
178 // No Child, set Our menu bar back.
179 SetMenuBar(m_pMyMenuBar
);
181 // Make sure we know our menu bar is in use
182 //m_pMyMenuBar = NULL;
186 if (pChild
->GetMenuBar() == NULL
)
189 // Do we need to save the current bar?
190 if (m_pMyMenuBar
== NULL
)
191 m_pMyMenuBar
= GetMenuBar();
193 SetMenuBar(pChild
->GetMenuBar());
195 #endif // wxUSE_MENUS
198 bool wxAuiMDIParentFrame
::ProcessEvent(wxEvent
& event
)
200 // stops the same event being processed repeatedly
201 if (m_pLastEvt
== &event
)
205 // let the active child (if any) process the event first.
207 if (m_pActiveChild
&&
208 event
.IsCommandEvent() &&
209 event
.GetEventObject() != m_pClientWindow
&&
210 !(event
.GetEventType() == wxEVT_ACTIVATE
||
211 event
.GetEventType() == wxEVT_SET_FOCUS
||
212 event
.GetEventType() == wxEVT_KILL_FOCUS
||
213 event
.GetEventType() == wxEVT_CHILD_FOCUS
||
214 event
.GetEventType() == wxEVT_COMMAND_SET_FOCUS
||
215 event
.GetEventType() == wxEVT_COMMAND_KILL_FOCUS
)
218 res
= m_pActiveChild
->GetEventHandler()->ProcessEvent(event
);
223 // if the event was not handled this frame will handle it,
224 // which is why we need the protection code at the beginning
226 res
= wxEvtHandler
::ProcessEvent(event
);
234 wxAuiMDIChildFrame
*wxAuiMDIParentFrame
::GetActiveChild() const
236 return m_pActiveChild
;
239 void wxAuiMDIParentFrame
::SetActiveChild(wxAuiMDIChildFrame
* pChildFrame
)
241 m_pActiveChild
= pChildFrame
;
244 wxAuiMDIClientWindow
*wxAuiMDIParentFrame
::GetClientWindow() const
246 return m_pClientWindow
;
249 wxAuiMDIClientWindow
*wxAuiMDIParentFrame
::OnCreateClient()
251 m_pClientWindow
= new wxAuiMDIClientWindow( this );
252 return m_pClientWindow
;
255 void wxAuiMDIParentFrame
::ActivateNext()
257 if (m_pClientWindow
&& m_pClientWindow
->GetSelection() != wxNOT_FOUND
)
259 size_t active
= m_pClientWindow
->GetSelection() + 1;
260 if (active
>= m_pClientWindow
->GetPageCount())
263 m_pClientWindow
->SetSelection(active
);
267 void wxAuiMDIParentFrame
::ActivatePrevious()
269 if (m_pClientWindow
&& m_pClientWindow
->GetSelection() != wxNOT_FOUND
)
271 int active
= m_pClientWindow
->GetSelection() - 1;
273 active
= m_pClientWindow
->GetPageCount() - 1;
275 m_pClientWindow
->SetSelection(active
);
279 void wxAuiMDIParentFrame
::Init()
282 m_pClientWindow
= NULL
;
283 m_pActiveChild
= NULL
;
285 m_pWindowMenu
= NULL
;
287 #endif // wxUSE_MENUS
291 void wxAuiMDIParentFrame
::RemoveWindowMenu(wxMenuBar
* pMenuBar
)
293 if (pMenuBar
&& m_pWindowMenu
)
295 // Remove old window menu
296 int pos
= pMenuBar
->FindMenu(_("&Window"));
297 if (pos
!= wxNOT_FOUND
)
299 // DBG:: We're going to delete the wrong menu!!!
300 wxASSERT(m_pWindowMenu
== pMenuBar
->GetMenu(pos
));
301 pMenuBar
->Remove(pos
);
306 void wxAuiMDIParentFrame
::AddWindowMenu(wxMenuBar
*pMenuBar
)
308 if (pMenuBar
&& m_pWindowMenu
)
310 int pos
= pMenuBar
->FindMenu(wxGetStockLabel(wxID_HELP
,wxSTOCK_NOFLAGS
));
311 if (pos
== wxNOT_FOUND
)
312 pMenuBar
->Append(m_pWindowMenu
, _("&Window"));
314 pMenuBar
->Insert(pos
, m_pWindowMenu
, _("&Window"));
318 void wxAuiMDIParentFrame
::DoHandleMenu(wxCommandEvent
& event
)
320 switch (event
.GetId())
324 m_pActiveChild
->Close();
326 case wxWINDOWCLOSEALL
:
327 while (m_pActiveChild
)
329 if (!m_pActiveChild
->Close())
335 delete m_pActiveChild
;
336 m_pActiveChild
= NULL
;
350 #endif // wxUSE_MENUS
352 void wxAuiMDIParentFrame
::DoGetClientSize(int* width
, int* height
) const
354 wxFrame
::DoGetClientSize(width
, height
);
357 //-----------------------------------------------------------------------------
358 // wxAuiMDIChildFrame
359 //-----------------------------------------------------------------------------
361 IMPLEMENT_DYNAMIC_CLASS(wxAuiMDIChildFrame
, wxPanel
)
363 BEGIN_EVENT_TABLE(wxAuiMDIChildFrame
, wxPanel
)
364 EVT_MENU_HIGHLIGHT_ALL(wxAuiMDIChildFrame
::OnMenuHighlight
)
365 EVT_ACTIVATE(wxAuiMDIChildFrame
::OnActivate
)
366 EVT_CLOSE(wxAuiMDIChildFrame
::OnCloseWindow
)
369 wxAuiMDIChildFrame
::wxAuiMDIChildFrame()
374 wxAuiMDIChildFrame
::wxAuiMDIChildFrame(wxAuiMDIParentFrame
*parent
,
376 const wxString
& title
,
377 const wxPoint
& WXUNUSED(pos
),
380 const wxString
& name
)
383 Create(parent
, id
, title
, wxDefaultPosition
, size
, style
, name
);
386 wxAuiMDIChildFrame
::~wxAuiMDIChildFrame()
389 wxDELETE(m_pMenuBar
);
390 #endif // wxUSE_MENUS
393 bool wxAuiMDIChildFrame
::Create(wxAuiMDIParentFrame
* parent
,
395 const wxString
& title
,
396 const wxPoint
& WXUNUSED(pos
),
399 const wxString
& name
)
401 wxAuiMDIClientWindow
* pClientWindow
= parent
->GetClientWindow();
402 wxASSERT_MSG((pClientWindow
!= (wxWindow
*) NULL
), wxT("Missing MDI client window."));
404 wxSize cli_size
= pClientWindow
->GetClientSize();
406 // create the window off-screen to prevent flicker
407 wxPanel
::Create(pClientWindow
,
409 wxPoint(cli_size
.x
+1, cli_size
.y
+1),
411 style
|wxNO_BORDER
, name
);
413 SetMDIParentFrame(parent
);
415 // this is the currently active child
416 parent
->SetActiveChild(this);
420 pClientWindow
->AddPage(this, title
, true);
421 pClientWindow
->Refresh();
426 bool wxAuiMDIChildFrame
::Destroy()
428 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
429 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
431 wxAuiMDIClientWindow
* pClientWindow
= pParentFrame
->GetClientWindow();
432 wxASSERT_MSG(pClientWindow
, wxT("Missing MDI Client Window"));
434 if (pParentFrame
->GetActiveChild() == this)
436 // deactivate ourself
437 wxActivateEvent
event(wxEVT_ACTIVATE
, false, GetId());
438 event
.SetEventObject(this);
439 GetEventHandler()->ProcessEvent(event
);
441 pParentFrame
->SetActiveChild(NULL
);
442 pParentFrame
->SetChildMenuBar(NULL
);
445 size_t page_count
= pClientWindow
->GetPageCount();
446 for (size_t pos
= 0; pos
< page_count
; pos
++)
448 if (pClientWindow
->GetPage(pos
) == this)
449 return pClientWindow
->DeletePage(pos
);
456 void wxAuiMDIChildFrame
::SetMenuBar(wxMenuBar
*menu_bar
)
458 wxMenuBar
*pOldMenuBar
= m_pMenuBar
;
459 m_pMenuBar
= menu_bar
;
463 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
464 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
466 m_pMenuBar
->SetParent(pParentFrame
);
467 if (pParentFrame
->GetActiveChild() == this)
469 // replace current menu bars
471 pParentFrame
->SetChildMenuBar(NULL
);
472 pParentFrame
->SetChildMenuBar(this);
477 wxMenuBar
*wxAuiMDIChildFrame
::GetMenuBar() const
481 #endif // wxUSE_MENUS
483 void wxAuiMDIChildFrame
::SetTitle(const wxString
& title
)
487 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
488 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
490 wxAuiMDIClientWindow
* pClientWindow
= pParentFrame
->GetClientWindow();
491 if (pClientWindow
!= NULL
)
494 for (pos
= 0; pos
< pClientWindow
->GetPageCount(); pos
++)
496 if (pClientWindow
->GetPage(pos
) == this)
498 pClientWindow
->SetPageText(pos
, m_title
);
505 wxString wxAuiMDIChildFrame
::GetTitle() const
510 void wxAuiMDIChildFrame
::SetIcons(const wxIconBundle
& icons
)
512 // get icon with the system icon size
513 SetIcon(icons
.GetIcon(-1));
514 m_icon_bundle
= icons
;
517 const wxIconBundle
& wxAuiMDIChildFrame
::GetIcons() const
519 return m_icon_bundle
;
522 void wxAuiMDIChildFrame
::SetIcon(const wxIcon
& icon
)
524 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
525 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
530 bmp
.CopyFromIcon(m_icon
);
532 wxAuiMDIClientWindow
* pClientWindow
= pParentFrame
->GetClientWindow();
533 if (pClientWindow
!= NULL
)
535 int idx
= pClientWindow
->GetPageIndex(this);
539 pClientWindow
->SetPageBitmap((size_t)idx
, bmp
);
544 const wxIcon
& wxAuiMDIChildFrame
::GetIcon() const
550 void wxAuiMDIChildFrame
::Activate()
552 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
553 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
555 wxAuiMDIClientWindow
* pClientWindow
= pParentFrame
->GetClientWindow();
557 if (pClientWindow
!= NULL
)
560 for (pos
= 0; pos
< pClientWindow
->GetPageCount(); pos
++)
562 if (pClientWindow
->GetPage(pos
) == this)
564 pClientWindow
->SetSelection(pos
);
571 void wxAuiMDIChildFrame
::OnMenuHighlight(wxMenuEvent
& event
)
574 if (m_pMDIParentFrame
)
576 // we don't have any help text for this item,
577 // but may be the MDI frame does?
578 m_pMDIParentFrame
->OnMenuHighlight(event
);
582 #endif // wxUSE_STATUSBAR
585 void wxAuiMDIChildFrame
::OnActivate(wxActivateEvent
& WXUNUSED(event
))
590 void wxAuiMDIChildFrame
::OnCloseWindow(wxCloseEvent
& WXUNUSED(event
))
595 void wxAuiMDIChildFrame
::SetMDIParentFrame(wxAuiMDIParentFrame
* parentFrame
)
597 m_pMDIParentFrame
= parentFrame
;
600 wxAuiMDIParentFrame
* wxAuiMDIChildFrame
::GetMDIParentFrame() const
602 return m_pMDIParentFrame
;
605 void wxAuiMDIChildFrame
::Init()
607 m_pMDIParentFrame
= NULL
;
610 #endif // wxUSE_MENUS
613 bool wxAuiMDIChildFrame
::Show(bool WXUNUSED(show
))
619 void wxAuiMDIChildFrame
::DoShow(bool show
)
621 wxWindow
::Show(show
);
624 void wxAuiMDIChildFrame
::DoSetSize(int x
, int y
, int width
, int height
, int sizeFlags
)
626 m_mdi_newrect
= wxRect(x
, y
, width
, height
);
628 wxPanel
::DoSetSize(x
,y
,width
, height
, sizeFlags
);
630 wxUnusedVar(sizeFlags
);
634 void wxAuiMDIChildFrame
::DoMoveWindow(int x
, int y
, int width
, int height
)
636 m_mdi_newrect
= wxRect(x
, y
, width
, height
);
639 void wxAuiMDIChildFrame
::ApplyMDIChildFrameRect()
641 if (m_mdi_currect
!= m_mdi_newrect
)
643 wxPanel
::DoMoveWindow(m_mdi_newrect
.x
, m_mdi_newrect
.y
,
644 m_mdi_newrect
.width
, m_mdi_newrect
.height
);
645 m_mdi_currect
= m_mdi_newrect
;
650 //-----------------------------------------------------------------------------
651 // wxAuiMDIClientWindow
652 //-----------------------------------------------------------------------------
654 IMPLEMENT_DYNAMIC_CLASS(wxAuiMDIClientWindow
, wxAuiNotebook
)
656 BEGIN_EVENT_TABLE(wxAuiMDIClientWindow
, wxAuiNotebook
)
657 EVT_AUINOTEBOOK_PAGE_CHANGED(wxID_ANY
, wxAuiMDIClientWindow
::OnPageChanged
)
658 EVT_AUINOTEBOOK_PAGE_CLOSE(wxID_ANY
, wxAuiMDIClientWindow
::OnPageClose
)
659 EVT_SIZE(wxAuiMDIClientWindow
::OnSize
)
662 wxAuiMDIClientWindow
::wxAuiMDIClientWindow()
666 wxAuiMDIClientWindow
::wxAuiMDIClientWindow(wxAuiMDIParentFrame
* parent
, long style
)
668 CreateClient(parent
, style
);
671 wxAuiMDIClientWindow
::~wxAuiMDIClientWindow()
676 bool wxAuiMDIClientWindow
::CreateClient(wxAuiMDIParentFrame
* parent
, long style
)
678 SetWindowStyleFlag(style
);
680 if (!wxAuiNotebook
::Create(parent
,
684 wxAUI_NB_DEFAULT_STYLE
| wxNO_BORDER
))
689 wxColour bkcolour
= wxSystemSettings
::GetColour(wxSYS_COLOUR_APPWORKSPACE
);
690 SetBackgroundColour(bkcolour
);
692 m_mgr
.GetArtProvider()->SetColour(wxAUI_ART_BACKGROUND_COLOUR
, bkcolour
);
697 int wxAuiMDIClientWindow
::SetSelection(size_t nPage
)
699 return wxAuiNotebook
::SetSelection(nPage
);
702 void wxAuiMDIClientWindow
::PageChanged(int old_selection
, int new_selection
)
704 // don't do anything if the page doesn't actually change
705 if (old_selection
== new_selection
)
709 // don't do anything if the new page is already active
710 if (new_selection != -1)
712 wxAuiMDIChildFrame* child = (wxAuiMDIChildFrame*)GetPage(new_selection);
713 if (child->GetMDIParentFrame()->GetActiveChild() == child)
718 // notify old active child that it has been deactivated
719 if (old_selection
!= -1)
721 wxAuiMDIChildFrame
* old_child
= (wxAuiMDIChildFrame
*)GetPage(old_selection
);
722 wxASSERT_MSG(old_child
, wxT("wxAuiMDIClientWindow::PageChanged - null page pointer"));
724 wxActivateEvent
event(wxEVT_ACTIVATE
, false, old_child
->GetId());
725 event
.SetEventObject(old_child
);
726 old_child
->GetEventHandler()->ProcessEvent(event
);
729 // notify new active child that it has been activated
730 if (new_selection
!= -1)
732 wxAuiMDIChildFrame
* active_child
= (wxAuiMDIChildFrame
*)GetPage(new_selection
);
733 wxASSERT_MSG(active_child
, wxT("wxAuiMDIClientWindow::PageChanged - null page pointer"));
735 wxActivateEvent
event(wxEVT_ACTIVATE
, true, active_child
->GetId());
736 event
.SetEventObject(active_child
);
737 active_child
->GetEventHandler()->ProcessEvent(event
);
739 if (active_child
->GetMDIParentFrame())
741 active_child
->GetMDIParentFrame()->SetActiveChild(active_child
);
742 active_child
->GetMDIParentFrame()->SetChildMenuBar(active_child
);
749 void wxAuiMDIClientWindow
::OnPageClose(wxAuiNotebookEvent
& evt
)
751 wxAuiMDIChildFrame
* wnd
;
752 wnd
= static_cast<wxAuiMDIChildFrame
*>(GetPage(evt
.GetSelection()));
756 // regardless of the result of wnd->Close(), we've
757 // already taken care of the close operations, so
758 // suppress further processing
762 void wxAuiMDIClientWindow
::OnPageChanged(wxAuiNotebookEvent
& evt
)
764 PageChanged(evt
.GetOldSelection(), evt
.GetSelection());
767 void wxAuiMDIClientWindow
::OnSize(wxSizeEvent
& evt
)
769 wxAuiNotebook
::OnSize(evt
);
771 for (size_t pos
= 0; pos
< GetPageCount(); pos
++)
772 ((wxAuiMDIChildFrame
*)GetPage(pos
))->ApplyMDIChildFrameRect();