]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk/menu.cpp
decouple item index from string value (patch 1905702)
[wxWidgets.git] / src / gtk / menu.cpp
index 533aa55cf6595ead68b09def1547ba870e622ee8..f7b037efd41a31da5f4850132b43872aa660e79b 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        src/gtk/menu.cpp
-// Purpose:
+// Purpose:     implementation of wxMenuBar and wxMenu classes for wxGTK
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
@@ -10,6 +10,8 @@
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
+#if wxUSE_MENUS
+
 #include "wx/menu.h"
 
 #ifndef WX_PRECOMP
 #include "wx/accel.h"
 #include "wx/stockitem.h"
 #include "wx/gtk/private.h"
-
-#ifdef __WXGTK20__
-#include <gdk/gdktypes.h>
-#endif
-
-// FIXME: is this right? somehow I don't think so (VZ)
-
-#define gtk_accel_group_attach(g, o) gtk_window_add_accel_group((o), (g))
-//#define gtk_accel_group_detach(g, o) gtk_window_remove_accel_group((o), (g))
-//#define gtk_menu_ensure_uline_accel_group(m) gtk_menu_get_accel_group(m)
-
-#define ACCEL_OBJECT        GtkWindow
-#define ACCEL_OBJECTS(a)    (a)->acceleratables
-#define ACCEL_OBJ_CAST(obj) ((GtkWindow*) obj)
+#include "wx/gtk/private/mnemonics.h"
 
 // we use normal item but with a special id for the menu title
 static const int wxGTK_TITLE_ID = -3;
 
-//-----------------------------------------------------------------------------
-// idle system
-//-----------------------------------------------------------------------------
+// forward declare it as it's used by wxMenuBar too when using Hildon
+extern "C"
+{
+    static void gtk_menu_clicked_callback(GtkWidget *widget, wxMenu *menu);
+}
 
 #if wxUSE_ACCEL
+static bool wxGetStockGtkAccelerator(const char *id, GdkModifierType *mod, guint *key);
 static wxString GetGtkHotKey( const wxMenuItem& item );
 #endif
 
-//-----------------------------------------------------------------------------
-// idle system
-//-----------------------------------------------------------------------------
-
-static wxString wxReplaceUnderscore( const wxString& title )
-{
-    const wxChar *pc;
-
-    // GTK 1.2 wants to have "_" instead of "&" for accelerators
-    wxString str;
-    pc = title;
-    while (*pc != wxT('\0'))
-    {
-        if ((*pc == wxT('&')) && (*(pc+1) == wxT('&')))
-        {
-            // "&" is doubled to indicate "&" instead of accelerator
-            ++pc;
-            str << wxT('&');
-        }
-        else if (*pc == wxT('&'))
-        {
-            str << wxT('_');
-        }
-        else
-        {
-            if ( *pc == wxT('_') )
-            {
-                // underscores must be doubled to prevent them from being
-                // interpreted as accelerator character prefix by GTK
-                str << *pc;
-            }
-
-            str << *pc;
-        }
-        ++pc;
-    }
-
-    // wxPrintf( wxT("before %s after %s\n"), title.c_str(), str.c_str() );
-
-    return str;
-}
-
 //-----------------------------------------------------------------------------
 // activate message from GTK
 //-----------------------------------------------------------------------------
@@ -100,24 +50,26 @@ static void DoCommonMenuCallbackCode(wxMenu *menu, wxMenuEvent& event)
     event.SetEventObject( menu );
 
     wxEvtHandler* handler = menu->GetEventHandler();
-    if (handler && handler->ProcessEvent(event))
+    if (handler && handler->SafelyProcessEvent(event))
         return;
 
     wxWindow *win = menu->GetInvokingWindow();
     if (win)
