]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/framecmn.cpp
document On{Open,Save}Document()
[wxWidgets.git] / src / common / framecmn.cpp
index 3137700a8875b5f0f66d598fe3cb7296f1760f49..c1a25b5a8ee44efa7818e9e9224d5f78878e5e93 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// 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
     #pragma hdrstop
 #endif
 
+#include "wx/frame.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"
-#endif
-#if wxUSE_STATUSBAR
     #include "wx/statusbr.h"
-#endif
+#endif // WX_PRECOMP
 
 // ----------------------------------------------------------------------------
 // event table
@@ -137,6 +133,8 @@ bool wxFrameBase::IsOneOfBars(const wxWindow *win) const
         return true;
 #endif // wxUSE_TOOLBAR
 
+    wxUnusedVar(win);
+
     return false;
 }
 
@@ -213,9 +211,10 @@ bool wxFrameBase::ProcessCommand(int id)
         }
     }
 
-    GetEventHandler()->ProcessEvent(commandEvent);
-    return true;
+    return HandleWindowEvent(commandEvent);
 #else // !wxUSE_MENUS
+    wxUnusedVar(id);
+
     return false;
 #endif // wxUSE_MENUS/!wxUSE_MENUS
 }
@@ -257,7 +256,7 @@ void wxFrameBase::UpdateWindowUI(long flags)
 void wxFrameBase::OnMenuHighlight(wxMenuEvent& event)
 {
 #if wxUSE_STATUSBAR
-    (void)ShowMenuHelp(GetStatusBar(), event.GetMenuId());
+    (void)ShowMenuHelp(event.GetMenuId());
 #endif // wxUSE_STATUSBAR
 }
 
@@ -274,18 +273,7 @@ void wxFrameBase::OnMenuOpen(wxMenuEvent& WXUNUSED(event))
 
 void wxFrameBase::OnMenuClose(wxMenuEvent& WXUNUSED(event))
 {
-    // do we have real status text to restore?
-    if ( !m_oldStatusText.empty() )
-    {
-        if ( m_statusBarPane >= 0 )
-        {
-            wxStatusBar *statbar = GetStatusBar();
-            if ( statbar )
-                statbar->SetStatusText(m_oldStatusText, m_statusBarPane);
-        }
-
-        m_oldStatusText.clear();
-    }
+    DoGiveHelp(wxEmptyString, false);
 }
 
 #endif // wxUSE_MENUS && wxUSE_STATUSBAR
@@ -364,27 +352,22 @@ void wxFrameBase::PopStatusText(int number)
     m_frameStatusBar->PopStatusText(number);
 }
 
-bool wxFrameBase::ShowMenuHelp(wxStatusBar *WXUNUSED(statbar), int menuId)
+bool wxFrameBase::ShowMenuHelp(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 )
+    if ( menuId != wxID_SEPARATOR && menuId != -3 /* 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();
-        }
+        const wxMenuItem * const item = FindItemInMenuBar(menuId);
+        if ( item )
+            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, show);
+    DoGiveHelp(helpString, true);
 
     return !helpString.empty();
 #else // !wxUSE_MENUS
@@ -407,7 +390,8 @@ void wxFrameBase::SetStatusBar(wxStatusBar *statBar)
 
 #endif // wxUSE_STATUSBAR
 
-void wxFrameBase::DoGiveHelp(const wxString& text, bool show)
+#if wxUSE_MENUS || wxUSE_TOOLBAR
+void wxFrameBase::DoGiveHelp(const wxString& help, bool show)
 {
 #if wxUSE_STATUSBAR
     if ( m_statusBarPane < 0 )
@@ -420,36 +404,45 @@ void wxFrameBase::DoGiveHelp(const wxString& text, bool show)
     if ( !statbar )
         return;
 
-    wxString help;
+    wxString text;
     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);
+        // 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() )
         {
-            // use special value to prevent us from doing this the next time
-            m_oldStatusText += _T('\0');
+            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');
+            }
         }
+
+        text = help;
+    }
+    else // hide help, restore the original text
+    {
+        text = m_oldStatusText;
+        m_oldStatusText.clear();
     }
 
-    statbar->SetStatusText(help, m_statusBarPane);
+    statbar->SetStatusText(text, m_statusBarPane);
 #else
-    wxUnusedVar(text);
+    wxUnusedVar(help);
     wxUnusedVar(show);
 #endif // wxUSE_STATUSBAR
 }
+#endif // wxUSE_MENUS || wxUSE_TOOLBAR
 
 
 // ----------------------------------------------------------------------------
@@ -462,7 +455,7 @@ 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,
                  wxT("recreating toolbar in wxFrame") );
@@ -523,16 +516,16 @@ void wxFrameBase::SetToolBar(wxToolBar *toolbar)
 // update all menus
 void wxFrameBase::DoMenuUpdates(wxMenu* menu)
 {
-    wxEvtHandler* source = GetEventHandler();
-    wxMenuBar* bar = GetMenuBar();
-
     if (menu)
+    {
+        wxEvtHandler* source = GetEventHandler();
         menu->UpdateUI(source);
-    else if ( bar != NULL )
+    }
+    else
     {
-        int nCount = bar->GetMenuCount();
-        for (int n = 0; n < nCount; n++)
-            bar->GetMenu(n)->UpdateUI(source);
+        wxMenuBar* bar = GetMenuBar();
+        if (bar != NULL)
+            bar->UpdateMenus();
     }
 }
 
@@ -567,4 +560,11 @@ void wxFrameBase::SetMenuBar(wxMenuBar *menubar)
     this->AttachMenuBar(menubar);
 }
 
+const wxMenuItem *wxFrameBase::FindItemInMenuBar(int menuId) const
+{
+    const wxMenuBar * const menuBar = GetMenuBar();
+
+    return menuBar ? menuBar->FindItem(menuId) : NULL;
+}
+
 #endif // wxUSE_MENUS