X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/405e126cc8cc95088866c4761c44e792c3fe9fac..94803e4ec8d61d24ebf9b1e483776d17e55a7ec5:/src/common/framecmn.cpp diff --git a/src/common/framecmn.cpp b/src/common/framecmn.cpp index d5bbdbfb1c..e888407f92 100644 --- a/src/common/framecmn.cpp +++ b/src/common/framecmn.cpp @@ -1,10 +1,10 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: common/framecmn.cpp +// Name: src/common/framecmn.cpp // Purpose: common (for all platforms) wxFrame functions // Author: Julian Smart, Vadim Zeitlin // Created: 01/02/97 // Id: $Id$ -// Copyright: (c) 1998 Robert Roebling, Julian Smart and Markus Holzem +// Copyright: (c) 1998 Robert Roebling and Julian Smart // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -16,10 +16,6 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "framebase.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -28,28 +24,30 @@ #endif #include "wx/frame.h" -#include "wx/menu.h" -#include "wx/menuitem.h" -#include "wx/dcclient.h" -#if wxUSE_TOOLBAR +#ifndef WX_PRECOMP + #include "wx/menu.h" + #include "wx/menuitem.h" + #include "wx/dcclient.h" #include "wx/toolbar.h" -#endif -#if wxUSE_STATUSBAR #include "wx/statusbr.h" -#endif +#endif // WX_PRECOMP // ---------------------------------------------------------------------------- // event table // ---------------------------------------------------------------------------- -BEGIN_EVENT_TABLE(wxFrameBase, wxWindow) - EVT_IDLE(wxFrameBase::OnIdle) - EVT_CLOSE(wxFrameBase::OnCloseWindow) +#if wxUSE_MENUS && wxUSE_STATUSBAR + +BEGIN_EVENT_TABLE(wxFrameBase, wxTopLevelWindow) + EVT_MENU_OPEN(wxFrameBase::OnMenuOpen) + EVT_MENU_CLOSE(wxFrameBase::OnMenuClose) + EVT_MENU_HIGHLIGHT_ALL(wxFrameBase::OnMenuHighlight) - EVT_SIZE(wxFrameBase::OnSize) END_EVENT_TABLE() +#endif // wxUSE_MENUS && wxUSE_STATUSBAR + // ============================================================================ // implementation // ============================================================================ @@ -60,7 +58,9 @@ END_EVENT_TABLE() wxFrameBase::wxFrameBase() { +#if wxUSE_MENUS m_frameMenuBar = NULL; +#endif // wxUSE_MENUS #if wxUSE_TOOLBAR m_frameToolBar = NULL; @@ -69,16 +69,13 @@ wxFrameBase::wxFrameBase() #if wxUSE_STATUSBAR m_frameStatusBar = NULL; #endif // wxUSE_STATUSBAR + + m_statusBarPane = 0; } -bool wxFrameBase::Destroy() +wxFrameBase::~wxFrameBase() { - // delayed destruction: the frame will be deleted during the next idle - // loop iteration - if ( !wxPendingDelete.Member(this) ) - wxPendingDelete.Append(this); - - return TRUE; + // this destructor is required for Darwin } wxFrame *wxFrameBase::New(wxWindow *parent, @@ -94,27 +91,39 @@ wxFrame *wxFrameBase::New(wxWindow *parent, void wxFrameBase::DeleteAllBars() { - if ( m_frameMenuBar ) - { - delete m_frameMenuBar; - m_frameMenuBar = (wxMenuBar *) NULL; - } +#if wxUSE_MENUS + wxDELETE(m_frameMenuBar); +#endif // wxUSE_MENUS #if wxUSE_STATUSBAR - if ( m_frameStatusBar ) - { - delete m_frameStatusBar; - m_frameStatusBar = (wxStatusBar *) NULL; - } + wxDELETE(m_frameStatusBar); #endif // wxUSE_STATUSBAR #if wxUSE_TOOLBAR - if ( m_frameToolBar ) - { - delete m_frameToolBar; - m_frameToolBar = (wxToolBar *) NULL; - } + wxDELETE(m_frameToolBar); +#endif // wxUSE_TOOLBAR +} + +bool wxFrameBase::IsOneOfBars(const wxWindow *win) const +{ +#if wxUSE_MENUS + if ( win == GetMenuBar() ) + return true; +#endif // wxUSE_MENUS + +#if wxUSE_STATUSBAR + if ( win == GetStatusBar() ) + return true; +#endif // wxUSE_STATUSBAR + +#if wxUSE_TOOLBAR + if ( win == GetToolBar() ) + return true; #endif // wxUSE_TOOLBAR + + wxUnusedVar(win); + + return false; } // ---------------------------------------------------------------------------- @@ -126,15 +135,16 @@ void wxFrameBase::DeleteAllBars() // get the origin of the client area in the client coordinates wxPoint wxFrameBase::GetClientAreaOrigin() const { - wxPoint pt(0, 0); + wxPoint pt = wxTopLevelWindow::GetClientAreaOrigin(); -#if wxUSE_TOOLBAR - if ( GetToolBar() ) +#if wxUSE_TOOLBAR && !defined(__WXUNIVERSAL__) + wxToolBar *toolbar = GetToolBar(); + if ( toolbar && toolbar->IsShown() ) { int w, h; - GetToolBar()->GetSize(& w, & h); + toolbar->GetSize(&w, &h); - if ( GetToolBar()->GetWindowStyleFlag() & wxTB_VERTICAL ) + if ( toolbar->GetWindowStyleFlag() & wxTB_VERTICAL ) { pt.x += w; } @@ -148,166 +158,114 @@ wxPoint wxFrameBase::GetClientAreaOrigin() const return pt; } -void wxFrameBase::DoScreenToClient(int *x, int *y) const -{ - wxWindow::DoScreenToClient(x, y); - - // We may be faking the client origin. - // So a window that's really at (0, 30) may appear - // (to wxWin apps) to be at (0, 0). - wxPoint pt(GetClientAreaOrigin()); - *x -= pt.x; - *y -= pt.y; -} - -void wxFrameBase::DoClientToScreen(int *x, int *y) const -{ - // We may be faking the client origin. - // So a window that's really at (0, 30) may appear - // (to wxWin apps) to be at (0, 0). - wxPoint pt1(GetClientAreaOrigin()); - *x += pt1.x; - *y += pt1.y; - - wxWindow::DoClientToScreen(x, y); -} - // ---------------------------------------------------------------------------- // misc // ---------------------------------------------------------------------------- -// make the window modal (all other windows unresponsive) -void wxFrameBase::MakeModal(bool modal) -{ - if ( modal ) - { - wxEnableTopLevelWindows(FALSE); - Enable(TRUE); // keep this window enabled - } - else - { - wxEnableTopLevelWindows(TRUE); - } -} +#if wxUSE_MENUS bool wxFrameBase::ProcessCommand(int id) { wxMenuBar *bar = GetMenuBar(); if ( !bar ) - return FALSE; + return false; wxMenuItem *item = bar->FindItem(id); - if ( item && item->IsCheckable() ) - { - item->Toggle(); - } + if ( !item ) + return false; + + return ProcessCommand(item); +} - wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id); - commandEvent.SetInt(id); +bool wxFrameBase::ProcessCommand(wxMenuItem *item) +{ + wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, item->GetId()); commandEvent.SetEventObject(this); - return GetEventHandler()->ProcessEvent(commandEvent); -} + if (!item->IsEnabled()) + return true; -// ---------------------------------------------------------------------------- -// event handlers -// ---------------------------------------------------------------------------- + if ((item->GetKind() == wxITEM_RADIO) && item->IsChecked() ) + return true; -// default resizing behaviour - if only ONE subwindow, resize to fill the -// whole client area -void wxFrameBase::OnSize(wxSizeEvent& WXUNUSED(event)) -{ - // if we're using constraints - do use them -#if wxUSE_CONSTRAINTS - if ( GetAutoLayout() ) + if (item->IsCheckable()) { - Layout(); + item->Toggle(); + + // use the new value + commandEvent.SetInt(item->IsChecked()); } - else -#endif - { - // do we have _exactly_ one child? - wxWindow *child = (wxWindow *)NULL; - for ( wxWindowList::Node *node = GetChildren().GetFirst(); - node; - node = node->GetNext() ) - { - wxWindow *win = node->GetData(); - // exclude top level and managed windows (status bar isn't - // currently in the children list except under wxMac anyhow, but - // it makes no harm to test for it) - if ( !win->IsTopLevel() -#if wxUSE_STATUSBAR - && (win != GetStatusBar()) -#endif // wxUSE_STATUSBAR -#if wxUSE_TOOLBAR - && (win != GetToolBar()) -#endif // wxUSE_TOOLBAR - ) - { - if ( child ) - { - return; // it's our second subwindow - nothing to do - } + return HandleWindowEvent(commandEvent); +} - child = win; - } - } +#endif // wxUSE_MENUS - // do we have any children at all? - if ( child ) - { - // exactly one child - set it's size to fill the whole frame - int clientW, clientH; - DoGetClientSize(&clientW, &clientH); - - // for whatever reasons, wxGTK wants to have a small offset - it - // probably looks better with it? -#ifdef __WXGTK__ - static const int ofs = 1; -#else - static const int ofs = 0; +// Do the UI update processing for this window. This is +// provided for the application to call if it wants to +// force a UI update, particularly for the menus and toolbar. +void wxFrameBase::UpdateWindowUI(long flags) +{ + wxWindowBase::UpdateWindowUI(flags); + +#if wxUSE_TOOLBAR + if (GetToolBar()) + GetToolBar()->UpdateWindowUI(flags); #endif - child->SetSize(ofs, ofs, clientW - 2*ofs, clientH - 2*ofs); - } +#if wxUSE_MENUS + if (GetMenuBar()) + { + // If coming from an idle event, we only want to update the menus if + // we're in the wxUSE_IDLEMENUUPDATES configuration, otherwise they + // will be update when the menu is opened later +#if !wxUSE_IDLEMENUUPDATES + if ( !(flags & wxUPDATE_UI_FROMIDLE) ) +#endif // wxUSE_IDLEMENUUPDATES + DoMenuUpdates(); } +#endif // wxUSE_MENUS } -// The default implementation for the close window event. -void wxFrameBase::OnCloseWindow(wxCloseEvent& WXUNUSED(event)) -{ - Destroy(); -} +// ---------------------------------------------------------------------------- +// event handlers for status bar updates from menus +// ---------------------------------------------------------------------------- + +#if wxUSE_MENUS && wxUSE_STATUSBAR void wxFrameBase::OnMenuHighlight(wxMenuEvent& event) { #if wxUSE_STATUSBAR - if ( GetStatusBar() ) - { - // if no help string found, we will clear the status bar text - wxString helpString; + (void)ShowMenuHelp(event.GetMenuId()); +#endif // wxUSE_STATUSBAR +} - int menuId = event.GetMenuId(); - if ( menuId != wxID_SEPARATOR && menuId != -2 /* wxID_TITLE */ ) - { - wxMenuBar *menuBar = GetMenuBar(); - if ( menuBar ) - { - // it's ok if we don't find the item because it might belong - // to the popup menu - wxMenuItem *item = menuBar->FindItem(menuId); - if ( item ) - helpString = item->GetHelp(); - } - } +void wxFrameBase::OnMenuOpen(wxMenuEvent& event) +{ +#if wxUSE_IDLEMENUUPDATES + wxUnusedVar(event); +#else // !wxUSE_IDLEMENUUPDATES + // as we didn't update the menus from idle time, do it now + DoMenuUpdates(event.GetMenu()); +#endif // wxUSE_IDLEMENUUPDATES/!wxUSE_IDLEMENUUPDATES +} - // set status text even if the string is empty - this will at least - // remove the string from the item which was previously selected - SetStatusText(helpString); - } -#endif // wxUSE_STATUSBAR +void wxFrameBase::OnMenuClose(wxMenuEvent& WXUNUSED(event)) +{ + DoGiveHelp(wxEmptyString, false); +} + +#endif // wxUSE_MENUS && wxUSE_STATUSBAR + +// Implement internal behaviour (menu updating on some platforms) +void wxFrameBase::OnInternalIdle() +{ + wxTopLevelWindow::OnInternalIdle(); + +#if wxUSE_MENUS && wxUSE_IDLEMENUUPDATES + if (wxUpdateUIEvent::CanUpdate(this)) + DoMenuUpdates(); +#endif } // ---------------------------------------------------------------------------- @@ -323,12 +281,10 @@ wxStatusBar* wxFrameBase::CreateStatusBar(int number, { // the main status bar can only be created once (or else it should be // deleted before calling CreateStatusBar() again) - wxCHECK_MSG( !m_frameStatusBar, (wxStatusBar *)NULL, + wxCHECK_MSG( !m_frameStatusBar, NULL, wxT("recreating status bar in wxFrame") ); - m_frameStatusBar = OnCreateStatusBar( number, style, id, name ); - if ( m_frameStatusBar ) - PositionStatusBar(); + SetStatusBar(OnCreateStatusBar(number, style, id, name)); return m_frameStatusBar; } @@ -338,20 +294,7 @@ wxStatusBar *wxFrameBase::OnCreateStatusBar(int number, wxWindowID id, const wxString& name) { - wxStatusBar *statusBar = new wxStatusBar(this, id, - wxPoint(0, 0), wxSize(100, 20), - style, name); - - // Set the height according to the font and the border size - wxClientDC dc(statusBar); - dc.SetFont(statusBar->GetFont()); - - long y; - dc.GetTextExtent( "X", NULL, &y ); - - int height = (int)( (11*y)/10 + 2*statusBar->GetBorderY()); - - statusBar->SetSize( -1, -1, 100, height ); + wxStatusBar *statusBar = new wxStatusBar(this, id, style, name); statusBar->SetFieldsCount(number); @@ -374,7 +317,129 @@ void wxFrameBase::SetStatusWidths(int n, const int widths_field[] ) PositionStatusBar(); } +void wxFrameBase::PushStatusText(const wxString& text, int number) +{ + wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") ); + + m_frameStatusBar->PushStatusText(text, number); +} + +void wxFrameBase::PopStatusText(int number) +{ + wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") ); + + m_frameStatusBar->PopStatusText(number); +} + +bool wxFrameBase::ShowMenuHelp(int menuId) +{ +#if wxUSE_MENUS + // if no help string found, we will clear the status bar text + // + // NB: wxID_NONE is used for (sub)menus themselves by wxMSW + wxString helpString; + if ( menuId != wxID_SEPARATOR && menuId != wxID_NONE ) + { + const wxMenuItem * const item = FindItemInMenuBar(menuId); + if ( item && !item->IsSeparator() ) + helpString = item->GetHelp(); + + // notice that it's ok if we don't find the item because it might + // belong to the popup menu, so don't assert here + } + + DoGiveHelp(helpString, true); + + return !helpString.empty(); +#else // !wxUSE_MENUS + return false; +#endif // wxUSE_MENUS/!wxUSE_MENUS +} + +void wxFrameBase::SetStatusBar(wxStatusBar *statBar) +{ + bool hadBar = m_frameStatusBar != NULL; + m_frameStatusBar = statBar; + + if ( (m_frameStatusBar != NULL) != hadBar ) + { + PositionStatusBar(); + + DoLayout(); + } +} + +#endif // wxUSE_STATUSBAR + +#if wxUSE_MENUS || wxUSE_TOOLBAR +void wxFrameBase::DoGiveHelp(const wxString& help, bool show) +{ +#if wxUSE_STATUSBAR + if ( m_statusBarPane < 0 ) + { + // status bar messages disabled + return; + } + + wxStatusBar *statbar = GetStatusBar(); + if ( !statbar ) + return; + + wxString text; + if ( show ) + { + // remember the old status bar text if this is the first time we're + // called since the menu has been opened as we're going to overwrite it + // in our DoGiveHelp() and we want to restore it when the menu is + // closed + // + // note that it would be logical to do this in OnMenuOpen() but under + // MSW we get an EVT_MENU_HIGHLIGHT before EVT_MENU_OPEN, strangely + // enough, and so this doesn't work and instead we use the ugly trick + // with using special m_oldStatusText value as "menu opened" (but it is + // arguably better than adding yet another member variable to wxFrame + // on all platforms) + if ( m_oldStatusText.empty() ) + { + m_oldStatusText = statbar->GetStatusText(m_statusBarPane); + if ( m_oldStatusText.empty() ) + { + // use special value to prevent us from doing this the next time + m_oldStatusText += wxT('\0'); + } + } + + m_lastHelpShown = + text = help; + } + else // hide help, restore the original text + { + // clear the last shown help string but remember its value + wxString lastHelpShown; + lastHelpShown.swap(m_lastHelpShown); + + // also clear the old status text but remember it too to restore it + // below + text.swap(m_oldStatusText); + + if ( statbar->GetStatusText(m_statusBarPane) != lastHelpShown ) + { + // if the text was changed with an explicit SetStatusText() call + // from the user code in the meanwhile, do not overwrite it with + // the old status bar contents -- this is almost certainly not what + // the user expects and would be very hard to avoid from user code + return; + } + } + + statbar->SetStatusText(text, m_statusBarPane); +#else + wxUnusedVar(help); + wxUnusedVar(show); #endif // wxUSE_STATUSBAR +} +#endif // wxUSE_MENUS || wxUSE_TOOLBAR + // ---------------------------------------------------------------------------- // toolbar stuff @@ -386,12 +451,24 @@ wxToolBar* wxFrameBase::CreateToolBar(long style, wxWindowID id, const wxString& name) { - // the main toolbar can't be recreated (unless it was explicitly deeleted + // the main toolbar can't be recreated (unless it was explicitly deleted // before) - wxCHECK_MSG( !m_frameToolBar, (wxToolBar *)NULL, + wxCHECK_MSG( !m_frameToolBar, NULL, wxT("recreating toolbar in wxFrame") ); - m_frameToolBar = OnCreateToolBar(style, id, name); + if ( style == -1 ) + { + // use default style + // + // NB: we don't specify the default value in the method declaration + // because + // a) this allows us to have different defaults for different + // platforms (even if we don't have them right now) + // b) we don't need to include wx/toolbar.h in the header then + style = wxBORDER_NONE | wxTB_HORIZONTAL | wxTB_FLAT; + } + + SetToolBar(OnCreateToolBar(style, id, name)); return m_frameToolBar; } @@ -400,62 +477,115 @@ wxToolBar* wxFrameBase::OnCreateToolBar(long style, wxWindowID id, const wxString& name) { +#if defined(__WXWINCE__) && defined(__POCKETPC__) + return new wxToolMenuBar(this, id, + wxDefaultPosition, wxDefaultSize, + style, name); +#else return new wxToolBar(this, id, wxDefaultPosition, wxDefaultSize, style, name); +#endif +} + +void wxFrameBase::SetToolBar(wxToolBar *toolbar) +{ + if ( (toolbar != NULL) != (m_frameToolBar != NULL) ) + { + // the toolbar visibility must have changed so we need to both position + // the toolbar itself (if it appeared) and to relayout the frame + // contents in any case + + if ( toolbar ) + { + // we need to assign it to m_frameToolBar for PositionToolBar() to + // do anything + m_frameToolBar = toolbar; + PositionToolBar(); + } + //else: tricky: do not reset m_frameToolBar yet as otherwise DoLayout() + // wouldn't recognize the (still existing) toolbar as one of our + // bars and wouldn't layout the single child of the frame correctly + + + // and this is even more tricky: we want DoLayout() to recognize the + // old toolbar for the purpose of not counting it among our non-bar + // children but we don't want to reserve any more space for it so we + // temporarily hide it + if ( m_frameToolBar ) + m_frameToolBar->Hide(); + + DoLayout(); + + if ( m_frameToolBar ) + m_frameToolBar->Show(); + } + + // this might have been already done above but it's simpler to just always + // do it unconditionally instead of testing for whether we already did it + m_frameToolBar = toolbar; } #endif // wxUSE_TOOLBAR // ---------------------------------------------------------------------------- -// Menu UI updating +// menus // ---------------------------------------------------------------------------- -void wxFrameBase::OnIdle(wxIdleEvent& WXUNUSED(event) ) +#if wxUSE_MENUS + +// update all menus +void wxFrameBase::DoMenuUpdates(wxMenu* menu) { - DoMenuUpdates(); + if (menu) + { + wxEvtHandler* source = GetEventHandler(); + menu->UpdateUI(source); + } + else + { + wxMenuBar* bar = GetMenuBar(); + if (bar != NULL) + bar->UpdateMenus(); + } } -// update all menus -void wxFrameBase::DoMenuUpdates() +void wxFrameBase::DetachMenuBar() { - wxMenuBar* bar = GetMenuBar(); + if ( m_frameMenuBar ) + { + m_frameMenuBar->Detach(); + m_frameMenuBar = NULL; + } +} - if ( bar != NULL ) +void wxFrameBase::AttachMenuBar(wxMenuBar *menubar) +{ + if ( menubar ) { - int nCount = bar->GetMenuCount(); - for (int n = 0; n < nCount; n++) - DoMenuUpdates(bar->GetMenu(n), (wxWindow*) NULL); + menubar->Attach((wxFrame *)this); + m_frameMenuBar = menubar; } } -// update a menu and all submenus recursively -void wxFrameBase::DoMenuUpdates(wxMenu* menu, wxWindow* WXUNUSED(focusWin)) +void wxFrameBase::SetMenuBar(wxMenuBar *menubar) { - wxEvtHandler* evtHandler = GetEventHandler(); - wxMenuItemList::Node* node = menu->GetMenuItems().GetFirst(); - while (node) + if ( menubar == GetMenuBar() ) { - wxMenuItem* item = node->GetData(); - if ( !item->IsSeparator() ) - { - wxWindowID id = item->GetId(); - wxUpdateUIEvent event(id); - event.SetEventObject( this ); + // nothing to do + return; + } - if (evtHandler->ProcessEvent(event)) - { - if (event.GetSetText()) - menu->SetLabel(id, event.GetText()); - if (event.GetSetChecked()) - menu->Check(id, event.GetChecked()); - if (event.GetSetEnabled()) - menu->Enable(id, event.GetEnabled()); - } + DetachMenuBar(); - if (item->GetSubMenu()) - DoMenuUpdates(item->GetSubMenu(), (wxWindow*) NULL); - } - node = node->GetNext(); - } + this->AttachMenuBar(menubar); +} + +wxMenuItem *wxFrameBase::FindItemInMenuBar(int menuId) const +{ + const wxMenuBar * const menuBar = GetMenuBar(); + + return menuBar ? menuBar->FindItem(menuId) : NULL; } + +#endif // wxUSE_MENUS