-        win->GetEventHandler()->ProcessEvent( event );
+        win->HandleWindowEvent( event );
 }
 
 extern "C" {
 
-static void gtk_menu_open_callback( GtkWidget *widget, wxMenu *menu )
+static void
+gtk_menu_open_callback(GtkWidget * WXUNUSED(widget), wxMenu *menu)
 {
     wxMenuEvent event(wxEVT_MENU_OPEN, -1, menu);
 
     DoCommonMenuCallbackCode(menu, event);
 }
 
-static void gtk_menu_close_callback( GtkWidget *widget, wxMenuBar *menubar )
+static void
+gtk_menu_close_callback(GtkWidget * WXUNUSED(widget), wxMenuBar *menubar)
 {
     if ( !menubar->GetMenuCount() )
     {
@@ -140,9 +92,14 @@ IMPLEMENT_DYNAMIC_CLASS(wxMenuBar,wxWindow)
 
 void wxMenuBar::Init(size_t n, wxMenu *menus[], const wxString titles[], long style)
 {
-    m_style = style;
     m_invokingWindow = NULL;
 
+#if wxUSE_LIBHILDON
+    // Hildon window uses a single menu instead of a menu bar, so wxMenuBar is
+    // the same as menu in this case
+    m_widget =
+    m_menubar = gtk_menu_new();
+#else // !wxUSE_LIBHILDON
     if (!PreCreation( NULL, wxDefaultPosition, wxDefaultSize ) ||
         !CreateBase( NULL, -1, wxDefaultPosition, wxDefaultSize, style, wxDefaultValidator, wxT("menubar") ))
     {
@@ -166,6 +123,7 @@ void wxMenuBar::Init(size_t n, wxMenu *menus[], const wxString titles[], long st
     PostCreation();
 
     ApplyWidgetStyle();
+#endif // wxUSE_LIBHILDON/!wxUSE_LIBHILDON
 
     for (size_t i = 0; i < n; ++i )
         Append(menus[i], titles[i]);
@@ -176,7 +134,6 @@ void wxMenuBar::Init(size_t n, wxMenu *menus[], const wxString titles[], long st
     //     can't pass the menu which was closed in wxMenuEvent object
     g_signal_connect (m_menubar, "deactivate",
                       G_CALLBACK (gtk_menu_close_callback), this);
-
 }
 
 wxMenuBar::wxMenuBar(size_t n, wxMenu *menus[], const wxString titles[], long style)
@@ -206,6 +163,10 @@ static void wxMenubarUnsetInvokingWindow( wxMenu *menu, wxWindow *win )
     while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
         top_frame = top_frame->GetParent();
 
+    // support for native hot keys
+    if (menu->m_accel && g_slist_find(menu->m_accel->acceleratables, top_frame->m_widget))
+        gtk_window_remove_accel_group(GTK_WINDOW(top_frame->m_widget), menu->m_accel);
+
     wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
     while (node)
     {
@@ -225,9 +186,8 @@ static void wxMenubarSetInvokingWindow( wxMenu *menu, wxWindow *win )
         top_frame = top_frame->GetParent();
 
     // support for native hot keys
-    ACCEL_OBJECT *obj = ACCEL_OBJ_CAST(top_frame->m_widget);
-    if ( !g_slist_find( ACCEL_OBJECTS(menu->m_accel), obj ) )
-        gtk_accel_group_attach( menu->m_accel, obj );
+    if (menu->m_accel && !g_slist_find(menu->m_accel->acceleratables, top_frame->m_widget))
+        gtk_window_add_accel_group(GTK_WINDOW(top_frame->m_widget), menu->m_accel);
 
     wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
     while (node)
@@ -325,18 +285,42 @@ bool wxMenuBar::Append( wxMenu *menu, const wxString &title )
 
 bool wxMenuBar::GtkAppend(wxMenu *menu, const wxString& title, int pos)
 {
-    wxString str( wxReplaceUnderscore( title ) );
+    menu->SetLayoutDirection(GetLayoutDirection());
 
-    // This doesn't have much effect right now.
-    menu->SetTitle( str );
+#if wxUSE_LIBHILDON
+    // if the menu has only one item, append it directly to the top level menu
+    // instead of inserting a useless submenu
+    if ( menu->GetMenuItemCount() == 1 )
+    {
+        wxMenuItem * const item = menu->FindItemByPosition(0);
 
-    // The "m_owner" is the "menu item"
-    menu->m_owner = gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str ) );
-    menu->SetLayoutDirection(GetLayoutDirection());
+        // remove both mnemonics and accelerator: neither is useful under Maemo
+        const wxString str(wxStripMenuCodes(item->GetItemLabel()));
 
-    gtk_widget_show( menu->m_owner );
+        if ( item->IsSubMenu() )
+            return GtkAppend(item->GetSubMenu(), str, pos);
+
+        menu->m_owner = gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str ) );
+
+        g_signal_connect(menu->m_owner, "activate",
+                          G_CALLBACK(gtk_menu_clicked_callback), menu);
+        item->SetMenuItem(menu->m_owner);
+    }
+    else
+#endif // wxUSE_LIBHILDON/!wxUSE_LIBHILDON
+    {
+        const wxString str(wxConvertMnemonicsToGTK(title));
+
+        // This doesn't have much effect right now.
+        menu->SetTitle( str );
 
-    gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
+        // The "m_owner" is the "menu item"
+        menu->m_owner = gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str ) );
+
+        gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
+    }
+
+    gtk_widget_show( menu->m_owner );
 
     if (pos == -1)
         gtk_menu_shell_append( GTK_MENU_SHELL(m_menubar), menu->m_owner );
@@ -350,21 +334,8 @@ bool wxMenuBar::GtkAppend(wxMenu *menu, const wxString& title, int pos)
     // m_invokingWindow is set after wxFrame::SetMenuBar(). This call enables
     // addings menu later on.
     if (m_invokingWindow)
-    {
         wxMenubarSetInvokingWindow( menu, m_invokingWindow );
 
-            // OPTIMISE ME:  we should probably cache this, or pass it
-            //               directly, but for now this is a minimal
-            //               change to validate the new dynamic sizing.
-            //               see (and refactor :) similar code in Remove
-            //               below.
-
-        wxFrame *frame = wxDynamicCast( m_invokingWindow, wxFrame );
-
-        if( frame )
-            frame->UpdateMenuBarSize();
-    }
-
     return true;
 }
 
@@ -400,27 +371,21 @@ wxMenu *wxMenuBar::Remove(size_t pos)
     if ( !menu )
         return (wxMenu*) NULL;
 
-    gtk_menu_item_remove_submenu( GTK_MENU_ITEM(menu->m_owner) );
+    gtk_menu_item_set_submenu(GTK_MENU_ITEM(menu->m_owner), NULL);
     gtk_container_remove(GTK_CONTAINER(m_menubar), menu->m_owner);
 
     gtk_widget_destroy( menu->m_owner );
     menu->m_owner = NULL;
 
     if (m_invokingWindow)
-    {
-        // OPTIMISE ME:  see comment in GtkAppend
-        wxFrame *frame = wxDynamicCast( m_invokingWindow, wxFrame );
-
-        if( frame )
-            frame->UpdateMenuBarSize();
-    }
+        wxMenubarUnsetInvokingWindow( menu, m_invokingWindow );
 
     return menu;
 }
 
 static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString, const wxString &itemString )
 {
-    if (wxMenuItem::GetLabelFromText(menu->GetTitle()) == wxMenuItem::GetLabelFromText(menuString))
+    if (wxMenuItem::GetLabelText(wxConvertMnemonicsFromGTK(menu->GetTitle())) == wxMenuItem::GetLabelText(menuString))
     {
         int res = menu->FindItem( itemString );
         if (res != wxNOT_FOUND)
@@ -505,7 +470,7 @@ void wxMenuBar::EnableTop( size_t pos, bool flag )
         gtk_widget_set_sensitive( menu->m_owner, flag );
 }
 
-wxString wxMenuBar::GetLabelTop( size_t pos ) const
+wxString wxMenuBar::GetMenuLabel( size_t pos ) const
 {
     wxMenuList::compatibility_iterator node = m_menus.Item( pos );
 
@@ -513,26 +478,10 @@ wxString wxMenuBar::GetLabelTop( size_t pos ) const
 
     wxMenu* menu = node->GetData();
 
-    wxString label;
-    wxString text( menu->GetTitle() );
-    for ( const wxChar *pc = text.c_str(); *pc; pc++ )
-    {
-        if ( *pc == wxT('_') )
-        {
-            // '_' is the escape character for GTK+
-            continue;
-        }
-
-        // don't remove ampersands '&' since if we have them in the menu title
-        // it means that they were doubled to indicate "&" instead of accelerator
-
-        label += *pc;
-    }
-
-    return label;
+    return wxConvertMnemonicsFromGTK(menu->GetTitle());
 }
 
-void wxMenuBar::SetLabelTop( size_t pos, const wxString& label )
+void wxMenuBar::SetMenuLabel( size_t pos, const wxString& label )
 {
     wxMenuList::compatibility_iterator node = m_menus.Item( pos );
 
@@ -540,7 +489,7 @@ void wxMenuBar::SetLabelTop( size_t pos, const wxString& label )
 
     wxMenu* menu = node->GetData();
 
-    const wxString str( wxReplaceUnderscore( label ) );
+    const wxString str(wxConvertMnemonicsToGTK(label));
 
     menu->SetTitle( str );
 
@@ -610,9 +559,8 @@ static void gtk_menu_clicked_callback( GtkWidget *widget, wxMenu *menu )
         commandEvent.SetEventObject(frame);
         if (item->IsCheckable())
             commandEvent.SetInt(item->IsChecked());
-        commandEvent.SetEventObject(menu);
 
-        frame->GetEventHandler()->ProcessEvent(commandEvent);
+        frame->HandleWindowEvent(commandEvent);
     }
     else
     {
@@ -640,11 +588,11 @@ static void gtk_menu_hilight_callback( GtkWidget *widget, wxMenu *menu )
     event.SetEventObject( menu );
 
     wxEvtHandler* handler = menu->GetEventHandler();
-    if (handler && handler->ProcessEvent(event))
+    if (handler && handler->SafelyProcessEvent(event))
         return;
 
     wxWindow *win = menu->GetInvokingWindow();
-    if (win) win->GetEventHandler()->ProcessEvent( event );
+    if (win) win->HandleWindowEvent( event );
 }
 }
 
@@ -666,12 +614,12 @@ static void gtk_menu_nolight_callback( GtkWidget *widget, wxMenu *menu )
     event.SetEventObject( menu );
 
     wxEvtHandler* handler = menu->GetEventHandler();
-    if (handler && handler->ProcessEvent(event))
+    if (handler && handler->SafelyProcessEvent(event))
         return;
 
     wxWindow *win = menu->GetInvokingWindow();
     if (win)
-        win->GetEventHandler()->ProcessEvent( event );
+        win->HandleWindowEvent( event );
 }
 }
 
@@ -729,8 +677,15 @@ wxMenuItem::~wxMenuItem()
 
 // return the menu item text without any menu accels
 /* static */
-wxString wxMenuItemBase::GetLabelFromText(const wxString& text)
+
+wxString wxMenuItemBase::GetLabelText(const wxString& text)
 {
+    // The argument to this function will now always be in wxWidgets standard label
+    // format, not GTK+ format, so we do what the other ports do.
+
+    return wxStripMenuCodes(text);
+
+#if 0
     wxString label;
 
     for ( const wxChar *pc = text.c_str(); *pc; pc++ )
@@ -764,12 +719,21 @@ wxString wxMenuItemBase::GetLabelFromText(const wxString& text)
         label += *pc;
     }
 
