]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/menucmn.cpp
Update version to 2.9.4 in version.bkl too and rebake everything.
[wxWidgets.git] / src / common / menucmn.cpp
index 5f7c8cd9b446156264bcdb5be47c8c31b767e3e1..d53056d9ee3ff34fedc5ec5240e31639c1105672 100644 (file)
@@ -30,6 +30,7 @@
     #include "wx/intl.h"
     #include "wx/log.h"
     #include "wx/menu.h"
+    #include "wx/frame.h"
 #endif
 
 #include "wx/stockitem.h"
@@ -47,17 +48,220 @@ WX_DEFINE_LIST(wxMenuItemList)
 // implementation
 // ============================================================================
 
+// ----------------------------------------------------------------------------
+// XTI for wxMenu(Bar)
+// ----------------------------------------------------------------------------
+
+wxDEFINE_FLAGS( wxMenuStyle )
+wxBEGIN_FLAGS( wxMenuStyle )
+wxFLAGS_MEMBER(wxMENU_TEAROFF)
+wxEND_FLAGS( wxMenuStyle )
+
+wxIMPLEMENT_DYNAMIC_CLASS_XTI(wxMenu, wxEvtHandler, "wx/menu.h")
+wxCOLLECTION_TYPE_INFO( wxMenuItem *, wxMenuItemList ) ;
+
+#if wxUSE_EXTENDED_RTTI    
+template<> void wxCollectionToVariantArray( wxMenuItemList const &theList,
+                                           wxAnyList &value)
+{
+    wxListCollectionToAnyList<wxMenuItemList::compatibility_iterator>( theList, value ) ;
+}
+#endif
+
+wxBEGIN_PROPERTIES_TABLE(wxMenu)
+wxEVENT_PROPERTY( Select, wxEVT_COMMAND_MENU_SELECTED, wxCommandEvent)
+
+wxPROPERTY( Title, wxString, SetTitle, GetTitle, wxString(), \
+           0 /*flags*/, wxT("Helpstring"), wxT("group") )
+
+wxREADONLY_PROPERTY_FLAGS( MenuStyle, wxMenuStyle, long, GetStyle, \
+                          wxEMPTY_PARAMETER_VALUE, 0 /*flags*/, wxT("Helpstring"), \
+                          wxT("group")) // style
+
+wxPROPERTY_COLLECTION( MenuItems, wxMenuItemList, wxMenuItem*, Append, \
+                      GetMenuItems, 0 /*flags*/, wxT("Helpstring"), wxT("group"))
+wxEND_PROPERTIES_TABLE()
+
+wxEMPTY_HANDLERS_TABLE(wxMenu)
+
+wxDIRECT_CONSTRUCTOR_2( wxMenu, wxString, Title, long, MenuStyle  )
+
+wxDEFINE_FLAGS( wxMenuBarStyle )
+
+wxBEGIN_FLAGS( wxMenuBarStyle )
+wxFLAGS_MEMBER(wxMB_DOCKABLE)
+wxEND_FLAGS( wxMenuBarStyle )
+
+#if wxUSE_EXTENDED_RTTI    
+// the negative id would lead the window (its superclass !) to
+// vetoe streaming out otherwise
+bool wxMenuBarStreamingCallback( const wxObject *WXUNUSED(object), wxObjectWriter *,
+                                wxObjectWriterCallback *, const wxStringToAnyHashMap & )
+{
+    return true;
+}
+#endif
+
+wxIMPLEMENT_DYNAMIC_CLASS_XTI_CALLBACK(wxMenuBar, wxWindow, "wx/menu.h", \
+                                       wxMenuBarStreamingCallback)
+
+
+#if wxUSE_EXTENDED_RTTI    
+WX_DEFINE_LIST( wxMenuInfoHelperList )
+
+wxIMPLEMENT_DYNAMIC_CLASS_XTI(wxMenuInfoHelper, wxObject, "wx/menu.h")
+
+wxBEGIN_PROPERTIES_TABLE(wxMenuInfoHelper)
+wxREADONLY_PROPERTY( Menu, wxMenu*, GetMenu, wxEMPTY_PARAMETER_VALUE, \
+                    0 /*flags*/, wxT("Helpstring"), wxT("group"))
+
+wxREADONLY_PROPERTY( Title, wxString, GetTitle, wxString(), \
+                    0 /*flags*/, wxT("Helpstring"), wxT("group"))
+wxEND_PROPERTIES_TABLE()
+
+wxEMPTY_HANDLERS_TABLE(wxMenuInfoHelper)
+
+wxCONSTRUCTOR_2( wxMenuInfoHelper, wxMenu*, Menu, wxString, Title )
+
+wxCOLLECTION_TYPE_INFO( wxMenuInfoHelper *, wxMenuInfoHelperList ) ;
+
+template<> void wxCollectionToVariantArray( wxMenuInfoHelperList const &theList, 
+                                           wxAnyList &value)
+{
+    wxListCollectionToAnyList<wxMenuInfoHelperList::compatibility_iterator>( theList, value ) ;
+}
+
+#endif
+
+wxBEGIN_PROPERTIES_TABLE(wxMenuBar)
+wxPROPERTY_COLLECTION( MenuInfos, wxMenuInfoHelperList, wxMenuInfoHelper*, AppendMenuInfo, \
+                      GetMenuInfos, 0 /*flags*/, wxT("Helpstring"), wxT("group"))
+wxEND_PROPERTIES_TABLE()
+
+wxEMPTY_HANDLERS_TABLE(wxMenuBar)
+
+wxCONSTRUCTOR_DUMMY( wxMenuBar )
+
+#if wxUSE_EXTENDED_RTTI    
+
+const wxMenuInfoHelperList& wxMenuBarBase::GetMenuInfos() const
+{
+    wxMenuInfoHelperList* list = const_cast< wxMenuInfoHelperList* > (& m_menuInfos);
+    WX_CLEAR_LIST( wxMenuInfoHelperList, *list);
+    for (size_t i = 0 ; i < GetMenuCount(); ++i)
+    {
+        wxMenuInfoHelper* info = new wxMenuInfoHelper();
+        info->Create( GetMenu(i), GetMenuLabel(i));
+        list->Append(info);
+    }
+    return m_menuInfos;
+}
+
+#endif
+
+// ----------------------------------------------------------------------------
+// XTI for wxMenuItem
+// ----------------------------------------------------------------------------
+
+#if wxUSE_EXTENDED_RTTI
+
+bool wxMenuItemStreamingCallback( const wxObject *object, wxObjectWriter *,
+                                 wxObjectWriterCallback *, const wxStringToAnyHashMap & )
+{
+    const wxMenuItem * mitem = wx_dynamic_cast(const wxMenuItem*, object);
+    if ( mitem->GetMenu() && !mitem->GetMenu()->GetTitle().empty() )
+    {
+        // we don't stream out the first two items for menus with a title,
+        // they will be reconstructed
+        if ( mitem->GetMenu()->FindItemByPosition(0) == mitem ||
+            mitem->GetMenu()->FindItemByPosition(1) == mitem )
+            return false;
+    }
+    return true;
+}
+
+#endif
+
+wxBEGIN_ENUM( wxItemKind )
+wxENUM_MEMBER( wxITEM_SEPARATOR )
+wxENUM_MEMBER( wxITEM_NORMAL )
+wxENUM_MEMBER( wxITEM_CHECK )
+wxENUM_MEMBER( wxITEM_RADIO )
+wxEND_ENUM( wxItemKind )
+
+wxIMPLEMENT_DYNAMIC_CLASS_XTI_CALLBACK(wxMenuItem, wxObject, "wx/menuitem.h", \
+                                       wxMenuItemStreamingCallback)
+
+wxBEGIN_PROPERTIES_TABLE(wxMenuItem)
+wxPROPERTY( Parent, wxMenu*, SetMenu, GetMenu, wxEMPTY_PARAMETER_VALUE, \
+           0 /*flags*/, wxT("Helpstring"), wxT("group") )
+wxPROPERTY( Id, int, SetId, GetId, wxEMPTY_PARAMETER_VALUE, \
+           0 /*flags*/, wxT("Helpstring"), wxT("group") )
+wxPROPERTY( ItemLabel, wxString, SetItemLabel, GetItemLabel, wxString(), \
+           0 /*flags*/, wxT("Helpstring"), wxT("group") )
+wxPROPERTY( Help, wxString, SetHelp, GetHelp, wxString(), \
+           0 /*flags*/, wxT("Helpstring"), wxT("group") )
+wxREADONLY_PROPERTY( Kind, wxItemKind, GetKind, wxEMPTY_PARAMETER_VALUE, \
+                    0 /*flags*/, wxT("Helpstring"), wxT("group") )
+wxPROPERTY( SubMenu, wxMenu*, SetSubMenu, GetSubMenu, wxEMPTY_PARAMETER_VALUE, \
+           0 /*flags*/, wxT("Helpstring"), wxT("group") )
+wxPROPERTY( Enabled, bool, Enable, IsEnabled, wxAny((bool)true), \
+           0 /*flags*/, wxT("Helpstring"), wxT("group") )
+wxPROPERTY( Checked, bool, Check, IsChecked, wxAny((bool)false), \
+           0 /*flags*/, wxT("Helpstring"), wxT("group") )
+wxPROPERTY( Checkable, bool, SetCheckable, IsCheckable, wxAny((bool)false), \
+           0 /*flags*/, wxT("Helpstring"), wxT("group") )
+wxEND_PROPERTIES_TABLE()
+
+wxEMPTY_HANDLERS_TABLE(wxMenuItem)
+
+wxDIRECT_CONSTRUCTOR_6( wxMenuItem, wxMenu*, Parent, int, Id, wxString, \
+                       Text, wxString, Help, wxItemKind, Kind, wxMenu*, SubMenu )
+
 // ----------------------------------------------------------------------------
 // wxMenuItemBase
 // ----------------------------------------------------------------------------
 
 wxMenuItemBase::wxMenuItemBase(wxMenu *parentMenu,
-                               int id,
+                               int itemid,
                                const wxString& text,
                                const wxString& help,
                                wxItemKind kind,
                                wxMenu *subMenu)
 {
+    switch ( itemid )
+    {
+        case wxID_ANY:
+            m_id = wxWindow::NewControlId();
+            break;
+
+        case wxID_SEPARATOR:
+            m_id = wxID_SEPARATOR;
+
+            // there is a lot of existing code just doing Append(wxID_SEPARATOR)
+            // and it makes sense to omit the following optional parameters,
+            // including the kind one which doesn't default to wxITEM_SEPARATOR,
+            // of course, so override it here
+            kind = wxITEM_SEPARATOR;
+            break;
+
+        case wxID_NONE:
+            // (popup) menu titles in wxMSW use this ID to indicate that
+            // it's not a real menu item, so we don't want the check below to
+            // apply to it
+            m_id = itemid;
+            break;
+
+        default:
+            // ids are limited to 16 bits under MSW so portable code shouldn't
+            // use ids outside of this range (negative ids generated by wx are
+            // fine though)
+            wxASSERT_MSG( (itemid >= 0 && itemid < SHRT_MAX) ||
+                            (itemid >= wxID_AUTO_LOWEST && itemid <= wxID_AUTO_HIGHEST),
+                          wxS("invalid itemid value") );
+            m_id = itemid;
+    }
+
     // notice that parentMenu can be NULL: the item can be attached to the menu
     // later with SetMenu()
 
@@ -65,12 +269,7 @@ wxMenuItemBase::wxMenuItemBase(wxMenu *parentMenu,
     m_subMenu     = subMenu;
     m_isEnabled   = true;
     m_isChecked   = false;
-    m_id          = id;
     m_kind        = kind;
-    if (m_id == wxID_ANY)
-        m_id = wxWindow::NewControlId();
-    if (m_id == wxID_SEPARATOR)
-        m_kind = wxITEM_SEPARATOR;
 
     SetItemLabel(text);
     SetHelp(help);
@@ -354,7 +553,7 @@ wxMenuItem *wxMenuBase::FindItem(int itemId, wxMenu **itemMenu) const
 }
 
 // non recursive search
-wxMenuItem *wxMenuBase::FindChildItem(int id, size_t *ppos) const
+wxMenuItem *wxMenuBase::FindChildItem(int itemid, size_t *ppos) const
 {
     wxMenuItem *item = NULL;
     wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
@@ -362,7 +561,7 @@ wxMenuItem *wxMenuBase::FindChildItem(int id, size_t *ppos) const
     size_t pos;
     for ( pos = 0; node; pos++ )
     {
-        if ( node->GetData()->GetId() == id )
+        if ( node->GetData()->GetId() == itemid )
         {
             item = node->GetData();
 
@@ -398,17 +597,18 @@ wxMenuItem* wxMenuBase::FindItemByPosition(size_t position) const
 // window will be used.
 void wxMenuBase::UpdateUI(wxEvtHandler* source)
 {
-    if (GetInvokingWindow())
+    wxWindow * const win = GetWindow();
+    if ( win )
     {
         // Don't update menus if the parent
         // frame is about to get deleted
-        wxWindow *tlw = wxGetTopLevelParent( GetInvokingWindow() );
+        wxWindow *tlw = wxGetTopLevelParent(win);
         if (tlw && wxPendingDelete.Member(tlw))
             return;
     }
 
-    if ( !source && GetInvokingWindow() )
-        source = GetInvokingWindow()->GetEventHandler();
+    if ( !source && win )
+        source = win->GetEventHandler();
     if ( !source )
         source = GetEventHandler();
     if ( !source )
@@ -420,19 +620,19 @@ void wxMenuBase::UpdateUI(wxEvtHandler* source)
         wxMenuItem* item = node->GetData();
         if ( !item->IsSeparator() )
         {
-            wxWindowID id = item->GetId();
-            wxUpdateUIEvent event(id);
+            wxWindowID itemid = item->GetId();
+            wxUpdateUIEvent event(itemid);
             event.SetEventObject( source );
 
             if ( source->ProcessEvent(event) )
             {
                 // if anything changed, update the changed attribute
                 if (event.GetSetText())
-                    SetLabel(id, event.GetText());
+                    SetLabel(itemid, event.GetText());
                 if (event.GetSetChecked())
-                    Check(id, event.GetChecked());
+                    Check(itemid, event.GetChecked());
                 if (event.GetSetEnabled())
-                    Enable(id, event.GetEnabled());
+                    Enable(itemid, event.GetEnabled());
             }
 
             // recurse to the submenus
@@ -445,38 +645,25 @@ void wxMenuBase::UpdateUI(wxEvtHandler* source)
     }
 }
 
-bool wxMenuBase::SendEvent(int id, int checked)
+bool wxMenuBase::SendEvent(int itemid, int checked)
 {
-    wxCommandEvent event(wxEVT_COMMAND_MENU_SELECTED, id);
+    wxCommandEvent event(wxEVT_COMMAND_MENU_SELECTED, itemid);
     event.SetEventObject(this);
     event.SetInt(checked);
 
     bool processed = false;
 
-    // Try the menu's event handler
-    // if ( !processed )
-    {
-        wxEvtHandler *handler = GetEventHandler();
-        if ( handler )
-            processed = handler->SafelyProcessEvent(event);
-    }
+    // Try the menu's event handler first
+    wxEvtHandler *handler = GetEventHandler();
+    if ( handler )
+        processed = handler->SafelyProcessEvent(event);
 
-    // Try the window the menu was popped up from (and up through the
-    // hierarchy)
+    // Try the window the menu was popped up from or its menu bar belongs to
     if ( !processed )
     {
-        const wxMenuBase *menu = this;
-        while ( menu )
-        {
-            wxWindow *win = menu->GetInvokingWindow();
-            if ( win )
-            {
-                processed = win->HandleWindowEvent(event);
-                break;
-            }
-
-            menu = menu->GetParent();
-        }
+        wxWindow * const win = GetWindow();
+        if ( win )
+            processed = win->HandleWindowEvent(event);
     }
 
     return processed;
@@ -512,76 +699,104 @@ void wxMenuBase::Detach()
     m_menuBar = NULL;
 }
 
+// ----------------------------------------------------------------------------
+// wxMenu invoking window handling
+// ----------------------------------------------------------------------------
+
+void wxMenuBase::SetInvokingWindow(wxWindow *win)
+{
+    wxASSERT_MSG( !GetParent(),
+                    "should only be called for top level popup menus" );
+    wxASSERT_MSG( !IsAttached(),
+                    "menus attached to menu bar can't have invoking window" );
+
+    m_invokingWindow = win;
+}
+
+wxWindow *wxMenuBase::GetWindow() const
+{
+    // only the top level menus have non-NULL invoking window or a pointer to
+    // the menu bar so recurse upwards until we find it
+    const wxMenuBase *menu = this;
+    while ( menu->GetParent() )
+    {
+        menu = menu->GetParent();
+    }
+
+    return menu->GetMenuBar() ? menu->GetMenuBar()->GetFrame()
+                              : menu->GetInvokingWindow();
+}
+
 // ----------------------------------------------------------------------------
 // wxMenu functions forwarded to wxMenuItem
 // ----------------------------------------------------------------------------
 
-void wxMenuBase::Enable( int id, bool enable )
+void wxMenuBase::Enable( int itemid, bool enable )
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_RET( item, wxT("wxMenu::Enable: no such item") );
 
     item->Enable(enable);
 }
 
-bool wxMenuBase::IsEnabled( int id ) const
+bool wxMenuBase::IsEnabled( int itemid ) const
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_MSG( item, false, wxT("wxMenu::IsEnabled: no such item") );
 
     return item->IsEnabled();
 }
 
-void wxMenuBase::Check( int id, bool enable )
+void wxMenuBase::Check( int itemid, bool enable )
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_RET( item, wxT("wxMenu::Check: no such item") );
 
     item->Check(enable);
 }
 
-bool wxMenuBase::IsChecked( int id ) const
+bool wxMenuBase::IsChecked( int itemid ) const
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_MSG( item, false, wxT("wxMenu::IsChecked: no such item") );
 
     return item->IsChecked();
 }
 
