Doc tweaks

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

diff --git a/src/gtk1/menu.cpp b/src/gtk1/menu.cpp
index c8c37a1fcb2747b1aadd7ed3f5e7141c5b0495e0..7922dd438b03a2c416f4221e38aa74aa151a6ff3 100644 (file)
--- a/src/gtk1/menu.cpp
+++ b/src/gtk1/menu.cpp
@@ -15,11 +15,11 @@
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 

+#include "wx/menu.h"

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

-#include "wx/menu.h"

 
 #if wxUSE_ACCEL
     #include "wx/accel.h"
 
 #if wxUSE_ACCEL
     #include "wx/accel.h"


@@ -46,6 +46,9 @@
     #define ACCEL_OBJ_CAST(obj) GTK_OBJECT(obj)
 #endif
 
     #define ACCEL_OBJ_CAST(obj) GTK_OBJECT(obj)
 #endif
 

+// we use normal item but with a special id for the menu title
+static const int wxGTK_TITLE_ID = -3;
+

 //-----------------------------------------------------------------------------
 // idle system
 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------
 // idle system
 //-----------------------------------------------------------------------------


@@ -136,9 +139,9 @@ static wxString wxReplaceUnderscore( const wxString& title )
         }
         ++pc;
     }
         }
         ++pc;
     }

-    
+

     // wxPrintf( wxT("before %s after %s\n"), title.c_str(), str.c_str() );
     // wxPrintf( wxT("before %s after %s\n"), title.c_str(), str.c_str() );

-    
+

     return str;
 }
 
     return str;
 }
 


@@ -167,7 +170,7 @@ static void gtk_menu_open_callback( GtkWidget *widget, wxMenu *menu )
 
 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar,wxWindow)
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar,wxWindow)
 

-wxMenuBar::wxMenuBar( long style )
+void wxMenuBar::Init(size_t n, wxMenu *menus[], const wxString titles[], long style)

 {
     // the parent window is known after wxFrame::SetMenu()
     m_needParent = FALSE;
 {
     // the parent window is known after wxFrame::SetMenu()
     m_needParent = FALSE;


@@ -200,32 +203,24 @@ wxMenuBar::wxMenuBar( long style )
     PostCreation();
 
     ApplyWidgetStyle();
     PostCreation();
 
     ApplyWidgetStyle();

+
+    for (size_t i = 0; i < n; ++i )
+        Append(menus[i], titles[i]);

 }
 
 }
 

-wxMenuBar::wxMenuBar()
+wxMenuBar::wxMenuBar(size_t n, wxMenu *menus[], const wxString titles[], long style)

 {
 {

-    // the parent window is known after wxFrame::SetMenu()
-    m_needParent = FALSE;
-    m_style = 0;
-    m_invokingWindow = (wxWindow*) NULL;
-
-    if (!PreCreation( (wxWindow*) NULL, wxDefaultPosition, wxDefaultSize ) ||
-        !CreateBase( (wxWindow*) NULL, -1, wxDefaultPosition, wxDefaultSize, 0, wxDefaultValidator, wxT("menubar") ))
-    {
-        wxFAIL_MSG( wxT("wxMenuBar creation failed") );
-        return;
-    }
-
-    m_menubar = gtk_menu_bar_new();
-#ifndef __WXGTK20__
-    m_accel = gtk_accel_group_new();
-#endif
-
-    m_widget = GTK_WIDGET(m_menubar);
+    Init(n, menus, titles, style);
+}

 
 

-    PostCreation();
+wxMenuBar::wxMenuBar(long style)
+{
+    Init(0, NULL, NULL, style);
+}

 
 

-    ApplyWidgetStyle();
+wxMenuBar::wxMenuBar()
+{
+    Init(0, NULL, NULL, 0);

 }
 
 wxMenuBar::~wxMenuBar()
 }
 
 wxMenuBar::~wxMenuBar()


@@ -307,7 +302,7 @@ void wxMenuBar::UnsetInvokingWindow( wxWindow *win )
     wxWindow *top_frame = win;
     while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
         top_frame = top_frame->GetParent();
     wxWindow *top_frame = win;
     while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
         top_frame = top_frame->GetParent();

-        
+

 #ifndef __WXGTK20__
     // support for native key accelerators indicated by underscroes
     gtk_accel_group_detach( m_accel, ACCEL_OBJ_CAST(top_frame->m_widget) );
 #ifndef __WXGTK20__
     // support for native key accelerators indicated by underscroes
     gtk_accel_group_detach( m_accel, ACCEL_OBJ_CAST(top_frame->m_widget) );


