X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/405e126cc8cc95088866c4761c44e792c3fe9fac..52069700e7f9c4cc1fc4379306e9f763c5b83073:/src/common/framecmn.cpp diff --git a/src/common/framecmn.cpp b/src/common/framecmn.cpp index d5bbdbfb1c..017c25578c 100644 --- a/src/common/framecmn.cpp +++ b/src/common/framecmn.cpp @@ -4,7 +4,7 @@ // 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,7 +16,7 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma implementation "framebase.h" #endif @@ -27,10 +27,12 @@ #pragma hdrstop #endif -#include "wx/frame.h" -#include "wx/menu.h" -#include "wx/menuitem.h" -#include "wx/dcclient.h" +#ifndef WX_PRECOMP + #include "wx/frame.h" + #include "wx/menu.h" + #include "wx/menuitem.h" + #include "wx/dcclient.h" +#endif // WX_PRECOMP #if wxUSE_TOOLBAR #include "wx/toolbar.h" @@ -43,13 +45,17 @@ // 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 +66,9 @@ END_EVENT_TABLE() wxFrameBase::wxFrameBase() { +#if wxUSE_MENUS m_frameMenuBar = NULL; +#endif // wxUSE_MENUS #if wxUSE_TOOLBAR m_frameToolBar = NULL; @@ -69,16 +77,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,11 +99,13 @@ wxFrame *wxFrameBase::New(wxWindow *parent, void wxFrameBase::DeleteAllBars() { +#if wxUSE_MENUS if ( m_frameMenuBar ) { delete m_frameMenuBar; m_frameMenuBar = (wxMenuBar *) NULL; } +#endif // wxUSE_MENUS #if wxUSE_STATUSBAR if ( m_frameStatusBar ) @@ -117,6 +124,26 @@ void wxFrameBase::DeleteAllBars() #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 + + return false; +} + // ---------------------------------------------------------------------------- // wxFrame size management: we exclude the areas taken by menu/status/toolbars // from the client area, so the client area is what's really available for the @@ -126,15 +153,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 +176,130 @@ 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 +void wxFrameBase::SendSizeEvent() { - // 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); + wxSizeEvent event( GetSize(), GetId() ); + event.SetEventObject( this ); + GetEventHandler()->AddPendingEvent( event ); } + // ---------------------------------------------------------------------------- // 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); - } -} - bool wxFrameBase::ProcessCommand(int id) { +#if wxUSE_MENUS wxMenuBar *bar = GetMenuBar(); if ( !bar ) - return FALSE; + return false; + + wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id); + commandEvent.SetEventObject(this); wxMenuItem *item = bar->FindItem(id); - if ( item && item->IsCheckable() ) + if (item) { - item->Toggle(); - } + if (!item->IsEnabled()) + return true; - wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id); - commandEvent.SetInt(id); - commandEvent.SetEventObject(this); + if (item->IsCheckable()) + { + item->Toggle(); - return GetEventHandler()->ProcessEvent(commandEvent); -} + // use the new value + commandEvent.SetInt(item->IsChecked()); + } + } -// ---------------------------------------------------------------------------- -// event handlers -// ---------------------------------------------------------------------------- + GetEventHandler()->ProcessEvent(commandEvent); + return true; +#else // !wxUSE_MENUS + return false; +#endif // wxUSE_MENUS/!wxUSE_MENUS +} -// default resizing behaviour - if only ONE subwindow, resize to fill the -// whole client area -void wxFrameBase::OnSize(wxSizeEvent& WXUNUSED(event)) +// 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) { - // if we're using constraints - do use them -#if wxUSE_CONSTRAINTS - if ( GetAutoLayout() ) - { - Layout(); - } - else + wxWindowBase::UpdateWindowUI(flags); + +#if wxUSE_TOOLBAR + if (GetToolBar()) + GetToolBar()->UpdateWindowUI(flags); #endif + +#if wxUSE_MENUS + if (GetMenuBar()) { - // do we have _exactly_ one child? - wxWindow *child = (wxWindow *)NULL; - for ( wxWindowList::Node *node = GetChildren().GetFirst(); - node; - node = node->GetNext() ) + if ((flags & wxUPDATE_UI_FROMIDLE) && !wxUSE_IDLEMENUUPDATES) { - wxWindow *win = node->GetData(); + // If coming from an idle event, we only + // want to update the menus if we're + // in the wxUSE_IDLEMENUUPDATES configuration: + // so if we're not, do nothing + } + else + DoMenuUpdates(); + } +#endif // wxUSE_MENUS +} + +// ---------------------------------------------------------------------------- +// event handlers for status bar updates from menus +// ---------------------------------------------------------------------------- + +#if wxUSE_MENUS && wxUSE_STATUSBAR - // 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() +void wxFrameBase::OnMenuHighlight(wxMenuEvent& event) +{ #if wxUSE_STATUSBAR - && (win != GetStatusBar()) + (void)ShowMenuHelp(GetStatusBar(), event.GetMenuId()); #endif // wxUSE_STATUSBAR -#if wxUSE_TOOLBAR - && (win != GetToolBar()) -#endif // wxUSE_TOOLBAR - ) - { - if ( child ) - { - return; // it's our second subwindow - nothing to do - } - - child = win; - } - } +} - // 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; +#if !wxUSE_IDLEMENUUPDATES +void wxFrameBase::OnMenuOpen(wxMenuEvent& event) #else - static const int ofs = 0; +void wxFrameBase::OnMenuOpen(wxMenuEvent& WXUNUSED(event)) #endif - - child->SetSize(ofs, ofs, clientW - 2*ofs, clientH - 2*ofs); - } - } -} - -// The default implementation for the close window event. -void wxFrameBase::OnCloseWindow(wxCloseEvent& WXUNUSED(event)) { - Destroy(); +#if !wxUSE_IDLEMENUUPDATES + DoMenuUpdates(event.GetMenu()); +#endif // !wxUSE_IDLEMENUUPDATES } -void wxFrameBase::OnMenuHighlight(wxMenuEvent& event) +void wxFrameBase::OnMenuClose(wxMenuEvent& WXUNUSED(event)) { -#if wxUSE_STATUSBAR - if ( GetStatusBar() ) + // do we have real status text to restore? + if ( m_oldStatusText.length() > 1 || m_oldStatusText[0u] ) { - // if no help string found, we will clear the status bar text - wxString helpString; - - int menuId = event.GetMenuId(); - if ( menuId != wxID_SEPARATOR && menuId != -2 /* wxID_TITLE */ ) + if ( m_statusBarPane >= 0 ) { - 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(); - } + wxStatusBar *statbar = GetStatusBar(); + if ( statbar ) + statbar->SetStatusText(m_oldStatusText, m_statusBarPane); } - // 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); + m_oldStatusText.clear(); } -#endif // wxUSE_STATUSBAR +} + +#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 } // ---------------------------------------------------------------------------- @@ -326,9 +318,7 @@ wxStatusBar* wxFrameBase::CreateStatusBar(int number, wxCHECK_MSG( !m_frameStatusBar, (wxStatusBar *)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 +328,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 +351,107 @@ 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(wxStatusBar *WXUNUSED(statbar), int menuId) +{ +#if wxUSE_MENUS + // if no help string found, we will clear the status bar text + wxString helpString; + bool show = menuId != wxID_SEPARATOR && menuId != -2 /* wxID_TITLE */; + + if ( show ) + { + 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(); + } + } + + DoGiveHelp(helpString, show); + + 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 + +void wxFrameBase::DoGiveHelp(const wxString& text, bool show) +{ +#if wxUSE_STATUSBAR + if ( m_statusBarPane < 0 ) + { + // status bar messages disabled + return; + } + + wxStatusBar *statbar = GetStatusBar(); + if ( !statbar ) + return; + + wxString help; + if ( show ) + help = text; + + // 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 += _T('\0'); + } + } + + statbar->SetStatusText(help, m_statusBarPane); +#else + wxUnusedVar(text); + wxUnusedVar(show); #endif // wxUSE_STATUSBAR +} + // ---------------------------------------------------------------------------- // toolbar stuff @@ -391,7 +468,19 @@ wxToolBar* wxFrameBase::CreateToolBar(long style, wxCHECK_MSG( !m_frameToolBar, (wxToolBar *)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; } @@ -405,57 +494,81 @@ wxToolBar* wxFrameBase::OnCreateToolBar(long style, style, name); } +void wxFrameBase::SetToolBar(wxToolBar *toolbar) +{ + bool hadBar = m_frameToolBar != NULL; + m_frameToolBar = toolbar; + + if ( (m_frameToolBar != NULL) != hadBar ) + { + PositionToolBar(); + + DoLayout(); + } +} + #endif // wxUSE_TOOLBAR // ---------------------------------------------------------------------------- -// Menu UI updating +// menus // ---------------------------------------------------------------------------- -void wxFrameBase::OnIdle(wxIdleEvent& WXUNUSED(event) ) -{ - DoMenuUpdates(); -} +#if wxUSE_MENUS // update all menus -void wxFrameBase::DoMenuUpdates() +void wxFrameBase::DoMenuUpdates(wxMenu* menu) { + wxEvtHandler* source = GetEventHandler(); wxMenuBar* bar = GetMenuBar(); - if ( bar != NULL ) + if (menu) + menu->UpdateUI(source); + else if ( bar != NULL ) { int nCount = bar->GetMenuCount(); for (int n = 0; n < nCount; n++) - DoMenuUpdates(bar->GetMenu(n), (wxWindow*) NULL); + bar->GetMenu(n)->UpdateUI(source); } } -// update a menu and all submenus recursively -void wxFrameBase::DoMenuUpdates(wxMenu* menu, wxWindow* WXUNUSED(focusWin)) +void wxFrameBase::DetachMenuBar() { - wxEvtHandler* evtHandler = GetEventHandler(); - wxMenuItemList::Node* node = menu->GetMenuItems().GetFirst(); - while (node) + if ( m_frameMenuBar ) { - wxMenuItem* item = node->GetData(); - if ( !item->IsSeparator() ) - { - wxWindowID id = item->GetId(); - wxUpdateUIEvent event(id); - event.SetEventObject( this ); - - 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()); - } - - if (item->GetSubMenu()) - DoMenuUpdates(item->GetSubMenu(), (wxWindow*) NULL); - } - node = node->GetNext(); + m_frameMenuBar->Detach(); + m_frameMenuBar = NULL; + } +} + +void wxFrameBase::AttachMenuBar(wxMenuBar *menubar) +{ + if ( menubar ) + { + menubar->Attach((wxFrame *)this); + m_frameMenuBar = menubar; } } + +void wxFrameBase::SetMenuBar(wxMenuBar *menubar) +{ + if ( menubar == GetMenuBar() ) + { + // nothing to do + return; + } + + DetachMenuBar(); + + this->AttachMenuBar(menubar); +} + +#endif // wxUSE_MENUS + +#if WXWIN_COMPATIBILITY_2_2 + +bool wxFrameBase::Command(int winid) +{ + return ProcessCommand(winid); +} + +#endif // WXWIN_COMPATIBILITY_2_2