X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f0e9f0d3ff8552bcbb19b323714471f06711c00e..9d17ee000a844ae3fe216c2ae79cc0741fafc936:/src/common/framecmn.cpp

diff --git a/src/common/framecmn.cpp b/src/common/framecmn.cpp
index 3cc2dff527..6c8b6ed182 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,11 +91,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 +116,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 +145,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() && GetToolBar()->IsShown() )
+#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,146 +168,133 @@ 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;
+
+        if ((item->GetKind() == wxITEM_RADIO) && item->IsChecked() )
+            return true;
 
-        // use the new value
-        commandEvent.SetInt(item->IsChecked());
+        if (item->IsCheckable())
+        {
+            item->Toggle();
+
+            // use the new value
+            commandEvent.SetInt(item->IsChecked());
+        }
     }
 
-    return GetEventHandler()->ProcessEvent(commandEvent);
+    GetEventHandler()->ProcessEvent(commandEvent);
+    return true;
+#else // !wxUSE_MENUS
+    return false;
+#endif // wxUSE_MENUS/!wxUSE_MENUS
 }
 
-// ----------------------------------------------------------------------------
-// event handlers
-// ----------------------------------------------------------------------------
-
-// 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
+// ----------------------------------------------------------------------------
 
-            // 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_MENUS && wxUSE_STATUSBAR
+
+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
+{
+#if !wxUSE_IDLEMENUUPDATES
+    DoMenuUpdates(event.GetMenu());
+#endif // !wxUSE_IDLEMENUUPDATES
+}
 
-            child->SetSize(ofs, ofs, clientW - 2*ofs, clientH - 2*ofs);
+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();
     }
 }
 
-// The default implementation for the close window event.
-void wxFrameBase::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
-{
-    Destroy();
-}
+#endif // wxUSE_MENUS && wxUSE_STATUSBAR
 
-void wxFrameBase::OnMenuHighlight(wxMenuEvent& event)
+// Implement internal behaviour (menu updating on some platforms)
+void wxFrameBase::OnInternalIdle()
 {
-#if wxUSE_STATUSBAR
-    (void)ShowMenuHelp(GetStatusBar(), event.GetMenuId());
-#endif // wxUSE_STATUSBAR
+    wxTopLevelWindow::OnInternalIdle();
+
+#if wxUSE_MENUS && wxUSE_IDLEMENUUPDATES
+    if (wxUpdateUIEvent::CanUpdate(this))
+        DoMenuUpdates();
+#endif
 }
 
 // ----------------------------------------------------------------------------
@@ -306,9 +313,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;
 }
@@ -320,17 +325,6 @@ wxStatusBar *wxFrameBase::OnCreateStatusBar(int number,
 {
     wxStatusBar *statusBar = new wxStatusBar(this, id, style, name);
 
-    // Set the height according to the font and the border size
-    wxClientDC dc(statusBar);
-    dc.SetFont(statusBar->GetFont());
-
-    wxCoord y;
-    dc.GetTextExtent( "X", NULL, &y );
-
-    int height = (int)( (11*y)/10 + 2*statusBar->GetBorderY());
-
-    statusBar->SetSize( -1, -1, -1, height );
-
     statusBar->SetFieldsCount(number);
 
     return statusBar;
@@ -352,15 +346,28 @@ void wxFrameBase::SetStatusWidths(int n, const int widths_field[] )
     PositionStatusBar();
 }
 
-bool wxFrameBase::ShowMenuHelp(wxStatusBar *statbar, int menuId)
+void wxFrameBase::PushStatusText(const wxString& text, int number)
 {
-    if ( !statbar )
-        return FALSE;
+    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 ( menuId != wxID_SEPARATOR && menuId != -2 /* wxID_TITLE */ )
+    if ( show )
     {
         wxMenuBar *menuBar = GetMenuBar();
         if ( menuBar )
@@ -373,15 +380,76 @@ bool wxFrameBase::ShowMenuHelp(wxStatusBar *statbar, int menuId)
         }
     }
 
-    // set status text even if the string is empty - this will at least
-    // remove the string from the item which was previously selected
-    statbar->SetStatusText(helpString);
+    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();
 
-    return !helpString.IsEmpty();
+        DoLayout();
+    }
 }
 
 #endif // wxUSE_STATUSBAR
 
+#if wxUSE_MENUS || wxUSE_TOOLBAR
+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
+}
+#endif // wxUSE_MENUS || wxUSE_TOOLBAR
+
+
 // ----------------------------------------------------------------------------
 // toolbar stuff
 // ----------------------------------------------------------------------------
@@ -392,12 +460,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,
                  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;
 }
@@ -406,67 +486,83 @@ 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)
+{
+    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) )
+#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;
+    }
+}
 
-#ifdef __WXMSW__
-    wxWindow* focusWin = wxFindFocusDescendant((wxWindow*) this);
-#else
-    wxWindow* focusWin = (wxWindow*) NULL;
-#endif
-    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), focusWin);
+        menubar->Attach((wxFrame *)this);
+        m_frameMenuBar = menubar;
     }
 }
 
-// update a menu and all submenus recursively
-void wxFrameBase::DoMenuUpdates(wxMenu* menu, wxWindow* focusWin)
+void wxFrameBase::SetMenuBar(wxMenuBar *menubar)
 {
-    wxEvtHandler* evtHandler = focusWin ? focusWin->GetEventHandler() : 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 );
-
-            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();
+        // nothing to do
+        return;
     }
+
+    DetachMenuBar();
+
+    this->AttachMenuBar(menubar);
 }
+
+#endif // wxUSE_MENUS