@@ -359,14 +354,14 @@ bool wxMenuBar::GtkAppend(wxMenu *menu, const wxString& title, int pos)
 #endif
 
     gtk_widget_show( menu->m_owner );
 #endif
 
     gtk_widget_show( menu->m_owner );

-    
+

     gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
     gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );

-    
+

     if (pos == -1)
         gtk_menu_shell_append( GTK_MENU_SHELL(m_menubar), menu->m_owner );
     else
         gtk_menu_shell_insert( GTK_MENU_SHELL(m_menubar), menu->m_owner, pos );
     if (pos == -1)
         gtk_menu_shell_append( GTK_MENU_SHELL(m_menubar), menu->m_owner );
     else
         gtk_menu_shell_insert( GTK_MENU_SHELL(m_menubar), menu->m_owner, pos );

-    
+

     gtk_signal_connect( GTK_OBJECT(menu->m_owner), "activate",
                         GTK_SIGNAL_FUNC(gtk_menu_open_callback),
                         (gpointer)menu );
     gtk_signal_connect( GTK_OBJECT(menu->m_owner), "activate",
                         GTK_SIGNAL_FUNC(gtk_menu_open_callback),
                         (gpointer)menu );


@@ -398,7 +393,7 @@ bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
         return FALSE;
 
     // TODO
         return FALSE;
 
     // TODO

-    
+

     if ( !GtkAppend(menu, title, (int)pos) )
         return FALSE;
 
     if ( !GtkAppend(menu, title, (int)pos) )
         return FALSE;
 


@@ -418,53 +413,17 @@ wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
     return menuOld;
 }
 
     return menuOld;
 }
 

