src/gtk/menu.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        menu.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifdef __GNUG__
  11 #pragma implementation "menu.h"
  12 #pragma implementation "menuitem.h"
  13 #endif
  14
  15 #include "wx/log.h"
  16 #include "wx/intl.h"
  17 #include "wx/app.h"
  18 #include "wx/bitmap.h"
  19 #include "wx/menu.h"
  20
  21 #if wxUSE_ACCEL
  22     #include "wx/accel.h"
  23 #endif // wxUSE_ACCEL
  24
  25 #include "wx/gtk/private.h"
  26
  27 #include <gdk/gdkkeysyms.h>
  28
  29 // FIXME: is this right? somehow I don't think so (VZ)
  30 #ifdef __WXGTK20__
  31     #include <glib-object.h>
  32
  33     #define gtk_accel_group_attach(g, o) _gtk_accel_group_attach((g), (o))
  34     #define gtk_accel_group_detach(g, o) _gtk_accel_group_detach((g), (o))
  35     #define gtk_menu_ensure_uline_accel_group(m) gtk_menu_get_accel_group(m)
  36
  37     #define ACCEL_OBJECT        GObject
  38     #define ACCEL_OBJECTS(a)    (a)->acceleratables
  39     #define ACCEL_OBJ_CAST(obj) G_OBJECT(obj)
  40 #else // GTK+ 1.x
  41     #define ACCEL_OBJECT        GtkObject
  42     #define ACCEL_OBJECTS(a)    (a)->attach_objects
  43     #define ACCEL_OBJ_CAST(obj) GTK_OBJECT(obj)
  44 #endif
  45
  46 //-----------------------------------------------------------------------------
  47 // idle system
  48 //-----------------------------------------------------------------------------
  49
  50 extern void wxapp_install_idle_handler();
  51 extern bool g_isIdle;
  52
  53 #if GTK_CHECK_VERSION(1, 2, 0) && wxUSE_ACCEL
  54     static wxString GetHotKey( const wxMenuItem& item );
  55 #endif
  56
  57 //-----------------------------------------------------------------------------
  58 // substitute for missing GtkPixmapMenuItem
  59 //-----------------------------------------------------------------------------
  60
  61 // FIXME: I can't make this compile with GTK+ 2.0, disabling for now (VZ)
  62 #ifndef __WXGTK20__
  63     #define USE_MENU_BITMAPS
  64 #endif
  65
  66 #ifdef USE_MENU_BITMAPS
  67
  68 #define GTK_TYPE_PIXMAP_MENU_ITEM            (gtk_pixmap_menu_item_get_type ())
  69 #define GTK_PIXMAP_MENU_ITEM(obj)            (GTK_CHECK_CAST ((obj), GTK_TYPE_PIXMAP_MENU_ITEM, GtkPixmapMenuItem))
  70 #define GTK_PIXMAP_MENU_ITEM_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_PIXMAP_MENU_ITEM, GtkPixmapMenuItemClass))
  71 #define GTK_IS_PIXMAP_MENU_ITEM(obj)         (GTK_CHECK_TYPE ((obj), GTK_TYPE_PIXMAP_MENU_ITEM))
  72 #define GTK_IS_PIXMAP_MENU_ITEM_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PIXMAP_MENU_ITEM))
  73 //#define GTK_PIXMAP_MENU_ITEM_GET_CLASS(obj)  (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_PIXMAP_MENU_ITEM))
  74 #define GTK_PIXMAP_MENU_ITEM_GET_CLASS(obj)  (GTK_PIXMAP_MENU_ITEM_CLASS( GTK_OBJECT_GET_CLASS(obj)))
  75
  76 #ifndef GTK_MENU_ITEM_GET_CLASS
  77 #define GTK_MENU_ITEM_GET_CLASS(obj) (GTK_MENU_ITEM_CLASS( GTK_OBJECT_GET_CLASS(obj)))
  78 #endif
  79
  80 typedef struct _GtkPixmapMenuItem       GtkPixmapMenuItem;
  81 typedef struct _GtkPixmapMenuItemClass  GtkPixmapMenuItemClass;
  82
  83 struct _GtkPixmapMenuItem
  84 {
  85     GtkMenuItem menu_item;
  86
  87     GtkWidget *pixmap;
  88 };
  89
  90 struct _GtkPixmapMenuItemClass
  91 {
  92     GtkMenuItemClass parent_class;
  93
  94     guint orig_toggle_size;
  95     guint have_pixmap_count;
  96 };
  97
  98
  99 GtkType           gtk_pixmap_menu_item_get_type       (void);
 100 GtkWidget* gtk_pixmap_menu_item_new            (void);
 101 void       gtk_pixmap_menu_item_set_pixmap     (GtkPixmapMenuItem *menu_item,
 102                                                                     GtkWidget *pixmap);
 103
 104 #endif // USE_MENU_BITMAPS
 105
 106 //-----------------------------------------------------------------------------
 107 // idle system
 108 //-----------------------------------------------------------------------------
 109
 110 static wxString wxReplaceUnderscore( const wxString& title )
 111 {
 112     const wxChar *pc;
 113
 114     /* GTK 1.2 wants to have "_" instead of "&" for accelerators */
 115     wxString str;
 116     pc = title;
 117     while (*pc != wxT('\0'))
 118     {
 119         if ((*pc == wxT('&')) && (*(pc+1) == wxT('&')))
 120         {
 121             // "&" is doubled to indicate "&" instead of accelerator
 122             ++pc;
 123             str << wxT('&');
 124         }
 125         else if (*pc == wxT('&'))
 126         {
 127 #if GTK_CHECK_VERSION(1, 2, 0)
 128             str << wxT('_');
 129 #endif
 130         }
 131 #if GTK_CHECK_VERSION(2, 0, 0)
 132         else if (*pc == wxT('/'))
 133         {
 134             str << wxT("\\/");
 135         }
 136         else if (*pc == wxT('\\'))
 137         {
 138             str << wxT("\\\\");
 139         }
 140 #elif GTK_CHECK_VERSION(1, 2, 0)
 141         else if (*pc == wxT('/'))
 142         {
 143             str << wxT('\\');
 144         }
 145 #endif
 146         else
 147         {
 148 #ifdef __WXGTK12__
 149             if ( *pc == wxT('_') )
 150             {
 151                 // underscores must be doubled to prevent them from being
 152                 // interpreted as accelerator character prefix by GTK
 153                 str << *pc;
 154             }
 155 #endif // GTK+ 1.2
 156
 157             str << *pc;
 158         }
 159         ++pc;
 160     }
 161     return str;
 162 }
 163
 164 //-----------------------------------------------------------------------------
 165 // activate message from GTK
 166 //-----------------------------------------------------------------------------
 167
 168 static void gtk_menu_open_callback( GtkWidget *widget, wxMenu *menu )
 169 {
 170     if (g_isIdle) wxapp_install_idle_handler();
 171
 172     wxMenuEvent event( wxEVT_MENU_OPEN, -1 );
 173     event.SetEventObject( menu );
 174
 175     if (menu->GetEventHandler()->ProcessEvent(event))
 176         return;
 177
 178     wxWindow *win = menu->GetInvokingWindow();
 179     if (win) win->GetEventHandler()->ProcessEvent( event );
 180 }
 181
 182 //-----------------------------------------------------------------------------
 183 // wxMenuBar
 184 //-----------------------------------------------------------------------------
 185
 186 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar,wxWindow)
 187
 188 wxMenuBar::wxMenuBar( long style )
 189 {
 190     /* the parent window is known after wxFrame::SetMenu() */
 191     m_needParent = FALSE;
 192     m_style = style;
 193     m_invokingWindow = (wxWindow*) NULL;
 194
 195     if (!PreCreation( (wxWindow*) NULL, wxDefaultPosition, wxDefaultSize ) ||
 196         !CreateBase( (wxWindow*) NULL, -1, wxDefaultPosition, wxDefaultSize, style, wxDefaultValidator, wxT("menubar") ))
 197     {
 198         wxFAIL_MSG( wxT("wxMenuBar creation failed") );
 199         return;
 200     }
 201
 202     m_menus.DeleteContents( TRUE );
 203
 204     /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
 205 #if GTK_CHECK_VERSION(1, 2, 1)
 206     m_accel = gtk_accel_group_new();
 207     m_factory = gtk_item_factory_new( GTK_TYPE_MENU_BAR, "<main>", m_accel );
 208     m_menubar = gtk_item_factory_get_widget( m_factory, "<main>" );
 209 #else
 210     m_menubar = gtk_menu_bar_new();
 211 #endif
 212
 213     if (style & wxMB_DOCKABLE)
 214     {
 215         m_widget = gtk_handle_box_new();
 216         gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_menubar) );
 217         gtk_widget_show( GTK_WIDGET(m_menubar) );
 218     }
 219     else
 220     {
 221         m_widget = GTK_WIDGET(m_menubar);
 222     }
 223
 224     PostCreation();
 225
 226     ApplyWidgetStyle();
 227 }
 228
 229 wxMenuBar::wxMenuBar()
 230 {
 231     /* the parent window is known after wxFrame::SetMenu() */
 232     m_needParent = FALSE;
 233     m_style = 0;
 234     m_invokingWindow = (wxWindow*) NULL;
 235
 236     if (!PreCreation( (wxWindow*) NULL, wxDefaultPosition, wxDefaultSize ) ||
 237         !CreateBase( (wxWindow*) NULL, -1, wxDefaultPosition, wxDefaultSize, 0, wxDefaultValidator, wxT("menubar") ))
 238     {
 239         wxFAIL_MSG( wxT("wxMenuBar creation failed") );
 240         return;
 241     }
 242
 243     m_menus.DeleteContents( TRUE );
 244
 245     /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
 246 #if GTK_CHECK_VERSION(1, 2, 1)
 247     m_accel = gtk_accel_group_new();
 248     m_factory = gtk_item_factory_new( GTK_TYPE_MENU_BAR, "<main>", m_accel );
 249     m_menubar = gtk_item_factory_get_widget( m_factory, "<main>" );
 250 #else
 251     m_menubar = gtk_menu_bar_new();
 252 #endif
 253
 254     m_widget = GTK_WIDGET(m_menubar);
 255
 256     PostCreation();
 257
 258     ApplyWidgetStyle();
 259 }
 260
 261 wxMenuBar::~wxMenuBar()
 262 {
 263 //    gtk_object_unref( GTK_OBJECT(m_factory) );  why not ?
 264 }
 265
 266 static void wxMenubarUnsetInvokingWindow( wxMenu *menu, wxWindow *win )
 267 {
 268     menu->SetInvokingWindow( (wxWindow*) NULL );
 269
 270     wxWindow *top_frame = win;
 271     while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
 272         top_frame = top_frame->GetParent();
 273
 274     /* support for native hot keys */
 275     gtk_accel_group_detach( menu->m_accel, ACCEL_OBJ_CAST(top_frame->m_widget) );
 276
 277     wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
 278     while (node)
 279     {
 280         wxMenuItem *menuitem = node->GetData();
 281         if (menuitem->IsSubMenu())
 282             wxMenubarUnsetInvokingWindow( menuitem->GetSubMenu(), win );
 283         node = node->GetNext();
 284     }
 285 }
 286
 287 static void wxMenubarSetInvokingWindow( wxMenu *menu, wxWindow *win )
 288 {
 289     menu->SetInvokingWindow( win );
 290
 291 #if GTK_CHECK_VERSION(1, 2, 1)
 292     wxWindow *top_frame = win;
 293     while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
 294         top_frame = top_frame->GetParent();
 295
 296     /* support for native hot keys  */
 297     ACCEL_OBJECT *obj = ACCEL_OBJ_CAST(top_frame->m_widget);
 298     if ( !g_slist_find( ACCEL_OBJECTS(menu->m_accel), obj ) )
 299         gtk_accel_group_attach( menu->m_accel, obj );
 300 #endif // GTK+ 1.2.1+
 301
 302     wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
 303     while (node)
 304     {
 305         wxMenuItem *menuitem = node->GetData();
 306         if (menuitem->IsSubMenu())
 307             wxMenubarSetInvokingWindow( menuitem->GetSubMenu(), win );
 308         node = node->GetNext();
 309     }
 310 }
 311
 312 void wxMenuBar::SetInvokingWindow( wxWindow *win )
 313 {
 314     m_invokingWindow = win;
 315 #if GTK_CHECK_VERSION(1, 2, 1)
 316     wxWindow *top_frame = win;
 317     while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
 318         top_frame = top_frame->GetParent();
 319
 320     /* support for native key accelerators indicated by underscroes */
 321     ACCEL_OBJECT *obj = ACCEL_OBJ_CAST(top_frame->m_widget);
 322     if ( !g_slist_find( ACCEL_OBJECTS(m_accel), obj ) )
 323         gtk_accel_group_attach( m_accel, obj );
 324 #endif // GTK+ 1.2.1+
 325
 326     wxMenuList::Node *node = m_menus.GetFirst();
 327     while (node)
 328     {
 329         wxMenu *menu = node->GetData();
 330         wxMenubarSetInvokingWindow( menu, win );
 331         node = node->GetNext();
 332     }
 333 }
 334
 335 void wxMenuBar::UnsetInvokingWindow( wxWindow *win )
 336 {
 337     m_invokingWindow = (wxWindow*) NULL;
 338 #if GTK_CHECK_VERSION(1, 2, 1)
 339     wxWindow *top_frame = win;
 340     while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
 341         top_frame = top_frame->GetParent();
 342
 343     // support for native key accelerators indicated by underscroes
 344     gtk_accel_group_detach( m_accel, ACCEL_OBJ_CAST(top_frame->m_widget) );
 345 #endif // GTK+ 1.2.1+
 346
 347     wxMenuList::Node *node = m_menus.GetFirst();
 348     while (node)
 349     {
 350         wxMenu *menu = node->GetData();
 351         wxMenubarUnsetInvokingWindow( menu, win );
 352         node = node->GetNext();
 353     }
 354 }
 355
 356 bool wxMenuBar::Append( wxMenu *menu, const wxString &title )
 357 {
 358     if ( !wxMenuBarBase::Append( menu, title ) )
 359         return FALSE;
 360
 361     return GtkAppend(menu, title);
 362 }
 363
 364 bool wxMenuBar::GtkAppend(wxMenu *menu, const wxString& title)
 365 {
 366     wxString str( wxReplaceUnderscore( title ) );
 367
 368     // This doesn't have much effect right now.
 369     menu->SetTitle( str );
 370
 371     // GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has.
 372 #if GTK_CHECK_VERSION(1, 2, 1)
 373
 374     wxString buf;
 375     buf << wxT('/') << str.c_str();
 376
 377     // local buffer in multibyte form
 378     char cbuf[400];
 379     strcpy(cbuf, wxGTK_CONV(buf) );
 380
 381     GtkItemFactoryEntry entry;
 382     entry.path = (gchar *)cbuf;  // const_cast
 383     entry.accelerator = (gchar*) NULL;
 384     entry.callback = (GtkItemFactoryCallback) NULL;
 385     entry.callback_action = 0;
 386     entry.item_type = (char *)"<Branch>";
 387
 388     gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  // what is 2 ?
 389     // in order to get the pointer to the item we need the item text _without_ underscores
 390     wxString tmp = wxT("<main>/");
 391     const wxChar *pc;
 392     for ( pc = str; *pc != wxT('\0'); pc++ )
 393     {
 394        // contrary to the common sense, we must throw out _all_ underscores,
 395        // (i.e. "Hello__World" => "HelloWorld" and not "Hello_World" as we
 396        // might naively think). IMHO it's a bug in GTK+ (VZ)
 397        while (*pc == wxT('_'))
 398            pc++;
 399        tmp << *pc;
 400     }
 401     menu->m_owner = gtk_item_factory_get_item( m_factory, wxGTK_CONV( tmp ) );
 402     gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
 403 #else
 404
 405     menu->m_owner = gtk_menu_item_new_with_label( wxGTK_CONV( str ) );
 406     gtk_widget_show( menu->m_owner );
 407     gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
 408
 409     gtk_menu_bar_append( GTK_MENU_BAR(m_menubar), menu->m_owner );
 410
 411 #endif
 412
 413     gtk_signal_connect( GTK_OBJECT(menu->m_owner), "activate",
 414                         GTK_SIGNAL_FUNC(gtk_menu_open_callback),
 415                         (gpointer)menu );
 416
 417     // m_invokingWindow is set after wxFrame::SetMenuBar(). This call enables
 418     // addings menu later on.
 419     if (m_invokingWindow)
 420     {
 421         wxMenubarSetInvokingWindow( menu, m_invokingWindow );
 422
 423             // OPTIMISE ME:  we should probably cache this, or pass it
 424             //               directly, but for now this is a minimal
 425             //               change to validate the new dynamic sizing.
 426             //               see (and refactor :) similar code in Remove
 427             //               below.
 428
 429         wxFrame *frame = wxDynamicCast( m_invokingWindow, wxFrame );
 430
 431         if( frame )
 432             frame->UpdateMenuBarSize();
 433     }
 434
 435     return TRUE;
 436 }
 437
 438 bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
 439 {
 440     if ( !wxMenuBarBase::Insert(pos, menu, title) )
 441         return FALSE;
 442
 443     // GTK+ doesn't have a function to insert a menu using GtkItemFactory (as
 444     // of version 1.2.6), so we first append the item and then change its
 445     // index
 446     if ( !GtkAppend(menu, title) )
 447         return FALSE;
 448
 449     if (pos+1 >= m_menus.GetCount())
 450         return TRUE;
 451
 452     GtkMenuShell *menu_shell = GTK_MENU_SHELL(m_factory->widget);
 453     gpointer data = g_list_last(menu_shell->children)->data;
 454     menu_shell->children = g_list_remove(menu_shell->children, data);
 455     menu_shell->children = g_list_insert(menu_shell->children, data, pos);
 456
 457     return TRUE;
 458 }
 459
 460 wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
 461 {
 462     // remove the old item and insert a new one
 463     wxMenu *menuOld = Remove(pos);
 464     if ( menuOld && !Insert(pos, menu, title) )
 465     {
 466         return (wxMenu*) NULL;
 467     }
 468
 469     // either Insert() succeeded or Remove() failed and menuOld is NULL
 470     return menuOld;
 471 }
 472
 473 static wxMenu *CopyMenu (wxMenu *menu)
 474 {
 475     wxMenu *menucopy = new wxMenu ();
 476     wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
 477     while (node)
 478     {
 479         wxMenuItem *item = node->GetData();
 480         int itemid = item->GetId();
 481         wxString text = item->GetText();
 482         text.Replace(wxT("_"), wxT("&"));
 483         wxMenu *submenu = item->GetSubMenu();
 484         if (!submenu)
 485         {
 486             wxMenuItem* itemcopy = new wxMenuItem(menucopy,
 487                                         itemid, text,
 488                                         menu->GetHelpString(itemid));
 489             itemcopy->SetBitmap(item->GetBitmap());
 490             itemcopy->SetCheckable(item->IsCheckable());
 491             menucopy->Append(itemcopy);
 492         }
 493         else
 494           menucopy->Append (itemid, text, CopyMenu(submenu),
 495                             menu->GetHelpString(itemid));
 496
 497         node = node->GetNext();
 498     }
 499
 500     return menucopy;
 501 }
 502
 503 wxMenu *wxMenuBar::Remove(size_t pos)
 504 {
 505     wxMenu *menu = wxMenuBarBase::Remove(pos);
 506     if ( !menu )
 507         return (wxMenu*) NULL;
 508
 509 /*
 510     GtkMenuShell *menu_shell = GTK_MENU_SHELL(m_factory->widget);
 511
 512     printf( "factory entries before %d\n", (int)g_slist_length(m_factory->items) );
 513     printf( "menu shell entries before %d\n", (int)g_list_length( menu_shell->children ) );
 514 */
 515
 516     wxMenu *menucopy = CopyMenu( menu );
 517
 518     // unparent calls unref() and that would delete the widget so we raise
 519     // the ref count to 2 artificially before invoking unparent.
 520     gtk_widget_ref( menu->m_menu );
 521     gtk_widget_unparent( menu->m_menu );
 522
 523     gtk_widget_destroy( menu->m_owner );
 524     delete menu;
 525
 526     menu = menucopy;
 527 /*
 528     printf( "factory entries after %d\n", (int)g_slist_length(m_factory->items) );
 529     printf( "menu shell entries after %d\n", (int)g_list_length( menu_shell->children ) );
 530 */
 531
 532     if (m_invokingWindow)
 533     {
 534             // OPTIMISE ME:  see comment in GtkAppend
 535
 536     wxFrame *frame = wxDynamicCast( m_invokingWindow, wxFrame );
 537
 538     if( frame )
 539             frame->UpdateMenuBarSize();
 540     }
 541
 542     return menu;
 543 }
 544
 545 static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString, const wxString &itemString )
 546 {
 547     if (wxMenuItem::GetLabelFromText(menu->GetTitle()) == wxMenuItem::GetLabelFromText(menuString))
 548     {
 549         int res = menu->FindItem( itemString );
 550         if (res != wxNOT_FOUND)
 551             return res;
 552     }
 553
 554     wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
 555     while (node)
 556     {
 557         wxMenuItem *item = node->GetData();
 558         if (item->IsSubMenu())
 559             return FindMenuItemRecursive(item->GetSubMenu(), menuString, itemString);
 560
 561         node = node->GetNext();
 562     }
 563
 564     return wxNOT_FOUND;
 565 }
 566
 567 int wxMenuBar::FindMenuItem( const wxString &menuString, const wxString &itemString ) const
 568 {
 569     wxMenuList::Node *node = m_menus.GetFirst();
 570     while (node)
 571     {
 572         wxMenu *menu = node->GetData();
 573         int res = FindMenuItemRecursive( menu, menuString, itemString);
 574         if (res != -1)
 575             return res;
 576         node = node->GetNext();
 577     }
 578
 579     return wxNOT_FOUND;
 580 }
 581
 582 // Find a wxMenuItem using its id. Recurses down into sub-menus
 583 static wxMenuItem* FindMenuItemByIdRecursive(const wxMenu* menu, int id)
 584 {
 585     wxMenuItem* result = menu->FindChildItem(id);
 586
 587     wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
 588     while ( node && result == NULL )
 589     {
 590         wxMenuItem *item = node->GetData();
 591         if (item->IsSubMenu())
 592         {
 593             result = FindMenuItemByIdRecursive( item->GetSubMenu(), id );
 594         }
 595         node = node->GetNext();
 596     }
 597
 598     return result;
 599 }
 600
 601 wxMenuItem* wxMenuBar::FindItem( int id, wxMenu **menuForItem ) const
 602 {
 603     wxMenuItem* result = 0;
 604     wxMenuList::Node *node = m_menus.GetFirst();
 605     while (node && result == 0)
 606     {
 607         wxMenu *menu = node->GetData();
 608         result = FindMenuItemByIdRecursive( menu, id );
 609         node = node->GetNext();
 610     }
 611
 612     if ( menuForItem )
 613     {
 614         *menuForItem = result ? result->GetMenu() : (wxMenu *)NULL;
 615     }
 616
 617     return result;
 618 }
 619
 620 void wxMenuBar::EnableTop( size_t pos, bool flag )
 621 {
 622     wxMenuList::Node *node = m_menus.Item( pos );
 623
 624     wxCHECK_RET( node, wxT("menu not found") );
 625
 626     wxMenu* menu = node->GetData();
 627
 628     if (menu->m_owner)
 629         gtk_widget_set_sensitive( menu->m_owner, flag );
 630 }
 631
 632 wxString wxMenuBar::GetLabelTop( size_t pos ) const
 633 {
 634     wxMenuList::Node *node = m_menus.Item( pos );
 635
 636     wxCHECK_MSG( node, wxT("invalid"), wxT("menu not found") );
 637
 638     wxMenu* menu = node->GetData();
 639
 640     wxString label;
 641     wxString text( menu->GetTitle() );
 642     for ( const wxChar *pc = text.c_str(); *pc; pc++ )
 643     {
 644         if ( *pc == wxT('_') )
 645         {
 646             // '_' is the escape character for GTK+
 647             continue;
 648         }
 649
 650         // don't remove ampersands '&' since if we have them in the menu title
 651         // it means that they were doubled to indicate "&" instead of accelerator
 652
 653         label += *pc;
 654     }
 655
 656     return label;
 657 }
 658
 659 void wxMenuBar::SetLabelTop( size_t pos, const wxString& label )
 660 {
 661     wxMenuList::Node *node = m_menus.Item( pos );
 662
 663     wxCHECK_RET( node, wxT("menu not found") );
 664
 665     wxMenu* menu = node->GetData();
 666
 667     wxString str( wxReplaceUnderscore( label ) );
 668
 669     menu->SetTitle( str );
 670
 671     if (menu->m_owner)
 672     {
 673         GtkLabel *label = GTK_LABEL( GTK_BIN(menu->m_owner)->child );
 674
 675         /* set new text */
 676         gtk_label_set( label, wxGTK_CONV( str ) );
 677
 678         /* reparse key accel */
 679         (void)gtk_label_parse_uline (GTK_LABEL(label), wxGTK_CONV( str ) );
 680         gtk_accel_label_refetch( GTK_ACCEL_LABEL(label) );
 681     }
 682
 683 }
 684
 685 //-----------------------------------------------------------------------------
 686 // "activate"
 687 //-----------------------------------------------------------------------------
 688
 689 static void gtk_menu_clicked_callback( GtkWidget *widget, wxMenu *menu )
 690 {
 691     if (g_isIdle)
 692         wxapp_install_idle_handler();
 693
 694     int id = menu->FindMenuIdByMenuItem(widget);
 695
 696     /* should find it for normal (not popup) menu */
 697     wxASSERT_MSG( (id != -1) || (menu->GetInvokingWindow() != NULL),
 698                   _T("menu item not found in gtk_menu_clicked_callback") );
 699
 700     if (!menu->IsEnabled(id))
 701         return;
 702
 703     wxMenuItem* item = menu->FindChildItem( id );
 704     wxCHECK_RET( item, wxT("error in menu item callback") );
 705
 706     if (item->IsCheckable())
 707     {
 708         bool isReallyChecked = item->IsChecked(),
 709              isInternallyChecked = item->wxMenuItemBase::IsChecked();
 710
 711         // ensure that the internal state is always consistent with what is
 712         // shown on the screen
 713         item->wxMenuItemBase::Check(isReallyChecked);
 714
 715         // we must not report the events for the radio button going up nor the
 716         // events resulting from the calls to wxMenuItem::Check()
 717         if ( (item->GetKind() == wxITEM_RADIO && !isReallyChecked) ||
 718              (isInternallyChecked == isReallyChecked) )
 719         {
 720             return;
 721         }
 722
 723         // the user pressed on the menu item: report the event below
 724     }
 725
 726     menu->SendEvent(id, item->IsCheckable() ? item->IsChecked() : -1);
 727 }
 728
 729 //-----------------------------------------------------------------------------
 730 // "select"
 731 //-----------------------------------------------------------------------------
 732
 733 static void gtk_menu_hilight_callback( GtkWidget *widget, wxMenu *menu )
 734 {
 735     if (g_isIdle) wxapp_install_idle_handler();
 736
 737     int id = menu->FindMenuIdByMenuItem(widget);
 738
 739     wxASSERT( id != -1 ); // should find it!
 740
 741     if (!menu->IsEnabled(id))
 742         return;
 743
 744     wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, id );
 745     event.SetEventObject( menu );
 746
 747     if (menu->GetEventHandler()->ProcessEvent(event))
 748         return;
 749
 750     wxWindow *win = menu->GetInvokingWindow();
 751     if (win) win->GetEventHandler()->ProcessEvent( event );
 752 }
 753
 754 //-----------------------------------------------------------------------------
 755 // "deselect"
 756 //-----------------------------------------------------------------------------
 757
 758 static void gtk_menu_nolight_callback( GtkWidget *widget, wxMenu *menu )
 759 {
 760     if (g_isIdle) wxapp_install_idle_handler();
 761
 762     int id = menu->FindMenuIdByMenuItem(widget);
 763
 764     wxASSERT( id != -1 ); // should find it!
 765
 766     if (!menu->IsEnabled(id))
 767         return;
 768
 769     wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, -1 );
 770     event.SetEventObject( menu );
 771
 772     if (menu->GetEventHandler()->ProcessEvent(event))
 773         return;
 774
 775     wxWindow *win = menu->GetInvokingWindow();
 776     if (win)
 777         win->GetEventHandler()->ProcessEvent( event );
 778 }
 779
 780 //-----------------------------------------------------------------------------
 781 // wxMenuItem
 782 //-----------------------------------------------------------------------------
 783
 784 IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)
 785
 786 wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu,
 787                                 int id,
 788                                 const wxString& name,
 789                                 const wxString& help,
 790                                 wxItemKind kind,
 791                                 wxMenu *subMenu)
 792 {
 793     return new wxMenuItem(parentMenu, id, name, help, kind, subMenu);
 794 }
 795
 796 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
 797                        int id,
 798                        const wxString& text,
 799                        const wxString& help,
 800                        wxItemKind kind,
 801                        wxMenu *subMenu)
 802           : wxMenuItemBase(parentMenu, id, text, help, kind, subMenu)
 803 {
 804     Init(text);
 805 }
 806
 807 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
 808                        int id,
 809                        const wxString& text,
 810                        const wxString& help,
 811                        bool isCheckable,
 812                        wxMenu *subMenu)
 813           : wxMenuItemBase(parentMenu, id, text, help,
 814                            isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu)
 815 {
 816     Init(text);
 817 }
 818
 819 void wxMenuItem::Init(const wxString& text)
 820 {
 821     m_labelWidget = (GtkWidget *) NULL;
 822     m_menuItem = (GtkWidget *) NULL;
 823
 824     DoSetText(text);
 825 }
 826
 827 wxMenuItem::~wxMenuItem()
 828 {
 829    // don't delete menu items, the menus take care of that
 830 }
 831
 832 // return the menu item text without any menu accels
 833 /* static */
 834 wxString wxMenuItemBase::GetLabelFromText(const wxString& text)
 835 {
 836     wxString label;
 837
 838     for ( const wxChar *pc = text.c_str(); *pc; pc++ )
 839     {
 840         if ( *pc == wxT('_') )
 841         {
 842             // GTK 1.2 escapes "xxx_xxx" to "xxx__xxx"
 843             pc++;
 844             label += *pc;
 845             continue;
 846         }
 847
 848 #if GTK_CHECK_VERSION(2, 0, 0)
 849         if ( *pc == wxT('\\')  )
 850         {
 851             // GTK 2.0 escapes "xxx/xxx" to "xxx\/xxx"
 852             pc++;
 853             label += *pc;
 854             continue;
 855         }
 856 #endif
 857
 858         if ( (*pc == wxT('&')) && (*(pc+1) != wxT('&')) )
 859         {
 860             // wxMSW escapes "&"
 861             // "&" is doubled to indicate "&" instead of accelerator
 862             continue;
 863         }
 864
 865         label += *pc;
 866     }
 867
 868     // wxPrintf( L"text %s label %s\n", text.c_str(), label.c_str() );
 869
 870     return label;
 871 }
 872
 873 void wxMenuItem::SetText( const wxString& str )
 874 {
 875     // Some optimization to avoid flicker
 876     wxString oldLabel = m_text;
 877     oldLabel = wxStripMenuCodes(oldLabel.BeforeFirst('\t'));
 878     oldLabel.Replace(wxT("_"), wxT(""));
 879     wxString label1 = wxStripMenuCodes(str.BeforeFirst('\t'));
 880     if (oldLabel == label1)
 881         return;
 882
 883     DoSetText(str);
 884
 885     if (m_menuItem)
 886     {
 887         GtkLabel *label;
 888         if (m_labelWidget)
 889             label = (GtkLabel*) m_labelWidget;
 890         else
 891             label = GTK_LABEL( GTK_BIN(m_menuItem)->child );
 892
 893 #if GTK_CHECK_VERSION(2, 0, 0)
 894         // We have to imitate item_factory_unescape_label here
 895         wxString tmp;
 896         for (size_t n = 0; n < m_text.Len(); n++)
 897         {
 898             if (m_text[n] != wxT('\\'))
 899                 tmp += m_text[n];
 900         }
 901
 902         gtk_label_set_text_with_mnemonic( GTK_LABEL(label), wxGTK_CONV(tmp) );
 903 #else
 904         // set new text
 905         gtk_label_set( label, wxGTK_CONV( m_text ) );
 906
 907         // reparse key accel
 908         (void)gtk_label_parse_uline (GTK_LABEL(label), wxGTK_CONV(m_text) );
 909         gtk_accel_label_refetch( GTK_ACCEL_LABEL(label) );
 910 #endif
 911     }
 912 }
 913
 914 // it's valid for this function to be called even if m_menuItem == NULL
 915 void wxMenuItem::DoSetText( const wxString& str )
 916 {
 917     // '\t' is the deliminator indicating a hot key
 918     m_text.Empty();
 919     const wxChar *pc = str;
 920     while ( (*pc != wxT('\0')) && (*pc != wxT('\t')) )
 921     {
 922         if ((*pc == wxT('&')) && (*(pc+1) == wxT('&')))
 923         {
 924             // "&" is doubled to indicate "&" instead of accelerator
 925             ++pc;
 926             m_text << wxT('&');
 927         }
 928         else if (*pc == wxT('&'))
 929         {
 930             m_text << wxT('_');
 931         }
 932 #if GTK_CHECK_VERSION(2, 0, 0)
 933         else if ( *pc == wxT('_') )    // escape underscores
 934         {
 935             // m_text << wxT("__");    doesn't work
 936             m_text << wxT("__");
 937         }
 938         else if (*pc == wxT('/'))      // we have to escape slashes
 939         {
 940             m_text << wxT("\\/");
 941         }
 942         else if (*pc == wxT('\\'))     // we have to double backslashes
 943         {
 944             m_text << wxT("\\\\");
 945         }
 946 #else
 947         else if ( *pc == wxT('_') )    // escape underscores
 948         {
 949             m_text << wxT("__");
 950         }
 951         else if (*pc == wxT('/'))      /* we have to filter out slashes ... */
 952         {
 953             m_text << wxT('\\');  /* ... and replace them with back slashes */
 954         }
 955 #endif
 956         else {
 957             m_text << *pc;
 958         }
 959         ++pc;
 960     }
 961
 962     // wxPrintf( L"str %s m_text %s\n", str.c_str(), m_text.c_str() );
 963
 964     m_hotKey = wxT("");
 965
 966     if(*pc == wxT('\t'))
 967     {
 968        pc++;
 969        m_hotKey = pc;
 970     }
 971 }
 972
 973 #if wxUSE_ACCEL
 974
 975 wxAcceleratorEntry *wxMenuItem::GetAccel() const
 976 {
 977     if ( !GetHotKey() )
 978     {
 979         // nothing
 980         return (wxAcceleratorEntry *)NULL;
 981     }
 982
 983     // as wxGetAccelFromString() looks for TAB, insert a dummy one here
 984     wxString label;
 985     label << wxT('\t') << GetHotKey();
 986
 987     return wxGetAccelFromString(label);
 988 }
 989
 990 #endif // wxUSE_ACCEL
 991
 992 void wxMenuItem::Check( bool check )
 993 {
 994     wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
 995
 996     if (check == m_isChecked)
 997         return;
 998
 999     wxMenuItemBase::Check( check );
1000
1001     switch ( GetKind() )
1002     {
1003         case wxITEM_CHECK:
1004         case wxITEM_RADIO:
1005             gtk_check_menu_item_set_state( (GtkCheckMenuItem*)m_menuItem, (gint)check );
1006             break;
1007
1008         default:
1009             wxFAIL_MSG( _T("can't check this item") );
1010     }
1011 }
1012
1013 void wxMenuItem::Enable( bool enable )
1014 {
1015     wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
1016
1017     gtk_widget_set_sensitive( m_menuItem, enable );
1018     wxMenuItemBase::Enable( enable );
1019 }
1020
1021 bool wxMenuItem::IsChecked() const
1022 {
1023     wxCHECK_MSG( m_menuItem, FALSE, wxT("invalid menu item") );
1024
1025     wxCHECK_MSG( IsCheckable(), FALSE,
1026                  wxT("can't get state of uncheckable item!") );
1027
1028     return ((GtkCheckMenuItem*)m_menuItem)->active != 0;
1029 }
1030
1031 wxString wxMenuItem::GetFactoryPath() const
1032 {
1033     // In order to get the pointer to the item we need the item
1034     // text _without_ underscores in GTK 1.2
1035     wxString path( wxT("<main>/") );
1036
1037     for ( const wxChar *pc = m_text.c_str(); *pc; pc++ )
1038     {
1039         if ( *pc == wxT('_') )
1040         {
1041 #ifdef __WXGTK20__
1042             pc++;
1043 #else
1044             // remove '_' unconditionally
1045             continue;
1046 #endif
1047         }
1048
1049         // don't remove ampersands '&' since if we have them in the menu item title
1050         // it means that they were doubled to indicate "&" instead of accelerator
1051
1052         path += *pc;
1053     }
1054
1055     return path;
1056 }
1057
1058 //-----------------------------------------------------------------------------
1059 // wxMenu
1060 //-----------------------------------------------------------------------------
1061
1062 IMPLEMENT_DYNAMIC_CLASS(wxMenu,wxEvtHandler)
1063
1064 void wxMenu::Init()
1065 {
1066     m_accel = gtk_accel_group_new();
1067     m_factory = gtk_item_factory_new( GTK_TYPE_MENU, "<main>", m_accel );
1068     m_menu = gtk_item_factory_get_widget( m_factory, "<main>" );
1069
1070     m_owner = (GtkWidget*) NULL;
1071
1072     // Tearoffs are entries, just like separators. So if we want this
1073     // menu to be a tear-off one, we just append a tearoff entry
1074     // immediately.
1075     if(m_style & wxMENU_TEAROFF)
1076     {
1077        GtkItemFactoryEntry entry;
1078        entry.path = (char *)"/tearoff";
1079        entry.callback = (GtkItemFactoryCallback) NULL;
1080        entry.callback_action = 0;
1081        entry.item_type = (char *)"<Tearoff>";
1082        entry.accelerator = (gchar*) NULL;
1083        gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  // what is 2 ?
1084        //GtkWidget *menuItem = gtk_item_factory_get_widget( m_factory, "<main>/tearoff" );
1085     }
1086
1087     // append the title as the very first entry if we have it
1088     if ( !!m_title )
1089     {
1090         Append(-2, m_title);
1091         AppendSeparator();
1092     }
1093 }
1094
1095 wxMenu::~wxMenu()
1096 {
1097    m_items.Clear();
1098
1099    gtk_widget_destroy( m_menu );
1100
1101    gtk_object_unref( GTK_OBJECT(m_factory) );
1102 }
1103
1104 bool wxMenu::GtkAppend(wxMenuItem *mitem)
1105 {
1106     GtkWidget *menuItem;
1107
1108 #if defined(USE_MENU_BITMAPS) || !GTK_CHECK_VERSION(1, 2, 0)
1109     bool appended = FALSE;
1110 #endif
1111
1112     // does this item terminate the current radio group?
1113     bool endOfRadioGroup = TRUE;
1114
1115     if ( mitem->IsSeparator() )
1116     {
1117         GtkItemFactoryEntry entry;
1118         entry.path = (char *)"/sep";
1119         entry.callback = (GtkItemFactoryCallback) NULL;
1120         entry.callback_action = 0;
1121         entry.item_type = (char *)"<Separator>";
1122         entry.accelerator = (gchar*) NULL;
1123
1124         gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  // what is 2 ?
1125
1126         // this will be wrong for more than one separator. do we care?
1127         menuItem = gtk_item_factory_get_widget( m_factory, "<main>/sep" );
1128
1129         // we might have a separator inside a radio group
1130         endOfRadioGroup = FALSE;
1131     }
1132     else if ( mitem->IsSubMenu() )
1133     {
1134         // text has "_" instead of "&" after mitem->SetText()
1135         wxString text( mitem->GetText() );
1136
1137         // local buffer in multibyte form
1138         char buf[200];
1139         strcpy( buf, "/" );
1140         strcat( buf, wxGTK_CONV( text ) );
1141
1142         GtkItemFactoryEntry entry;
1143         entry.path = buf;
1144         entry.callback = (GtkItemFactoryCallback) 0;
1145         entry.callback_action = 0;
1146         entry.item_type = (char *)"<Branch>";
1147         entry.accelerator = (gchar*) NULL;
1148
1149         gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  // what is 2 ?
1150
1151         wxString path( mitem->GetFactoryPath() );
1152         menuItem = gtk_item_factory_get_item( m_factory, wxGTK_CONV( path ) );
1153
1154         gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem), mitem->GetSubMenu()->m_menu );
1155
1156         // if adding a submenu to a menu already existing in the menu bar, we
1157         // must set invoking window to allow processing events from this
1158         // submenu
1159         if ( m_invokingWindow )
1160             wxMenubarSetInvokingWindow(mitem->GetSubMenu(), m_invokingWindow);
1161     }
1162 #ifdef USE_MENU_BITMAPS
1163     else if (mitem->GetBitmap().Ok()) // An item with bitmap
1164     {
1165         wxString text( mitem->GetText() );
1166         const wxBitmap *bitmap = &mitem->GetBitmap();
1167
1168         menuItem = gtk_pixmap_menu_item_new ();
1169         GtkWidget *label = gtk_accel_label_new ( wxGTK_CONV( text ) );
1170         gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
1171         gtk_container_add (GTK_CONTAINER (menuItem), label);
1172         guint accel_key = gtk_label_parse_uline (GTK_LABEL(label), wxGTK_CONV( text ) );
1173         gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (label), menuItem);
1174         if (accel_key != GDK_VoidSymbol)
1175         {
1176             gtk_widget_add_accelerator (menuItem,
1177                                         "activate_item",
1178                                         gtk_menu_ensure_uline_accel_group (GTK_MENU (m_menu)),
1179                                         accel_key, 0,
1180                                         GTK_ACCEL_LOCKED);
1181         }
1182         gtk_widget_show (label);
1183
1184         mitem->SetLabelWidget(label);
1185
1186         GtkWidget* pixmap = gtk_pixmap_new( bitmap->GetPixmap(), bitmap->GetMask() ? bitmap->GetMask()->GetBitmap() : (GdkBitmap* )NULL);
1187         gtk_widget_show(pixmap);
1188         gtk_pixmap_menu_item_set_pixmap(GTK_PIXMAP_MENU_ITEM( menuItem ), pixmap);
1189
1190         gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
1191                             GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
1192                             (gpointer)this );
1193
1194         gtk_menu_append( GTK_MENU(m_menu), menuItem );
1195         gtk_widget_show( menuItem );
1196
1197         appended = TRUE; // We've done this, don't do it again
1198     }
1199 #endif // USE_MENU_BITMAPS
1200     else // a normal item
1201     {
1202         // text has "_" instead of "&" after mitem->SetText() so don't use it
1203         wxString text( mitem->GetText() );
1204
1205         // buffers containing the menu item path and type in multibyte form
1206         char bufPath[256],
1207              bufType[256];
1208
1209         strcpy( bufPath, "/" );
1210         strncat( bufPath, wxGTK_CONV(text), WXSIZEOF(bufPath) - 2 );
1211         bufPath[WXSIZEOF(bufPath) - 1] = '\0';
1212
1213         GtkItemFactoryEntry entry;
1214         entry.path = bufPath;
1215         entry.callback = (GtkItemFactoryCallback) gtk_menu_clicked_callback;
1216         entry.callback_action = 0;
1217
1218         wxString pathRadio;
1219         const char *item_type;
1220         switch ( mitem->GetKind() )
1221         {
1222             case wxITEM_CHECK:
1223                 item_type = "<CheckItem>";
1224                 break;
1225
1226             case wxITEM_RADIO:
1227                 if ( m_pathLastRadio.empty() )
1228                 {
1229                     // start of a new radio group
1230                     item_type = "<RadioItem>";
1231                     wxString tmp( wxGTK_CONV_BACK( bufPath ) );
1232                     tmp.Remove(0,1);
1233                     m_pathLastRadio = tmp;
1234                 }
1235                 else // continue the radio group
1236                 {
1237                     pathRadio = m_pathLastRadio;
1238                     pathRadio.Replace(wxT("_"), wxT(""));
1239                     pathRadio.Prepend(wxT("<main>/"));
1240
1241                     strncpy(bufType, wxGTK_CONV(pathRadio), WXSIZEOF(bufType));
1242                     bufType[WXSIZEOF(bufType) - 1] = '\0';
1243                     item_type = bufType;
1244                 }
1245
1246                 // continue the existing radio group, if any
1247                 endOfRadioGroup = FALSE;
1248                 break;
1249
1250             default:
1251                 wxFAIL_MSG( _T("unexpected menu item kind") );
1252                 // fall through
1253
1254             case wxITEM_NORMAL:
1255                 item_type = "<Item>";
1256                 break;
1257         }
1258
1259         entry.item_type = (char *)item_type; // cast needed for GTK+
1260         entry.accelerator = (gchar*) NULL;
1261
1262 #if wxUSE_ACCEL
1263         // due to an apparent bug in GTK+, we have to use a static buffer here -
1264         // otherwise GTK+ 1.2.2 manages to override the memory we pass to it
1265         // somehow! (VZ)
1266         char s_accel[50]; // should be big enough, we check for overruns
1267         wxString tmp( GetHotKey(*mitem) );
1268         strncpy(s_accel, wxGTK_CONV( tmp ), WXSIZEOF(s_accel));
1269         s_accel[WXSIZEOF(s_accel) - 1] = '\0';
1270         entry.accelerator = s_accel;
1271 #else // !wxUSE_ACCEL
1272         entry.accelerator = (char*) NULL;
1273 #endif // wxUSE_ACCEL/!wxUSE_ACCEL
1274
1275         gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
1276
1277         wxString path( mitem->GetFactoryPath() );
1278         menuItem = gtk_item_factory_get_widget( m_factory, wxGTK_CONV( path ) );
1279
1280         if (!menuItem)
1281             wxLogError( wxT("Wrong menu path: %s\n"), path.c_str() );
1282     }
1283
1284     if ( !mitem->IsSeparator() )
1285     {
1286         wxASSERT_MSG( menuItem, wxT("invalid menuitem") );
1287
1288         gtk_signal_connect( GTK_OBJECT(menuItem), "select",
1289                             GTK_SIGNAL_FUNC(gtk_menu_hilight_callback),
1290                             (gpointer)this );
1291
1292         gtk_signal_connect( GTK_OBJECT(menuItem), "deselect",
1293                             GTK_SIGNAL_FUNC(gtk_menu_nolight_callback),
1294                             (gpointer)this );
1295     }
1296
1297     mitem->SetMenuItem(menuItem);
1298
1299     if ( endOfRadioGroup )
1300     {
1301         m_pathLastRadio.clear();
1302     }
1303
1304     return TRUE;
1305 }
1306
1307 bool wxMenu::DoAppend(wxMenuItem *mitem)
1308 {
1309     return GtkAppend(mitem) && wxMenuBase::DoAppend(mitem);
1310 }
1311
1312 bool wxMenu::DoInsert(size_t pos, wxMenuItem *item)
1313 {
1314     if ( !wxMenuBase::DoInsert(pos, item) )
1315         return FALSE;
1316
1317     // GTK+ doesn't have a function to insert a menu using GtkItemFactory (as
1318     // of version 1.2.6), so we first append the item and then change its
1319     // index
1320     if ( !GtkAppend(item) )
1321         return FALSE;
1322
1323     if ( m_style & wxMENU_TEAROFF )
1324     {
1325         // change the position as the first item is the tear-off marker
1326         pos++;
1327     }
1328
1329     GtkMenuShell *menu_shell = GTK_MENU_SHELL(m_factory->widget);
1330     gpointer data = g_list_last(menu_shell->children)->data;
1331     menu_shell->children = g_list_remove(menu_shell->children, data);
1332     menu_shell->children = g_list_insert(menu_shell->children, data, pos);
1333
1334     return TRUE;
1335 }
1336
1337 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
1338 {
1339     if ( !wxMenuBase::DoRemove(item) )
1340         return (wxMenuItem *)NULL;
1341
1342     // TODO: this code doesn't delete the item factory item and this seems
1343     //       impossible as of GTK 1.2.6.
1344     gtk_widget_destroy( item->GetMenuItem() );
1345
1346     return item;
1347 }
1348
1349 int wxMenu::FindMenuIdByMenuItem( GtkWidget *menuItem ) const
1350 {
1351     wxMenuItemList::Node    *node = m_items.GetFirst();
1352     while (node)
1353     {
1354         wxMenuItem *item = node->GetData();
1355         if (item->GetMenuItem() == menuItem)
1356            return item->GetId();
1357         node = node->GetNext();
1358     }
1359
1360     return wxNOT_FOUND;
1361 }
1362
1363 // ----------------------------------------------------------------------------
1364 // helpers
1365 // ----------------------------------------------------------------------------
1366
1367 #if GTK_CHECK_VERSION(1, 2, 0) && wxUSE_ACCEL
1368
1369 static wxString GetHotKey( const wxMenuItem& item )
1370 {
1371     wxString hotkey;
1372
1373     wxAcceleratorEntry *accel = item.GetAccel();
1374     if ( accel )
1375     {
1376         int flags = accel->GetFlags();
1377         if ( flags & wxACCEL_ALT )
1378             hotkey += wxT("<alt>");
1379         if ( flags & wxACCEL_CTRL )
1380             hotkey += wxT("<control>");
1381         if ( flags & wxACCEL_SHIFT )
1382             hotkey += wxT("<shift>");
1383
1384         int code = accel->GetKeyCode();
1385         switch ( code )
1386         {
1387             case WXK_F1:
1388             case WXK_F2:
1389             case WXK_F3:
1390             case WXK_F4:
1391             case WXK_F5:
1392             case WXK_F6:
1393             case WXK_F7:
1394             case WXK_F8:
1395             case WXK_F9:
1396             case WXK_F10:
1397             case WXK_F11:
1398             case WXK_F12:
1399                 hotkey << wxT('F') << code - WXK_F1 + 1;
1400                 break;
1401
1402                 // TODO: we should use gdk_keyval_name() (a.k.a.
1403                 //       XKeysymToString) here as well as hardcoding the keysym
1404                 //       names this might be not portable
1405             case WXK_NUMPAD_INSERT:
1406                 hotkey << wxT("KP_Insert" );
1407                 break;
1408             case WXK_NUMPAD_DELETE:
1409                 hotkey << wxT("KP_Delete" );
1410                 break;
1411             case WXK_INSERT:
1412                 hotkey << wxT("Insert" );
1413                 break;
1414             case WXK_DELETE:
1415                 hotkey << wxT("Delete" );
1416                 break;
1417             case WXK_UP:
1418                 hotkey << wxT("Up" );
1419                 break;
1420             case WXK_DOWN:
1421                 hotkey << wxT("Down" );
1422                 break;
1423             case WXK_PAGEUP:
1424                 hotkey << wxT("Prior" );
1425                 break;
1426             case WXK_PAGEDOWN:
1427                 hotkey << wxT("Next" );
1428                 break;
1429             case WXK_LEFT:
1430                 hotkey << wxT("Left" );
1431                 break;
1432             case WXK_RIGHT:
1433                 hotkey << wxT("Right" );
1434                 break;
1435             case WXK_HOME:
1436                 hotkey << wxT("Home" );
1437                 break;
1438             case WXK_END:
1439                 hotkey << wxT("End" );
1440                 break;
1441             case WXK_RETURN:
1442                 hotkey << wxT("Return" );
1443                 break;
1444
1445                 // if there are any other keys wxGetAccelFromString() may
1446                 // return, we should process them here
1447
1448             default:
1449                 if ( code < 127 )
1450                 {
1451                     wxString name = wxGTK_CONV_BACK( gdk_keyval_name((guint)code) );
1452                     if ( name )
1453                     {
1454                         hotkey << name;
1455                         break;
1456                     }
1457                 }
1458
1459                 wxFAIL_MSG( wxT("unknown keyboard accel") );
1460         }
1461
1462         delete accel;
1463     }
1464
1465     return hotkey;
1466 }
1467
1468 #endif // wxUSE_ACCEL
1469
1470
1471 //-----------------------------------------------------------------------------
1472 // substitute for missing GtkPixmapMenuItem
1473 //-----------------------------------------------------------------------------
1474
1475 #ifdef USE_MENU_BITMAPS
1476
1477 /*
1478  * Copyright (C) 1998, 1999, 2000 Free Software Foundation
1479  * All rights reserved.
1480  *
1481  * This file is part of the Gnome Library.
1482  *
1483  * The Gnome Library is free software; you can redistribute it and/or
1484  * modify it under the terms of the GNU Library General Public License as
1485  * published by the Free Software Foundation; either version 2 of the
1486  * License, or (at your option) any later version.
1487  *
1488  * The Gnome Library is distributed in the hope that it will be useful,
1489  * but WITHOUT ANY WARRANTY; without even the implied warranty of
1490  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
1491  * Library General Public License for more details.
1492  *
1493  * You should have received a copy of the GNU Library General Public
1494  * License along with the Gnome Library; see the file COPYING.LIB.  If not,
1495  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
1496  * Boston, MA 02111-1307, USA.
1497  */
1498 /*
1499   @NOTATION@
1500  */
1501
1502 /* Author: Dietmar Maurer <dm@vlsivie.tuwien.ac.at> */
1503
1504 #include <gtk/gtkaccellabel.h>
1505 #include <gtk/gtksignal.h>
1506 #include <gtk/gtkmenuitem.h>
1507 #include <gtk/gtkmenu.h>
1508 #include <gtk/gtkcontainer.h>
1509
1510 extern "C"
1511 {
1512
1513 static void gtk_pixmap_menu_item_class_init    (GtkPixmapMenuItemClass *klass);
1514 static void gtk_pixmap_menu_item_init          (GtkPixmapMenuItem      *menu_item);
1515 static void gtk_pixmap_menu_item_draw          (GtkWidget              *widget,
1516                                                 GdkRectangle           *area);
1517 static gint gtk_pixmap_menu_item_expose        (GtkWidget              *widget,
1518                                                 GdkEventExpose         *event);
1519
1520 /* we must override the following functions */
1521
1522 static void gtk_pixmap_menu_item_map           (GtkWidget        *widget);
1523 static void gtk_pixmap_menu_item_size_allocate (GtkWidget        *widget,
1524                                                 GtkAllocation    *allocation);
1525 static void gtk_pixmap_menu_item_forall        (GtkContainer    *container,
1526                                                 gboolean         include_internals,
1527                                                 GtkCallback      callback,
1528                                                 gpointer         callback_data);
1529 static void gtk_pixmap_menu_item_size_request  (GtkWidget        *widget,
1530                                                 GtkRequisition   *requisition);
1531 static void gtk_pixmap_menu_item_remove        (GtkContainer *container,
1532                                                 GtkWidget    *child);
1533
1534 static void changed_have_pixmap_status         (GtkPixmapMenuItem *menu_item);
1535
1536 static GtkMenuItemClass *parent_class = NULL;
1537
1538 }
1539
1540 #define BORDER_SPACING  3
1541 #define PMAP_WIDTH 20
1542
1543 GtkType
1544 gtk_pixmap_menu_item_get_type (void)
1545 {
1546   static GtkType pixmap_menu_item_type = 0;
1547
1548   if (!pixmap_menu_item_type)
1549     {
1550       GtkTypeInfo pixmap_menu_item_info =
1551       {
1552         (char *)"GtkPixmapMenuItem",
1553         sizeof (GtkPixmapMenuItem),
1554         sizeof (GtkPixmapMenuItemClass),
1555         (GtkClassInitFunc) gtk_pixmap_menu_item_class_init,
1556         (GtkObjectInitFunc) gtk_pixmap_menu_item_init,
1557         /* reserved_1 */ NULL,
1558         /* reserved_2 */ NULL,
1559         (GtkClassInitFunc) NULL,
1560       };
1561
1562       pixmap_menu_item_type = gtk_type_unique (gtk_menu_item_get_type (),
1563                                                &pixmap_menu_item_info);
1564     }
1565
1566   return pixmap_menu_item_type;
1567 }
1568
1569 /**
1570  * gtk_pixmap_menu_item_new
1571  *
1572  * Creates a new pixmap menu item. Use gtk_pixmap_menu_item_set_pixmap()
1573  * to set the pixmap wich is displayed at the left side.
1574  *
1575  * Returns:
1576  * &GtkWidget pointer to new menu item
1577  **/
1578
1579 GtkWidget*
1580 gtk_pixmap_menu_item_new (void)
1581 {
1582   return GTK_WIDGET (gtk_type_new (gtk_pixmap_menu_item_get_type ()));
1583 }
1584
1585 static void
1586 gtk_pixmap_menu_item_class_init (GtkPixmapMenuItemClass *klass)
1587 {
1588   GtkObjectClass *object_class;
1589   GtkWidgetClass *widget_class;
1590   GtkMenuItemClass *menu_item_class;
1591   GtkContainerClass *container_class;
1592
1593   object_class = (GtkObjectClass*) klass;
1594   widget_class = (GtkWidgetClass*) klass;
1595   menu_item_class = (GtkMenuItemClass*) klass;
1596   container_class = (GtkContainerClass*) klass;
1597
1598   parent_class = (GtkMenuItemClass*) gtk_type_class (gtk_menu_item_get_type ());
1599
1600   widget_class->draw = gtk_pixmap_menu_item_draw;
1601   widget_class->expose_event = gtk_pixmap_menu_item_expose;
1602   widget_class->map = gtk_pixmap_menu_item_map;
1603   widget_class->size_allocate = gtk_pixmap_menu_item_size_allocate;
1604   widget_class->size_request = gtk_pixmap_menu_item_size_request;
1605
1606   container_class->forall = gtk_pixmap_menu_item_forall;
1607   container_class->remove = gtk_pixmap_menu_item_remove;
1608
1609   klass->orig_toggle_size = menu_item_class->toggle_size;
1610   klass->have_pixmap_count = 0;
1611 }
1612
1613 static void
1614 gtk_pixmap_menu_item_init (GtkPixmapMenuItem *menu_item)
1615 {
1616   GtkMenuItem *mi;
1617
1618   mi = GTK_MENU_ITEM (menu_item);
1619
1620   menu_item->pixmap = NULL;
1621 }
1622
1623 static void
1624 gtk_pixmap_menu_item_draw (GtkWidget    *widget,
1625                            GdkRectangle *area)
1626 {
1627   g_return_if_fail (widget != NULL);
1628   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (widget));
1629   g_return_if_fail (area != NULL);
1630
1631   if (GTK_WIDGET_CLASS (parent_class)->draw)
1632     (* GTK_WIDGET_CLASS (parent_class)->draw) (widget, area);
1633
1634   if (GTK_WIDGET_DRAWABLE (widget) &&
1635       GTK_PIXMAP_MENU_ITEM(widget)->pixmap) {
1636     gtk_widget_draw(GTK_WIDGET(GTK_PIXMAP_MENU_ITEM(widget)->pixmap),NULL);
1637   }
1638 }
1639
1640 static gint
1641 gtk_pixmap_menu_item_expose (GtkWidget      *widget,
1642                              GdkEventExpose *event)
1643 {
1644   g_return_val_if_fail (widget != NULL, FALSE);
1645   g_return_val_if_fail (GTK_IS_PIXMAP_MENU_ITEM (widget), FALSE);
1646   g_return_val_if_fail (event != NULL, FALSE);
1647
1648   if (GTK_WIDGET_CLASS (parent_class)->expose_event)
1649     (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
1650
1651   if (GTK_WIDGET_DRAWABLE (widget) &&
1652       GTK_PIXMAP_MENU_ITEM(widget)->pixmap) {
1653     gtk_widget_draw(GTK_WIDGET(GTK_PIXMAP_MENU_ITEM(widget)->pixmap),NULL);
1654   }
1655
1656   return FALSE;
1657 }
1658
1659 /**
1660  * gtk_pixmap_menu_item_set_pixmap
1661  * @menu_item: Pointer to the pixmap menu item
1662  * @pixmap: Pointer to a pixmap widget
1663  *
1664  * Set the pixmap of the menu item.
1665  *
1666  **/
1667
1668 void
1669 gtk_pixmap_menu_item_set_pixmap (GtkPixmapMenuItem *menu_item,
1670                                  GtkWidget         *pixmap)
1671 {
1672   g_return_if_fail (menu_item != NULL);
1673   g_return_if_fail (pixmap != NULL);
1674   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (menu_item));
1675   g_return_if_fail (GTK_IS_WIDGET (pixmap));
1676   g_return_if_fail (menu_item->pixmap == NULL);
1677
1678   gtk_widget_set_parent (pixmap, GTK_WIDGET (menu_item));
1679   menu_item->pixmap = pixmap;
1680
1681   if (GTK_WIDGET_REALIZED (pixmap->parent) &&
1682       !GTK_WIDGET_REALIZED (pixmap))
1683     gtk_widget_realize (pixmap);
1684
1685   if (GTK_WIDGET_VISIBLE (pixmap->parent)) {
1686     if (GTK_WIDGET_MAPPED (pixmap->parent) &&
1687         GTK_WIDGET_VISIBLE(pixmap) &&
1688         !GTK_WIDGET_MAPPED (pixmap))
1689       gtk_widget_map (pixmap);
1690   }
1691
1692   changed_have_pixmap_status(menu_item);
1693
1694   if (GTK_WIDGET_VISIBLE (pixmap) && GTK_WIDGET_VISIBLE (menu_item))
1695     gtk_widget_queue_resize (pixmap);
1696 }
1697
1698 static void
1699 gtk_pixmap_menu_item_map (GtkWidget *widget)
1700 {
1701   GtkPixmapMenuItem *menu_item;
1702
1703   g_return_if_fail (widget != NULL);
1704   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (widget));
1705
1706   menu_item = GTK_PIXMAP_MENU_ITEM(widget);
1707
1708   GTK_WIDGET_CLASS(parent_class)->map(widget);
1709
1710   if (menu_item->pixmap &&
1711       GTK_WIDGET_VISIBLE (menu_item->pixmap) &&
1712       !GTK_WIDGET_MAPPED (menu_item->pixmap))
1713     gtk_widget_map (menu_item->pixmap);
1714 }
1715
1716 static void
1717 gtk_pixmap_menu_item_size_allocate (GtkWidget        *widget,
1718                                     GtkAllocation    *allocation)
1719 {
1720   GtkPixmapMenuItem *pmenu_item;
1721
1722   pmenu_item = GTK_PIXMAP_MENU_ITEM(widget);
1723
1724   if (pmenu_item->pixmap && GTK_WIDGET_VISIBLE(pmenu_item))
1725     {
1726       GtkAllocation child_allocation;
1727       int border_width;
1728
1729       border_width = GTK_CONTAINER (widget)->border_width;
1730
1731       child_allocation.width = pmenu_item->pixmap->requisition.width;
1732       child_allocation.height = pmenu_item->pixmap->requisition.height;
1733       child_allocation.x = border_width + BORDER_SPACING;
1734       child_allocation.y = (border_width + BORDER_SPACING
1735                             + (((allocation->height - child_allocation.height) - child_allocation.x)
1736                                / 2)); /* center pixmaps vertically */
1737       gtk_widget_size_allocate (pmenu_item->pixmap, &child_allocation);
1738     }
1739
1740   if (GTK_WIDGET_CLASS (parent_class)->size_allocate)
1741     GTK_WIDGET_CLASS(parent_class)->size_allocate (widget, allocation);
1742 }
1743
1744 static void
1745 gtk_pixmap_menu_item_forall (GtkContainer    *container,
1746                              gboolean         include_internals,
1747                              GtkCallback      callback,
1748                              gpointer         callback_data)
1749 {
1750   GtkPixmapMenuItem *menu_item;
1751
1752   g_return_if_fail (container != NULL);
1753   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (container));
1754   g_return_if_fail (callback != NULL);
1755
1756   menu_item = GTK_PIXMAP_MENU_ITEM (container);
1757
1758   if (menu_item->pixmap)
1759     (* callback) (menu_item->pixmap, callback_data);
1760
1761   GTK_CONTAINER_CLASS(parent_class)->forall(container,include_internals,
1762                                             callback,callback_data);
1763 }
1764
1765 static void
1766 gtk_pixmap_menu_item_size_request (GtkWidget      *widget,
1767                                    GtkRequisition *requisition)
1768 {
1769   GtkPixmapMenuItem *menu_item;
1770   GtkRequisition req = {0, 0};
1771
1772   g_return_if_fail (widget != NULL);
1773   g_return_if_fail (GTK_IS_MENU_ITEM (widget));
1774   g_return_if_fail (requisition != NULL);
1775
1776   GTK_WIDGET_CLASS(parent_class)->size_request(widget,requisition);
1777
1778   menu_item = GTK_PIXMAP_MENU_ITEM (widget);
1779
1780   if (menu_item->pixmap)
1781     gtk_widget_size_request(menu_item->pixmap, &req);
1782
1783   requisition->height = MAX(req.height + GTK_CONTAINER(widget)->border_width + BORDER_SPACING, (unsigned int) requisition->height);
1784   requisition->width += (req.width + GTK_CONTAINER(widget)->border_width + BORDER_SPACING);
1785 }
1786
1787 static void
1788 gtk_pixmap_menu_item_remove (GtkContainer *container,
1789                              GtkWidget    *child)
1790 {
1791   GtkBin *bin;
1792   gboolean widget_was_visible;
1793
1794   g_return_if_fail (container != NULL);
1795   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (container));
1796   g_return_if_fail (child != NULL);
1797   g_return_if_fail (GTK_IS_WIDGET (child));
1798
1799   bin = GTK_BIN (container);
1800   g_return_if_fail ((bin->child == child ||
1801                      (GTK_PIXMAP_MENU_ITEM(container)->pixmap == child)));
1802
1803   widget_was_visible = GTK_WIDGET_VISIBLE (child);
1804
1805   gtk_widget_unparent (child);
1806   if (bin->child == child)
1807     bin->child = NULL;
1808   else {
1809     GTK_PIXMAP_MENU_ITEM(container)->pixmap = NULL;
1810     changed_have_pixmap_status(GTK_PIXMAP_MENU_ITEM(container));
1811   }
1812
1813   if (widget_was_visible)
1814     gtk_widget_queue_resize (GTK_WIDGET (container));
1815 }
1816
1817
1818 /* important to only call this if there was actually a _change_ in pixmap == NULL */
1819 static void
1820 changed_have_pixmap_status (GtkPixmapMenuItem *menu_item)
1821 {
1822   if (menu_item->pixmap != NULL) {
1823     GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count += 1;
1824
1825     if (GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count == 1) {
1826       /* Install pixmap toggle size */
1827       GTK_MENU_ITEM_GET_CLASS(menu_item)->toggle_size = MAX(GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->orig_toggle_size, PMAP_WIDTH);
1828     }
1829   } else {
1830     GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count -= 1;
1831
1832     if (GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count == 0) {
1833       /* Install normal toggle size */
1834       GTK_MENU_ITEM_GET_CLASS(menu_item)->toggle_size = GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->orig_toggle_size;
1835     }
1836   }
1837
1838   /* Note that we actually need to do this for _all_ GtkPixmapMenuItem
1839      whenever the klass->toggle_size changes; but by doing it anytime
1840      this function is called, we get the same effect, just because of
1841      how the preferences option to show pixmaps works. Bogus, broken.
1842   */
1843   if (GTK_WIDGET_VISIBLE(GTK_WIDGET(menu_item)))
1844     gtk_widget_queue_resize(GTK_WIDGET(menu_item));
1845 }
1846
1847 #endif // USE_MENU_BITMAPS
1848