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 void wxAuiMDIParentFrame::Tile(wxOrientation orient
)
359 wxAuiMDIClientWindow
* client_window
= GetClientWindow();
360 wxASSERT_MSG(client_window
, wxT("Missing MDI Client Window"));
362 int cur_idx
= client_window
->GetSelection();
366 if (orient
== wxVERTICAL
)
368 client_window
->Split(cur_idx
, wxLEFT
);
370 else if (orient
== wxHORIZONTAL
)
372 client_window
->Split(cur_idx
, wxTOP
);
377 //-----------------------------------------------------------------------------
378 // wxAuiMDIChildFrame
379 //-----------------------------------------------------------------------------
381 IMPLEMENT_DYNAMIC_CLASS(wxAuiMDIChildFrame
, wxPanel
)
383 BEGIN_EVENT_TABLE(wxAuiMDIChildFrame
, wxPanel
)
384 EVT_MENU_HIGHLIGHT_ALL(wxAuiMDIChildFrame::OnMenuHighlight
)
385 EVT_ACTIVATE(wxAuiMDIChildFrame::OnActivate
)
386 EVT_CLOSE(wxAuiMDIChildFrame::OnCloseWindow
)
389 wxAuiMDIChildFrame::wxAuiMDIChildFrame()
394 wxAuiMDIChildFrame::wxAuiMDIChildFrame(wxAuiMDIParentFrame
*parent
,
396 const wxString
& title
,
397 const wxPoint
& WXUNUSED(pos
),
400 const wxString
& name
)
404 // There are two ways to create an tabbed mdi child fram without
405 // making it the active document. Either Show(false) can be called
406 // before Create() (as is customary on some ports with wxFrame-type
407 // windows), or wxMINIMIZE can be passed in the style flags. Note that
408 // wxAuiMDIChildFrame is not really derived from wxFrame, as wxMDIChildFrame
409 // is, but those are the expected symantics. No style flag is passed
410 // onto the panel underneath.
411 if (style
& wxMINIMIZE
)
412 m_activate_on_create
= false;
414 Create(parent
, id
, title
, wxDefaultPosition
, size
, 0, name
);
417 wxAuiMDIChildFrame::~wxAuiMDIChildFrame()
420 wxDELETE(m_pMenuBar
);
421 #endif // wxUSE_MENUS
424 bool wxAuiMDIChildFrame::Create(wxAuiMDIParentFrame
* parent
,
426 const wxString
& title
,
427 const wxPoint
& WXUNUSED(pos
),
430 const wxString
& name
)
432 wxAuiMDIClientWindow
* pClientWindow
= parent
->GetClientWindow();
433 wxASSERT_MSG((pClientWindow
!= (wxWindow
*) NULL
), wxT("Missing MDI client window."));
435 // see comment in constructor
436 if (style
& wxMINIMIZE
)
437 m_activate_on_create
= false;
439 wxSize cli_size
= pClientWindow
->GetClientSize();
441 // create the window off-screen to prevent flicker
442 wxPanel::Create(pClientWindow
,
444 wxPoint(cli_size
.x
+1, cli_size
.y
+1),
450 SetMDIParentFrame(parent
);
452 // this is the currently active child
453 parent
->SetActiveChild(this);
457 pClientWindow
->AddPage(this, title
, m_activate_on_create
);
458 pClientWindow
->Refresh();
463 bool wxAuiMDIChildFrame::Destroy()
465 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
466 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
468 wxAuiMDIClientWindow
* pClientWindow
= pParentFrame
->GetClientWindow();
469 wxASSERT_MSG(pClientWindow
, wxT("Missing MDI Client Window"));
471 if (pParentFrame
->GetActiveChild() == this)
473 // deactivate ourself
474 wxActivateEvent
event(wxEVT_ACTIVATE
, false, GetId());
475 event
.SetEventObject(this);
476 GetEventHandler()->ProcessEvent(event
);
478 pParentFrame
->SetActiveChild(NULL
);
479 pParentFrame
->SetChildMenuBar(NULL
);
482 size_t page_count
= pClientWindow
->GetPageCount();
483 for (size_t pos
= 0; pos
< page_count
; pos
++)
485 if (pClientWindow
->GetPage(pos
) == this)
486 return pClientWindow
->DeletePage(pos
);
493 void wxAuiMDIChildFrame::SetMenuBar(wxMenuBar
*menu_bar
)
495 wxMenuBar
*pOldMenuBar
= m_pMenuBar
;
496 m_pMenuBar
= menu_bar
;
500 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
501 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
503 m_pMenuBar
->SetParent(pParentFrame
);
504 if (pParentFrame
->GetActiveChild() == this)
506 // replace current menu bars
508 pParentFrame
->SetChildMenuBar(NULL
);
509 pParentFrame
->SetChildMenuBar(this);
514 wxMenuBar
*wxAuiMDIChildFrame::GetMenuBar() const
518 #endif // wxUSE_MENUS
520 void wxAuiMDIChildFrame::SetTitle(const wxString
& title
)
524 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
525 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
527 wxAuiMDIClientWindow
* pClientWindow
= pParentFrame
->GetClientWindow();
528 if (pClientWindow
!= NULL
)
531 for (pos
= 0; pos
< pClientWindow
->GetPageCount(); pos
++)
533 if (pClientWindow
->GetPage(pos
) == this)
535 pClientWindow
->SetPageText(pos
, m_title
);
542 wxString
wxAuiMDIChildFrame::GetTitle() const
547 void wxAuiMDIChildFrame::SetIcons(const wxIconBundle
& icons
)
549 // get icon with the system icon size
550 SetIcon(icons
.GetIcon(-1));
551 m_icon_bundle
= icons
;
554 const wxIconBundle
& wxAuiMDIChildFrame::GetIcons() const
556 return m_icon_bundle
;
559 void wxAuiMDIChildFrame::SetIcon(const wxIcon
& icon
)
561 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
562 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
567 bmp
.CopyFromIcon(m_icon
);
569 wxAuiMDIClientWindow
* pClientWindow
= pParentFrame
->GetClientWindow();
570 if (pClientWindow
!= NULL
)
572 int idx
= pClientWindow
->GetPageIndex(this);
576 pClientWindow
->SetPageBitmap((size_t)idx
, bmp
);
581 const wxIcon
& wxAuiMDIChildFrame::GetIcon() const
587 void wxAuiMDIChildFrame::Activate()
589 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
590 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
592 wxAuiMDIClientWindow
* pClientWindow
= pParentFrame
->GetClientWindow();
594 if (pClientWindow
!= NULL
)
597 for (pos
= 0; pos
< pClientWindow
->GetPageCount(); pos
++)
599 if (pClientWindow
->GetPage(pos
) == this)
601 pClientWindow
->SetSelection(pos
);
608 void wxAuiMDIChildFrame::OnMenuHighlight(wxMenuEvent
& event
)
611 if (m_pMDIParentFrame
)
613 // we don't have any help text for this item,
614 // but may be the MDI frame does?
615 m_pMDIParentFrame
->OnMenuHighlight(event
);
619 #endif // wxUSE_STATUSBAR
622 void wxAuiMDIChildFrame::OnActivate(wxActivateEvent
& WXUNUSED(event
))
627 void wxAuiMDIChildFrame::OnCloseWindow(wxCloseEvent
& WXUNUSED(event
))
632 void wxAuiMDIChildFrame::SetMDIParentFrame(wxAuiMDIParentFrame
* parentFrame
)
634 m_pMDIParentFrame
= parentFrame
;
637 wxAuiMDIParentFrame
* wxAuiMDIChildFrame::GetMDIParentFrame() const
639 return m_pMDIParentFrame
;
642 void wxAuiMDIChildFrame::Init()
644 m_activate_on_create
= true;
645 m_pMDIParentFrame
= NULL
;
648 #endif // wxUSE_MENUS
651 bool wxAuiMDIChildFrame::Show(bool show
)
653 m_activate_on_create
= show
;
659 void wxAuiMDIChildFrame::DoShow(bool show
)
661 wxWindow::Show(show
);
664 void wxAuiMDIChildFrame::DoSetSize(int x
, int y
, int width
, int height
, int sizeFlags
)
666 m_mdi_newrect
= wxRect(x
, y
, width
, height
);
668 wxPanel::DoSetSize(x
,y
,width
, height
, sizeFlags
);
670 wxUnusedVar(sizeFlags
);
674 void wxAuiMDIChildFrame::DoMoveWindow(int x
, int y
, int width
, int height
)
676 m_mdi_newrect
= wxRect(x
, y
, width
, height
);
679 void wxAuiMDIChildFrame::ApplyMDIChildFrameRect()
681 if (m_mdi_currect
!= m_mdi_newrect
)
683 wxPanel::DoMoveWindow(m_mdi_newrect
.x
, m_mdi_newrect
.y
,
684 m_mdi_newrect
.width
, m_mdi_newrect
.height
);
685 m_mdi_currect
= m_mdi_newrect
;
690 //-----------------------------------------------------------------------------
691 // wxAuiMDIClientWindow
692 //-----------------------------------------------------------------------------
694 IMPLEMENT_DYNAMIC_CLASS(wxAuiMDIClientWindow
, wxAuiNotebook
)
696 BEGIN_EVENT_TABLE(wxAuiMDIClientWindow
, wxAuiNotebook
)
697 EVT_AUINOTEBOOK_PAGE_CHANGED(wxID_ANY
, wxAuiMDIClientWindow::OnPageChanged
)
698 EVT_AUINOTEBOOK_PAGE_CLOSE(wxID_ANY
, wxAuiMDIClientWindow::OnPageClose
)
699 EVT_SIZE(wxAuiMDIClientWindow::OnSize
)
702 wxAuiMDIClientWindow::wxAuiMDIClientWindow()
706 wxAuiMDIClientWindow::wxAuiMDIClientWindow(wxAuiMDIParentFrame
* parent
, long style
)
708 CreateClient(parent
, style
);
711 wxAuiMDIClientWindow::~wxAuiMDIClientWindow()
716 bool wxAuiMDIClientWindow::CreateClient(wxAuiMDIParentFrame
* parent
, long style
)
718 SetWindowStyleFlag(style
);
720 wxSize caption_icon_size
=
721 wxSize(wxSystemSettings::GetMetric(wxSYS_SMALLICON_X
),
722 wxSystemSettings::GetMetric(wxSYS_SMALLICON_Y
));
723 SetUniformBitmapSize(caption_icon_size
);
725 if (!wxAuiNotebook::Create(parent
,
729 wxAUI_NB_DEFAULT_STYLE
| wxNO_BORDER
))
734 wxColour bkcolour
= wxSystemSettings::GetColour(wxSYS_COLOUR_APPWORKSPACE
);
735 SetOwnBackgroundColour(bkcolour
);
737 m_mgr
.GetArtProvider()->SetColour(wxAUI_DOCKART_BACKGROUND_COLOUR
, bkcolour
);
742 int wxAuiMDIClientWindow::SetSelection(size_t nPage
)
744 return wxAuiNotebook::SetSelection(nPage
);
747 void wxAuiMDIClientWindow::PageChanged(int old_selection
, int new_selection
)
749 // don't do anything if the page doesn't actually change
750 if (old_selection
== new_selection
)
754 // don't do anything if the new page is already active
755 if (new_selection != -1)
757 wxAuiMDIChildFrame* child = (wxAuiMDIChildFrame*)GetPage(new_selection);
758 if (child->GetMDIParentFrame()->GetActiveChild() == child)
763 // notify old active child that it has been deactivated
764 if (old_selection
!= -1)
766 wxAuiMDIChildFrame
* old_child
= (wxAuiMDIChildFrame
*)GetPage(old_selection
);
767 wxASSERT_MSG(old_child
, wxT("wxAuiMDIClientWindow::PageChanged - null page pointer"));
769 wxActivateEvent
event(wxEVT_ACTIVATE
, false, old_child
->GetId());
770 event
.SetEventObject(old_child
);
771 old_child
->GetEventHandler()->ProcessEvent(event
);
774 // notify new active child that it has been activated
775 if (new_selection
!= -1)
777 wxAuiMDIChildFrame
* active_child
= (wxAuiMDIChildFrame
*)GetPage(new_selection
);
778 wxASSERT_MSG(active_child
, wxT("wxAuiMDIClientWindow::PageChanged - null page pointer"));
780 wxActivateEvent
event(wxEVT_ACTIVATE
, true, active_child
->GetId());
781 event
.SetEventObject(active_child
);
782 active_child
->GetEventHandler()->ProcessEvent(event
);
784 if (active_child
->GetMDIParentFrame())
786 active_child
->GetMDIParentFrame()->SetActiveChild(active_child
);
787 active_child
->GetMDIParentFrame()->SetChildMenuBar(active_child
);
794 void wxAuiMDIClientWindow::OnPageClose(wxAuiNotebookEvent
& evt
)
796 wxAuiMDIChildFrame
* wnd
;
797 wnd
= static_cast<wxAuiMDIChildFrame
*>(GetPage(evt
.GetSelection()));
801 // regardless of the result of wnd->Close(), we've
802 // already taken care of the close operations, so
803 // suppress further processing
807 void wxAuiMDIClientWindow::OnPageChanged(wxAuiNotebookEvent
& evt
)
809 PageChanged(evt
.GetOldSelection(), evt
.GetSelection());
812 void wxAuiMDIClientWindow::OnSize(wxSizeEvent
& evt
)
814 wxAuiNotebook::OnSize(evt
);
816 for (size_t pos
= 0; pos
< GetPageCount(); pos
++)
817 ((wxAuiMDIChildFrame
*)GetPage(pos
))->ApplyMDIChildFrameRect();