-void wxMenuBase::SetLabel( int id, const wxString &label )
+void wxMenuBase::SetLabel( int itemid, const wxString &label )
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_RET( item, wxT("wxMenu::SetLabel: no such item") );
 
     item->SetItemLabel(label);
 }
 
-wxString wxMenuBase::GetLabel( int id ) const
+wxString wxMenuBase::GetLabel( int itemid ) const
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_MSG( item, wxEmptyString, wxT("wxMenu::GetLabel: no such item") );
 
     return item->GetItemLabel();
 }
 
-void wxMenuBase::SetHelpString( int id, const wxString& helpString )
+void wxMenuBase::SetHelpString( int itemid, const wxString& helpString )
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_RET( item, wxT("wxMenu::SetHelpString: no such item") );
 
     item->SetHelp( helpString );
 }
 
-wxString wxMenuBase::GetHelpString( int id ) const
+wxString wxMenuBase::GetHelpString( int itemid ) const
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_MSG( item, wxEmptyString, wxT("wxMenu::GetHelpString: no such item") );
 
@@ -719,7 +934,7 @@ void wxMenuBarBase::Detach()
 // wxMenuBar searching for items
 // ----------------------------------------------------------------------------
 
-wxMenuItem *wxMenuBarBase::FindItem(int id, wxMenu **menu) const
+wxMenuItem *wxMenuBarBase::FindItem(int itemid, wxMenu **menu) const
 {
     if ( menu )
         *menu = NULL;
@@ -729,7 +944,7 @@ wxMenuItem *wxMenuBarBase::FindItem(int id, wxMenu **menu) const
     wxMenuList::const_iterator it;
     for ( i = 0, it = m_menus.begin(); !item && (i < count); i++, it++ )
     {
-        item = (*it)->FindItem(id, menu);
+        item = (*it)->FindItem(itemid, menu);
     }
 
     return item;
@@ -754,18 +969,18 @@ int wxMenuBarBase::FindMenuItem(const wxString& menu, const wxString& item) cons
 // wxMenuBar functions forwarded to wxMenuItem
 // ---------------------------------------------------------------------------
 
-void wxMenuBarBase::Enable(int id, bool enable)
+void wxMenuBarBase::Enable(int itemid, bool enable)
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_RET( item, wxT("attempt to enable an item which doesn't exist") );
 
     item->Enable(enable);
 }
 
