added (and documented) msw.xp-tab-ok option

[wxWidgets.git] / src / common / framecmn.cpp

diff --git a/src/common/framecmn.cpp b/src/common/framecmn.cpp
index 87c94e3fe34de846622daf480f4180216036fe0f..0020580068af974a7aa254ebdabaffec33cf8ae7 100644 (file)
--- a/src/common/framecmn.cpp
+++ b/src/common/framecmn.cpp
@@ -45,13 +45,17 @@
 // event table
 // ----------------------------------------------------------------------------
 
 // event table
 // ----------------------------------------------------------------------------
 

+#if wxUSE_MENUS && wxUSE_STATUSBAR
+

 BEGIN_EVENT_TABLE(wxFrameBase, wxTopLevelWindow)
 BEGIN_EVENT_TABLE(wxFrameBase, wxTopLevelWindow)

-#if wxUSE_MENUS && !wxUSE_IDLEMENUUPDATES

     EVT_MENU_OPEN(wxFrameBase::OnMenuOpen)
     EVT_MENU_OPEN(wxFrameBase::OnMenuOpen)

-#endif
+    EVT_MENU_CLOSE(wxFrameBase::OnMenuClose)
+

     EVT_MENU_HIGHLIGHT_ALL(wxFrameBase::OnMenuHighlight)
 END_EVENT_TABLE()
 
     EVT_MENU_HIGHLIGHT_ALL(wxFrameBase::OnMenuHighlight)
 END_EVENT_TABLE()
 

+#endif // wxUSE_MENUS && wxUSE_STATUSBAR
+

 // ============================================================================
 // implementation
 // ============================================================================
 // ============================================================================
 // implementation
 // ============================================================================


