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 menuitem_activate(GtkWidget*, wxMenuItem* item);
  37 }
  38
  39 #if wxUSE_ACCEL
  40 static void wxGetGtkAccel(const wxMenuItem*, guint*, GdkModifierType*);
  41 #endif
  42
  43 static void DoCommonMenuCallbackCode(wxMenu *menu, wxMenuEvent& event)
  44 {
  45     event.SetEventObject( menu );
  46
  47     wxEvtHandler* handler = menu->GetEventHandler();
  48     if (handler && handler->SafelyProcessEvent(event))
  49         return;
  50
  51     wxWindow *win = menu->GetInvokingWindow();
  52     if (win)
  53         win->HandleWindowEvent( event );
  54 }
  55
  56 //-----------------------------------------------------------------------------
  57 // wxMenuBar
  58 //-----------------------------------------------------------------------------
  59
  60 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar,wxWindow)
  61
  62 void wxMenuBar::Init(size_t n, wxMenu *menus[], const wxString titles[], long style)
  63 {
  64     m_invokingWindow = NULL;
  65
  66 #if wxUSE_LIBHILDON
  67     // Hildon window uses a single menu instead of a menu bar, so wxMenuBar is
  68     // the same as menu in this case
  69     m_widget =
  70     m_menubar = gtk_menu_new();
  71 #else // !wxUSE_LIBHILDON
  72     if (!PreCreation( NULL, wxDefaultPosition, wxDefaultSize ) ||
  73         !CreateBase( NULL, -1, wxDefaultPosition, wxDefaultSize, style, wxDefaultValidator, wxT("menubar") ))
  74     {
  75         wxFAIL_MSG( wxT("wxMenuBar creation failed") );
  76         return;
  77     }
  78
  79     m_menubar = gtk_menu_bar_new();
  80
  81     if (style & wxMB_DOCKABLE)
  82     {
  83         m_widget = gtk_handle_box_new();
  84         gtk_container_add(GTK_CONTAINER(m_widget), m_menubar);
  85         gtk_widget_show(m_menubar);
  86     }
  87     else
  88     {
  89         m_widget = m_menubar;
  90     }
  91
  92     PostCreation();
  93
  94     ApplyWidgetStyle();
  95 #endif // wxUSE_LIBHILDON/!wxUSE_LIBHILDON
  96
  97     for (size_t i = 0; i < n; ++i )
  98         Append(menus[i], titles[i]);
  99 }
 100
 101 wxMenuBar::wxMenuBar(size_t n, wxMenu *menus[], const wxString titles[], long style)
 102 {
 103     Init(n, menus, titles, style);
 104 }
 105
 106 wxMenuBar::wxMenuBar(long style)
 107 {
 108     Init(0, NULL, NULL, style);
 109 }
 110
 111 wxMenuBar::wxMenuBar()
 112 {
 113     Init(0, NULL, NULL, 0);
 114 }
 115
 116 wxMenuBar::~wxMenuBar()
 117 {
 118 }
 119
 120 static void
 121 wxMenubarUnsetInvokingWindow(wxMenu* menu, wxWindow* win, GtkWindow* tlw = NULL)
 122 {
 123     menu->SetInvokingWindow( (wxWindow*) NULL );
 124
 125     // support for native hot keys
 126     if (menu->m_accel)
 127     {
 128         if (tlw == NULL)
 129             tlw = GTK_WINDOW(wxGetTopLevelParent(win)->m_widget);
 130         if (g_slist_find(menu->m_accel->acceleratables, tlw))
 131             gtk_window_remove_accel_group(tlw, menu->m_accel);
 132     }
 133
 134     wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
 135     while (node)
 136     {
 137         wxMenuItem *menuitem = node->GetData();
 138         if (menuitem->IsSubMenu())
 139             wxMenubarUnsetInvokingWindow(menuitem->GetSubMenu(), win, tlw);
 140         node = node->GetNext();
 141     }
 142 }
 143
 144 static void
 145 wxMenubarSetInvokingWindow(wxMenu* menu, wxWindow* win, GtkWindow* tlw = NULL)
 146 {
 147     menu->SetInvokingWindow( win );
 148
 149     // support for native hot keys
 150     if (menu->m_accel)
 151     {
 152         if (tlw == NULL)
 153             tlw = GTK_WINDOW(wxGetTopLevelParent(win)->m_widget);
 154         if (!g_slist_find(menu->m_accel->acceleratables, tlw))
 155             gtk_window_add_accel_group(tlw, menu->m_accel);
 156     }
 157
 158     wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
 159     while (node)
 160     {
 161         wxMenuItem *menuitem = node->GetData();
 162         if (menuitem->IsSubMenu())
 163             wxMenubarSetInvokingWindow(menuitem->GetSubMenu(), win, tlw);
 164         node = node->GetNext();
 165     }
 166 }
 167
 168 void wxMenuBar::SetInvokingWindow( wxWindow *win )
 169 {
 170     m_invokingWindow = win;
 171
 172     wxMenuList::compatibility_iterator node = m_menus.GetFirst();
 173     while (node)
 174     {
 175         wxMenu *menu = node->GetData();
 176         wxMenubarSetInvokingWindow( menu, win );
 177         node = node->GetNext();
 178     }
 179 }
 180
 181 void wxMenuBar::SetLayoutDirection(wxLayoutDirection dir)
 182 {
 183     if ( dir == wxLayout_Default )
 184     {
 185         const wxWindow *const frame = GetFrame();
 186         if ( frame )
 187         {
 188             // inherit layout from frame.
 189             dir = frame->GetLayoutDirection();
 190         }
 191         else // use global layout
 192         {
 193             dir = wxTheApp->GetLayoutDirection();
 194         }
 195     }
 196
 197     if ( dir == wxLayout_Default )
 198         return;
 199
 200     GTKSetLayout(m_menubar, dir);
 201
 202     // also set the layout of all menus we already have (new ones will inherit
 203     // the current layout)
 204     for ( wxMenuList::compatibility_iterator node = m_menus.GetFirst();
 205           node;
 206           node = node->GetNext() )
 207     {
 208         wxMenu *const menu = node->GetData();
 209         menu->SetLayoutDirection(dir);
 210     }
 211 }
 212
 213 wxLayoutDirection wxMenuBar::GetLayoutDirection() const
 214 {
 215     return GTKGetLayout(m_menubar);
 216 }
 217
 218 void wxMenuBar::Attach(wxFrame *frame)
 219 {
 220     wxMenuBarBase::Attach(frame);
 221
 222     SetLayoutDirection(wxLayout_Default);
 223 }
 224
 225 void wxMenuBar::UnsetInvokingWindow( wxWindow *win )
 226 {
 227     m_invokingWindow = (wxWindow*) NULL;
 228
 229     wxMenuList::compatibility_iterator node = m_menus.GetFirst();
 230     while (node)
 231     {
 232         wxMenu *menu = node->GetData();
 233         wxMenubarUnsetInvokingWindow( menu, win );
 234         node = node->GetNext();
 235     }
 236 }
 237
 238 bool wxMenuBar::Append( wxMenu *menu, const wxString &title )
 239 {
 240     if ( !wxMenuBarBase::Append( menu, title ) )
 241         return false;
 242
 243     return GtkAppend(menu, title);
 244 }
 245
 246 bool wxMenuBar::GtkAppend(wxMenu *menu, const wxString& title, int pos)
 247 {
 248     menu->SetLayoutDirection(GetLayoutDirection());
 249
 250 #if wxUSE_LIBHILDON
 251     // if the menu has only one item, append it directly to the top level menu
 252     // instead of inserting a useless submenu
 253     if ( menu->GetMenuItemCount() == 1 )
 254     {
 255         wxMenuItem * const item = menu->FindItemByPosition(0);
 256
 257         // remove both mnemonics and accelerator: neither is useful under Maemo
 258         const wxString str(wxStripMenuCodes(item->GetItemLabel()));
 259
 260         if ( item->IsSubMenu() )
 261             return GtkAppend(item->GetSubMenu(), str, pos);
 262
 263         menu->m_owner = gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str ) );
 264
 265         g_signal_connect(menu->m_owner, "activate",
 266                          G_CALLBACK(menuitem_activate), item);
 267         item->SetMenuItem(menu->m_owner);
 268     }
 269     else
 270 #endif // wxUSE_LIBHILDON/!wxUSE_LIBHILDON
 271     {
 272         const wxString str(wxConvertMnemonicsToGTK(title));
 273
 274         // This doesn't have much effect right now.
 275         menu->SetTitle( str );
 276
 277         // The "m_owner" is the "menu item"
 278         menu->m_owner = gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str ) );
 279
 280         gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
 281     }
 282
 283     gtk_widget_show( menu->m_owner );
 284
 285     if (pos == -1)
 286         gtk_menu_shell_append( GTK_MENU_SHELL(m_menubar), menu->m_owner );
 287     else
 288         gtk_menu_shell_insert( GTK_MENU_SHELL(m_menubar), menu->m_owner, pos );
 289
 290     // m_invokingWindow is set after wxFrame::SetMenuBar(). This call enables
 291     // addings menu later on.
 292     if (m_invokingWindow)
 293         wxMenubarSetInvokingWindow( menu, m_invokingWindow );
 294
 295     return true;
 296 }
 297
 298 bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
 299 {
 300     if ( !wxMenuBarBase::Insert(pos, menu, title) )
 301         return false;
 302
 303     // TODO
 304
 305     if ( !GtkAppend(menu, title, (int)pos) )
 306         return false;
 307
 308     return true;
 309 }
 310
 311 wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
 312 {
 313     // remove the old item and insert a new one
 314     wxMenu *menuOld = Remove(pos);
 315     if ( menuOld && !Insert(pos, menu, title) )
 316     {
 317         return (wxMenu*) NULL;
 318     }
 319
 320     // either Insert() succeeded or Remove() failed and menuOld is NULL
 321     return menuOld;
 322 }
 323
 324 wxMenu *wxMenuBar::Remove(size_t pos)
 325 {
 326     wxMenu *menu = wxMenuBarBase::Remove(pos);
 327     if ( !menu )
 328         return (wxMenu*) NULL;
 329
 330     gtk_menu_item_set_submenu(GTK_MENU_ITEM(menu->m_owner), NULL);
 331     gtk_container_remove(GTK_CONTAINER(m_menubar), menu->m_owner);
 332
 333     gtk_widget_destroy( menu->m_owner );
 334     menu->m_owner = NULL;
 335
 336     if (m_invokingWindow)
 337         wxMenubarUnsetInvokingWindow( menu, m_invokingWindow );
 338
 339     return menu;
 340 }
 341
 342 static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString, const wxString &itemString )
 343 {
 344     if (wxMenuItem::GetLabelText(wxConvertMnemonicsFromGTK(menu->GetTitle())) == wxMenuItem::GetLabelText(menuString))
 345     {
 346         int res = menu->FindItem( itemString );
 347         if (res != wxNOT_FOUND)
 348             return res;
 349     }
 350
 351     wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
 352     while (node)
 353     {
 354         wxMenuItem *item = node->GetData();
 355         if (item->IsSubMenu())
 356             return FindMenuItemRecursive(item->GetSubMenu(), menuString, itemString);
 357
 358         node = node->GetNext();
 359     }
 360
 361     return wxNOT_FOUND;
 362 }
 363
 364 int wxMenuBar::FindMenuItem( const wxString &menuString, const wxString &itemString ) const
 365 {
 366     wxMenuList::compatibility_iterator node = m_menus.GetFirst();
 367     while (node)
 368     {
 369         wxMenu *menu = node->GetData();
 370         int res = FindMenuItemRecursive( menu, menuString, itemString);
 371         if (res != -1)
 372             return res;
 373         node = node->GetNext();
 374     }
 375
 376     return wxNOT_FOUND;
 377 }
 378
 379 // Find a wxMenuItem using its id. Recurses down into sub-menus
 380 static wxMenuItem* FindMenuItemByIdRecursive(const wxMenu* menu, int id)
 381 {
 382     wxMenuItem* result = menu->FindChildItem(id);
 383
 384     wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
 385     while ( node && result == NULL )
 386     {
 387         wxMenuItem *item = node->GetData();
 388         if (item->IsSubMenu())
 389         {
 390             result = FindMenuItemByIdRecursive( item->GetSubMenu(), id );
 391         }
 392         node = node->GetNext();
 393     }
 394
 395     return result;
 396 }
 397
 398 wxMenuItem* wxMenuBar::FindItem( int id, wxMenu **menuForItem ) const
 399 {
 400     wxMenuItem* result = 0;
 401     wxMenuList::compatibility_iterator node = m_menus.GetFirst();
 402     while (node && result == 0)
 403     {
 404         wxMenu *menu = node->GetData();
 405         result = FindMenuItemByIdRecursive( menu, id );
 406         node = node->GetNext();
 407     }
 408
 409     if ( menuForItem )
 410     {
 411         *menuForItem = result ? result->GetMenu() : (wxMenu *)NULL;
 412     }
 413
 414     return result;
 415 }
 416
 417 void wxMenuBar::EnableTop( size_t pos, bool flag )
 418 {
 419     wxMenuList::compatibility_iterator node = m_menus.Item( pos );
 420
 421     wxCHECK_RET( node, wxT("menu not found") );
 422
 423     wxMenu* menu = node->GetData();
 424
 425     if (menu->m_owner)
 426         gtk_widget_set_sensitive( menu->m_owner, flag );
 427 }
 428
 429 wxString wxMenuBar::GetMenuLabel( size_t pos ) const
 430 {
 431     wxMenuList::compatibility_iterator node = m_menus.Item( pos );
 432
 433     wxCHECK_MSG( node, wxT("invalid"), wxT("menu not found") );
 434
 435     wxMenu* menu = node->GetData();
 436
 437     return wxConvertMnemonicsFromGTK(menu->GetTitle());
 438 }
 439
 440 void wxMenuBar::SetMenuLabel( size_t pos, const wxString& label )
 441 {
 442     wxMenuList::compatibility_iterator node = m_menus.Item( pos );
 443
 444     wxCHECK_RET( node, wxT("menu not found") );
 445
 446     wxMenu* menu = node->GetData();
 447
 448     const wxString str(wxConvertMnemonicsToGTK(label));
 449
 450     menu->SetTitle( str );
 451
 452     if (menu->m_owner)
 453         gtk_label_set_text_with_mnemonic( GTK_LABEL( GTK_BIN(menu->m_owner)->child), wxGTK_CONV(str) );
 454 }
 455
 456 //-----------------------------------------------------------------------------
 457 // "activate"
 458 //-----------------------------------------------------------------------------
 459
 460 extern "C" {
 461 static void menuitem_activate(GtkWidget*, wxMenuItem* item)
 462 {
 463     if (!item->IsEnabled())
 464         return;
 465
 466     int id = item->GetId();
 467     if (id == wxGTK_TITLE_ID)
 468     {
 469         // ignore events from the menu title
 470         return;
 471     }
 472
 473     if (item->IsCheckable())
 474     {
 475         bool isReallyChecked = item->IsChecked(),
 476             isInternallyChecked = item->wxMenuItemBase::IsChecked();
 477
 478         // ensure that the internal state is always consistent with what is
 479         // shown on the screen
 480         item->wxMenuItemBase::Check(isReallyChecked);
 481
 482         // we must not report the events for the radio button going up nor the
 483         // events resulting from the calls to wxMenuItem::Check()
 484         if ( (item->GetKind() == wxITEM_RADIO && !isReallyChecked) ||
 485              (isInternallyChecked == isReallyChecked) )
 486         {
 487             return;
 488         }
 489     }
 490
 491     wxMenu* menu = item->GetMenu();
 492     menu->SendEvent(id, item->IsCheckable() ? item->IsChecked() : -1);
 493 }
 494 }
 495
 496 //-----------------------------------------------------------------------------
 497 // "select"
 498 //-----------------------------------------------------------------------------
 499
 500 extern "C" {
 501 static void menuitem_select(GtkWidget*, wxMenuItem* item)
 502 {
 503     if (!item->IsEnabled())
 504         return;
 505
 506     wxMenu* menu = item->GetMenu();
 507     wxMenuEvent event(wxEVT_MENU_HIGHLIGHT, item->GetId());
 508     event.SetEventObject( menu );
 509
 510     wxEvtHandler* handler = menu->GetEventHandler();
 511     if (handler && handler->SafelyProcessEvent(event))
 512         return;
 513
 514     wxWindow *win = menu->GetInvokingWindow();
 515     if (win) win->HandleWindowEvent( event );
 516 }
 517 }
 518
 519 //-----------------------------------------------------------------------------
 520 // "deselect"
 521 //-----------------------------------------------------------------------------
 522
 523 extern "C" {
 524 static void menuitem_deselect(GtkWidget*, wxMenuItem* item)
 525 {
 526     if (!item->IsEnabled())
 527         return;
 528
 529     wxMenu* menu = item->GetMenu();
 530     wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, -1 );
 531     event.SetEventObject( menu );
 532
 533     wxEvtHandler* handler = menu->GetEventHandler();
 534     if (handler && handler->SafelyProcessEvent(event))
 535         return;
 536
 537     wxWindow *win = menu->GetInvokingWindow();
 538     if (win)
 539         win->HandleWindowEvent( event );
 540 }
 541 }
 542
 543 //-----------------------------------------------------------------------------
 544 // wxMenuItem
 545 //-----------------------------------------------------------------------------
 546
 547 IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)
 548
 549 wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu,
 550                                 int id,
 551                                 const wxString& name,
 552                                 const wxString& help,
 553                                 wxItemKind kind,
 554                                 wxMenu *subMenu)
 555 {
 556     return new wxMenuItem(parentMenu, id, name, help, kind, subMenu);
 557 }
 558
 559 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
 560                        int id,
 561                        const wxString& text,
 562                        const wxString& help,
 563                        wxItemKind kind,
 564                        wxMenu *subMenu)
 565           : wxMenuItemBase(parentMenu, id, text, help, kind, subMenu)
 566 {
 567     m_menuItem = NULL;
 568 }
 569
 570 #if WXWIN_COMPATIBILITY_2_8
 571 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
 572                        int id,
 573                        const wxString& text,
 574                        const wxString& help,
 575                        bool isCheckable,
 576                        wxMenu *subMenu)
 577           : wxMenuItemBase(parentMenu, id, text, help,
 578                            isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu)
 579 {
 580     m_menuItem = NULL;
 581 }
 582 #endif
 583
 584 wxMenuItem::~wxMenuItem()
 585 {
 586    // don't delete menu items, the menus take care of that
 587 }
 588
 589 void wxMenuItem::SetItemLabel( const wxString& str )
 590 {
 591 #if wxUSE_ACCEL
 592     if (m_menuItem)
 593     {
 594         // remove old accelerator
 595         guint accel_key;
 596         GdkModifierType accel_mods;
 597         wxGetGtkAccel(this, &accel_key, &accel_mods);
 598         if (accel_key)
 599         {
 600             gtk_widget_remove_accelerator(
 601                 m_menuItem, m_parentMenu->m_accel, accel_key, accel_mods);
 602         }
 603     }
 604 #endif // wxUSE_ACCEL
 605     wxMenuItemBase::SetItemLabel(str);
 606     if (m_menuItem)
 607         SetGtkLabel();
 608 }
 609
 610 void wxMenuItem::SetGtkLabel()
 611 {
 612     const wxString text = wxConvertMnemonicsToGTK(m_text.BeforeFirst('\t'));
 613     GtkLabel* label = GTK_LABEL(GTK_BIN(m_menuItem)->child);
 614     gtk_label_set_text_with_mnemonic(label, wxGTK_CONV_SYS(text));
 615 #if wxUSE_ACCEL
 616     guint accel_key;
 617     GdkModifierType accel_mods;
 618     wxGetGtkAccel(this, &accel_key, &accel_mods);
 619     if (accel_key)
 620     {
 621         gtk_widget_add_accelerator(
 622             m_menuItem, "activate", m_parentMenu->m_accel,
 623             accel_key, accel_mods, GTK_ACCEL_VISIBLE);
 624     }
 625 #endif // wxUSE_ACCEL
 626 }
 627
 628 void wxMenuItem::SetBitmap(const wxBitmap& bitmap)
 629 {
 630     if (m_kind == wxITEM_NORMAL)
 631         m_bitmap = bitmap;
 632     else
 633         wxFAIL_MSG("only normal menu items can have bitmaps");
 634 }
 635
 636 void wxMenuItem::Check( bool check )
 637 {
 638     wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
 639
 640     if (check == m_isChecked)
 641         return;
 642
 643     wxMenuItemBase::Check( check );
 644
 645     switch ( GetKind() )
 646     {
 647         case wxITEM_CHECK:
 648         case wxITEM_RADIO:
 649             gtk_check_menu_item_set_active( (GtkCheckMenuItem*)m_menuItem, (gint)check );
 650             break;
 651
 652         default:
 653             wxFAIL_MSG( _T("can't check this item") );
 654     }
 655 }
 656
 657 void wxMenuItem::Enable( bool enable )
 658 {
 659     wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
 660
 661     gtk_widget_set_sensitive( m_menuItem, enable );
 662     wxMenuItemBase::Enable( enable );
 663 }
 664
 665 bool wxMenuItem::IsChecked() const
 666 {
 667     wxCHECK_MSG( m_menuItem, false, wxT("invalid menu item") );
 668
 669     wxCHECK_MSG( IsCheckable(), false,
 670                  wxT("can't get state of uncheckable item!") );
 671
 672     return ((GtkCheckMenuItem*)m_menuItem)->active != 0;
 673 }
 674
 675 //-----------------------------------------------------------------------------
 676 // wxMenu
 677 //-----------------------------------------------------------------------------
 678
 679 extern "C" {
 680 // "map" from m_menu
 681 static void menu_map(GtkWidget*, wxMenu* menu)
 682 {
 683     wxMenuEvent event(wxEVT_MENU_OPEN, menu->m_popupShown ? -1 : 0, menu);
 684     DoCommonMenuCallbackCode(menu, event);
 685 }
 686
 687 // "hide" from m_menu
 688 static void menu_hide(GtkWidget*, wxMenu* menu)
 689 {
 690     wxMenuEvent event(wxEVT_MENU_CLOSE, menu->m_popupShown ? -1 : 0, menu);
 691     menu->m_popupShown = false;
 692     DoCommonMenuCallbackCode(menu, event);
 693 }
 694 }
 695
 696 IMPLEMENT_DYNAMIC_CLASS(wxMenu,wxEvtHandler)
 697
 698 void wxMenu::Init()
 699 {
 700     m_popupShown = false;
 701
 702     m_accel = gtk_accel_group_new();
 703     m_menu = gtk_menu_new();
 704     // NB: keep reference to the menu so that it is not destroyed behind
 705     //     our back by GTK+ e.g. when it is removed from menubar:
 706     g_object_ref(m_menu);
 707     gtk_object_sink(GTK_OBJECT(m_menu));
 708
 709     m_owner = (GtkWidget*) NULL;
 710
 711     // Tearoffs are entries, just like separators. So if we want this
 712     // menu to be a tear-off one, we just append a tearoff entry
 713     // immediately.
 714     if ( m_style & wxMENU_TEAROFF )
 715     {
 716         GtkWidget *tearoff = gtk_tearoff_menu_item_new();
 717
 718         gtk_menu_shell_append(GTK_MENU_SHELL(m_menu), tearoff);
 719     }
 720
 721     m_prevRadio = NULL;
 722
 723     // append the title as the very first entry if we have it
 724     if ( !m_title.empty() )
 725     {
 726         Append(wxGTK_TITLE_ID, m_title);
 727         AppendSeparator();
 728     }
 729
 730     // "show" occurs for sub-menus which are not showing, so use "map" instead
 731     g_signal_connect(m_menu, "map", G_CALLBACK(menu_map), this);
 732     g_signal_connect(m_menu, "hide", G_CALLBACK(menu_hide), this);
 733 }
 734
 735 wxMenu::~wxMenu()
 736 {
 737     // see wxMenu::Init
 738     g_object_unref(m_menu);
 739
 740     // if the menu is inserted in another menu at this time, there was
 741     // one more reference to it:
 742     if (m_owner)
 743        gtk_widget_destroy(m_menu);
 744
 745     g_object_unref(m_accel);
 746 }
 747
 748 void wxMenu::SetLayoutDirection(const wxLayoutDirection dir)
 749 {
 750     if ( m_owner )
 751         wxWindow::GTKSetLayout(m_owner, dir);
 752     //else: will be called later by wxMenuBar again
 753 }
 754
 755 wxLayoutDirection wxMenu::GetLayoutDirection() const
 756 {
 757     return wxWindow::GTKGetLayout(m_owner);
 758 }
 759
 760 bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
 761 {
 762     GtkWidget *menuItem;
 763     GtkWidget* prevRadio = m_prevRadio;
 764     m_prevRadio = NULL;
 765     switch (mitem->GetKind())
 766     {
 767         case wxITEM_SEPARATOR:
 768             menuItem = gtk_separator_menu_item_new();
 769             break;
 770         case wxITEM_CHECK:
 771             menuItem = gtk_check_menu_item_new_with_label("");
 772             break;
 773         case wxITEM_RADIO:
 774             {
 775                 GSList* group = NULL;
 776                 if (prevRadio)
 777                     group = gtk_radio_menu_item_get_group(GTK_RADIO_MENU_ITEM(prevRadio));
 778                 menuItem = gtk_radio_menu_item_new_with_label(group, "");
 779                 m_prevRadio = menuItem;
 780             }
 781             break;
 782         default:
 783             wxFAIL_MSG("unexpected menu item kind");
 784             // fall through
 785         case wxITEM_NORMAL:
 786             const wxBitmap& bitmap = mitem->GetBitmap();
 787             const char* stockid;
 788             if (bitmap.IsOk())
 789             {
 790                 // always use pixbuf, because pixmap mask does not
 791                 // work with disabled images in some themes
 792                 GtkWidget* image = gtk_image_new_from_pixbuf(bitmap.GetPixbuf());
 793                 menuItem = gtk_image_menu_item_new_with_label("");
 794                 gtk_widget_show(image);
 795                 gtk_image_menu_item_set_image(GTK_IMAGE_MENU_ITEM(menuItem), image);
 796             }
 797             else if ((stockid = wxGetStockGtkID(mitem->GetId())) != NULL)
 798                 // use stock bitmap for this item if available on the assumption
 799                 // that it never hurts to follow GTK+ conventions more closely
 800                 menuItem = gtk_image_menu_item_new_from_stock(stockid, NULL);
 801             else
 802                 menuItem = gtk_menu_item_new_with_label("");
 803             break;
 804     }
 805     mitem->SetMenuItem(menuItem);
 806
 807     gtk_menu_shell_insert(GTK_MENU_SHELL(m_menu), menuItem, pos);
 808
 809     gtk_widget_show( menuItem );
 810
 811     if ( !mitem->IsSeparator() )
 812     {
 813         mitem->SetGtkLabel();
 814         g_signal_connect (menuItem, "select",
 815                           G_CALLBACK(menuitem_select), mitem);
 816         g_signal_connect (menuItem, "deselect",
 817                           G_CALLBACK(menuitem_deselect), mitem);
 818
 819         if ( mitem->IsSubMenu() && mitem->GetKind() != wxITEM_RADIO && mitem->GetKind() != wxITEM_CHECK )
 820         {
 821             gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem), mitem->GetSubMenu()->m_menu );
 822
 823             gtk_widget_show( mitem->GetSubMenu()->m_menu );
 824
 825             // if adding a submenu to a menu already existing in the menu bar, we
 826             // must set invoking window to allow processing events from this
 827             // submenu
 828             if ( m_invokingWindow )
 829                 wxMenubarSetInvokingWindow(mitem->GetSubMenu(), m_invokingWindow);
 830         }
 831         else
 832         {
 833             g_signal_connect (menuItem, "activate",
 834                               G_CALLBACK(menuitem_activate),
 835                               mitem);
 836         }
 837     }
 838
 839     return true;
 840 }
 841
 842 wxMenuItem* wxMenu::DoAppend(wxMenuItem *mitem)
 843 {
 844     if (!GtkAppend(mitem))
 845         return NULL;
 846
 847     return wxMenuBase::DoAppend(mitem);
 848 }
 849
 850 wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item)
 851 {
 852     if ( !wxMenuBase::DoInsert(pos, item) )
 853         return NULL;
 854
 855     // TODO
 856     if ( !GtkAppend(item, (int)pos) )
 857         return NULL;
 858
 859     return item;
 860 }
 861
 862 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
 863 {
 864     if ( !wxMenuBase::DoRemove(item) )
 865         return NULL;
 866
 867     GtkWidget * const mitem = item->GetMenuItem();
 868     if ( m_prevRadio == mitem )
 869     {
 870         // deleting an item starts a new radio group (has to as we shouldn't
 871         // keep a deleted pointer anyhow)
 872         m_prevRadio = NULL;
 873     }
 874
 875     gtk_menu_item_set_submenu(GTK_MENU_ITEM(mitem), NULL);
 876     gtk_widget_destroy(mitem);
 877     item->SetMenuItem(NULL);
 878
 879     return item;
 880 }
 881
 882 void wxMenu::Attach(wxMenuBarBase *menubar)
 883 {
 884     wxMenuBase::Attach(menubar);
 885
 886     // inherit layout direction from menubar.
 887     SetLayoutDirection(menubar->GetLayoutDirection());
 888 }
 889
 890 // ----------------------------------------------------------------------------
 891 // helpers
 892 // ----------------------------------------------------------------------------
 893
 894 #if wxUSE_ACCEL
 895
 896 static wxString GetGtkHotKey( const wxMenuItem& item )
 897 {
 898     wxString hotkey;
 899
 900     wxAcceleratorEntry *accel = item.GetAccel();
 901     if ( accel )
 902     {
 903         int flags = accel->GetFlags();
 904         if ( flags & wxACCEL_ALT )
 905             hotkey += wxT("<alt>");
 906         if ( flags & wxACCEL_CTRL )
 907             hotkey += wxT("<control>");
 908         if ( flags & wxACCEL_SHIFT )
 909             hotkey += wxT("<shift>");
 910
 911         int code = accel->GetKeyCode();
 912         switch ( code )
 913         {
 914             case WXK_F1:
 915             case WXK_F2:
 916             case WXK_F3:
 917             case WXK_F4:
 918             case WXK_F5:
 919             case WXK_F6:
 920             case WXK_F7:
 921             case WXK_F8:
 922             case WXK_F9:
 923             case WXK_F10:
 924             case WXK_F11:
 925             case WXK_F12:
 926             case WXK_F13:
 927             case WXK_F14:
 928             case WXK_F15:
 929             case WXK_F16:
 930             case WXK_F17:
 931             case WXK_F18:
 932             case WXK_F19:
 933             case WXK_F20:
 934             case WXK_F21:
 935             case WXK_F22:
 936             case WXK_F23:
 937             case WXK_F24:
 938                 hotkey += wxString::Format(wxT("F%d"), code - WXK_F1 + 1);
 939                 break;
 940
 941                 // TODO: we should use gdk_keyval_name() (a.k.a.
 942                 //       XKeysymToString) here as well as hardcoding the keysym
 943                 //       names this might be not portable
 944            case WXK_INSERT:
 945                 hotkey << wxT("Insert" );
 946                 break;
 947             case WXK_DELETE:
 948                 hotkey << wxT("Delete" );
 949                 break;
 950             case WXK_UP:
 951                 hotkey << wxT("Up" );
 952                 break;
 953             case WXK_DOWN:
 954                 hotkey << wxT("Down" );
 955                 break;
 956             case WXK_PAGEUP:
 957                 hotkey << wxT("Page_Up" );
 958                 break;
 959             case WXK_PAGEDOWN:
 960                 hotkey << wxT("Page_Down" );
 961                 break;
 962             case WXK_LEFT:
 963                 hotkey << wxT("Left" );
 964                 break;
 965             case WXK_RIGHT:
 966                 hotkey << wxT("Right" );
 967                 break;
 968             case WXK_HOME:
 969                 hotkey << wxT("Home" );
 970                 break;
 971             case WXK_END:
 972                 hotkey << wxT("End" );
 973                 break;
 974             case WXK_RETURN:
 975                 hotkey << wxT("Return" );
 976                 break;
 977             case WXK_BACK:
 978                 hotkey << wxT("BackSpace" );
 979                 break;
 980             case WXK_TAB:
 981                 hotkey << wxT("Tab" );
 982                 break;
 983             case WXK_ESCAPE:
 984                 hotkey << wxT("Esc" );
 985                 break;
 986             case WXK_SPACE:
 987                 hotkey << wxT("space" );
 988                 break;
 989             case WXK_MULTIPLY:
 990                 hotkey << wxT("Multiply" );
 991                 break;
 992             case WXK_ADD:
 993                 hotkey << wxT("Add" );
 994                 break;
 995             case WXK_SEPARATOR:
 996                 hotkey << wxT("Separator" );
 997                 break;
 998             case WXK_SUBTRACT:
 999                 hotkey << wxT("Subtract" );
1000                 break;
1001             case WXK_DECIMAL:
1002                 hotkey << wxT("Decimal" );
1003                 break;
1004             case WXK_DIVIDE:
1005                 hotkey << wxT("Divide" );
1006                 break;
1007             case WXK_CANCEL:
1008                 hotkey << wxT("Cancel" );
1009                 break;
1010             case WXK_CLEAR:
1011                 hotkey << wxT("Clear" );
1012                 break;
1013             case WXK_MENU:
1014                 hotkey << wxT("Menu" );
1015                 break;
1016             case WXK_PAUSE:
1017                 hotkey << wxT("Pause" );
1018                 break;
1019             case WXK_CAPITAL:
1020                 hotkey << wxT("Capital" );
1021                 break;
1022             case WXK_SELECT:
1023                 hotkey << wxT("Select" );
1024                 break;
1025             case WXK_PRINT:
1026                 hotkey << wxT("Print" );
1027                 break;
1028             case WXK_EXECUTE:
1029                 hotkey << wxT("Execute" );
1030                 break;
1031             case WXK_SNAPSHOT:
1032                 hotkey << wxT("Snapshot" );
1033                 break;
1034             case WXK_HELP:
1035                 hotkey << wxT("Help" );
1036                 break;
1037             case WXK_NUMLOCK:
1038                 hotkey << wxT("Num_Lock" );
1039                 break;
1040             case WXK_SCROLL:
1041                 hotkey << wxT("Scroll_Lock" );
1042                 break;
1043             case WXK_NUMPAD_INSERT:
1044                 hotkey << wxT("KP_Insert" );
1045                 break;
1046             case WXK_NUMPAD_DELETE:
1047                 hotkey << wxT("KP_Delete" );
1048                 break;
1049              case WXK_NUMPAD_SPACE:
1050                 hotkey << wxT("KP_Space" );
1051                 break;
1052             case WXK_NUMPAD_TAB:
1053                 hotkey << wxT("KP_Tab" );
1054                 break;
1055             case WXK_NUMPAD_ENTER:
1056                 hotkey << wxT("KP_Enter" );
1057                 break;
1058             case WXK_NUMPAD_F1: case WXK_NUMPAD_F2: case WXK_NUMPAD_F3:
1059             case WXK_NUMPAD_F4:
1060                 hotkey += wxString::Format(wxT("KP_F%d"), code - WXK_NUMPAD_F1 + 1);
1061                 break;
1062             case WXK_NUMPAD_HOME:
1063                 hotkey << wxT("KP_Home" );
1064                 break;
1065             case WXK_NUMPAD_LEFT:
1066                 hotkey << wxT("KP_Left" );
1067                 break;
1068              case WXK_NUMPAD_UP:
1069                 hotkey << wxT("KP_Up" );
1070                 break;
1071             case WXK_NUMPAD_RIGHT:
1072                 hotkey << wxT("KP_Right" );
1073                 break;
1074             case WXK_NUMPAD_DOWN:
1075                 hotkey << wxT("KP_Down" );
1076                 break;
1077             case WXK_NUMPAD_PAGEUP:
1078                 hotkey << wxT("KP_Page_Up" );
1079                 break;
1080             case WXK_NUMPAD_PAGEDOWN:
1081                 hotkey << wxT("KP_Page_Down" );
1082                 break;
1083             case WXK_NUMPAD_END:
1084                 hotkey << wxT("KP_End" );
1085                 break;
1086             case WXK_NUMPAD_BEGIN:
1087                 hotkey << wxT("KP_Begin" );
1088                 break;
1089             case WXK_NUMPAD_EQUAL:
1090                 hotkey << wxT("KP_Equal" );
1091                 break;
1092             case WXK_NUMPAD_MULTIPLY:
1093                 hotkey << wxT("KP_Multiply" );
1094                 break;
1095             case WXK_NUMPAD_ADD:
1096                 hotkey << wxT("KP_Add" );
1097                 break;
1098             case WXK_NUMPAD_SEPARATOR:
1099                 hotkey << wxT("KP_Separator" );
1100                 break;
1101             case WXK_NUMPAD_SUBTRACT:
1102                 hotkey << wxT("KP_Subtract" );
1103                 break;
1104             case WXK_NUMPAD_DECIMAL:
1105                 hotkey << wxT("KP_Decimal" );
1106                 break;
1107             case WXK_NUMPAD_DIVIDE:
1108                 hotkey << wxT("KP_Divide" );
1109                 break;
1110            case WXK_NUMPAD0: case WXK_NUMPAD1: case WXK_NUMPAD2:
1111            case WXK_NUMPAD3: case WXK_NUMPAD4: case WXK_NUMPAD5:
1112            case WXK_NUMPAD6: case WXK_NUMPAD7: case WXK_NUMPAD8: case WXK_NUMPAD9:
1113                 hotkey += wxString::Format(wxT("KP_%d"), code - WXK_NUMPAD0);
1114                 break;
1115             case WXK_WINDOWS_LEFT:
1116                 hotkey << wxT("Super_L" );
1117                 break;
1118             case WXK_WINDOWS_RIGHT:
1119                 hotkey << wxT("Super_R" );
1120                 break;
1121             case WXK_WINDOWS_MENU:
1122                 hotkey << wxT("Menu" );
1123                 break;
1124             case WXK_COMMAND:
1125                 hotkey << wxT("Command" );
1126                 break;
1127           /* These probably wouldn't work as there is no SpecialX in gdk/keynames.txt
1128             case WXK_SPECIAL1: case WXK_SPECIAL2: case WXK_SPECIAL3: case WXK_SPECIAL4:
1129             case WXK_SPECIAL5: case WXK_SPECIAL6: case WXK_SPECIAL7: case WXK_SPECIAL8:
1130             case WXK_SPECIAL9:  case WXK_SPECIAL10:  case WXK_SPECIAL11: case WXK_SPECIAL12:
1131             case WXK_SPECIAL13: case WXK_SPECIAL14: case WXK_SPECIAL15: case WXK_SPECIAL16:
1132             case WXK_SPECIAL17: case WXK_SPECIAL18: case WXK_SPECIAL19:  case WXK_SPECIAL20:
1133                 hotkey += wxString::Format(wxT("Special%d"), code - WXK_SPECIAL1 + 1);
1134                 break;
1135           */
1136                 // if there are any other keys wxAcceleratorEntry::Create() may
1137                 // return, we should process them here
1138
1139             default:
1140                 if ( code < 127 )
1141                 {
1142                     const wxString
1143                         name = wxGTK_CONV_BACK_SYS(gdk_keyval_name((guint)code));
1144                     if ( !name.empty() )
1145                     {
1146                         hotkey << name;
1147                         break;
1148                     }
1149                 }
1150
1151                 wxFAIL_MSG( wxT("unknown keyboard accel") );
1152         }
1153
1154         delete accel;
1155     }
1156
1157     return hotkey;
1158 }
1159
1160 static void
1161 wxGetGtkAccel(const wxMenuItem* item, guint* accel_key, GdkModifierType* accel_mods)
1162 {
1163     *accel_key = 0;
1164     const wxString string = GetGtkHotKey(*item);
1165     if (!string.empty())
1166         gtk_accelerator_parse(wxGTK_CONV_SYS(string), accel_key, accel_mods);
1167     else
1168     {
1169         GtkStockItem stock_item;
1170         const char* stockid = wxGetStockGtkID(item->GetId());
1171         if (stockid && gtk_stock_lookup(stockid, &stock_item))
1172         {
1173             *accel_key = stock_item.keyval;
1174             *accel_mods = stock_item.modifier;
1175         }
1176     }
1177 }
1178 #endif // wxUSE_ACCEL
1179
1180 const char *wxGetStockGtkID(wxWindowID id)
1181 {
1182     #define STOCKITEM(wx,gtk)      \
1183         case wx:                   \
1184             return gtk;
1185
1186     #if GTK_CHECK_VERSION(2,6,0)
1187         #define STOCKITEM_26(wx,gtk) STOCKITEM(wx,gtk)
1188     #else
1189         #define STOCKITEM_26(wx,gtk)
1190     #endif
1191
1192     #if GTK_CHECK_VERSION(2,10,0)
1193         #define STOCKITEM_210(wx,gtk) STOCKITEM(wx,gtk)
1194     #else
1195         #define STOCKITEM_210(wx,gtk)
1196     #endif
1197
1198
1199     switch (id)
1200     {
1201         STOCKITEM_26(wxID_ABOUT,         GTK_STOCK_ABOUT)
1202         STOCKITEM(wxID_ADD,              GTK_STOCK_ADD)
1203         STOCKITEM(wxID_APPLY,            GTK_STOCK_APPLY)
1204         STOCKITEM(wxID_BOLD,             GTK_STOCK_BOLD)
1205         STOCKITEM(wxID_CANCEL,           GTK_STOCK_CANCEL)
1206         STOCKITEM(wxID_CLEAR,            GTK_STOCK_CLEAR)
1207         STOCKITEM(wxID_CLOSE,            GTK_STOCK_CLOSE)
1208         STOCKITEM(wxID_COPY,             GTK_STOCK_COPY)
1209         STOCKITEM(wxID_CUT,              GTK_STOCK_CUT)
1210         STOCKITEM(wxID_DELETE,           GTK_STOCK_DELETE)
1211         STOCKITEM_26(wxID_EDIT,          GTK_STOCK_EDIT)
1212         STOCKITEM(wxID_FIND,             GTK_STOCK_FIND)
1213         STOCKITEM_26(wxID_FILE,          GTK_STOCK_FILE)
1214         STOCKITEM(wxID_REPLACE,          GTK_STOCK_FIND_AND_REPLACE)
1215         STOCKITEM(wxID_BACKWARD,         GTK_STOCK_GO_BACK)
1216         STOCKITEM(wxID_DOWN,             GTK_STOCK_GO_DOWN)
1217         STOCKITEM(wxID_FORWARD,          GTK_STOCK_GO_FORWARD)
1218         STOCKITEM(wxID_UP,               GTK_STOCK_GO_UP)
1219         STOCKITEM(wxID_HELP,             GTK_STOCK_HELP)
1220         STOCKITEM(wxID_HOME,             GTK_STOCK_HOME)
1221         STOCKITEM(wxID_INDENT,           GTK_STOCK_INDENT)
1222         STOCKITEM(wxID_INDEX,            GTK_STOCK_INDEX)
1223         STOCKITEM(wxID_ITALIC,           GTK_STOCK_ITALIC)
1224         STOCKITEM(wxID_JUSTIFY_CENTER,   GTK_STOCK_JUSTIFY_CENTER)
1225         STOCKITEM(wxID_JUSTIFY_FILL,     GTK_STOCK_JUSTIFY_FILL)
1226         STOCKITEM(wxID_JUSTIFY_LEFT,     GTK_STOCK_JUSTIFY_LEFT)
1227         STOCKITEM(wxID_JUSTIFY_RIGHT,    GTK_STOCK_JUSTIFY_RIGHT)
1228         STOCKITEM(wxID_NEW,              GTK_STOCK_NEW)
1229         STOCKITEM(wxID_NO,               GTK_STOCK_NO)
1230         STOCKITEM(wxID_OK,               GTK_STOCK_OK)
1231         STOCKITEM(wxID_OPEN,             GTK_STOCK_OPEN)
1232         STOCKITEM(wxID_PASTE,            GTK_STOCK_PASTE)
1233         STOCKITEM(wxID_PREFERENCES,      GTK_STOCK_PREFERENCES)
1234         STOCKITEM(wxID_PRINT,            GTK_STOCK_PRINT)
1235         STOCKITEM(wxID_PREVIEW,          GTK_STOCK_PRINT_PREVIEW)
1236         STOCKITEM(wxID_PROPERTIES,       GTK_STOCK_PROPERTIES)
1237         STOCKITEM(wxID_EXIT,             GTK_STOCK_QUIT)
1238         STOCKITEM(wxID_REDO,             GTK_STOCK_REDO)
1239         STOCKITEM(wxID_REFRESH,          GTK_STOCK_REFRESH)
1240         STOCKITEM(wxID_REMOVE,           GTK_STOCK_REMOVE)
1241         STOCKITEM(wxID_REVERT_TO_SAVED,  GTK_STOCK_REVERT_TO_SAVED)
1242         STOCKITEM(wxID_SAVE,             GTK_STOCK_SAVE)
1243         STOCKITEM(wxID_SAVEAS,           GTK_STOCK_SAVE_AS)
1244         STOCKITEM_210(wxID_SELECTALL,    GTK_STOCK_SELECT_ALL)
1245         STOCKITEM(wxID_STOP,             GTK_STOCK_STOP)
1246         STOCKITEM(wxID_UNDELETE,         GTK_STOCK_UNDELETE)
1247         STOCKITEM(wxID_UNDERLINE,        GTK_STOCK_UNDERLINE)
1248         STOCKITEM(wxID_UNDO,             GTK_STOCK_UNDO)
1249         STOCKITEM(wxID_UNINDENT,         GTK_STOCK_UNINDENT)
1250         STOCKITEM(wxID_YES,              GTK_STOCK_YES)
1251         STOCKITEM(wxID_ZOOM_100,         GTK_STOCK_ZOOM_100)
1252         STOCKITEM(wxID_ZOOM_FIT,         GTK_STOCK_ZOOM_FIT)
1253         STOCKITEM(wxID_ZOOM_IN,          GTK_STOCK_ZOOM_IN)
1254         STOCKITEM(wxID_ZOOM_OUT,         GTK_STOCK_ZOOM_OUT)
1255
1256         default:
1257             break;
1258     };
1259
1260     #undef STOCKITEM
1261
1262     return NULL;
1263 }
1264
1265 #endif // wxUSE_MENUS