-static wxMenu *CopyMenu (wxMenu *menu)
-{
-    wxMenu *menucopy = new wxMenu ();
-    wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
-    while (node)
-    {
-        wxMenuItem *item = node->GetData();
-        int itemid = item->GetId();
-        wxString text = item->GetText();
-        text.Replace(wxT("_"), wxT("&"));
-        wxMenu *submenu = item->GetSubMenu();
-        if (!submenu)
-        {
-            wxMenuItem* itemcopy = new wxMenuItem(menucopy,
-                                        itemid, text,
-                                        menu->GetHelpString(itemid));
-            itemcopy->SetBitmap(item->GetBitmap());
-            itemcopy->SetCheckable(item->IsCheckable());
-            menucopy->Append(itemcopy);
-        }
-        else
-          menucopy->Append (itemid, text, CopyMenu(submenu),
-                            menu->GetHelpString(itemid));
-
-        node = node->GetNext();
-    }
-
-    return menucopy;
-}
-

 wxMenu *wxMenuBar::Remove(size_t pos)
 {
     wxMenu *menu = wxMenuBarBase::Remove(pos);
     if ( !menu )
         return (wxMenu*) NULL;
 
 wxMenu *wxMenuBar::Remove(size_t pos)
 {
     wxMenu *menu = wxMenuBarBase::Remove(pos);
     if ( !menu )
         return (wxMenu*) NULL;
 

-    wxMenu *menucopy = CopyMenu( menu );
-
-    // unparent calls unref() and that would delete the widget so we raise
-    // the ref count to 2 artificially before invoking unparent.
-    gtk_widget_ref( menu->m_menu );
-    gtk_widget_unparent( menu->m_menu );
+    gtk_menu_item_remove_submenu( GTK_MENU_ITEM(menu->m_owner) );
+    gtk_container_remove(GTK_CONTAINER(m_menubar), menu->m_owner);

 
     gtk_widget_destroy( menu->m_owner );
 
     gtk_widget_destroy( menu->m_owner );

-    delete menu;
-
-    menu = menucopy;
+    menu->m_owner = NULL;

 
     if (m_invokingWindow)
     {
 
     if (m_invokingWindow)
     {


@@ -639,6 +598,12 @@ static void gtk_menu_clicked_callback( GtkWidget *widget, wxMenu *menu )
     wxMenuItem* item = menu->FindChildItem( id );
     wxCHECK_RET( item, wxT("error in menu item callback") );
 
     wxMenuItem* item = menu->FindChildItem( id );
     wxCHECK_RET( item, wxT("error in menu item callback") );
 

+    if ( item->GetId() == wxGTK_TITLE_ID )
+    {
+        // ignore events from the menu title
+        return;
+    }
+

     if (item->IsCheckable())
     {
         bool isReallyChecked = item->IsChecked(),
     if (item->IsCheckable())
     {
         bool isReallyChecked = item->IsChecked(),


@@ -802,7 +767,7 @@ wxString wxMenuItemBase::GetLabelFromText(const wxString& text)
     {
         if ( *pc == wxT('\t'))
             break;
     {
         if ( *pc == wxT('\t'))
             break;

-    
+

         if ( *pc == wxT('_') )
         {
             // GTK 1.2 escapes "xxx_xxx" to "xxx__xxx"
         if ( *pc == wxT('_') )
         {
             // GTK 1.2 escapes "xxx_xxx" to "xxx__xxx"


@@ -891,7 +856,7 @@ void wxMenuItem::DoSetText( const wxString& str )
         {
             m_text << wxT("__");
         }
         {
             m_text << wxT("__");
         }

-        else 
+        else

         {
             m_text << *pc;
         }
         {
             m_text << *pc;
         }


@@ -977,25 +942,28 @@ void wxMenu::Init()
 {
     m_accel = gtk_accel_group_new();
     m_menu = gtk_menu_new();
 {
     m_accel = gtk_accel_group_new();
     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);

 
     m_owner = (GtkWidget*) NULL;
 
     // Tearoffs are entries, just like separators. So if we want this
     // menu to be a tear-off one, we just append a tearoff entry
     // immediately.
 
     m_owner = (GtkWidget*) NULL;
 
     // Tearoffs are entries, just like separators. So if we want this
     // menu to be a tear-off one, we just append a tearoff entry
     // immediately.

-    if(m_style & wxMENU_TEAROFF)
+    if ( m_style & wxMENU_TEAROFF )

     {
     {

-               GtkWidget *tearoff = gtk_tearoff_menu_item_new();
+        GtkWidget *tearoff = gtk_tearoff_menu_item_new();

 
 

-               gtk_menu_append(GTK_MENU(m_menu), tearoff);
-       }
+        gtk_menu_append(GTK_MENU(m_menu), tearoff);
+    }

 
 

-       m_prevRadio = NULL;
+    m_prevRadio = NULL;

 
     // append the title as the very first entry if we have it
 
     // append the title as the very first entry if we have it

-    if ( !!m_title )
+    if ( !m_title.empty() )

     {
     {

-        Append(-2, m_title);
+        Append(wxGTK_TITLE_ID, m_title);

         AppendSeparator();
     }
 }
         AppendSeparator();
     }
 }


@@ -1005,7 +973,14 @@ wxMenu::~wxMenu()
    WX_CLEAR_LIST(wxMenuItemList, m_items);
 
    if ( GTK_IS_WIDGET( m_menu ))
    WX_CLEAR_LIST(wxMenuItemList, m_items);
 
    if ( GTK_IS_WIDGET( m_menu ))

-       gtk_widget_destroy( m_menu );
+   {
+       // see wxMenu::Init
+       gtk_widget_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 );
+   }

 }
 
 bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
 }
 
 bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)


@@ -1055,7 +1030,7 @@ bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
             gtk_menu_shell_append(GTK_MENU_SHELL(m_menu), menuItem);
         else
             gtk_menu_shell_insert(GTK_MENU_SHELL(m_menu), menuItem, pos);
             gtk_menu_shell_append(GTK_MENU_SHELL(m_menu), menuItem);
         else
             gtk_menu_shell_insert(GTK_MENU_SHELL(m_menu), menuItem, pos);

- 
+

         gtk_widget_show( mitem->GetSubMenu()->m_menu );
 
         // if adding a submenu to a menu already existing in the menu bar, we
         gtk_widget_show( mitem->GetSubMenu()->m_menu );
 
         // if adding a submenu to a menu already existing in the menu bar, we


@@ -1070,17 +1045,28 @@ bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
     {
         wxString text = mitem->GetText();
         const wxBitmap *bitmap = &mitem->GetBitmap();
     {
         wxString text = mitem->GetText();
         const wxBitmap *bitmap = &mitem->GetBitmap();

-        GdkPixmap *gdk_pixmap = bitmap->GetPixmap();
-        GdkBitmap *gdk_bitmap = bitmap->GetMask() ? bitmap->GetMask()->GetBitmap() : (GdkBitmap*) NULL;
-        
+

 #ifdef __WXGTK20__
         menuItem = gtk_image_menu_item_new_with_mnemonic( wxGTK_CONV( text ) );
 #ifdef __WXGTK20__
         menuItem = gtk_image_menu_item_new_with_mnemonic( wxGTK_CONV( text ) );

+
+        GtkWidget *image;
+        if (bitmap->HasPixbuf())
+        {
+            image = gtk_image_new_from_pixbuf(bitmap->GetPixbuf());
+        }
+        else
+        {
+            GdkPixmap *gdk_pixmap = bitmap->GetPixmap();
+            GdkBitmap *gdk_bitmap = bitmap->GetMask() ? 
+                                        bitmap->GetMask()->GetBitmap() :
+                                        (GdkBitmap*) NULL;
+            image = gtk_image_new_from_pixmap( gdk_pixmap, gdk_bitmap );
+        }

         
         

-        GtkWidget *image = gtk_image_new_from_pixmap( gdk_pixmap, gdk_bitmap );

         gtk_widget_show(image);
         gtk_widget_show(image);

-        
+

         gtk_image_menu_item_set_image( GTK_IMAGE_MENU_ITEM(menuItem), image );
         gtk_image_menu_item_set_image( GTK_IMAGE_MENU_ITEM(menuItem), image );

-        
+

         gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
                             GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
                             (gpointer)this );
         gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
                             GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
                             (gpointer)this );


@@ -1090,6 +1076,8 @@ bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
         else
             gtk_menu_shell_insert(GTK_MENU_SHELL(m_menu), menuItem, pos);
 #else
         else
             gtk_menu_shell_insert(GTK_MENU_SHELL(m_menu), menuItem, pos);
 #else

+        GdkPixmap *gdk_pixmap = bitmap->GetPixmap();
+        GdkBitmap *gdk_bitmap = bitmap->GetMask() ? bitmap->GetMask()->GetBitmap() : (GdkBitmap*) NULL;

 
         menuItem = gtk_pixmap_menu_item_new ();
         GtkWidget *label = gtk_accel_label_new ( wxGTK_CONV( text ) );
 
         menuItem = gtk_pixmap_menu_item_new ();
         GtkWidget *label = gtk_accel_label_new ( wxGTK_CONV( text ) );


@@ -1270,24 +1258,24 @@ bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
         else
             gtk_menu_shell_insert(GTK_MENU_SHELL(m_menu), menuItem, pos);
     }
         else
             gtk_menu_shell_insert(GTK_MENU_SHELL(m_menu), menuItem, pos);
     }

-    
+

     guint accel_key;
     GdkModifierType accel_mods;
     wxCharBuffer buf = wxGTK_CONV( GetHotKey(*mitem) );
     guint accel_key;
     GdkModifierType accel_mods;
     wxCharBuffer buf = wxGTK_CONV( GetHotKey(*mitem) );

-    
-    // wxPrintf( wxT("item: %s hotkey %s\n"), mitem->GetText().c_str(), GetHotKey(*mitem).c_str() ); 
-    
+
+    // wxPrintf( wxT("item: %s hotkey %s\n"), mitem->GetText().c_str(), GetHotKey(*mitem).c_str() );
+

     gtk_accelerator_parse( (const char*) buf, &accel_key, &accel_mods);
     if (accel_key != 0)
     {
     gtk_accelerator_parse( (const char*) buf, &accel_key, &accel_mods);
     if (accel_key != 0)
     {

-        gtk_widget_add_accelerator (GTK_WIDGET(menuItem), 
-                                    "activate", 
+        gtk_widget_add_accelerator (GTK_WIDGET(menuItem),
+                                    "activate",

                                     m_accel,
                                     m_accel,

-                                    accel_key, 
+                                    accel_key,

                                     accel_mods,
                                     GTK_ACCEL_VISIBLE);
     }
                                     accel_mods,
                                     GTK_ACCEL_VISIBLE);
     }

- 
+

     gtk_widget_show( menuItem );
 
     if ( !mitem->IsSeparator() )
     gtk_widget_show( menuItem );
 
     if ( !mitem->IsSeparator() )


@@ -1318,7 +1306,7 @@ wxMenuItem* wxMenu::DoAppend(wxMenuItem *mitem)
 {
     if (!GtkAppend(mitem))
         return NULL;
 {
     if (!GtkAppend(mitem))
         return NULL;

-        
+

     return wxMenuBase::DoAppend(mitem);
 }
 
     return wxMenuBase::DoAppend(mitem);
 }
 


@@ -1396,7 +1384,7 @@ static wxString GetHotKey( const wxMenuItem& item )
             case WXK_F10:
             case WXK_F11:
             case WXK_F12:
             case WXK_F10:
             case WXK_F11:
             case WXK_F12:

-                hotkey << wxT('F') << code - WXK_F1 + 1;
+                hotkey += wxString::Format(wxT("F%d"), code - WXK_F1 + 1);

                 break;
 
                 // TODO: we should use gdk_keyval_name() (a.k.a.
                 break;
 
                 // TODO: we should use gdk_keyval_name() (a.k.a.