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