-void wxMenuBarBase::Check(int id, bool check)
+void wxMenuBarBase::Check(int itemid, bool check)
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_RET( item, wxT("attempt to check an item which doesn't exist") );
     wxCHECK_RET( item->IsCheckable(), wxT("attempt to check an uncheckable item") );
@@ -773,36 +988,36 @@ void wxMenuBarBase::Check(int id, bool check)
     item->Check(check);
 }
 
-bool wxMenuBarBase::IsChecked(int id) const
+bool wxMenuBarBase::IsChecked(int itemid) const
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_MSG( item, false, wxT("wxMenuBar::IsChecked(): no such item") );
 
     return item->IsChecked();
 }
 
-bool wxMenuBarBase::IsEnabled(int id) const
+bool wxMenuBarBase::IsEnabled(int itemid) const
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_MSG( item, false, wxT("wxMenuBar::IsEnabled(): no such item") );
 
     return item->IsEnabled();
 }
 
-void wxMenuBarBase::SetLabel(int id, const wxString& label)
+void wxMenuBarBase::SetLabel(int itemid, const wxString& label)
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_RET( item, wxT("wxMenuBar::SetLabel(): no such item") );
 
     item->SetItemLabel(label);
 }
 
-wxString wxMenuBarBase::GetLabel(int id) const
+wxString wxMenuBarBase::GetLabel(int itemid) const
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_MSG( item, wxEmptyString,
                  wxT("wxMenuBar::GetLabel(): no such item") );
@@ -810,18 +1025,18 @@ wxString wxMenuBarBase::GetLabel(int id) const
     return item->GetItemLabel();
 }
 
-void wxMenuBarBase::SetHelpString(int id, const wxString& helpString)
+void wxMenuBarBase::SetHelpString(int itemid, const wxString& helpString)
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_RET( item, wxT("wxMenuBar::SetHelpString(): no such item") );
 
     item->SetHelp(helpString);
 }
 
-wxString wxMenuBarBase::GetHelpString(int id) const
+wxString wxMenuBarBase::GetHelpString(int itemid) const
 {
-    wxMenuItem *item = FindItem(id);
+    wxMenuItem *item = FindItem(itemid);
 
     wxCHECK_MSG( item, wxEmptyString,
                  wxT("wxMenuBar::GetHelpString(): no such item") );