A little clarification

[wxWidgets.git] / src / gtk / menu.cpp

diff --git a/src/gtk/menu.cpp b/src/gtk/menu.cpp
index 88eb8cf728ff54b81fdd36b7fc54a5c16fe82885..edcbeb0d65c3506f8e685724cd62ab29c9d1d354 100644 (file)
--- a/src/gtk/menu.cpp
+++ b/src/gtk/menu.cpp
@@ -7,11 +7,14 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "menu.h"
-#pragma implementation "menuitem.h"
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+    #pragma implementation "menu.h"
+    #pragma implementation "menuitem.h"

 #endif
 
 #endif
 

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

 #include "wx/log.h"
 #include "wx/intl.h"
 #include "wx/app.h"
 #include "wx/log.h"
 #include "wx/intl.h"
 #include "wx/app.h"


@@ -169,7 +172,7 @@ static void gtk_menu_open_callback( GtkWidget *widget, wxMenu *menu )
 {
     if (g_isIdle) wxapp_install_idle_handler();
 
 {
     if (g_isIdle) wxapp_install_idle_handler();
 

-    wxMenuEvent event( wxEVT_MENU_OPEN, -1 );
+    wxMenuEvent event( wxEVT_MENU_OPEN, -1, menu );

     event.SetEventObject( menu );
 
     wxEvtHandler* handler = menu->GetEventHandler();
     event.SetEventObject( menu );
 
     wxEvtHandler* handler = menu->GetEventHandler();


@@ -200,8 +203,6 @@ wxMenuBar::wxMenuBar( long style )
         return;
     }
 
         return;
     }
 

-    m_menus.DeleteContents( TRUE );
-

     /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
 #if GTK_CHECK_VERSION(1, 2, 1)
     m_accel = gtk_accel_group_new();
     /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
 #if GTK_CHECK_VERSION(1, 2, 1)
     m_accel = gtk_accel_group_new();


@@ -241,8 +242,6 @@ wxMenuBar::wxMenuBar()
         return;
     }
 
         return;
     }
 

-    m_menus.DeleteContents( TRUE );
-

     /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
 #if GTK_CHECK_VERSION(1, 2, 1)
     m_accel = gtk_accel_group_new();
     /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
 #if GTK_CHECK_VERSION(1, 2, 1)
     m_accel = gtk_accel_group_new();


@@ -275,7 +274,7 @@ static void wxMenubarUnsetInvokingWindow( wxMenu *menu, wxWindow *win )
     /* support for native hot keys */
     gtk_accel_group_detach( menu->m_accel, ACCEL_OBJ_CAST(top_frame->m_widget) );
 
     /* support for native hot keys */
     gtk_accel_group_detach( menu->m_accel, ACCEL_OBJ_CAST(top_frame->m_widget) );
 

