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