-    // wxPrintf( wxT("GetLabelFromText(): text %s label %s\n"), text.c_str(), label.c_str() );
+    // wxPrintf( wxT("GetLabelText(): text %s label %s\n"), text.c_str(), label.c_str() );
+
+    return label;
+#endif
+}
 
+wxString wxMenuItem::GetItemLabel() const
+{
+    wxString label = wxConvertMnemonicsFromGTK(m_text);
+    if (!m_hotKey.IsEmpty())
+        label << "\t" << m_hotKey;
     return label;
 }
 
-void wxMenuItem::SetText( const wxString& str )
+void wxMenuItem::SetItemLabel( const wxString& str )
 {
     // cache some data which must be used later
     bool isstock = wxIsStockID(GetId());
@@ -782,11 +746,14 @@ void wxMenuItem::SetText( const wxString& str )
     oldLabel = wxStripMenuCodes(oldLabel);
     oldLabel.Replace(wxT("_"), wxT(""));
     wxString label1 = wxStripMenuCodes(str);
+#if wxUSE_ACCEL
     wxString oldhotkey = GetHotKey();    // Store the old hotkey in Ctrl-foo format
     wxCharBuffer oldbuf = wxGTK_CONV_SYS( GetGtkHotKey(*this) );  // and as <control>foo
+#endif // wxUSE_ACCEL
 
     DoSetText(str);
 
+#if wxUSE_ACCEL
     if (oldLabel == label1 &&
         oldhotkey == GetHotKey())    // Make sure we can change a hotkey even if the label is unaltered
         return;
@@ -861,28 +828,33 @@ void wxMenuItem::SetText( const wxString& str )
                                            accel_key,
                                            accel_mods );
     }