@@ -124,20 +128,20 @@ bool wxFrameBase::IsOneOfBars(const wxWindow *win) const
 {
 #if wxUSE_MENUS
     if ( win == GetMenuBar() )
 {
 #if wxUSE_MENUS
     if ( win == GetMenuBar() )

-        return TRUE;
+        return true;

 #endif // wxUSE_MENUS
 
 #if wxUSE_STATUSBAR
     if ( win == GetStatusBar() )
 #endif // wxUSE_MENUS
 
 #if wxUSE_STATUSBAR
     if ( win == GetStatusBar() )

-        return TRUE;
+        return true;

 #endif // wxUSE_STATUSBAR
 
 #if wxUSE_TOOLBAR
     if ( win == GetToolBar() )
 #endif // wxUSE_STATUSBAR
 
 #if wxUSE_TOOLBAR
     if ( win == GetToolBar() )

-        return TRUE;
+        return true;

 #endif // wxUSE_TOOLBAR
 
 #endif // wxUSE_TOOLBAR
 

-    return FALSE;
+    return false;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -151,7 +155,7 @@ wxPoint wxFrameBase::GetClientAreaOrigin() const
 {
     wxPoint pt = wxTopLevelWindow::GetClientAreaOrigin();
 
 {
     wxPoint pt = wxTopLevelWindow::GetClientAreaOrigin();
 

-#if wxUSE_TOOLBAR && !defined(__WXUNIVERSAL__) && !defined(__WXWINCE__)
+#if wxUSE_TOOLBAR && !defined(__WXUNIVERSAL__)

     wxToolBar *toolbar = GetToolBar();
     if ( toolbar && toolbar->IsShown() )
     {
     wxToolBar *toolbar = GetToolBar();
     if ( toolbar && toolbar->IsShown() )
     {


@@ -172,6 +176,15 @@ wxPoint wxFrameBase::GetClientAreaOrigin() const
     return pt;
 }
 
     return pt;
 }
 

+
+void wxFrameBase::SendSizeEvent()
+{
+    wxSizeEvent event( GetSize(), GetId() );
+    event.SetEventObject( this );
+    GetEventHandler()->AddPendingEvent( event );
+}
+
+

 // ----------------------------------------------------------------------------
 // misc
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // misc
 // ----------------------------------------------------------------------------


@@ -181,7 +194,7 @@ bool wxFrameBase::ProcessCommand(int id)
 #if wxUSE_MENUS
     wxMenuBar *bar = GetMenuBar();
     if ( !bar )
 #if wxUSE_MENUS
     wxMenuBar *bar = GetMenuBar();
     if ( !bar )

-        return FALSE;
+        return false;

 
     wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id);
     commandEvent.SetEventObject(this);
 
     wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id);
     commandEvent.SetEventObject(this);


@@ -190,7 +203,7 @@ bool wxFrameBase::ProcessCommand(int id)
     if (item)
     {
         if (!item->IsEnabled())
     if (item)
     {
         if (!item->IsEnabled())

-            return TRUE;
+            return true;

 
         if (item->IsCheckable())
         {
 
         if (item->IsCheckable())
         {


@@ -202,9 +215,9 @@ bool wxFrameBase::ProcessCommand(int id)
     }
 
     GetEventHandler()->ProcessEvent(commandEvent);
     }
 
     GetEventHandler()->ProcessEvent(commandEvent);

-    return TRUE;
+    return true;

 #else // !wxUSE_MENUS
 #else // !wxUSE_MENUS

-    return FALSE;
+    return false;

 #endif // wxUSE_MENUS/!wxUSE_MENUS
 }
 
 #endif // wxUSE_MENUS/!wxUSE_MENUS
 }
 


@@ -214,7 +227,7 @@ bool wxFrameBase::ProcessCommand(int id)
 void wxFrameBase::UpdateWindowUI(long flags)
 {
     wxWindowBase::UpdateWindowUI(flags);
 void wxFrameBase::UpdateWindowUI(long flags)
 {
     wxWindowBase::UpdateWindowUI(flags);

-    
+

 #if wxUSE_TOOLBAR
     if (GetToolBar())
         GetToolBar()->UpdateWindowUI(flags);
 #if wxUSE_TOOLBAR
     if (GetToolBar())
         GetToolBar()->UpdateWindowUI(flags);


@@ -233,13 +246,15 @@ void wxFrameBase::UpdateWindowUI(long flags)
         else
             DoMenuUpdates();
     }
         else
             DoMenuUpdates();
     }

-#endif
+#endif // wxUSE_MENUS

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------

-// event handlers
+// event handlers for status bar updates from menus

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

+#if wxUSE_MENUS && wxUSE_STATUSBAR
+

 void wxFrameBase::OnMenuHighlight(wxMenuEvent& event)
 {
 #if wxUSE_STATUSBAR
 void wxFrameBase::OnMenuHighlight(wxMenuEvent& event)
 {
 #if wxUSE_STATUSBAR


@@ -247,24 +262,46 @@ void wxFrameBase::OnMenuHighlight(wxMenuEvent& event)
 #endif // wxUSE_STATUSBAR
 }
 
 #endif // wxUSE_STATUSBAR
 }
 

+#if !wxUSE_IDLEMENUUPDATES
+void wxFrameBase::OnMenuOpen(wxMenuEvent& event)
+#else
+void wxFrameBase::OnMenuOpen(wxMenuEvent& WXUNUSED(event))
+#endif
+{
+#if !wxUSE_IDLEMENUUPDATES
+    DoMenuUpdates(event.GetMenu());
+#endif // !wxUSE_IDLEMENUUPDATES
+}
+
+void wxFrameBase::OnMenuClose(wxMenuEvent& WXUNUSED(event))
+{
+    // do we have real status text to restore?
+    if ( m_oldStatusText.length() > 1 || m_oldStatusText[0u] )
+    {
+        if ( m_statusBarPane >= 0 )
+        {
+            wxStatusBar *statbar = GetStatusBar();
+            if ( statbar )
+                statbar->SetStatusText(m_oldStatusText, m_statusBarPane);
+        }
+
+        m_oldStatusText.clear();
+    }
+}
+
+#endif // wxUSE_MENUS && wxUSE_STATUSBAR
+

 // Implement internal behaviour (menu updating on some platforms)
 void wxFrameBase::OnInternalIdle()
 {
     wxTopLevelWindow::OnInternalIdle();
 // Implement internal behaviour (menu updating on some platforms)
 void wxFrameBase::OnInternalIdle()
 {
     wxTopLevelWindow::OnInternalIdle();

-    
+

 #if wxUSE_MENUS && wxUSE_IDLEMENUUPDATES
     if (wxUpdateUIEvent::CanUpdate(this))
         DoMenuUpdates();
 #endif
 }
 
 #if wxUSE_MENUS && wxUSE_IDLEMENUUPDATES
     if (wxUpdateUIEvent::CanUpdate(this))
         DoMenuUpdates();
 #endif
 }
 

-void wxFrameBase::OnMenuOpen(wxMenuEvent& event)
-{
-#if wxUSE_MENUS && !wxUSE_IDLEMENUUPDATES
-    DoMenuUpdates(event.GetMenu());
-#endif
-}
-

 // ----------------------------------------------------------------------------
 // status bar stuff
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // status bar stuff
 // ----------------------------------------------------------------------------


@@ -281,9 +318,7 @@ wxStatusBar* wxFrameBase::CreateStatusBar(int number,
     wxCHECK_MSG( !m_frameStatusBar, (wxStatusBar *)NULL,
                  wxT("recreating status bar in wxFrame") );
 
     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;
 }
 
     return m_frameStatusBar;
 }


@@ -354,21 +389,66 @@ bool wxFrameBase::ShowMenuHelp(wxStatusBar *WXUNUSED(statbar), int menuId)
 
     return !helpString.IsEmpty();
 #else // !wxUSE_MENUS
 
     return !helpString.IsEmpty();
 #else // !wxUSE_MENUS

-    return FALSE;
+    return false;

 #endif // wxUSE_MENUS/!wxUSE_MENUS
 }
 
 #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
 #endif // wxUSE_STATUSBAR
 
 void wxFrameBase::DoGiveHelp(const wxString& text, bool show)
 {
 #if wxUSE_STATUSBAR

-    if ( m_statusBarPane < 0 ) return;
-    wxStatusBar* statbar = GetStatusBar();
-    if ( !statbar ) return;
+    if ( m_statusBarPane < 0 )
+    {
+        // status bar messages disabled
+        return;
+    }

 
 

-    wxString help = show ? text : wxString();
-    statbar->SetStatusText( help, m_statusBarPane );
+    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
 }
 
 #endif // wxUSE_STATUSBAR
 }
 


@@ -400,7 +480,7 @@ wxToolBar* wxFrameBase::CreateToolBar(long style,
         style = wxBORDER_NONE | wxTB_HORIZONTAL | wxTB_FLAT;
     }
 
         style = wxBORDER_NONE | wxTB_HORIZONTAL | wxTB_FLAT;
     }
 

-    m_frameToolBar = OnCreateToolBar(style, id, name);
+    SetToolBar(OnCreateToolBar(style, id, name));

 
     return m_frameToolBar;
 }
 
     return m_frameToolBar;
 }


@@ -414,6 +494,19 @@ wxToolBar* wxFrameBase::OnCreateToolBar(long style,
                          style, name);
 }
 
                          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
 
 // ----------------------------------------------------------------------------
 #endif // wxUSE_TOOLBAR
 
 // ----------------------------------------------------------------------------


@@ -466,7 +559,7 @@ void wxFrameBase::SetMenuBar(wxMenuBar *menubar)
 
     DetachMenuBar();
 
 
     DetachMenuBar();
 

-    AttachMenuBar(menubar);
+    this->AttachMenuBar(menubar);

 }
 
 #endif // wxUSE_MENUS
 }
 
 #endif // wxUSE_MENUS