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 wxDELETE(m_pMyMenuBar
);
86 RemoveWindowMenu(GetMenuBar());
87 wxDELETE(m_pWindowMenu
);
91 bool wxAuiMDIParentFrame::Create(wxWindow
*parent
,
93 const wxString
& title
,
100 // this style can be used to prevent a window from having the standard MDI
102 if (!(style
& wxFRAME_NO_WINDOW_MENU
))
104 m_pWindowMenu
= new wxMenu
;
105 m_pWindowMenu
->Append(wxWINDOWCLOSE
, _("Cl&ose"));
106 m_pWindowMenu
->Append(wxWINDOWCLOSEALL
, _("Close All"));
107 m_pWindowMenu
->AppendSeparator();
108 m_pWindowMenu
->Append(wxWINDOWNEXT
, _("&Next"));
109 m_pWindowMenu
->Append(wxWINDOWPREV
, _("&Previous"));
111 #endif // wxUSE_MENUS
113 wxFrame::Create(parent
, id
, title
, pos
, size
, style
, name
);
119 void wxAuiMDIParentFrame::SetArtProvider(wxAuiTabArt
* provider
)
123 m_pClientWindow
->SetArtProvider(provider
);
127 wxAuiTabArt
* wxAuiMDIParentFrame::GetArtProvider()
129 if (!m_pClientWindow
)
132 return m_pClientWindow
->GetArtProvider();
135 wxAuiNotebook
* wxAuiMDIParentFrame::GetNotebook() const
137 return static_cast<wxAuiNotebook
*>(m_pClientWindow
);
143 void wxAuiMDIParentFrame::SetWindowMenu(wxMenu
* pMenu
)
145 // Replace the window menu from the currently loaded menu bar.
146 wxMenuBar
*pMenuBar
= GetMenuBar();
150 RemoveWindowMenu(pMenuBar
);
151 wxDELETE(m_pWindowMenu
);
156 m_pWindowMenu
= pMenu
;
157 AddWindowMenu(pMenuBar
);
161 void wxAuiMDIParentFrame::SetMenuBar(wxMenuBar
* pMenuBar
)
163 // Remove the Window menu from the old menu bar
164 RemoveWindowMenu(GetMenuBar());
166 // Add the Window menu to the new menu bar.
167 AddWindowMenu(pMenuBar
);
169 wxFrame::SetMenuBar(pMenuBar
);
170 //m_pMyMenuBar = GetMenuBar();
172 #endif // wxUSE_MENUS
174 void wxAuiMDIParentFrame::SetChildMenuBar(wxAuiMDIChildFrame
* pChild
)
179 // No Child, set Our menu bar back.
180 SetMenuBar(m_pMyMenuBar
);
182 // Make sure we know our menu bar is in use
187 if (pChild
->GetMenuBar() == NULL
)
190 // Do we need to save the current bar?
191 if (m_pMyMenuBar
== NULL
)
192 m_pMyMenuBar
= GetMenuBar();
194 SetMenuBar(pChild
->GetMenuBar());
196 #endif // wxUSE_MENUS
199 bool wxAuiMDIParentFrame::ProcessEvent(wxEvent
& event
)
201 // stops the same event being processed repeatedly
202 if (m_pLastEvt
== &event
)
206 // let the active child (if any) process the event first.
208 if (m_pActiveChild
&&
209 event
.IsCommandEvent() &&
210 event
.GetEventObject() != m_pClientWindow
&&
211 !(event
.GetEventType() == wxEVT_ACTIVATE
||
212 event
.GetEventType() == wxEVT_SET_FOCUS
||
213 event
.GetEventType() == wxEVT_KILL_FOCUS
||
214 event
.GetEventType() == wxEVT_CHILD_FOCUS
||
215 event
.GetEventType() == wxEVT_COMMAND_SET_FOCUS
||
216 event
.GetEventType() == wxEVT_COMMAND_KILL_FOCUS
)
219 res
= m_pActiveChild
->GetEventHandler()->ProcessEvent(event
);
224 // if the event was not handled this frame will handle it,
225 // which is why we need the protection code at the beginning
227 res
= wxEvtHandler::ProcessEvent(event
);
235 wxAuiMDIChildFrame
*wxAuiMDIParentFrame::GetActiveChild() const
237 return m_pActiveChild
;
240 void wxAuiMDIParentFrame::SetActiveChild(wxAuiMDIChildFrame
* pChildFrame
)
242 m_pActiveChild
= pChildFrame
;
245 wxAuiMDIClientWindow
*wxAuiMDIParentFrame::GetClientWindow() const
247 return m_pClientWindow
;
250 wxAuiMDIClientWindow
*wxAuiMDIParentFrame::OnCreateClient()
252 m_pClientWindow
= new wxAuiMDIClientWindow( this );
253 return m_pClientWindow
;
256 void wxAuiMDIParentFrame::ActivateNext()
258 if (m_pClientWindow
&& m_pClientWindow
->GetSelection() != wxNOT_FOUND
)
260 size_t active
= m_pClientWindow
->GetSelection() + 1;
261 if (active
>= m_pClientWindow
->GetPageCount())
264 m_pClientWindow
->SetSelection(active
);
268 void wxAuiMDIParentFrame::ActivatePrevious()
270 if (m_pClientWindow
&& m_pClientWindow
->GetSelection() != wxNOT_FOUND
)
272 int active
= m_pClientWindow
->GetSelection() - 1;
274 active
= m_pClientWindow
->GetPageCount() - 1;
276 m_pClientWindow
->SetSelection(active
);
280 void wxAuiMDIParentFrame::Init()
283 m_pClientWindow
= NULL
;
284 m_pActiveChild
= NULL
;
286 m_pWindowMenu
= NULL
;
288 #endif // wxUSE_MENUS
292 void wxAuiMDIParentFrame::RemoveWindowMenu(wxMenuBar
* pMenuBar
)
294 if (pMenuBar
&& m_pWindowMenu
)
296 // Remove old window menu
297 int pos
= pMenuBar
->FindMenu(_("&Window"));
298 if (pos
!= wxNOT_FOUND
)
300 // DBG:: We're going to delete the wrong menu!!!
301 wxASSERT(m_pWindowMenu
== pMenuBar
->GetMenu(pos
));
302 pMenuBar
->Remove(pos
);
307 void wxAuiMDIParentFrame::AddWindowMenu(wxMenuBar
*pMenuBar
)
309 if (pMenuBar
&& m_pWindowMenu
)
311 int pos
= pMenuBar
->FindMenu(wxGetStockLabel(wxID_HELP
,wxSTOCK_NOFLAGS
));
312 if (pos
== wxNOT_FOUND
)
313 pMenuBar
->Append(m_pWindowMenu
, _("&Window"));
315 pMenuBar
->Insert(pos
, m_pWindowMenu
, _("&Window"));
319 void wxAuiMDIParentFrame::DoHandleMenu(wxCommandEvent
& event
)
321 switch (event
.GetId())
325 m_pActiveChild
->Close();
327 case wxWINDOWCLOSEALL
:
328 while (m_pActiveChild
)
330 if (!m_pActiveChild
->Close())
346 #endif // wxUSE_MENUS
348 void wxAuiMDIParentFrame::DoGetClientSize(int* width
, int* height
) const
350 wxFrame::DoGetClientSize(width
, height
);
353 void wxAuiMDIParentFrame::Tile(wxOrientation orient
)
355 wxAuiMDIClientWindow
* client_window
= GetClientWindow();
356 wxASSERT_MSG(client_window
, wxT("Missing MDI Client Window"));
358 int cur_idx
= client_window
->GetSelection();
362 if (orient
== wxVERTICAL
)
364 client_window
->Split(cur_idx
, wxLEFT
);
366 else if (orient
== wxHORIZONTAL
)
368 client_window
->Split(cur_idx
, wxTOP
);
373 //-----------------------------------------------------------------------------
374 // wxAuiMDIChildFrame
375 //-----------------------------------------------------------------------------
377 IMPLEMENT_DYNAMIC_CLASS(wxAuiMDIChildFrame
, wxPanel
)
379 BEGIN_EVENT_TABLE(wxAuiMDIChildFrame
, wxPanel
)
380 EVT_MENU_HIGHLIGHT_ALL(wxAuiMDIChildFrame::OnMenuHighlight
)
381 EVT_ACTIVATE(wxAuiMDIChildFrame::OnActivate
)
382 EVT_CLOSE(wxAuiMDIChildFrame::OnCloseWindow
)
385 wxAuiMDIChildFrame::wxAuiMDIChildFrame()
390 wxAuiMDIChildFrame::wxAuiMDIChildFrame(wxAuiMDIParentFrame
*parent
,
392 const wxString
& title
,
393 const wxPoint
& WXUNUSED(pos
),
396 const wxString
& name
)
400 // There are two ways to create an tabbed mdi child fram without
401 // making it the active document. Either Show(false) can be called
402 // before Create() (as is customary on some ports with wxFrame-type
403 // windows), or wxMINIMIZE can be passed in the style flags. Note that
404 // wxAuiMDIChildFrame is not really derived from wxFrame, as wxMDIChildFrame
405 // is, but those are the expected symantics. No style flag is passed
406 // onto the panel underneath.
407 if (style
& wxMINIMIZE
)
408 m_activate_on_create
= false;
410 Create(parent
, id
, title
, wxDefaultPosition
, size
, 0, name
);
413 wxAuiMDIChildFrame::~wxAuiMDIChildFrame()
415 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
416 if (pParentFrame
&& pParentFrame
->GetActiveChild() == this)
418 pParentFrame
->SetActiveChild(NULL
);
419 pParentFrame
->SetChildMenuBar(NULL
);
423 wxDELETE(m_pMenuBar
);
424 #endif // wxUSE_MENUS
427 bool wxAuiMDIChildFrame::Create(wxAuiMDIParentFrame
* parent
,
429 const wxString
& title
,
430 const wxPoint
& WXUNUSED(pos
),
433 const wxString
& name
)
435 wxAuiMDIClientWindow
* pClientWindow
= parent
->GetClientWindow();
436 wxASSERT_MSG((pClientWindow
!= (wxWindow
*) NULL
), wxT("Missing MDI client window."));
438 // see comment in constructor
439 if (style
& wxMINIMIZE
)
440 m_activate_on_create
= false;
442 wxSize cli_size
= pClientWindow
->GetClientSize();
444 // create the window off-screen to prevent flicker
445 wxPanel::Create(pClientWindow
,
447 wxPoint(cli_size
.x
+1, cli_size
.y
+1),
453 SetMDIParentFrame(parent
);
455 // this is the currently active child
456 parent
->SetActiveChild(this);
460 pClientWindow
->AddPage(this, title
, m_activate_on_create
);
461 pClientWindow
->Refresh();
466 bool wxAuiMDIChildFrame::Destroy()
468 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
469 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
471 wxAuiMDIClientWindow
* pClientWindow
= pParentFrame
->GetClientWindow();
472 wxASSERT_MSG(pClientWindow
, wxT("Missing MDI Client Window"));
474 if (pParentFrame
->GetActiveChild() == this)
476 // deactivate ourself
477 wxActivateEvent
event(wxEVT_ACTIVATE
, false, GetId());
478 event
.SetEventObject(this);
479 GetEventHandler()->ProcessEvent(event
);
481 pParentFrame
->SetActiveChild(NULL
);
482 pParentFrame
->SetChildMenuBar(NULL
);
485 size_t page_count
= pClientWindow
->GetPageCount();
486 for (size_t pos
= 0; pos
< page_count
; pos
++)
488 if (pClientWindow
->GetPage(pos
) == this)
489 return pClientWindow
->DeletePage(pos
);
496 void wxAuiMDIChildFrame::SetMenuBar(wxMenuBar
*menu_bar
)
498 wxMenuBar
*pOldMenuBar
= m_pMenuBar
;
499 m_pMenuBar
= menu_bar
;
503 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
504 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
506 m_pMenuBar
->SetParent(pParentFrame
);
507 if (pParentFrame
->GetActiveChild() == this)
509 // replace current menu bars
511 pParentFrame
->SetChildMenuBar(NULL
);
512 pParentFrame
->SetChildMenuBar(this);
517 wxMenuBar
*wxAuiMDIChildFrame::GetMenuBar() const
521 #endif // wxUSE_MENUS
523 void wxAuiMDIChildFrame::SetTitle(const wxString
& title
)
527 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
528 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
530 wxAuiMDIClientWindow
* pClientWindow
= pParentFrame
->GetClientWindow();
531 if (pClientWindow
!= NULL
)
534 for (pos
= 0; pos
< pClientWindow
->GetPageCount(); pos
++)
536 if (pClientWindow
->GetPage(pos
) == this)
538 pClientWindow
->SetPageText(pos
, m_title
);
545 wxString
wxAuiMDIChildFrame::GetTitle() const
550 void wxAuiMDIChildFrame::SetIcons(const wxIconBundle
& icons
)
552 // get icon with the system icon size
553 SetIcon(icons
.GetIcon(-1));
554 m_icon_bundle
= icons
;
557 const wxIconBundle
& wxAuiMDIChildFrame::GetIcons() const
559 return m_icon_bundle
;
562 void wxAuiMDIChildFrame::SetIcon(const wxIcon
& icon
)
564 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
565 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
570 bmp
.CopyFromIcon(m_icon
);
572 wxAuiMDIClientWindow
* pClientWindow
= pParentFrame
->GetClientWindow();
573 if (pClientWindow
!= NULL
)
575 int idx
= pClientWindow
->GetPageIndex(this);
579 pClientWindow
->SetPageBitmap((size_t)idx
, bmp
);
584 const wxIcon
& wxAuiMDIChildFrame::GetIcon() const
590 void wxAuiMDIChildFrame::Activate()
592 wxAuiMDIParentFrame
* pParentFrame
= GetMDIParentFrame();
593 wxASSERT_MSG(pParentFrame
, wxT("Missing MDI Parent Frame"));
595 wxAuiMDIClientWindow
* pClientWindow
= pParentFrame
->GetClientWindow();
597 if (pClientWindow
!= NULL
)
600 for (pos
= 0; pos
< pClientWindow
->GetPageCount(); pos
++)
602 if (pClientWindow
->GetPage(pos
) == this)
604 pClientWindow
->SetSelection(pos
);
611 void wxAuiMDIChildFrame::OnMenuHighlight(wxMenuEvent
& event
)
614 if (m_pMDIParentFrame
)
616 // we don't have any help text for this item,
617 // but may be the MDI frame does?
618 m_pMDIParentFrame
->OnMenuHighlight(event
);
622 #endif // wxUSE_STATUSBAR
625 void wxAuiMDIChildFrame::OnActivate(wxActivateEvent
& WXUNUSED(event
))
630 void wxAuiMDIChildFrame::OnCloseWindow(wxCloseEvent
& WXUNUSED(event
))
635 void wxAuiMDIChildFrame::SetMDIParentFrame(wxAuiMDIParentFrame
* parentFrame
)
637 m_pMDIParentFrame
= parentFrame
;
640 wxAuiMDIParentFrame
* wxAuiMDIChildFrame::GetMDIParentFrame() const
642 return m_pMDIParentFrame
;
645 void wxAuiMDIChildFrame::Init()
647 m_activate_on_create
= true;
648 m_pMDIParentFrame
= NULL
;
651 #endif // wxUSE_MENUS
654 bool wxAuiMDIChildFrame::Show(bool show
)
656 m_activate_on_create
= show
;
662 void wxAuiMDIChildFrame::DoShow(bool show
)
664 wxWindow::Show(show
);
667 void wxAuiMDIChildFrame::DoSetSize(int x
, int y
, int width
, int height
, int sizeFlags
)
669 m_mdi_newrect
= wxRect(x
, y
, width
, height
);
671 wxPanel::DoSetSize(x
,y
,width
, height
, sizeFlags
);
673 wxUnusedVar(sizeFlags
);
677 void wxAuiMDIChildFrame::DoMoveWindow(int x
, int y
, int width
, int height
)
679 m_mdi_newrect
= wxRect(x
, y
, width
, height
);
682 void wxAuiMDIChildFrame::ApplyMDIChildFrameRect()
684 if (m_mdi_currect
!= m_mdi_newrect
)
686 wxPanel::DoMoveWindow(m_mdi_newrect
.x
, m_mdi_newrect
.y
,
687 m_mdi_newrect
.width
, m_mdi_newrect
.height
);
688 m_mdi_currect
= m_mdi_newrect
;
693 //-----------------------------------------------------------------------------
694 // wxAuiMDIClientWindow
695 //-----------------------------------------------------------------------------
697 IMPLEMENT_DYNAMIC_CLASS(wxAuiMDIClientWindow
, wxAuiNotebook
)
699 BEGIN_EVENT_TABLE(wxAuiMDIClientWindow
, wxAuiNotebook
)
700 EVT_AUINOTEBOOK_PAGE_CHANGED(wxID_ANY
, wxAuiMDIClientWindow::OnPageChanged
)
701 EVT_AUINOTEBOOK_PAGE_CLOSE(wxID_ANY
, wxAuiMDIClientWindow::OnPageClose
)
702 EVT_SIZE(wxAuiMDIClientWindow::OnSize
)
705 wxAuiMDIClientWindow::wxAuiMDIClientWindow()
709 wxAuiMDIClientWindow::wxAuiMDIClientWindow(wxAuiMDIParentFrame
* parent
, long style
)
711 CreateClient(parent
, style
);
714 wxAuiMDIClientWindow::~wxAuiMDIClientWindow()
719 bool wxAuiMDIClientWindow::CreateClient(wxAuiMDIParentFrame
* parent
, long style
)
721 SetWindowStyleFlag(style
);
723 wxSize caption_icon_size
=
724 wxSize(wxSystemSettings::GetMetric(wxSYS_SMALLICON_X
),
725 wxSystemSettings::GetMetric(wxSYS_SMALLICON_Y
));
726 SetUniformBitmapSize(caption_icon_size
);
728 if (!wxAuiNotebook::Create(parent
,
732 wxAUI_NB_DEFAULT_STYLE
| wxNO_BORDER
))
737 wxColour bkcolour
= wxSystemSettings::GetColour(wxSYS_COLOUR_APPWORKSPACE
);
738 SetOwnBackgroundColour(bkcolour
);
740 m_mgr
.GetArtProvider()->SetColour(wxAUI_DOCKART_BACKGROUND_COLOUR
, bkcolour
);
745 int wxAuiMDIClientWindow::SetSelection(size_t nPage
)
747 return wxAuiNotebook::SetSelection(nPage
);
750 void wxAuiMDIClientWindow::PageChanged(int old_selection
, int new_selection
)
752 // don't do anything if the page doesn't actually change
753 if (old_selection
== new_selection
)
757 // don't do anything if the new page is already active
758 if (new_selection != -1)
760 wxAuiMDIChildFrame* child = (wxAuiMDIChildFrame*)GetPage(new_selection);
761 if (child->GetMDIParentFrame()->GetActiveChild() == child)
766 // notify old active child that it has been deactivated
767 if (old_selection
!= -1)
769 wxAuiMDIChildFrame
* old_child
= (wxAuiMDIChildFrame
*)GetPage(old_selection
);
770 wxASSERT_MSG(old_child
, wxT("wxAuiMDIClientWindow::PageChanged - null page pointer"));
772 wxActivateEvent
event(wxEVT_ACTIVATE
, false, old_child
->GetId());
773 event
.SetEventObject(old_child
);
774 old_child
->GetEventHandler()->ProcessEvent(event
);
777 // notify new active child that it has been activated
778 if (new_selection
!= -1)
780 wxAuiMDIChildFrame
* active_child
= (wxAuiMDIChildFrame
*)GetPage(new_selection
);
781 wxASSERT_MSG(active_child
, wxT("wxAuiMDIClientWindow::PageChanged - null page pointer"));
783 wxActivateEvent
event(wxEVT_ACTIVATE
, true, active_child
->GetId());
784 event
.SetEventObject(active_child
);
785 active_child
->GetEventHandler()->ProcessEvent(event
);
787 if (active_child
->GetMDIParentFrame())
789 active_child
->GetMDIParentFrame()->SetActiveChild(active_child
);
790 active_child
->GetMDIParentFrame()->SetChildMenuBar(active_child
);
797 void wxAuiMDIClientWindow::OnPageClose(wxAuiNotebookEvent
& evt
)
799 wxAuiMDIChildFrame
* wnd
;
800 wnd
= static_cast<wxAuiMDIChildFrame
*>(GetPage(evt
.GetSelection()));
804 // regardless of the result of wnd->Close(), we've
805 // already taken care of the close operations, so
806 // suppress further processing
810 void wxAuiMDIClientWindow::OnPageChanged(wxAuiNotebookEvent
& evt
)
812 PageChanged(evt
.GetOldSelection(), evt
.GetSelection());
815 void wxAuiMDIClientWindow::OnSize(wxSizeEvent
& evt
)
817 wxAuiNotebook::OnSize(evt
);
819 for (size_t pos
= 0; pos
< GetPageCount(); pos
++)
820 ((wxAuiMDIChildFrame
*)GetPage(pos
))->ApplyMDIChildFrameRect();