+#endif // wxUSE_ACCEL
 }
 
 // NOTE: this function is different from the similar functions GTKProcessMnemonics()
-//       implemented in control.cpp and from wxMenuItemBase::GetLabelFromText...
+//       implemented in control.cpp and from wxMenuItemBase::GetLabelText...
 //       so there's no real code duplication
 wxString wxMenuItem::GTKProcessMenuItemLabel(const wxString& str, wxString *hotKey)
 {
     wxString text;
 
     // '\t' is the deliminator indicating a hot key
-    const wxChar *pc = str;
-    while ( (*pc != wxT('\0')) && (*pc != wxT('\t')) )
+    wxString::const_iterator pc = str.begin();
+    while ( pc != str.end() && *pc != wxT('\t') )
     {
-        if ((*pc == wxT('&')) && (*(pc+1) == wxT('&')))
-        {
-            // "&" is doubled to indicate "&" instead of accelerator
-            ++pc;
-            text << wxT('&');
-        }
-        else if (*pc == wxT('&'))
+        if (*pc == wxT('&'))
         {
-            text << wxT('_');
+            wxString::const_iterator next = pc + 1;
+            if (next != str.end() && *next == wxT('&'))
+            {
+                // "&" is doubled to indicate "&" instead of accelerator
+                ++pc;
+                text << wxT('&');
+            }
+            else
+            {
+                text << wxT('_');
+            }
         }
         else if ( *pc == wxT('_') )    // escape underscores
         {
@@ -901,7 +873,7 @@ wxString wxMenuItem::GTKProcessMenuItemLabel(const wxString& str, wxString *hotK
         if(*pc == wxT('\t'))
         {
             pc++;
-            *hotKey = pc;
+            hotKey->assign(pc, str.end());
         }
     }
 
@@ -986,7 +958,8 @@ void wxMenu::Init()
     m_menu = gtk_menu_new();
     // NB: keep reference to the menu so that it is not destroyed behind
     //     our back by GTK+ e.g. when it is removed from menubar:
-    gtk_widget_ref(m_menu);
+    g_object_ref(m_menu);
+    gtk_object_sink(GTK_OBJECT(m_menu));
 
     m_owner = (GtkWidget*) NULL;
 
@@ -1012,16 +985,17 @@ void wxMenu::Init()
 
 wxMenu::~wxMenu()
 {
-   WX_CLEAR_LIST(wxMenuItemList, m_items);
-
    if ( GTK_IS_WIDGET( m_menu ))
    {
        // see wxMenu::Init
-       gtk_widget_unref( m_menu );
+       g_object_unref(m_menu);
+
        // if the menu is inserted in another menu at this time, there was
        // one more reference to it:
        if ( m_owner )
            gtk_widget_destroy( m_menu );
+
+       g_object_unref(m_accel);
    }
 }
 
@@ -1042,7 +1016,7 @@ bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
     GtkWidget *menuItem;
 
     // cache some data used later
-    wxString text = mitem->GetText();
+    wxString text = mitem->wxMenuItemBase::GetItemLabel();
     int id = mitem->GetId();
     bool isstock = wxIsStockID(id);
     const char *stockid = NULL;
@@ -1062,6 +1036,7 @@ bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
     if ( mitem->IsSeparator() )
     {
         menuItem = gtk_separator_menu_item_new();
+        m_prevRadio = NULL;
     }
     else if ( mitem->GetBitmap().Ok() ||
                 (mitem->GetKind() == wxITEM_NORMAL && isstock) )
@@ -1108,7 +1083,7 @@ bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
     }
     else // a normal item
     {
-        // NB: 'text' variable has "_" instead of "&" after mitem->SetText()
+        // NB: 'text' variable has "_" instead of "&" after mitem->SetItemLabel()
         //     so don't use it
 
         switch ( mitem->GetKind() )
@@ -1152,11 +1127,11 @@ bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
 
     }
 
+#if wxUSE_ACCEL
     guint accel_key;
     GdkModifierType accel_mods;
     wxCharBuffer buf = wxGTK_CONV_SYS( GetGtkHotKey(*mitem) );
 
-    // wxPrintf( wxT("item: %s hotkey %s\n"), mitem->GetText().c_str(), GetGtkHotKey(*mitem).c_str() );
     if (buf[(size_t)0] != '\0')
     {
         gtk_accelerator_parse( (const char*) buf, &accel_key, &accel_mods);
@@ -1181,6 +1156,7 @@ bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
                                         accel_mods,
                                         GTK_ACCEL_VISIBLE);
     }
+#endif // wxUSE_ACCEL
 
     if (pos == -1)
         gtk_menu_shell_append(GTK_MENU_SHELL(m_menu), menuItem);
@@ -1252,11 +1228,19 @@ wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item)
 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
 {
     if ( !wxMenuBase::DoRemove(item) )
-        return (wxMenuItem *)NULL;
+        return NULL;
+
+    GtkWidget * const mitem = item->GetMenuItem();
+    if ( m_prevRadio == mitem )
+    {
+        // deleting an item starts a new radio group (has to as we shouldn't
+        // keep a deleted pointer anyhow)
+        m_prevRadio = NULL;
+    }
 
     // TODO: this code doesn't delete the item factory item and this seems
     //       impossible as of GTK 1.2.6.
-    gtk_widget_destroy( item->GetMenuItem() );
+    gtk_widget_destroy( mitem );
 
     return item;
 }
@@ -1668,8 +1652,6 @@ bool wxWindowGTK::DoPopupMenu( wxMenu *menu, int x, int y )
 
 #endif // wxUSE_MENUS_NATIVE
 
-#ifdef __WXGTK20__
-
 #include <gtk/gtk.h>
 
 const char *wxGetStockGtkID(wxWindowID id)
@@ -1768,6 +1750,8 @@ const char *wxGetStockGtkID(wxWindowID id)
     return NULL;
 }
 
+#if wxUSE_ACCEL
+static
 bool wxGetStockGtkAccelerator(const char *id, GdkModifierType *mod, guint *key)
 {
     if (!id)
@@ -1787,5 +1771,6 @@ bool wxGetStockGtkAccelerator(const char *id, GdkModifierType *mod, guint *key)
 
     return false;
 }
+#endif // wxUSE_ACCEL
 
-#endif // __WXGTK20__
+#endif // wxUSE_MENUS