src/gtk1/menu.cpp

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