src/gtk/menu.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/menu.cpp
   3 // Purpose:     implementation of wxMenuBar and wxMenu classes for wxGTK
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 // For compilers that support precompilation, includes "wx.h".
  11 #include "wx/wxprec.h"
  12
  13 #if wxUSE_MENUS
  14
  15 #include "wx/menu.h"
  16
  17 #ifndef WX_PRECOMP
  18     #include "wx/intl.h"
  19     #include "wx/log.h"
  20     #include "wx/frame.h"
  21     #include "wx/bitmap.h"
  22     #include "wx/app.h"
  23 #endif
  24
  25 #include "wx/accel.h"
  26 #include "wx/stockitem.h"
  27 #include "wx/gtk/private.h"
  28 #include "wx/gtk/private/mnemonics.h"
  29
  30 // we use normal item but with a special id for the menu title
  31 static const int wxGTK_TITLE_ID = -3;
  32
  33 // forward declare it as it's used by wxMenuBar too when using Hildon
  34 extern "C"
  35 {
  36     static void gtk_menu_clicked_callback(GtkWidget *widget, wxMenu *menu);
  37 }
  38
  39 #if wxUSE_ACCEL
  40 static bool wxGetStockGtkAccelerator(const char *id, GdkModifierType *mod, guint *key);
  41 static wxString GetGtkHotKey( const wxMenuItem& item );
  42 #endif
  43
  44 static void DoCommonMenuCallbackCode(wxMenu *menu, wxMenuEvent& event)
  45 {
  46     event.SetEventObject( menu );
  47
  48     wxEvtHandler* handler = menu->GetEventHandler();
  49     if (handler && handler->SafelyProcessEvent(event))
  50         return;
  51
  52     wxWindow *win = menu->GetInvokingWindow();
  53     if (win)
  54         win->HandleWindowEvent( event );
  55 }
  56
  57 //-----------------------------------------------------------------------------
  58 // wxMenuBar
  59 //-----------------------------------------------------------------------------
  60
  61 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar,wxWindow)
  62
  63 void wxMenuBar::Init(size_t n, wxMenu *menus[], const wxString titles[], long style)
  64 {
  65     m_invokingWindow = NULL;
  66
  67 #if wxUSE_LIBHILDON
  68     // Hildon window uses a single menu instead of a menu bar, so wxMenuBar is
  69     // the same as menu in this case
  70     m_widget =
  71     m_menubar = gtk_menu_new();
  72 #else // !wxUSE_LIBHILDON
  73     if (!PreCreation( NULL, wxDefaultPosition, wxDefaultSize ) ||
  74         !CreateBase( NULL, -1, wxDefaultPosition, wxDefaultSize, style, wxDefaultValidator, wxT("menubar") ))
  75     {
  76         wxFAIL_MSG( wxT("wxMenuBar creation failed") );
  77         return;
  78     }
  79
  80     m_menubar = gtk_menu_bar_new();
  81
  82     if (style & wxMB_DOCKABLE)
  83     {
  84         m_widget = gtk_handle_box_new();
  85         gtk_container_add(GTK_CONTAINER(m_widget), m_menubar);
  86         gtk_widget_show(m_menubar);
  87     }
  88     else
  89     {
  90         m_widget = m_menubar;
  91     }
  92
  93     PostCreation();
  94
  95     ApplyWidgetStyle();
  96 #endif // wxUSE_LIBHILDON/!wxUSE_LIBHILDON
  97
  98     for (size_t i = 0; i < n; ++i )
  99         Append(menus[i], titles[i]);
 100 }
 101
 102 wxMenuBar::wxMenuBar(size_t n, wxMenu *menus[], const wxString titles[], long style)
 103 {
 104     Init(n, menus, titles, style);
 105 }
 106
 107 wxMenuBar::wxMenuBar(long style)
 108 {
 109     Init(0, NULL, NULL, style);
 110 }
 111
 112 wxMenuBar::wxMenuBar()
 113 {
 114     Init(0, NULL, NULL, 0);
 115 }
 116
 117 wxMenuBar::~wxMenuBar()
 118 {
 119 }
 120
 121 static void
 122 wxMenubarUnsetInvokingWindow(wxMenu* menu, wxWindow* win, GtkWindow* tlw = NULL)
 123 {
 124     menu->SetInvokingWindow( (wxWindow*) NULL );
 125
 126     // support for native hot keys
 127     if (menu->m_accel)
 128     {
 129         if (tlw == NULL)
 130             tlw = GTK_WINDOW(wxGetTopLevelParent(win)->m_widget);
 131         if (g_slist_find(menu->m_accel->acceleratables, tlw))
 132             gtk_window_remove_accel_group(tlw, menu->m_accel);
 133     }
 134
 135     wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
 136     while (node)
 137     {
 138         wxMenuItem *menuitem = node->GetData();
 139         if (menuitem->IsSubMenu())
 140             wxMenubarUnsetInvokingWindow(menuitem->GetSubMenu(), win, tlw);
 141         node = node->GetNext();
 142     }
 143 }
 144
 145 static void
 146 wxMenubarSetInvokingWindow(wxMenu* menu, wxWindow* win, GtkWindow* tlw = NULL)
 147 {
 148     menu->SetInvokingWindow( win );
 149
 150     // support for native hot keys
 151     if (menu->m_accel)
 152     {
 153         if (tlw == NULL)
 154             tlw = GTK_WINDOW(wxGetTopLevelParent(win)->m_widget);
 155         if (!g_slist_find(menu->m_accel->acceleratables, tlw))
 156             gtk_window_add_accel_group(tlw, menu->m_accel);
 157     }
 158
 159     wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
 160     while (node)
 161     {
 162         wxMenuItem *menuitem = node->GetData();
 163         if (menuitem->IsSubMenu())
 164             wxMenubarSetInvokingWindow(menuitem->GetSubMenu(), win, tlw);
 165         node = node->GetNext();
 166     }
 167 }
 168
 169 void wxMenuBar::SetInvokingWindow( wxWindow *win )
 170 {
 171     m_invokingWindow = win;
 172
 173     wxMenuList::compatibility_iterator node = m_menus.GetFirst();
 174     while (node)
 175     {
 176         wxMenu *menu = node->GetData();
 177         wxMenubarSetInvokingWindow( menu, win );
 178         node = node->GetNext();
 179     }
 180 }
 181
 182 void wxMenuBar::SetLayoutDirection(wxLayoutDirection dir)
 183 {
 184     if ( dir == wxLayout_Default )
 185     {
 186         const wxWindow *const frame = GetFrame();
 187         if ( frame )
 188         {
 189             // inherit layout from frame.
 190             dir = frame->GetLayoutDirection();
 191         }
 192         else // use global layout
 193         {
 194             dir = wxTheApp->GetLayoutDirection();
 195         }
 196     }
 197
 198     if ( dir == wxLayout_Default )
 199         return;
 200
 201     GTKSetLayout(m_menubar, dir);
 202
 203     // also set the layout of all menus we already have (new ones will inherit
 204     // the current layout)
 205     for ( wxMenuList::compatibility_iterator node = m_menus.GetFirst();
 206           node;
 207           node = node->GetNext() )
 208     {
 209         wxMenu *const menu = node->GetData();
 210         menu->SetLayoutDirection(dir);
 211     }
 212 }
 213
 214 wxLayoutDirection wxMenuBar::GetLayoutDirection() const
 215 {
 216     return GTKGetLayout(m_menubar);
 217 }
 218
 219 void wxMenuBar::Attach(wxFrame *frame)
 220 {
 221     wxMenuBarBase::Attach(frame);
 222
 223     SetLayoutDirection(wxLayout_Default);
 224 }
 225
 226 void wxMenuBar::UnsetInvokingWindow( wxWindow *win )
 227 {
 228     m_invokingWindow = (wxWindow*) NULL;
 229
 230     wxMenuList::compatibility_iterator node = m_menus.GetFirst();
 231     while (node)
 232     {
 233         wxMenu *menu = node->GetData();
 234         wxMenubarUnsetInvokingWindow( menu, win );
 235         node = node->GetNext();
 236     }
 237 }
 238
 239 bool wxMenuBar::Append( wxMenu *menu, const wxString &title )
 240 {
 241     if ( !wxMenuBarBase::Append( menu, title ) )
 242         return false;
 243
 244     return GtkAppend(menu, title);
 245 }
 246
 247 bool wxMenuBar::GtkAppend(wxMenu *menu, const wxString& title, int pos)
 248 {
 249     menu->SetLayoutDirection(GetLayoutDirection());
 250
 251 #if wxUSE_LIBHILDON
 252     // if the menu has only one item, append it directly to the top level menu
 253     // instead of inserting a useless submenu
 254     if ( menu->GetMenuItemCount() == 1 )
 255     {
 256         wxMenuItem * const item = menu->FindItemByPosition(0);
 257
 258         // remove both mnemonics and accelerator: neither is useful under Maemo
 259         const wxString str(wxStripMenuCodes(item->GetItemLabel()));
 260
 261         if ( item->IsSubMenu() )
 262             return GtkAppend(item->GetSubMenu(), str, pos);
 263
 264         menu->m_owner = gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str ) );
 265
 266         g_signal_connect(menu->m_owner, "activate",
 267                           G_CALLBACK(gtk_menu_clicked_callback), menu);
 268         item->SetMenuItem(menu->m_owner);
 269     }
 270     else
 271 #endif // wxUSE_LIBHILDON/!wxUSE_LIBHILDON
 272     {
 273         const wxString str(wxConvertMnemonicsToGTK(title));
 274
 275         // This doesn't have much effect right now.
 276         menu->SetTitle( str );
 277
 278         // The "m_owner" is the "menu item"
 279         menu->m_owner = gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str ) );
 280
 281         gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
 282     }
 283
 284     gtk_widget_show( menu->m_owner );
 285
 286     if (pos == -1)
 287         gtk_menu_shell_append( GTK_MENU_SHELL(m_menubar), menu->m_owner );
 288     else
 289         gtk_menu_shell_insert( GTK_MENU_SHELL(m_menubar), menu->m_owner, pos );
 290
 291     // m_invokingWindow is set after wxFrame::SetMenuBar(). This call enables
 292     // addings menu later on.
 293     if (m_invokingWindow)
 294         wxMenubarSetInvokingWindow( menu, m_invokingWindow );
 295
 296     return true;
 297 }
 298
 299 bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
 300 {
 301     if ( !wxMenuBarBase::Insert(pos, menu, title) )
 302         return false;
 303
 304     // TODO
 305
 306     if ( !GtkAppend(menu, title, (int)pos) )
 307         return false;
 308
 309     return true;
 310 }
 311
 312 wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
 313 {
 314     // remove the old item and insert a new one
 315     wxMenu *menuOld = Remove(pos);
 316     if ( menuOld && !Insert(pos, menu, title) )
 317     {
 318         return (wxMenu*) NULL;
 319     }
 320
 321     // either Insert() succeeded or Remove() failed and menuOld is NULL
 322     return menuOld;
 323 }
 324
 325 wxMenu *wxMenuBar::Remove(size_t pos)
 326 {
 327     wxMenu *menu = wxMenuBarBase::Remove(pos);
 328     if ( !menu )
 329         return (wxMenu*) NULL;
 330
 331     gtk_menu_item_set_submenu(GTK_MENU_ITEM(menu->m_owner), NULL);
 332     gtk_container_remove(GTK_CONTAINER(m_menubar), menu->m_owner);
 333
 334     gtk_widget_destroy( menu->m_owner );
 335     menu->m_owner = NULL;
 336
 337     if (m_invokingWindow)
 338         wxMenubarUnsetInvokingWindow( menu, m_invokingWindow );
 339
 340     return menu;
 341 }
 342
 343 static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString, const wxString &itemString )
 344 {
 345     if (wxMenuItem::GetLabelText(wxConvertMnemonicsFromGTK(menu->GetTitle())) == wxMenuItem::GetLabelText(menuString))
 346     {
 347         int res = menu->FindItem( itemString );
 348         if (res != wxNOT_FOUND)
 349             return res;
 350     }
 351
 352     wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
 353     while (node)
 354     {
 355         wxMenuItem *item = node->GetData();
 356         if (item->IsSubMenu())
 357             return FindMenuItemRecursive(item->GetSubMenu(), menuString, itemString);
 358
 359         node = node->GetNext();
 360     }
 361
 362     return wxNOT_FOUND;
 363 }
 364
 365 int wxMenuBar::FindMenuItem( const wxString &menuString, const wxString &itemString ) const
 366 {
 367     wxMenuList::compatibility_iterator node = m_menus.GetFirst();
 368     while (node)
 369     {
 370         wxMenu *menu = node->GetData();
 371         int res = FindMenuItemRecursive( menu, menuString, itemString);
 372         if (res != -1)
 373             return res;
 374         node = node->GetNext();
 375     }
 376
 377     return wxNOT_FOUND;
 378 }
 379
 380 // Find a wxMenuItem using its id. Recurses down into sub-menus
 381 static wxMenuItem* FindMenuItemByIdRecursive(const wxMenu* menu, int id)
 382 {
 383     wxMenuItem* result = menu->FindChildItem(id);
 384
 385     wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
 386     while ( node && result == NULL )
 387     {
 388         wxMenuItem *item = node->GetData();
 389         if (item->IsSubMenu())
 390         {
 391             result = FindMenuItemByIdRecursive( item->GetSubMenu(), id );
 392         }
 393         node = node->GetNext();
 394     }
 395
 396     return result;
 397 }
 398
 399 wxMenuItem* wxMenuBar::FindItem( int id, wxMenu **menuForItem ) const
 400 {
 401     wxMenuItem* result = 0;
 402     wxMenuList::compatibility_iterator node = m_menus.GetFirst();
 403     while (node && result == 0)
 404     {
 405         wxMenu *menu = node->GetData();
 406         result = FindMenuItemByIdRecursive( menu, id );
 407         node = node->GetNext();
 408     }
 409
 410     if ( menuForItem )
 411     {
 412         *menuForItem = result ? result->GetMenu() : (wxMenu *)NULL;
 413     }
 414
 415     return result;
 416 }
 417
 418 void wxMenuBar::EnableTop( size_t pos, bool flag )
 419 {
 420     wxMenuList::compatibility_iterator node = m_menus.Item( pos );
 421
 422     wxCHECK_RET( node, wxT("menu not found") );
 423
 424     wxMenu* menu = node->GetData();
 425
 426     if (menu->m_owner)
 427         gtk_widget_set_sensitive( menu->m_owner, flag );
 428 }
 429
 430 wxString wxMenuBar::GetMenuLabel( size_t pos ) const
 431 {
 432     wxMenuList::compatibility_iterator node = m_menus.Item( pos );
 433
 434     wxCHECK_MSG( node, wxT("invalid"), wxT("menu not found") );
 435
 436     wxMenu* menu = node->GetData();
 437
 438     return wxConvertMnemonicsFromGTK(menu->GetTitle());
 439 }
 440
 441 void wxMenuBar::SetMenuLabel( size_t pos, const wxString& label )
 442 {
 443     wxMenuList::compatibility_iterator node = m_menus.Item( pos );
 444
 445     wxCHECK_RET( node, wxT("menu not found") );
 446
 447     wxMenu* menu = node->GetData();
 448
 449     const wxString str(wxConvertMnemonicsToGTK(label));
 450
 451     menu->SetTitle( str );
 452
 453     if (menu->m_owner)
 454         gtk_label_set_text_with_mnemonic( GTK_LABEL( GTK_BIN(menu->m_owner)->child), wxGTK_CONV(str) );
 455 }
 456
 457 //-----------------------------------------------------------------------------
 458 // "activate"
 459 //-----------------------------------------------------------------------------
 460
 461 extern "C" {
 462 static void gtk_menu_clicked_callback( GtkWidget *widget, wxMenu *menu )
 463 {
 464     int id = menu->FindMenuIdByMenuItem(widget);
 465
 466     /* should find it for normal (not popup) menu */
 467     wxASSERT_MSG( (id != -1) || (menu->GetInvokingWindow() != NULL),
 468                   _T("menu item not found in gtk_menu_clicked_callback") );
 469
 470     if (!menu->IsEnabled(id))
 471         return;
 472
 473     wxMenuItem* item = menu->FindChildItem( id );
 474     wxCHECK_RET( item, wxT("error in menu item callback") );
 475
 476     if ( item->GetId() == wxGTK_TITLE_ID )
 477     {
 478         // ignore events from the menu title
 479         return;
 480     }
 481
 482     if (item->IsCheckable())
 483     {
 484         bool isReallyChecked = item->IsChecked(),
 485             isInternallyChecked = item->wxMenuItemBase::IsChecked();
 486
 487         // ensure that the internal state is always consistent with what is
 488         // shown on the screen
 489         item->wxMenuItemBase::Check(isReallyChecked);
 490
 491         // we must not report the events for the radio button going up nor the
 492         // events resulting from the calls to wxMenuItem::Check()
 493         if ( (item->GetKind() == wxITEM_RADIO && !isReallyChecked) ||
 494              (isInternallyChecked == isReallyChecked) )
 495         {
 496             return;
 497         }
 498     }
 499
 500
 501     // Is this menu on a menubar?  (possibly nested)
 502     wxFrame* frame = NULL;
 503     if(menu->IsAttached())
 504         frame = menu->GetMenuBar()->GetFrame();
 505
 506     // FIXME: why do we have to call wxFrame::GetEventHandler() directly here?
 507     //        normally wxMenu::SendEvent() should be enough, if it doesn't work
 508     //        in wxGTK then we have a bug in wxMenu::GetInvokingWindow() which
 509     //        should be fixed instead of working around it here...
 510     if (frame)
 511     {
 512         // If it is attached then let the frame send the event.
 513         // Don't call frame->ProcessCommand(id) because it toggles
 514         // checkable items and we've already done that above.
 515         wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id);
 516         commandEvent.SetEventObject(frame);
 517         if (item->IsCheckable())
 518             commandEvent.SetInt(item->IsChecked());
 519
 520         frame->HandleWindowEvent(commandEvent);
 521     }
 522     else
 523     {
 524         // otherwise let the menu have it
 525         menu->SendEvent(id, item->IsCheckable() ? item->IsChecked() : -1);
 526     }
 527 }
 528 }
 529
 530 //-----------------------------------------------------------------------------
 531 // "select"
 532 //-----------------------------------------------------------------------------
 533
 534 extern "C" {
 535 static void gtk_menu_hilight_callback( GtkWidget *widget, wxMenu *menu )
 536 {
 537     int id = menu->FindMenuIdByMenuItem(widget);
 538
 539     wxASSERT( id != -1 ); // should find it!
 540
 541     if (!menu->IsEnabled(id))
 542         return;
 543
 544     wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, id );
 545     event.SetEventObject( menu );
 546
 547     wxEvtHandler* handler = menu->GetEventHandler();
 548     if (handler && handler->SafelyProcessEvent(event))
 549         return;
 550
 551     wxWindow *win = menu->GetInvokingWindow();
 552     if (win) win->HandleWindowEvent( event );
 553 }
 554 }
 555
 556 //-----------------------------------------------------------------------------
 557 // "deselect"
 558 //-----------------------------------------------------------------------------
 559
 560 extern "C" {
 561 static void gtk_menu_nolight_callback( GtkWidget *widget, wxMenu *menu )
 562 {
 563     int id = menu->FindMenuIdByMenuItem(widget);
 564
 565     wxASSERT( id != -1 ); // should find it!
 566
 567     if (!menu->IsEnabled(id))
 568         return;
 569
 570     wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, -1 );
 571     event.SetEventObject( menu );
 572
 573     wxEvtHandler* handler = menu->GetEventHandler();
 574     if (handler && handler->SafelyProcessEvent(event))
 575         return;
 576
 577     wxWindow *win = menu->GetInvokingWindow();
 578     if (win)
 579         win->HandleWindowEvent( event );
 580 }
 581 }
 582
 583 //-----------------------------------------------------------------------------
 584 // wxMenuItem
 585 //-----------------------------------------------------------------------------
 586
 587 IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)
 588
 589 wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu,
 590                                 int id,
 591                                 const wxString& name,
 592                                 const wxString& help,
 593                                 wxItemKind kind,
 594                                 wxMenu *subMenu)
 595 {
 596     return new wxMenuItem(parentMenu, id, name, help, kind, subMenu);
 597 }
 598
 599 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
 600                        int id,
 601                        const wxString& text,
 602                        const wxString& help,
 603                        wxItemKind kind,
 604                        wxMenu *subMenu)
 605           : wxMenuItemBase(parentMenu, id, text, help, kind, subMenu)
 606 {
 607     Init(text);
 608 }
 609
 610 #if WXWIN_COMPATIBILITY_2_8
 611 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
 612                        int id,
 613                        const wxString& text,
 614                        const wxString& help,
 615                        bool isCheckable,
 616                        wxMenu *subMenu)
 617           : wxMenuItemBase(parentMenu, id, text, help,
 618                            isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu)
 619 {
 620     Init(text);
 621 }
 622 #endif
 623
 624 void wxMenuItem::Init(const wxString& text)
 625 {
 626     m_labelWidget = (GtkWidget *) NULL;
 627     m_menuItem = (GtkWidget *) NULL;
 628
 629     DoSetText(text);
 630 }
 631
 632 wxMenuItem::~wxMenuItem()
 633 {
 634    // don't delete menu items, the menus take care of that
 635 }
 636
 637 // return the menu item text without any menu accels
 638 /* static */
 639
 640 wxString wxMenuItemBase::GetLabelText(const wxString& text)
 641 {
 642     // The argument to this function will now always be in wxWidgets standard label
 643     // format, not GTK+ format, so we do what the other ports do.
 644
 645     return wxStripMenuCodes(text);
 646
 647 #if 0
 648     wxString label;
 649
 650     for ( const wxChar *pc = text.c_str(); *pc; pc++ )
 651     {
 652         if ( *pc == wxT('\t'))
 653             break;
 654
 655         if ( *pc == wxT('_') )
 656         {
 657             // GTK 1.2 escapes "xxx_xxx" to "xxx__xxx"
 658             pc++;
 659             label += *pc;
 660             continue;
 661         }
 662
 663         if ( *pc == wxT('\\')  )
 664         {
 665             // GTK 2.0 escapes "xxx/xxx" to "xxx\/xxx"
 666             pc++;
 667             label += *pc;
 668             continue;
 669         }
 670
 671         if ( (*pc == wxT('&')) && (*(pc+1) != wxT('&')) )
 672         {
 673             // wxMSW escapes "&"
 674             // "&" is doubled to indicate "&" instead of accelerator
 675             continue;
 676         }
 677
 678         label += *pc;
 679     }
 680
 681     // wxPrintf( wxT("GetLabelText(): text %s label %s\n"), text.c_str(), label.c_str() );
 682
 683     return label;
 684 #endif
 685 }
 686
 687 wxString wxMenuItem::GetItemLabel() const
 688 {
 689     wxString label = wxConvertMnemonicsFromGTK(m_text);
 690     if (!m_hotKey.IsEmpty())
 691         label << "\t" << m_hotKey;
 692     return label;
 693 }
 694
 695 void wxMenuItem::SetItemLabel( const wxString& str )
 696 {
 697     // cache some data which must be used later
 698     bool isstock = wxIsStockID(GetId());
 699     const char *stockid = NULL;
 700     if (isstock)
 701         stockid = wxGetStockGtkID(GetId());
 702
 703     // Some optimization to avoid flicker
 704     wxString oldLabel = m_text;
 705     oldLabel = wxStripMenuCodes(oldLabel);
 706     oldLabel.Replace(wxT("_"), wxT(""));
 707     wxString label1 = wxStripMenuCodes(str);
 708 #if wxUSE_ACCEL
 709     wxString oldhotkey = GetHotKey();    // Store the old hotkey in Ctrl-foo format
 710     wxCharBuffer oldbuf = wxGTK_CONV_SYS( GetGtkHotKey(*this) );  // and as <control>foo
 711 #endif // wxUSE_ACCEL
 712
 713     DoSetText(str);
 714
 715 #if wxUSE_ACCEL
 716     if (oldLabel == label1 &&
 717         oldhotkey == GetHotKey())    // Make sure we can change a hotkey even if the label is unaltered
 718         return;
 719
 720     if (m_menuItem)
 721     {
 722         GtkLabel *label;
 723         if (m_labelWidget)
 724             label = (GtkLabel*) m_labelWidget;
 725         else
 726             label = GTK_LABEL( GTK_BIN(m_menuItem)->child );
 727
 728         // stock menu items can have empty labels:
 729         wxString text = m_text;
 730         if (text.IsEmpty() && !IsSeparator())
 731         {
 732             wxASSERT_MSG(isstock, wxT("A non-stock menu item with an empty label?"));
 733             text = wxGetStockLabel(GetId());
 734
 735             // need & => _ conversion
 736             text = GTKProcessMenuItemLabel(text, NULL);
 737         }
 738
 739         gtk_label_set_text_with_mnemonic( GTK_LABEL(label), wxGTK_CONV_SYS(text) );
 740     }
 741
 742     // remove old accelerator from our parent's accelerator group, if present
 743     guint accel_key;
 744     GdkModifierType accel_mods;
 745     if (oldbuf[(size_t)0] != '\0')
 746     {
 747         gtk_accelerator_parse( (const char*) oldbuf, &accel_key, &accel_mods);
 748         if (accel_key != 0)
 749         {
 750             gtk_widget_remove_accelerator(m_menuItem,
 751                                         m_parentMenu->m_accel,
 752                                         accel_key,
 753                                         accel_mods );
 754         }
 755     }
 756     else if (isstock)
 757     {
 758         // if the accelerator was taken from a stock ID, just get it back from GTK+ stock
 759         if (wxGetStockGtkAccelerator(stockid, &accel_mods, &accel_key))
 760             gtk_widget_remove_accelerator( m_menuItem,
 761                                            m_parentMenu->m_accel,
 762                                            accel_key,
 763                                            accel_mods );
 764     }
 765
 766     // add new accelerator to our parent's accelerator group
 767     wxCharBuffer buf = wxGTK_CONV_SYS( GetGtkHotKey(*this) );
 768     if (buf[(size_t)0] != '\0')
 769     {
 770         gtk_accelerator_parse( (const char*) buf, &accel_key, &accel_mods);
 771         if (accel_key != 0)
 772         {
 773             gtk_widget_add_accelerator( m_menuItem,
 774                                         "activate",
 775                                         m_parentMenu->m_accel,
 776                                         accel_key,
 777                                         accel_mods,
 778                                         GTK_ACCEL_VISIBLE);
 779         }
 780     }
 781     else if (isstock)
 782     {
 783         // if the accelerator was taken from a stock ID, just get it back from GTK+ stock
 784         if (wxGetStockGtkAccelerator(stockid, &accel_mods, &accel_key))
 785             gtk_widget_remove_accelerator( m_menuItem,
 786                                            m_parentMenu->m_accel,
 787                                            accel_key,
 788                                            accel_mods );
 789     }
 790 #endif // wxUSE_ACCEL
 791 }
 792
 793 // NOTE: this function is different from the similar functions GTKProcessMnemonics()
 794 //       implemented in control.cpp and from wxMenuItemBase::GetLabelText...
 795 //       so there's no real code duplication
 796 wxString wxMenuItem::GTKProcessMenuItemLabel(const wxString& str, wxString *hotKey)
 797 {
 798     wxString text;
 799
 800     // '\t' is the deliminator indicating a hot key
 801     wxString::const_iterator pc = str.begin();
 802     while ( pc != str.end() && *pc != wxT('\t') )
 803     {
 804         if (*pc == wxT('&'))
 805         {
 806             wxString::const_iterator next = pc + 1;
 807             if (next != str.end() && *next == wxT('&'))
 808             {
 809                 // "&" is doubled to indicate "&" instead of accelerator
 810                 ++pc;
 811                 text << wxT('&');
 812             }
 813             else
 814             {
 815                 text << wxT('_');
 816             }
 817         }
 818         else if ( *pc == wxT('_') )    // escape underscores
 819         {
 820             text << wxT("__");
 821         }
 822         else
 823         {
 824             text << *pc;
 825         }
 826         ++pc;
 827     }
 828
 829     if (hotKey)
 830     {
 831         hotKey->Empty();
 832         if(*pc == wxT('\t'))
 833         {
 834             ++pc;
 835             hotKey->assign(pc, str.end());
 836         }
 837     }
 838
 839     return text;
 840 }
 841
 842 // it's valid for this function to be called even if m_menuItem == NULL
 843 void wxMenuItem::DoSetText( const wxString& str )
 844 {
 845     m_text.Empty();
 846     m_text = GTKProcessMenuItemLabel(str, &m_hotKey);
 847 }
 848
 849 #if wxUSE_ACCEL
 850
 851 wxAcceleratorEntry *wxMenuItem::GetAccel() const
 852 {
 853     if ( !GetHotKey() )
 854     {
 855         // nothing
 856         return NULL;
 857     }
 858
 859     // accelerator parsing code looks for them after a TAB, so insert a dummy
 860     // one here
 861     wxString label;
 862     label << wxT('\t') << GetHotKey();
 863
 864     return wxAcceleratorEntry::Create(label);
 865 }
 866
 867 #endif // wxUSE_ACCEL
 868
 869 void wxMenuItem::Check( bool check )
 870 {
 871     wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
 872
 873     if (check == m_isChecked)
 874         return;
 875
 876     wxMenuItemBase::Check( check );
 877
 878     switch ( GetKind() )
 879     {
 880         case wxITEM_CHECK:
 881         case wxITEM_RADIO:
 882             gtk_check_menu_item_set_active( (GtkCheckMenuItem*)m_menuItem, (gint)check );
 883             break;
 884
 885         default:
 886             wxFAIL_MSG( _T("can't check this item") );
 887     }
 888 }
 889
 890 void wxMenuItem::Enable( bool enable )
 891 {
 892     wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
 893
 894     gtk_widget_set_sensitive( m_menuItem, enable );
 895     wxMenuItemBase::Enable( enable );
 896 }
 897
 898 bool wxMenuItem::IsChecked() const
 899 {
 900     wxCHECK_MSG( m_menuItem, false, wxT("invalid menu item") );
 901
 902     wxCHECK_MSG( IsCheckable(), false,
 903                  wxT("can't get state of uncheckable item!") );
 904
 905     return ((GtkCheckMenuItem*)m_menuItem)->active != 0;
 906 }
 907
 908 //-----------------------------------------------------------------------------
 909 // wxMenu
 910 //-----------------------------------------------------------------------------
 911
 912 extern "C" {
 913 // "map" from m_menu
 914 static void menu_map(GtkWidget*, wxMenu* menu)
 915 {
 916     wxMenuEvent event(wxEVT_MENU_OPEN, menu->m_popupShown ? -1 : 0, menu);
 917     DoCommonMenuCallbackCode(menu, event);
 918 }
 919
 920 // "hide" from m_menu
 921 static void menu_hide(GtkWidget*, wxMenu* menu)
 922 {
 923     wxMenuEvent event(wxEVT_MENU_CLOSE, menu->m_popupShown ? -1 : 0, menu);
 924     menu->m_popupShown = false;
 925     DoCommonMenuCallbackCode(menu, event);
 926 }
 927 }
 928
 929 IMPLEMENT_DYNAMIC_CLASS(wxMenu,wxEvtHandler)
 930
 931 void wxMenu::Init()
 932 {
 933     m_popupShown = false;
 934
 935     m_accel = gtk_accel_group_new();
 936     m_menu = gtk_menu_new();
 937     // NB: keep reference to the menu so that it is not destroyed behind
 938     //     our back by GTK+ e.g. when it is removed from menubar:
 939     g_object_ref(m_menu);
 940     gtk_object_sink(GTK_OBJECT(m_menu));
 941
 942     m_owner = (GtkWidget*) NULL;
 943
 944     // Tearoffs are entries, just like separators. So if we want this
 945     // menu to be a tear-off one, we just append a tearoff entry
 946     // immediately.
 947     if ( m_style & wxMENU_TEAROFF )
 948     {
 949         GtkWidget *tearoff = gtk_tearoff_menu_item_new();
 950
 951         gtk_menu_shell_append(GTK_MENU_SHELL(m_menu), tearoff);
 952     }
 953
 954     m_prevRadio = NULL;
 955
 956     // append the title as the very first entry if we have it
 957     if ( !m_title.empty() )
 958     {
 959         Append(wxGTK_TITLE_ID, m_title);
 960         AppendSeparator();
 961     }
 962
 963     // "show" occurs for sub-menus which are not showing, so use "map" instead
 964     g_signal_connect(m_menu, "map", G_CALLBACK(menu_map), this);
 965     g_signal_connect(m_menu, "hide", G_CALLBACK(menu_hide), this);
 966 }
 967
 968 wxMenu::~wxMenu()
 969 {
 970     // see wxMenu::Init
 971     g_object_unref(m_menu);
 972
 973     // if the menu is inserted in another menu at this time, there was
 974     // one more reference to it:
 975     if (m_owner)
 976        gtk_widget_destroy(m_menu);
 977
 978     g_object_unref(m_accel);
 979 }
 980
 981 void wxMenu::SetLayoutDirection(const wxLayoutDirection dir)
 982 {
 983     if ( m_owner )
 984         wxWindow::GTKSetLayout(m_owner, dir);
 985     //else: will be called later by wxMenuBar again
 986 }
 987
 988 wxLayoutDirection wxMenu::GetLayoutDirection() const
 989 {
 990     return wxWindow::GTKGetLayout(m_owner);
 991 }
 992
 993 bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
 994 {
 995     GtkWidget *menuItem;
 996
 997     // cache some data used later
 998     wxString text = mitem->wxMenuItemBase::GetItemLabel();
 999     int id = mitem->GetId();
1000     bool isstock = wxIsStockID(id);
1001     const char *stockid = NULL;
1002     if (isstock)
1003         stockid = wxGetStockGtkID(mitem->GetId());
1004
1005     // stock menu items can have an empty label
1006     if (text.IsEmpty() && !mitem->IsSeparator())
1007     {
1008         wxASSERT_MSG(isstock, wxT("A non-stock menu item with an empty label?"));
1009         text = wxGetStockLabel(id);
1010
1011         // need & => _ conversion
1012         text = wxMenuItem::GTKProcessMenuItemLabel(text, NULL);
1013     }
1014
1015     if ( mitem->IsSeparator() )
1016     {
1017         menuItem = gtk_separator_menu_item_new();
1018         m_prevRadio = NULL;
1019     }
1020     else if ( mitem->GetBitmap().Ok() ||
1021                 (mitem->GetKind() == wxITEM_NORMAL && isstock) )
1022     {
1023         wxBitmap bitmap(mitem->GetBitmap());
1024
1025         menuItem = gtk_image_menu_item_new_with_mnemonic( wxGTK_CONV_SYS( text ) );
1026
1027         GtkWidget *image;
1028         if ( !bitmap.Ok() )
1029         {
1030             // use stock bitmap for this item if available on the assumption
1031             // that it never hurts to follow GTK+ conventions more closely
1032             image = stockid ? gtk_image_new_from_stock(stockid, GTK_ICON_SIZE_MENU)
1033                             : NULL;
1034         }
1035         else // we have a custom bitmap
1036         {
1037             wxASSERT_MSG( mitem->GetKind() == wxITEM_NORMAL,
1038                             _T("only normal menu items can have bitmaps") );
1039
1040             if ( bitmap.HasPixbuf() )
1041             {
1042                 image = gtk_image_new_from_pixbuf(bitmap.GetPixbuf());
1043             }
1044             else
1045             {
1046                 GdkPixmap *gdk_pixmap = bitmap.GetPixmap();
1047                 GdkBitmap *gdk_bitmap = bitmap.GetMask() ?
1048                                             bitmap.GetMask()->GetBitmap() :
1049                                             (GdkBitmap*) NULL;
1050                 image = gtk_image_new_from_pixmap( gdk_pixmap, gdk_bitmap );
1051             }
1052         }
1053
1054         if ( image )
1055         {
1056             gtk_widget_show(image);
1057
1058             gtk_image_menu_item_set_image( GTK_IMAGE_MENU_ITEM(menuItem), image );
1059         }
1060
1061         m_prevRadio = NULL;
1062     }
1063     else // a normal item
1064     {
1065         // NB: 'text' variable has "_" instead of "&" after mitem->SetItemLabel()
1066         //     so don't use it
1067
1068         switch ( mitem->GetKind() )
1069         {
1070             case wxITEM_CHECK:
1071             {
1072                 menuItem = gtk_check_menu_item_new_with_mnemonic( wxGTK_CONV_SYS( text ) );
1073                 m_prevRadio = NULL;
1074                 break;
1075             }
1076
1077             case wxITEM_RADIO:
1078             {
1079                 GSList *group = NULL;
1080                 if ( m_prevRadio == NULL )
1081                 {
1082                     // start of a new radio group
1083                     m_prevRadio = menuItem =
1084                         gtk_radio_menu_item_new_with_mnemonic( group, wxGTK_CONV_SYS( text ) );
1085                 }
1086                 else // continue the radio group
1087                 {
1088                     group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (m_prevRadio));
1089                     m_prevRadio = menuItem =
1090                         gtk_radio_menu_item_new_with_mnemonic( group, wxGTK_CONV_SYS( text ) );
1091                 }
1092                 break;
1093             }
1094
1095             default:
1096                 wxFAIL_MSG( _T("unexpected menu item kind") );
1097                 // fall through
1098
1099             case wxITEM_NORMAL:
1100             {
1101                 menuItem = gtk_menu_item_new_with_mnemonic( wxGTK_CONV_SYS( text ) );
1102                 m_prevRadio = NULL;
1103                 break;
1104             }
1105         }
1106
1107     }
1108
1109 #if wxUSE_ACCEL
1110     guint accel_key;
1111     GdkModifierType accel_mods;
1112     wxCharBuffer buf = wxGTK_CONV_SYS( GetGtkHotKey(*mitem) );
1113
1114     if (buf[(size_t)0] != '\0')
1115     {
1116         gtk_accelerator_parse( (const char*) buf, &accel_key, &accel_mods);
1117         if (accel_key != 0)
1118         {
1119             gtk_widget_add_accelerator (menuItem,
1120                                         "activate",
1121                                         m_accel,
1122                                         accel_key,
1123                                         accel_mods,
1124                                         GTK_ACCEL_VISIBLE);
1125         }
1126     }
1127     else if (isstock)
1128     {
1129         // if the accelerator was taken from a stock ID, just get it back from GTK+ stock
1130         if (wxGetStockGtkAccelerator(stockid, &accel_mods, &accel_key))
1131             gtk_widget_add_accelerator( menuItem,
1132                                         "activate",
1133                                         m_accel,
1134                                         accel_key,
1135                                         accel_mods,
1136                                         GTK_ACCEL_VISIBLE);
1137     }
1138 #endif // wxUSE_ACCEL
1139
1140     if (pos == -1)
1141         gtk_menu_shell_append(GTK_MENU_SHELL(m_menu), menuItem);
1142     else
1143         gtk_menu_shell_insert(GTK_MENU_SHELL(m_menu), menuItem, pos);
1144
1145     gtk_widget_show( menuItem );
1146
1147     if ( !mitem->IsSeparator() )
1148     {
1149         wxASSERT_MSG( menuItem, wxT("invalid menuitem") );
1150
1151         g_signal_connect (menuItem, "select",
1152                           G_CALLBACK (gtk_menu_hilight_callback), this);
1153         g_signal_connect (menuItem, "deselect",
1154                           G_CALLBACK (gtk_menu_nolight_callback), this);
1155
1156         if ( mitem->IsSubMenu() && mitem->GetKind() != wxITEM_RADIO && mitem->GetKind() != wxITEM_CHECK )
1157         {
1158             gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem), mitem->GetSubMenu()->m_menu );
1159
1160             gtk_widget_show( mitem->GetSubMenu()->m_menu );
1161
1162             // if adding a submenu to a menu already existing in the menu bar, we
1163             // must set invoking window to allow processing events from this
1164             // submenu
1165             if ( m_invokingWindow )
1166                 wxMenubarSetInvokingWindow(mitem->GetSubMenu(), m_invokingWindow);
1167         }
1168         else
1169         {
1170             g_signal_connect (menuItem, "activate",
1171                               G_CALLBACK (gtk_menu_clicked_callback),
1172                               this);
1173         }
1174     }
1175
1176     mitem->SetMenuItem(menuItem);
1177
1178     if (ms_locked)
1179     {
1180         // This doesn't even exist!
1181         // gtk_widget_lock_accelerators(mitem->GetMenuItem());
1182     }
1183
1184     return true;
1185 }
1186
1187 wxMenuItem* wxMenu::DoAppend(wxMenuItem *mitem)
1188 {
1189     if (!GtkAppend(mitem))
1190         return NULL;
1191
1192     return wxMenuBase::DoAppend(mitem);
1193 }
1194
1195 wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item)
1196 {
1197     if ( !wxMenuBase::DoInsert(pos, item) )
1198         return NULL;
1199
1200     // TODO
1201     if ( !GtkAppend(item, (int)pos) )
1202         return NULL;
1203
1204     return item;
1205 }
1206
1207 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
1208 {
1209     if ( !wxMenuBase::DoRemove(item) )
1210         return NULL;
1211
1212     GtkWidget * const mitem = item->GetMenuItem();
1213     if ( m_prevRadio == mitem )
1214     {
1215         // deleting an item starts a new radio group (has to as we shouldn't
1216         // keep a deleted pointer anyhow)
1217         m_prevRadio = NULL;
1218     }
1219
1220     gtk_menu_item_set_submenu(GTK_MENU_ITEM(mitem), NULL);
1221     gtk_widget_destroy(mitem);
1222     item->SetMenuItem(NULL);
1223
1224     return item;
1225 }
1226
1227 int wxMenu::FindMenuIdByMenuItem( GtkWidget *menuItem ) const
1228 {
1229     wxMenuItemList::compatibility_iterator node = m_items.GetFirst();
1230     while (node)
1231     {
1232         wxMenuItem *item = node->GetData();
1233         if (item->GetMenuItem() == menuItem)
1234             return item->GetId();
1235         node = node->GetNext();
1236     }
1237
1238     return wxNOT_FOUND;
1239 }
1240
1241 void wxMenu::Attach(wxMenuBarBase *menubar)
1242 {
1243     wxMenuBase::Attach(menubar);
1244
1245     // inherit layout direction from menubar.
1246     SetLayoutDirection(menubar->GetLayoutDirection());
1247 }
1248
1249 // ----------------------------------------------------------------------------
1250 // helpers
1251 // ----------------------------------------------------------------------------
1252
1253 #if wxUSE_ACCEL
1254
1255 static wxString GetGtkHotKey( const wxMenuItem& item )
1256 {
1257     wxString hotkey;
1258
1259     wxAcceleratorEntry *accel = item.GetAccel();
1260     if ( accel )
1261     {
1262         int flags = accel->GetFlags();
1263         if ( flags & wxACCEL_ALT )
1264             hotkey += wxT("<alt>");
1265         if ( flags & wxACCEL_CTRL )
1266             hotkey += wxT("<control>");
1267         if ( flags & wxACCEL_SHIFT )
1268             hotkey += wxT("<shift>");
1269
1270         int code = accel->GetKeyCode();
1271         switch ( code )
1272         {
1273             case WXK_F1:
1274             case WXK_F2:
1275             case WXK_F3:
1276             case WXK_F4:
1277             case WXK_F5:
1278             case WXK_F6:
1279             case WXK_F7:
1280             case WXK_F8:
1281             case WXK_F9:
1282             case WXK_F10:
1283             case WXK_F11:
1284             case WXK_F12:
1285             case WXK_F13:
1286             case WXK_F14:
1287             case WXK_F15:
1288             case WXK_F16:
1289             case WXK_F17:
1290             case WXK_F18:
1291             case WXK_F19:
1292             case WXK_F20:
1293             case WXK_F21:
1294             case WXK_F22:
1295             case WXK_F23:
1296             case WXK_F24:
1297                 hotkey += wxString::Format(wxT("F%d"), code - WXK_F1 + 1);
1298                 break;
1299
1300                 // TODO: we should use gdk_keyval_name() (a.k.a.
1301                 //       XKeysymToString) here as well as hardcoding the keysym
1302                 //       names this might be not portable
1303            case WXK_INSERT:
1304                 hotkey << wxT("Insert" );
1305                 break;
1306             case WXK_DELETE:
1307                 hotkey << wxT("Delete" );
1308                 break;
1309             case WXK_UP:
1310                 hotkey << wxT("Up" );
1311                 break;
1312             case WXK_DOWN:
1313                 hotkey << wxT("Down" );
1314                 break;
1315             case WXK_PAGEUP:
1316                 hotkey << wxT("Page_Up" );
1317                 break;
1318             case WXK_PAGEDOWN:
1319                 hotkey << wxT("Page_Down" );
1320                 break;
1321             case WXK_LEFT:
1322                 hotkey << wxT("Left" );
1323                 break;
1324             case WXK_RIGHT:
1325                 hotkey << wxT("Right" );
1326                 break;
1327             case WXK_HOME:
1328                 hotkey << wxT("Home" );
1329                 break;
1330             case WXK_END:
1331                 hotkey << wxT("End" );
1332                 break;
1333             case WXK_RETURN:
1334                 hotkey << wxT("Return" );
1335                 break;
1336             case WXK_BACK:
1337                 hotkey << wxT("BackSpace" );
1338                 break;
1339             case WXK_TAB:
1340                 hotkey << wxT("Tab" );
1341                 break;
1342             case WXK_ESCAPE:
1343                 hotkey << wxT("Esc" );
1344                 break;
1345             case WXK_SPACE:
1346                 hotkey << wxT("space" );
1347                 break;
1348             case WXK_MULTIPLY:
1349                 hotkey << wxT("Multiply" );
1350                 break;
1351             case WXK_ADD:
1352                 hotkey << wxT("Add" );
1353                 break;
1354             case WXK_SEPARATOR:
1355                 hotkey << wxT("Separator" );
1356                 break;
1357             case WXK_SUBTRACT:
1358                 hotkey << wxT("Subtract" );
1359                 break;
1360             case WXK_DECIMAL:
1361                 hotkey << wxT("Decimal" );
1362                 break;
1363             case WXK_DIVIDE:
1364                 hotkey << wxT("Divide" );
1365                 break;
1366             case WXK_CANCEL:
1367                 hotkey << wxT("Cancel" );
1368                 break;
1369             case WXK_CLEAR:
1370                 hotkey << wxT("Clear" );
1371                 break;
1372             case WXK_MENU:
1373                 hotkey << wxT("Menu" );
1374                 break;
1375             case WXK_PAUSE:
1376                 hotkey << wxT("Pause" );
1377                 break;
1378             case WXK_CAPITAL:
1379                 hotkey << wxT("Capital" );
1380                 break;
1381             case WXK_SELECT:
1382                 hotkey << wxT("Select" );
1383                 break;
1384             case WXK_PRINT:
1385                 hotkey << wxT("Print" );
1386                 break;
1387             case WXK_EXECUTE:
1388                 hotkey << wxT("Execute" );
1389                 break;
1390             case WXK_SNAPSHOT:
1391                 hotkey << wxT("Snapshot" );
1392                 break;
1393             case WXK_HELP:
1394                 hotkey << wxT("Help" );
1395                 break;
1396             case WXK_NUMLOCK:
1397                 hotkey << wxT("Num_Lock" );
1398                 break;
1399             case WXK_SCROLL:
1400                 hotkey << wxT("Scroll_Lock" );
1401                 break;
1402             case WXK_NUMPAD_INSERT:
1403                 hotkey << wxT("KP_Insert" );
1404                 break;
1405             case WXK_NUMPAD_DELETE:
1406                 hotkey << wxT("KP_Delete" );
1407                 break;
1408              case WXK_NUMPAD_SPACE:
1409                 hotkey << wxT("KP_Space" );
1410                 break;
1411             case WXK_NUMPAD_TAB:
1412                 hotkey << wxT("KP_Tab" );
1413                 break;
1414             case WXK_NUMPAD_ENTER:
1415                 hotkey << wxT("KP_Enter" );
1416                 break;
1417             case WXK_NUMPAD_F1: case WXK_NUMPAD_F2: case WXK_NUMPAD_F3:
1418             case WXK_NUMPAD_F4:
1419                 hotkey += wxString::Format(wxT("KP_F%d"), code - WXK_NUMPAD_F1 + 1);
1420                 break;
1421             case WXK_NUMPAD_HOME:
1422                 hotkey << wxT("KP_Home" );
1423                 break;
1424             case WXK_NUMPAD_LEFT:
1425                 hotkey << wxT("KP_Left" );
1426                 break;
1427              case WXK_NUMPAD_UP:
1428                 hotkey << wxT("KP_Up" );
1429                 break;
1430             case WXK_NUMPAD_RIGHT:
1431                 hotkey << wxT("KP_Right" );
1432                 break;
1433             case WXK_NUMPAD_DOWN:
1434                 hotkey << wxT("KP_Down" );
1435                 break;
1436             case WXK_NUMPAD_PAGEUP:
1437                 hotkey << wxT("KP_Page_Up" );
1438                 break;
1439             case WXK_NUMPAD_PAGEDOWN:
1440                 hotkey << wxT("KP_Page_Down" );
1441                 break;
1442             case WXK_NUMPAD_END:
1443                 hotkey << wxT("KP_End" );
1444                 break;
1445             case WXK_NUMPAD_BEGIN:
1446                 hotkey << wxT("KP_Begin" );
1447                 break;
1448             case WXK_NUMPAD_EQUAL:
1449                 hotkey << wxT("KP_Equal" );
1450                 break;
1451             case WXK_NUMPAD_MULTIPLY:
1452                 hotkey << wxT("KP_Multiply" );
1453                 break;
1454             case WXK_NUMPAD_ADD:
1455                 hotkey << wxT("KP_Add" );
1456                 break;
1457             case WXK_NUMPAD_SEPARATOR:
1458                 hotkey << wxT("KP_Separator" );
1459                 break;
1460             case WXK_NUMPAD_SUBTRACT:
1461                 hotkey << wxT("KP_Subtract" );
1462                 break;
1463             case WXK_NUMPAD_DECIMAL:
1464                 hotkey << wxT("KP_Decimal" );
1465                 break;
1466             case WXK_NUMPAD_DIVIDE:
1467                 hotkey << wxT("KP_Divide" );
1468                 break;
1469            case WXK_NUMPAD0: case WXK_NUMPAD1: case WXK_NUMPAD2:
1470            case WXK_NUMPAD3: case WXK_NUMPAD4: case WXK_NUMPAD5:
1471            case WXK_NUMPAD6: case WXK_NUMPAD7: case WXK_NUMPAD8: case WXK_NUMPAD9:
1472                 hotkey += wxString::Format(wxT("KP_%d"), code - WXK_NUMPAD0);
1473                 break;
1474             case WXK_WINDOWS_LEFT:
1475                 hotkey << wxT("Super_L" );
1476                 break;
1477             case WXK_WINDOWS_RIGHT:
1478                 hotkey << wxT("Super_R" );
1479                 break;
1480             case WXK_WINDOWS_MENU:
1481                 hotkey << wxT("Menu" );
1482                 break;
1483             case WXK_COMMAND:
1484                 hotkey << wxT("Command" );
1485                 break;
1486           /* These probably wouldn't work as there is no SpecialX in gdk/keynames.txt
1487             case WXK_SPECIAL1: case WXK_SPECIAL2: case WXK_SPECIAL3: case WXK_SPECIAL4:
1488             case WXK_SPECIAL5: case WXK_SPECIAL6: case WXK_SPECIAL7: case WXK_SPECIAL8:
1489             case WXK_SPECIAL9:  case WXK_SPECIAL10:  case WXK_SPECIAL11: case WXK_SPECIAL12:
1490             case WXK_SPECIAL13: case WXK_SPECIAL14: case WXK_SPECIAL15: case WXK_SPECIAL16:
1491             case WXK_SPECIAL17: case WXK_SPECIAL18: case WXK_SPECIAL19:  case WXK_SPECIAL20:
1492                 hotkey += wxString::Format(wxT("Special%d"), code - WXK_SPECIAL1 + 1);
1493                 break;
1494           */
1495                 // if there are any other keys wxAcceleratorEntry::Create() may
1496                 // return, we should process them here
1497
1498             default:
1499                 if ( code < 127 )
1500                 {
1501                     const wxString
1502                         name = wxGTK_CONV_BACK_SYS(gdk_keyval_name((guint)code));
1503                     if ( !name.empty() )
1504                     {
1505                         hotkey << name;
1506                         break;
1507                     }
1508                 }
1509
1510                 wxFAIL_MSG( wxT("unknown keyboard accel") );
1511         }
1512
1513         delete accel;
1514     }
1515
1516     return hotkey;
1517 }
1518
1519 #endif // wxUSE_ACCEL
1520
1521 const char *wxGetStockGtkID(wxWindowID id)
1522 {
1523     #define STOCKITEM(wx,gtk)      \
1524         case wx:                   \
1525             return gtk;
1526
1527     #define STOCKITEM_MISSING(wx)  \
1528         case wx:                 \
1529             return NULL;
1530
1531     #if GTK_CHECK_VERSION(2,4,0)
1532         #define STOCKITEM_24(wx,gtk) STOCKITEM(wx,gtk)
1533     #else
1534         #define STOCKITEM_24(wx,gtk) STOCKITEM_MISSING(wx)
1535     #endif
1536
1537     #if GTK_CHECK_VERSION(2,6,0)
1538         #define STOCKITEM_26(wx,gtk) STOCKITEM(wx,gtk)
1539     #else
1540         #define STOCKITEM_26(wx,gtk) STOCKITEM_MISSING(wx)
1541     #endif
1542
1543     #if GTK_CHECK_VERSION(2,10,0)
1544         #define STOCKITEM_210(wx,gtk) STOCKITEM(wx,gtk)
1545     #else
1546         #define STOCKITEM_210(wx,gtk) STOCKITEM_MISSING(wx)
1547     #endif
1548
1549
1550     switch (id)
1551     {
1552         STOCKITEM_26(wxID_ABOUT,         GTK_STOCK_ABOUT)
1553         STOCKITEM(wxID_ADD,              GTK_STOCK_ADD)
1554         STOCKITEM(wxID_APPLY,            GTK_STOCK_APPLY)
1555         STOCKITEM(wxID_BOLD,             GTK_STOCK_BOLD)
1556         STOCKITEM(wxID_CANCEL,           GTK_STOCK_CANCEL)
1557         STOCKITEM(wxID_CLEAR,            GTK_STOCK_CLEAR)
1558         STOCKITEM(wxID_CLOSE,            GTK_STOCK_CLOSE)
1559         STOCKITEM(wxID_COPY,             GTK_STOCK_COPY)
1560         STOCKITEM(wxID_CUT,              GTK_STOCK_CUT)
1561         STOCKITEM(wxID_DELETE,           GTK_STOCK_DELETE)
1562         STOCKITEM_26(wxID_EDIT,          GTK_STOCK_EDIT)
1563         STOCKITEM(wxID_FIND,             GTK_STOCK_FIND)
1564         STOCKITEM_26(wxID_FILE,          GTK_STOCK_FILE)
1565         STOCKITEM(wxID_REPLACE,          GTK_STOCK_FIND_AND_REPLACE)
1566         STOCKITEM(wxID_BACKWARD,         GTK_STOCK_GO_BACK)
1567         STOCKITEM(wxID_DOWN,             GTK_STOCK_GO_DOWN)
1568         STOCKITEM(wxID_FORWARD,          GTK_STOCK_GO_FORWARD)
1569         STOCKITEM(wxID_UP,               GTK_STOCK_GO_UP)
1570         STOCKITEM(wxID_HELP,             GTK_STOCK_HELP)
1571         STOCKITEM(wxID_HOME,             GTK_STOCK_HOME)
1572         STOCKITEM_24(wxID_INDENT,        GTK_STOCK_INDENT)
1573         STOCKITEM(wxID_INDEX,            GTK_STOCK_INDEX)
1574         STOCKITEM(wxID_ITALIC,           GTK_STOCK_ITALIC)
1575         STOCKITEM(wxID_JUSTIFY_CENTER,   GTK_STOCK_JUSTIFY_CENTER)
1576         STOCKITEM(wxID_JUSTIFY_FILL,     GTK_STOCK_JUSTIFY_FILL)
1577         STOCKITEM(wxID_JUSTIFY_LEFT,     GTK_STOCK_JUSTIFY_LEFT)
1578         STOCKITEM(wxID_JUSTIFY_RIGHT,    GTK_STOCK_JUSTIFY_RIGHT)
1579         STOCKITEM(wxID_NEW,              GTK_STOCK_NEW)
1580         STOCKITEM(wxID_NO,               GTK_STOCK_NO)
1581         STOCKITEM(wxID_OK,               GTK_STOCK_OK)
1582         STOCKITEM(wxID_OPEN,             GTK_STOCK_OPEN)
1583         STOCKITEM(wxID_PASTE,            GTK_STOCK_PASTE)
1584         STOCKITEM(wxID_PREFERENCES,      GTK_STOCK_PREFERENCES)
1585         STOCKITEM(wxID_PRINT,            GTK_STOCK_PRINT)
1586         STOCKITEM(wxID_PREVIEW,          GTK_STOCK_PRINT_PREVIEW)
1587         STOCKITEM(wxID_PROPERTIES,       GTK_STOCK_PROPERTIES)
1588         STOCKITEM(wxID_EXIT,             GTK_STOCK_QUIT)
1589         STOCKITEM(wxID_REDO,             GTK_STOCK_REDO)
1590         STOCKITEM(wxID_REFRESH,          GTK_STOCK_REFRESH)
1591         STOCKITEM(wxID_REMOVE,           GTK_STOCK_REMOVE)
1592         STOCKITEM(wxID_REVERT_TO_SAVED,  GTK_STOCK_REVERT_TO_SAVED)
1593         STOCKITEM(wxID_SAVE,             GTK_STOCK_SAVE)
1594         STOCKITEM(wxID_SAVEAS,           GTK_STOCK_SAVE_AS)
1595         STOCKITEM_210(wxID_SELECTALL,    GTK_STOCK_SELECT_ALL)
1596         STOCKITEM(wxID_STOP,             GTK_STOCK_STOP)
1597         STOCKITEM(wxID_UNDELETE,         GTK_STOCK_UNDELETE)
1598         STOCKITEM(wxID_UNDERLINE,        GTK_STOCK_UNDERLINE)
1599         STOCKITEM(wxID_UNDO,             GTK_STOCK_UNDO)
1600         STOCKITEM_24(wxID_UNINDENT,      GTK_STOCK_UNINDENT)
1601         STOCKITEM(wxID_YES,              GTK_STOCK_YES)
1602         STOCKITEM(wxID_ZOOM_100,         GTK_STOCK_ZOOM_100)
1603         STOCKITEM(wxID_ZOOM_FIT,         GTK_STOCK_ZOOM_FIT)
1604         STOCKITEM(wxID_ZOOM_IN,          GTK_STOCK_ZOOM_IN)
1605         STOCKITEM(wxID_ZOOM_OUT,         GTK_STOCK_ZOOM_OUT)
1606
1607         default:
1608             wxFAIL_MSG( _T("invalid stock item ID") );
1609             break;
1610     };
1611
1612     #undef STOCKITEM
1613
1614     return NULL;
1615 }
1616
1617 #if wxUSE_ACCEL
1618 static
1619 bool wxGetStockGtkAccelerator(const char *id, GdkModifierType *mod, guint *key)
1620 {
1621     if (!id)
1622         return false;
1623
1624     GtkStockItem stock_item;
1625     if (gtk_stock_lookup (id, &stock_item))
1626     {
1627         if (key) *key = stock_item.keyval;
1628         if (mod) *mod = stock_item.modifier;
1629
1630         // some GTK stock items have zero values for the keyval;
1631         // it means that they do not have an accelerator...
1632         if (stock_item.keyval)
1633             return true;
1634     }
1635
1636     return false;
1637 }
1638 #endif // wxUSE_ACCEL
1639
1640 #endif // wxUSE_MENUS