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