-    wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
+    wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();

     while (node)
     {
         wxMenuItem *menuitem = node->GetData();
     while (node)
     {
         wxMenuItem *menuitem = node->GetData();


@@ -300,7 +299,7 @@ static void wxMenubarSetInvokingWindow( wxMenu *menu, wxWindow *win )
         gtk_accel_group_attach( menu->m_accel, obj );
 #endif // GTK+ 1.2.1+
 
         gtk_accel_group_attach( menu->m_accel, obj );
 #endif // GTK+ 1.2.1+
 

-    wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
+    wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();

     while (node)
     {
         wxMenuItem *menuitem = node->GetData();
     while (node)
     {
         wxMenuItem *menuitem = node->GetData();


@@ -324,7 +323,7 @@ void wxMenuBar::SetInvokingWindow( wxWindow *win )
         gtk_accel_group_attach( m_accel, obj );
 #endif // GTK+ 1.2.1+
 
         gtk_accel_group_attach( m_accel, obj );
 #endif // GTK+ 1.2.1+
 

-    wxMenuList::Node *node = m_menus.GetFirst();
+    wxMenuList::compatibility_iterator node = m_menus.GetFirst();

     while (node)
     {
         wxMenu *menu = node->GetData();
     while (node)
     {
         wxMenu *menu = node->GetData();


@@ -345,7 +344,7 @@ void wxMenuBar::UnsetInvokingWindow( wxWindow *win )
     gtk_accel_group_detach( m_accel, ACCEL_OBJ_CAST(top_frame->m_widget) );
 #endif // GTK+ 1.2.1+
 
     gtk_accel_group_detach( m_accel, ACCEL_OBJ_CAST(top_frame->m_widget) );
 #endif // GTK+ 1.2.1+
 

-    wxMenuList::Node *node = m_menus.GetFirst();
+    wxMenuList::compatibility_iterator node = m_menus.GetFirst();

     while (node)
     {
         wxMenu *menu = node->GetData();
     while (node)
     {
         wxMenu *menu = node->GetData();


@@ -474,7 +473,7 @@ wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
 static wxMenu *CopyMenu (wxMenu *menu)
 {
     wxMenu *menucopy = new wxMenu ();
 static wxMenu *CopyMenu (wxMenu *menu)
 {
     wxMenu *menucopy = new wxMenu ();

-    wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
+    wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();

     while (node)
     {
         wxMenuItem *item = node->GetData();
     while (node)
     {
         wxMenuItem *item = node->GetData();


@@ -552,7 +551,7 @@ static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString
             return res;
     }
 
             return res;
     }
 

-    wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
+    wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();

     while (node)
     {
         wxMenuItem *item = node->GetData();
     while (node)
     {
         wxMenuItem *item = node->GetData();


@@ -567,7 +566,7 @@ static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString
 
 int wxMenuBar::FindMenuItem( const wxString &menuString, const wxString &itemString ) const
 {
 
 int wxMenuBar::FindMenuItem( const wxString &menuString, const wxString &itemString ) const
 {

-    wxMenuList::Node *node = m_menus.GetFirst();
+    wxMenuList::compatibility_iterator node = m_menus.GetFirst();

     while (node)
     {
         wxMenu *menu = node->GetData();
     while (node)
     {
         wxMenu *menu = node->GetData();


@@ -585,7 +584,7 @@ static wxMenuItem* FindMenuItemByIdRecursive(const wxMenu* menu, int id)
 {
     wxMenuItem* result = menu->FindChildItem(id);
 
 {
     wxMenuItem* result = menu->FindChildItem(id);
 

-    wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
+    wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();

     while ( node && result == NULL )
     {
         wxMenuItem *item = node->GetData();
     while ( node && result == NULL )
     {
         wxMenuItem *item = node->GetData();


@@ -602,7 +601,7 @@ static wxMenuItem* FindMenuItemByIdRecursive(const wxMenu* menu, int id)
 wxMenuItem* wxMenuBar::FindItem( int id, wxMenu **menuForItem ) const
 {
     wxMenuItem* result = 0;
 wxMenuItem* wxMenuBar::FindItem( int id, wxMenu **menuForItem ) const
 {
     wxMenuItem* result = 0;

-    wxMenuList::Node *node = m_menus.GetFirst();
+    wxMenuList::compatibility_iterator node = m_menus.GetFirst();

     while (node && result == 0)
     {
         wxMenu *menu = node->GetData();
     while (node && result == 0)
     {
         wxMenu *menu = node->GetData();


@@ -620,7 +619,7 @@ wxMenuItem* wxMenuBar::FindItem( int id, wxMenu **menuForItem ) const
 
 void wxMenuBar::EnableTop( size_t pos, bool flag )
 {
 
 void wxMenuBar::EnableTop( size_t pos, bool flag )
 {

-    wxMenuList::Node *node = m_menus.Item( pos );
+    wxMenuList::compatibility_iterator node = m_menus.Item( pos );

 
     wxCHECK_RET( node, wxT("menu not found") );
 
 
     wxCHECK_RET( node, wxT("menu not found") );
 


@@ -632,7 +631,7 @@ void wxMenuBar::EnableTop( size_t pos, bool flag )
 
 wxString wxMenuBar::GetLabelTop( size_t pos ) const
 {
 
 wxString wxMenuBar::GetLabelTop( size_t pos ) const
 {

-    wxMenuList::Node *node = m_menus.Item( pos );
+    wxMenuList::compatibility_iterator node = m_menus.Item( pos );

 
     wxCHECK_MSG( node, wxT("invalid"), wxT("menu not found") );
 
 
     wxCHECK_MSG( node, wxT("invalid"), wxT("menu not found") );
 


@@ -659,7 +658,7 @@ wxString wxMenuBar::GetLabelTop( size_t pos ) const
 
 void wxMenuBar::SetLabelTop( size_t pos, const wxString& label )
 {
 
 void wxMenuBar::SetLabelTop( size_t pos, const wxString& label )
 {

-    wxMenuList::Node *node = m_menus.Item( pos );
+    wxMenuList::compatibility_iterator node = m_menus.Item( pos );

 
     wxCHECK_RET( node, wxT("menu not found") );
 
 
     wxCHECK_RET( node, wxT("menu not found") );
 


@@ -701,6 +700,28 @@ static void gtk_menu_clicked_callback( GtkWidget *widget, wxMenu *menu )
     if (!menu->IsEnabled(id))
         return;
 
     if (!menu->IsEnabled(id))
         return;
 

+    wxMenuItem* item = menu->FindChildItem( id );
+    wxCHECK_RET( item, wxT("error in menu item callback") );
+
+    if (item->IsCheckable())
+    {
+        bool isReallyChecked = item->IsChecked(),
+            isInternallyChecked = item->wxMenuItemBase::IsChecked();
+
+        // ensure that the internal state is always consistent with what is
+        // shown on the screen
+        item->wxMenuItemBase::Check(isReallyChecked);
+
+        // we must not report the events for the radio button going up nor the
+        // events resulting from the calls to wxMenuItem::Check()
+        if ( (item->GetKind() == wxITEM_RADIO && !isReallyChecked) ||
+             (isInternallyChecked == isReallyChecked) )
+        {
+            return;
+        }
+    }
+
+

     // Is this menu on a menubar?  (possibly nested)
     wxFrame* frame = NULL;
     wxMenu*  pm = menu;
     // Is this menu on a menubar?  (possibly nested)
     wxFrame* frame = NULL;
     wxMenu*  pm = menu;


@@ -708,41 +729,29 @@ static void gtk_menu_clicked_callback( GtkWidget *widget, wxMenu *menu )
     {
         if ( pm->IsAttached() )
             frame = pm->GetMenuBar()->GetFrame();
     {
         if ( pm->IsAttached() )
             frame = pm->GetMenuBar()->GetFrame();

-        else
-            pm = pm->GetParent();
+        pm = pm->GetParent();

     }
 
     }
 

-    // If it is then let the frame send the event
+    // FIXME: why do we have to call wxFrame::GetEventHandler() directly here?
+    //        normally wxMenu::SendEvent() should be enough, if it doesn't work
+    //        in wxGTK then we have a bug in wxMenu::GetInvokingWindow() which
+    //        should be fixed instead of working around it here...

     if (frame)
     {
     if (frame)
     {

-        frame->ProcessCommand(id);
+        // If it is attached then let the frame send the event.
+        // Don't call frame->ProcessCommand(id) because it toggles
+        // checkable items and we've already done that above.
+        wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id);
+        commandEvent.SetEventObject(frame);
+        if (item->IsCheckable())
+            commandEvent.SetInt(item->IsChecked());
+        commandEvent.SetEventObject(menu);
+
+        frame->GetEventHandler()->ProcessEvent(commandEvent);

     }
     }

-    // otherwise let the menu have it

     else
     {
     else
     {

-        wxMenuItem* item = menu->FindChildItem( id );
-        wxCHECK_RET( item, wxT("error in menu item callback") );
-
-        if (item->IsCheckable())
-        {
-            bool isReallyChecked = item->IsChecked(),
-                isInternallyChecked = item->wxMenuItemBase::IsChecked();
-
-            // ensure that the internal state is always consistent with what is
-            // shown on the screen
-            item->wxMenuItemBase::Check(isReallyChecked);
-
-            // we must not report the events for the radio button going up nor the
-            // events resulting from the calls to wxMenuItem::Check()
-            if ( (item->GetKind() == wxITEM_RADIO && !isReallyChecked) ||
-                 (isInternallyChecked == isReallyChecked) )
-            {
-                return;
-            }
-
-            // the user pressed on the menu item: report the event below
-        }
-
+        // otherwise let the menu have it

         menu->SendEvent(id, item->IsCheckable() ? item->IsChecked() : -1);
     }
 }
         menu->SendEvent(id, item->IsCheckable() ? item->IsChecked() : -1);
     }
 }


@@ -1117,9 +1126,10 @@ void wxMenu::Init()
 
 wxMenu::~wxMenu()
 {
 
 wxMenu::~wxMenu()
 {

-   m_items.Clear();
+   WX_CLEAR_LIST(wxMenuItemList, m_items);

 
 

-   gtk_widget_destroy( m_menu );
+   if ( GTK_IS_WIDGET( m_menu ))
+       gtk_widget_destroy( m_menu );

 
    gtk_object_unref( GTK_OBJECT(m_factory) );
 }
 
    gtk_object_unref( GTK_OBJECT(m_factory) );
 }


@@ -1192,16 +1202,36 @@ bool wxMenu::GtkAppend(wxMenuItem *mitem)
         GtkWidget *label = gtk_accel_label_new ( wxGTK_CONV( text ) );
         gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
         gtk_container_add (GTK_CONTAINER (menuItem), label);
         GtkWidget *label = gtk_accel_label_new ( wxGTK_CONV( text ) );
         gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
         gtk_container_add (GTK_CONTAINER (menuItem), label);

-        guint accel_key = gtk_label_parse_uline (GTK_LABEL(label), wxGTK_CONV( text ) );

         gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (label), menuItem);
         gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (label), menuItem);

+        guint accel_key;
+        GdkModifierType accel_mods;
+
+        // accelerator for the item, as specified by its label
+        // (ex. Ctrl+O for open)
+        gtk_accelerator_parse(GetHotKey(*mitem).c_str(),
+                              &accel_key, &accel_mods);

         if (accel_key != GDK_VoidSymbol)
         {
             gtk_widget_add_accelerator (menuItem,
                                         "activate_item",
         if (accel_key != GDK_VoidSymbol)
         {
             gtk_widget_add_accelerator (menuItem,
                                         "activate_item",

-                                        gtk_menu_ensure_uline_accel_group (GTK_MENU (m_menu)),
+                                        gtk_menu_get_accel_group(
+                                            GTK_MENU(m_menu)),
+                                        accel_key, accel_mods,
+                                        GTK_ACCEL_VISIBLE);
+        }
+
+        // accelerator for the underlined char (ex ALT+F for the File menu)
+        accel_key = gtk_label_parse_uline (GTK_LABEL(label), wxGTK_CONV( text ) );
+        if (accel_key != GDK_VoidSymbol)
+        {
+            gtk_widget_add_accelerator (menuItem,
+                                        "activate_item",
+                                        gtk_menu_ensure_uline_accel_group (
+                                            GTK_MENU (m_menu)),

                                         accel_key, 0,
                                         GTK_ACCEL_LOCKED);
         }
                                         accel_key, 0,
                                         GTK_ACCEL_LOCKED);
         }

+

         gtk_widget_show (label);
 
         mitem->SetLabelWidget(label);
         gtk_widget_show (label);
 
         mitem->SetLabelWidget(label);


@@ -1215,6 +1245,7 @@ bool wxMenu::GtkAppend(wxMenuItem *mitem)
                             (gpointer)this );
 
         gtk_menu_append( GTK_MENU(m_menu), menuItem );
                             (gpointer)this );
 
         gtk_menu_append( GTK_MENU(m_menu), menuItem );

+

         gtk_widget_show( menuItem );
 
         appended = TRUE; // We've done this, don't do it again
         gtk_widget_show( menuItem );
 
         appended = TRUE; // We've done this, don't do it again


@@ -1371,7 +1402,7 @@ wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
 
 int wxMenu::FindMenuIdByMenuItem( GtkWidget *menuItem ) const
 {
 
 int wxMenu::FindMenuIdByMenuItem( GtkWidget *menuItem ) const
 {

-    wxMenuItemList::Node    *node = m_items.GetFirst();
+    wxMenuItemList::compatibility_iterator node = m_items.GetFirst();

     while (node)
     {
         wxMenuItem *item = node->GetData();
     while (node)
     {
         wxMenuItem *item = node->GetData();


@@ -1444,9 +1475,11 @@ static wxString GetHotKey( const wxMenuItem& item )
                 hotkey << wxT("Down" );
                 break;
             case WXK_PAGEUP:
                 hotkey << wxT("Down" );
                 break;
             case WXK_PAGEUP:

+            case WXK_PRIOR:

                 hotkey << wxT("Prior" );
                 break;
             case WXK_PAGEDOWN:
                 hotkey << wxT("Prior" );
                 break;
             case WXK_PAGEDOWN:

+            case WXK_NEXT:

                 hotkey << wxT("Next" );
                 break;
             case WXK_LEFT:
                 hotkey << wxT("Next" );
                 break;
             case WXK_LEFT: