Implement and document wxDataViewTreeCtrl::IsContainer(), use it in the sample to...

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

diff --git a/src/common/framecmn.cpp b/src/common/framecmn.cpp
index 8bc2ffb5db650f512cc7343be534c2789b90109d..7cbe913304cc6f63cd4ef4fa17b3d6b72374dc69 100644 (file)
--- 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$
 // 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
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -16,10 +16,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "framebase.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -27,34 +23,31 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#include "wx/frame.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-    #include "wx/frame.h"

     #include "wx/menu.h"
     #include "wx/menuitem.h"
     #include "wx/dcclient.h"
     #include "wx/menu.h"
     #include "wx/menuitem.h"
     #include "wx/dcclient.h"

-#endif // WX_PRECOMP
-
-#if wxUSE_TOOLBAR

     #include "wx/toolbar.h"
     #include "wx/toolbar.h"

-#endif
-#if wxUSE_STATUSBAR

     #include "wx/statusbr.h"
     #include "wx/statusbr.h"

-#endif
-
-// FIXME - temporary hack in absence of wxTLW in all ports!
-#ifndef wxTopLevelWindowNative
-    #define wxTopLevelWindow wxTopLevelWindowBase
-#endif
+#endif // WX_PRECOMP

 
 // ----------------------------------------------------------------------------
 // event table
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // event table
 // ----------------------------------------------------------------------------
 

+#if wxUSE_MENUS && wxUSE_STATUSBAR
+

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

-    EVT_IDLE(wxFrameBase::OnIdle)
+    EVT_MENU_OPEN(wxFrameBase::OnMenuOpen)
+    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
 // ============================================================================


@@ -76,6 +69,8 @@ wxFrameBase::wxFrameBase()
 #if wxUSE_STATUSBAR
     m_frameStatusBar = NULL;
 #endif // wxUSE_STATUSBAR
 #if wxUSE_STATUSBAR
     m_frameStatusBar = NULL;
 #endif // wxUSE_STATUSBAR

+
+    m_statusBarPane = 0;

 }
 
 wxFrameBase::~wxFrameBase()
 }
 
 wxFrameBase::~wxFrameBase()


@@ -100,7 +95,7 @@ void wxFrameBase::DeleteAllBars()
     if ( m_frameMenuBar )
     {
         delete m_frameMenuBar;
     if ( m_frameMenuBar )
     {
         delete m_frameMenuBar;

-        m_frameMenuBar = (wxMenuBar *) NULL;
+        m_frameMenuBar = NULL;

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


@@ -108,7 +103,7 @@ void wxFrameBase::DeleteAllBars()
     if ( m_frameStatusBar )
     {
         delete m_frameStatusBar;
     if ( m_frameStatusBar )
     {
         delete m_frameStatusBar;

-        m_frameStatusBar = (wxStatusBar *) NULL;
+        m_frameStatusBar = NULL;

     }
 #endif // wxUSE_STATUSBAR
 
     }
 #endif // wxUSE_STATUSBAR
 


@@ -116,7 +111,7 @@ void wxFrameBase::DeleteAllBars()
     if ( m_frameToolBar )
     {
         delete m_frameToolBar;
     if ( m_frameToolBar )
     {
         delete m_frameToolBar;

-        m_frameToolBar = (wxToolBar *) NULL;
+        m_frameToolBar = NULL;

     }
 #endif // wxUSE_TOOLBAR
 }
     }
 #endif // wxUSE_TOOLBAR
 }


@@ -125,20 +120,22 @@ 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;
+    wxUnusedVar(win);
+
+    return false;

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


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

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

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


@@ -177,52 +174,110 @@ wxPoint wxFrameBase::GetClientAreaOrigin() const
 // misc
 // ----------------------------------------------------------------------------
 
 // misc
 // ----------------------------------------------------------------------------
 

+#if wxUSE_MENUS
+

 bool wxFrameBase::ProcessCommand(int id)
 {
 bool wxFrameBase::ProcessCommand(int id)
 {

-#if wxUSE_MENUS

     wxMenuBar *bar = GetMenuBar();
     if ( !bar )
     wxMenuBar *bar = GetMenuBar();
     if ( !bar )

-        return FALSE;
+        return false;

 
 

-    wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id);
+    wxMenuItem *item = bar->FindItem(id);
+    if ( !item )
+        return false;
+
+    return ProcessCommand(item);
+}
+
+bool wxFrameBase::ProcessCommand(wxMenuItem *item)
+{
+    wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, item->GetId());

     commandEvent.SetEventObject(this);
 
     commandEvent.SetEventObject(this);
 

-    wxMenuItem *item = bar->FindItem(id);
-    if (item)
+    if (!item->IsEnabled())
+        return true;
+
+    if ((item->GetKind() == wxITEM_RADIO) && item->IsChecked() )
+        return true;
+
+    if (item->IsCheckable())

     {
     {

-        if (!item->IsEnabled())
-            return TRUE;
+        item->Toggle();

 
 

-        if (item->IsCheckable())
-        {
-            item->Toggle();
-            // use the new value
-            commandEvent.SetInt(item->IsChecked());
-        }
+        // use the new value
+        commandEvent.SetInt(item->IsChecked());

     }
 
     }
 

-    return GetEventHandler()->ProcessEvent(commandEvent);
-#else // !wxUSE_MENUS
-    return FALSE;
-#endif // wxUSE_MENUS/!wxUSE_MENUS
+    return HandleWindowEvent(commandEvent);
+}
+
+#endif // wxUSE_MENUS
+
+// 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
+
+#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

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

-// 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

-    (void)ShowMenuHelp(GetStatusBar(), event.GetMenuId());
+    (void)ShowMenuHelp(event.GetMenuId());

 #endif // wxUSE_STATUSBAR
 }
 
 #endif // wxUSE_STATUSBAR
 }
 

-void wxFrameBase::OnIdle(wxIdleEvent& WXUNUSED(event) )
+void wxFrameBase::OnMenuOpen(wxMenuEvent& event)

 {
 {

-#if wxUSE_MENUS
-    DoMenuUpdates();
-#endif // wxUSE_MENUS
+#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
+}
+
+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

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


@@ -238,12 +293,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)
 {
     // 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") );
 
                  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;
 }


@@ -276,40 +329,128 @@ void wxFrameBase::SetStatusWidths(int n, const int widths_field[] )
     PositionStatusBar();
 }
 
     PositionStatusBar();
 }
 

-bool wxFrameBase::ShowMenuHelp(wxStatusBar *statbar, int menuId)
+void wxFrameBase::PushStatusText(const wxString& text, int number)

 {
 {

-#if wxUSE_MENUS
-    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(int menuId)
+{
+#if wxUSE_MENUS

     // if no help string found, we will clear the status bar text
     wxString helpString;
     // if no help string found, we will clear the status bar text
     wxString helpString;

-
-    if ( menuId != wxID_SEPARATOR && menuId != -2 /* wxID_TITLE */ )
+    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 && !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

     }
 
     }
 

-    // 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, true);

 
 

-    return !helpString.IsEmpty();
+    return !helpString.empty();

 #else // !wxUSE_MENUS
 #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
 
 #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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // toolbar stuff
 // ----------------------------------------------------------------------------


@@ -320,12 +461,24 @@ wxToolBar* wxFrameBase::CreateToolBar(long style,
                                       wxWindowID id,
                                       const wxString& name)
 {
                                       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)
     // before)

-    wxCHECK_MSG( !m_frameToolBar, (wxToolBar *)NULL,
+    wxCHECK_MSG( !m_frameToolBar, NULL,

                  wxT("recreating toolbar in wxFrame") );
 
                  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;
 }
 
     return m_frameToolBar;
 }


@@ -334,9 +487,28 @@ wxToolBar* wxFrameBase::OnCreateToolBar(long style,
                                         wxWindowID id,
                                         const wxString& name)
 {
                                         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);
     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
 }
 
 #endif // wxUSE_TOOLBAR


@@ -348,51 +520,18 @@ wxToolBar* wxFrameBase::OnCreateToolBar(long style,
 #if wxUSE_MENUS
 
 // update all menus
 #if wxUSE_MENUS
 
 // update all menus

-void wxFrameBase::DoMenuUpdates()
+void wxFrameBase::DoMenuUpdates(wxMenu* menu)

 {
 {

-    wxMenuBar* bar = GetMenuBar();
-
-#ifdef __WXMSW__
-    wxWindow* focusWin = wxFindFocusDescendant((wxWindow*) this);
-#else
-    wxWindow* focusWin = (wxWindow*) NULL;
-#endif
-    if ( bar != NULL )
+    if (menu)

     {
     {

-        int nCount = bar->GetMenuCount();
-        for (int n = 0; n < nCount; n++)
-            DoMenuUpdates(bar->GetMenu(n), focusWin);
+        wxEvtHandler* source = GetEventHandler();
+        menu->UpdateUI(source);

     }
     }

-}
-
-// update a menu and all submenus recursively
-void wxFrameBase::DoMenuUpdates(wxMenu* menu, wxWindow* focusWin)
-{
-    wxEvtHandler* evtHandler = focusWin ? focusWin->GetEventHandler() : GetEventHandler();
-    wxMenuItemList::Node* node = menu->GetMenuItems().GetFirst();
-    while (node)
+    else

     {
     {

-        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();
+        wxMenuBar* bar = GetMenuBar();
+        if (bar != NULL)
+            bar->UpdateMenus();

     }
 }
 
     }
 }
 


@@ -424,7 +563,14 @@ void wxFrameBase::SetMenuBar(wxMenuBar *menubar)
 
     DetachMenuBar();
 
 
     DetachMenuBar();
 

-    AttachMenuBar(menubar);
+    this->AttachMenuBar(menubar);
+}
+
+wxMenuItem *wxFrameBase::FindItemInMenuBar(int menuId) const
+{
+    const wxMenuBar * const menuBar = GetMenuBar();
+
+    return menuBar ? menuBar->FindItem(menuId) : NULL;

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