src/gtk/menu.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        menu.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifdef __GNUG__
  11 #pragma implementation "menu.h"
  12 #pragma implementation "menuitem.h"
  13 #endif
  14
  15 #include "wx/log.h"
  16 #include "wx/intl.h"
  17 #include "wx/app.h"
  18 #include "wx/bitmap.h"
  19 #include "wx/menu.h"
  20
  21 #if wxUSE_ACCEL
  22     #include "wx/accel.h"
  23 #endif // wxUSE_ACCEL
  24
  25 #include "wx/gtk/private.h"
  26
  27 #include <gdk/gdkkeysyms.h>
  28
  29 // FIXME: is this right? somehow I don't think so (VZ)
  30 #ifdef __WXGTK20__
  31     #include <glib-object.h>
  32
  33     #define gtk_accel_group_attach(g, o) _gtk_accel_group_attach((g), (o))
  34     #define gtk_accel_group_detach(g, o) _gtk_accel_group_detach((g), (o))
  35     #define gtk_menu_ensure_uline_accel_group(m) gtk_menu_get_accel_group(m)
  36
  37     #define ACCEL_OBJECT        GObject
  38     #define ACCEL_OBJECTS(a)    (a)->acceleratables
  39     #define ACCEL_OBJ_CAST(obj) G_OBJECT(obj)
  40 #else // GTK+ 1.x
  41     #define ACCEL_OBJECT        GtkObject
  42     #define ACCEL_OBJECTS(a)    (a)->attach_objects
  43     #define ACCEL_OBJ_CAST(obj) GTK_OBJECT(obj)
  44 #endif
  45
  46 //-----------------------------------------------------------------------------
  47 // idle system
  48 //-----------------------------------------------------------------------------
  49
  50 extern void wxapp_install_idle_handler();
  51 extern bool g_isIdle;
  52
  53 #if GTK_CHECK_VERSION(1, 2, 0) && wxUSE_ACCEL
  54     static wxString GetHotKey( const wxMenuItem& item );
  55 #endif
  56
  57 //-----------------------------------------------------------------------------
  58 // substitute for missing GtkPixmapMenuItem
  59 //-----------------------------------------------------------------------------
  60
  61 // FIXME: I can't make this compile with GTK+ 2.0, disabling for now (VZ)
  62 #ifndef __WXGTK20__
  63     #define USE_MENU_BITMAPS
  64 #endif
  65
  66 #ifdef USE_MENU_BITMAPS
  67
  68 #define GTK_TYPE_PIXMAP_MENU_ITEM            (gtk_pixmap_menu_item_get_type ())
  69 #define GTK_PIXMAP_MENU_ITEM(obj)            (GTK_CHECK_CAST ((obj), GTK_TYPE_PIXMAP_MENU_ITEM, GtkPixmapMenuItem))
  70 #define GTK_PIXMAP_MENU_ITEM_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_PIXMAP_MENU_ITEM, GtkPixmapMenuItemClass))
  71 #define GTK_IS_PIXMAP_MENU_ITEM(obj)         (GTK_CHECK_TYPE ((obj), GTK_TYPE_PIXMAP_MENU_ITEM))
  72 #define GTK_IS_PIXMAP_MENU_ITEM_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PIXMAP_MENU_ITEM))
  73 //#define GTK_PIXMAP_MENU_ITEM_GET_CLASS(obj)  (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_PIXMAP_MENU_ITEM))
  74 #define GTK_PIXMAP_MENU_ITEM_GET_CLASS(obj)  (GTK_PIXMAP_MENU_ITEM_CLASS( GTK_OBJECT_GET_CLASS(obj)))
  75
  76 #ifndef GTK_MENU_ITEM_GET_CLASS
  77 #define GTK_MENU_ITEM_GET_CLASS(obj) (GTK_MENU_ITEM_CLASS( GTK_OBJECT_GET_CLASS(obj)))
  78 #endif
  79
  80 typedef struct _GtkPixmapMenuItem       GtkPixmapMenuItem;
  81 typedef struct _GtkPixmapMenuItemClass  GtkPixmapMenuItemClass;
  82
  83 struct _GtkPixmapMenuItem
  84 {
  85     GtkMenuItem menu_item;
  86
  87     GtkWidget *pixmap;
  88 };
  89
  90 struct _GtkPixmapMenuItemClass
  91 {
  92     GtkMenuItemClass parent_class;
  93
  94     guint orig_toggle_size;
  95     guint have_pixmap_count;
  96 };
  97
  98
  99 GtkType    gtk_pixmap_menu_item_get_type       (void);
 100 GtkWidget* gtk_pixmap_menu_item_new            (void);
 101 void       gtk_pixmap_menu_item_set_pixmap     (GtkPixmapMenuItem *menu_item,
 102                                                                     GtkWidget *pixmap);
 103
 104 #endif // USE_MENU_BITMAPS
 105
 106 //-----------------------------------------------------------------------------
 107 // idle system
 108 //-----------------------------------------------------------------------------
 109
 110 static wxString wxReplaceUnderscore( const wxString& title )
 111 {
 112     const wxChar *pc;
 113
 114     /* GTK 1.2 wants to have "_" instead of "&" for accelerators */
 115     wxString str;
 116     for ( pc = title; *pc != wxT('\0'); pc++ )
 117     {
 118         if (*pc == wxT('&'))
 119         {
 120 #if GTK_CHECK_VERSION(1, 2, 1)
 121             str << wxT('_');
 122         }
 123         else if (*pc == wxT('/'))
 124         {
 125             str << wxT('\\');
 126 #endif
 127         }
 128         else
 129         {
 130 #if __WXGTK12__
 131             if ( *pc == wxT('_') )
 132             {
 133                 // underscores must be doubled to prevent them from being
 134                 // interpreted as accelerator character prefix by GTK
 135                 str << *pc;
 136             }
 137 #endif // GTK+ 1.2
 138
 139             str << *pc;
 140         }
 141     }
 142     return str;
 143 }
 144
 145 //-----------------------------------------------------------------------------
 146 // wxMenuBar
 147 //-----------------------------------------------------------------------------
 148
 149 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar,wxWindow)
 150
 151 wxMenuBar::wxMenuBar( long style )
 152 {
 153     /* the parent window is known after wxFrame::SetMenu() */
 154     m_needParent = FALSE;
 155     m_style = style;
 156     m_invokingWindow = (wxWindow*) NULL;
 157
 158     if (!PreCreation( (wxWindow*) NULL, wxDefaultPosition, wxDefaultSize ) ||
 159         !CreateBase( (wxWindow*) NULL, -1, wxDefaultPosition, wxDefaultSize, style, wxDefaultValidator, wxT("menubar") ))
 160     {
 161         wxFAIL_MSG( wxT("wxMenuBar creation failed") );
 162         return;
 163     }
 164
 165     m_menus.DeleteContents( TRUE );
 166
 167     /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
 168 #if GTK_CHECK_VERSION(1, 2, 1)
 169     m_accel = gtk_accel_group_new();
 170     m_factory = gtk_item_factory_new( GTK_TYPE_MENU_BAR, "<main>", m_accel );
 171     m_menubar = gtk_item_factory_get_widget( m_factory, "<main>" );
 172 #else
 173     m_menubar = gtk_menu_bar_new();
 174 #endif
 175
 176     if (style & wxMB_DOCKABLE)
 177     {
 178         m_widget = gtk_handle_box_new();
 179         gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_menubar) );
 180         gtk_widget_show( GTK_WIDGET(m_menubar) );
 181     }
 182     else
 183     {
 184         m_widget = GTK_WIDGET(m_menubar);
 185     }
 186
 187     PostCreation();
 188
 189     ApplyWidgetStyle();
 190 }
 191
 192 wxMenuBar::wxMenuBar()
 193 {
 194     /* the parent window is known after wxFrame::SetMenu() */
 195     m_needParent = FALSE;
 196     m_style = 0;
 197     m_invokingWindow = (wxWindow*) NULL;
 198
 199     if (!PreCreation( (wxWindow*) NULL, wxDefaultPosition, wxDefaultSize ) ||
 200         !CreateBase( (wxWindow*) NULL, -1, wxDefaultPosition, wxDefaultSize, 0, wxDefaultValidator, wxT("menubar") ))
 201     {
 202         wxFAIL_MSG( wxT("wxMenuBar creation failed") );
 203         return;
 204     }
 205
 206     m_menus.DeleteContents( TRUE );
 207
 208     /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
 209 #if GTK_CHECK_VERSION(1, 2, 1)
 210     m_accel = gtk_accel_group_new();
 211     m_factory = gtk_item_factory_new( GTK_TYPE_MENU_BAR, "<main>", m_accel );
 212     m_menubar = gtk_item_factory_get_widget( m_factory, "<main>" );
 213 #else
 214     m_menubar = gtk_menu_bar_new();
 215 #endif
 216
 217     m_widget = GTK_WIDGET(m_menubar);
 218
 219     PostCreation();
 220
 221     ApplyWidgetStyle();
 222 }
 223
 224 wxMenuBar::~wxMenuBar()
 225 {
 226 //    gtk_object_unref( GTK_OBJECT(m_factory) );  why not ?
 227 }
 228
 229 static void wxMenubarUnsetInvokingWindow( wxMenu *menu, wxWindow *win )
 230 {
 231     menu->SetInvokingWindow( (wxWindow*) NULL );
 232
 233 #if GTK_CHECK_VERSION(1, 2, 0)
 234     wxWindow *top_frame = win;
 235     while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
 236         top_frame = top_frame->GetParent();
 237
 238     /* support for native hot keys  */
 239     gtk_accel_group_detach( menu->m_accel, ACCEL_OBJ_CAST(top_frame->m_widget) );
 240 #endif
 241
 242     wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
 243     while (node)
 244     {
 245         wxMenuItem *menuitem = node->GetData();
 246         if (menuitem->IsSubMenu())
 247             wxMenubarUnsetInvokingWindow( menuitem->GetSubMenu(), win );
 248         node = node->GetNext();
 249     }
 250 }
 251
 252 static void wxMenubarSetInvokingWindow( wxMenu *menu, wxWindow *win )
 253 {
 254     menu->SetInvokingWindow( win );
 255
 256 #if GTK_CHECK_VERSION(1, 2, 1)
 257     wxWindow *top_frame = win;
 258     while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
 259         top_frame = top_frame->GetParent();
 260
 261     /* support for native hot keys  */
 262     ACCEL_OBJECT *obj = ACCEL_OBJ_CAST(top_frame->m_widget);
 263     if ( !g_slist_find( ACCEL_OBJECTS(menu->m_accel), obj ) )
 264         gtk_accel_group_attach( menu->m_accel, obj );
 265 #endif // GTK+ 1.2.1+
 266
 267     wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
 268     while (node)
 269     {
 270         wxMenuItem *menuitem = node->GetData();
 271         if (menuitem->IsSubMenu())
 272             wxMenubarSetInvokingWindow( menuitem->GetSubMenu(), win );
 273         node = node->GetNext();
 274     }
 275 }
 276
 277 void wxMenuBar::SetInvokingWindow( wxWindow *win )
 278 {
 279     m_invokingWindow = win;
 280 #if GTK_CHECK_VERSION(1, 2, 1)
 281     wxWindow *top_frame = win;
 282     while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
 283         top_frame = top_frame->GetParent();
 284
 285     /* support for native key accelerators indicated by underscroes */
 286     ACCEL_OBJECT *obj = ACCEL_OBJ_CAST(top_frame->m_widget);
 287     if ( !g_slist_find( ACCEL_OBJECTS(m_accel), obj ) )
 288         gtk_accel_group_attach( m_accel, obj );
 289 #endif // GTK+ 1.2.1+
 290
 291     wxMenuList::Node *node = m_menus.GetFirst();
 292     while (node)
 293     {
 294         wxMenu *menu = node->GetData();
 295         wxMenubarSetInvokingWindow( menu, win );
 296         node = node->GetNext();
 297     }
 298 }
 299
 300 void wxMenuBar::UnsetInvokingWindow( wxWindow *win )
 301 {
 302     m_invokingWindow = (wxWindow*) NULL;
 303 #if GTK_CHECK_VERSION(1, 2, 1)
 304     wxWindow *top_frame = win;
 305     while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
 306         top_frame = top_frame->GetParent();
 307
 308     /* support for native key accelerators indicated by underscroes */
 309     gtk_accel_group_detach( m_accel, ACCEL_OBJ_CAST(top_frame->m_widget) );
 310 #endif // GTK+ 1.2.1+
 311
 312     wxMenuList::Node *node = m_menus.GetFirst();
 313     while (node)
 314     {
 315         wxMenu *menu = node->GetData();
 316         wxMenubarUnsetInvokingWindow( menu, win );
 317         node = node->GetNext();
 318     }
 319 }
 320
 321 bool wxMenuBar::Append( wxMenu *menu, const wxString &title )
 322 {
 323     if ( !wxMenuBarBase::Append( menu, title ) )
 324         return FALSE;
 325
 326     return GtkAppend(menu, title);
 327 }
 328
 329 bool wxMenuBar::GtkAppend(wxMenu *menu, const wxString& title)
 330 {
 331     wxString str( wxReplaceUnderscore( title ) );
 332
 333     /* this doesn't have much effect right now */
 334     menu->SetTitle( str );
 335
 336     /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
 337 #if GTK_CHECK_VERSION(1, 2, 1)
 338
 339     /* local buffer in multibyte form */
 340     wxString buf;
 341     buf << wxT('/') << str.c_str();
 342
 343     char *cbuf = new char[buf.Length()+1];
 344     strcpy(cbuf, buf.mbc_str());
 345
 346     GtkItemFactoryEntry entry;
 347     entry.path = (gchar *)cbuf;  // const_cast
 348     entry.accelerator = (gchar*) NULL;
 349     entry.callback = (GtkItemFactoryCallback) NULL;
 350     entry.callback_action = 0;
 351     entry.item_type = (char *)"<Branch>";
 352
 353     gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
 354     /* in order to get the pointer to the item we need the item text _without_ underscores */
 355     wxString tmp = wxT("<main>/");
 356     const wxChar *pc;
 357     for ( pc = str; *pc != wxT('\0'); pc++ )
 358     {
 359        // contrary to the common sense, we must throw out _all_ underscores,
 360        // (i.e. "Hello__World" => "HelloWorld" and not "Hello_World" as we
 361        // might naively think). IMHO it's a bug in GTK+ (VZ)
 362        while (*pc == wxT('_'))
 363            pc++;
 364        tmp << *pc;
 365     }
 366     menu->m_owner = gtk_item_factory_get_item( m_factory, tmp.mb_str() );
 367     gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
 368     delete [] cbuf;
 369 #else
 370
 371     menu->m_owner = gtk_menu_item_new_with_label( str.mb_str() );
 372     gtk_widget_show( menu->m_owner );
 373     gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
 374
 375     gtk_menu_bar_append( GTK_MENU_BAR(m_menubar), menu->m_owner );
 376
 377 #endif
 378
 379     // m_invokingWindow is set after wxFrame::SetMenuBar(). This call enables
 380     // adding menu later on.
 381     if (m_invokingWindow)
 382         wxMenubarSetInvokingWindow( menu, m_invokingWindow );
 383
 384     return TRUE;
 385 }
 386
 387 bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
 388 {
 389     if ( !wxMenuBarBase::Insert(pos, menu, title) )
 390         return FALSE;
 391
 392 #if __WXGTK12__
 393     // GTK+ doesn't have a function to insert a menu using GtkItemFactory (as
 394     // of version 1.2.6), so we first append the item and then change its
 395     // index
 396     if ( !GtkAppend(menu, title) )
 397         return FALSE;
 398
 399     if (pos+1 >= m_menus.GetCount())
 400         return TRUE;
 401
 402     GtkMenuShell *menu_shell = GTK_MENU_SHELL(m_factory->widget);
 403     gpointer data = g_list_last(menu_shell->children)->data;
 404     menu_shell->children = g_list_remove(menu_shell->children, data);
 405     menu_shell->children = g_list_insert(menu_shell->children, data, pos);
 406
 407     return TRUE;
 408 #else  // GTK < 1.2
 409     // this should be easy to do with GTK 1.0 - can use standard functions for
 410     // this and don't need any hacks like above, but as I don't have GTK 1.0
 411     // any more I can't do it
 412     wxFAIL_MSG( wxT("TODO") );
 413
 414     return FALSE;
 415 #endif // GTK 1.2/1.0
 416 }
 417
 418 wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
 419 {
 420     // remove the old item and insert a new one
 421     wxMenu *menuOld = Remove(pos);
 422     if ( menuOld && !Insert(pos, menu, title) )
 423     {
 424         return (wxMenu*) NULL;
 425     }
 426
 427     // either Insert() succeeded or Remove() failed and menuOld is NULL
 428     return menuOld;
 429 }
 430
 431 wxMenu *wxMenuBar::Remove(size_t pos)
 432 {
 433     wxMenu *menu = wxMenuBarBase::Remove(pos);
 434     if ( !menu )
 435         return (wxMenu*) NULL;
 436
 437 /*
 438     GtkMenuShell *menu_shell = GTK_MENU_SHELL(m_factory->widget);
 439
 440     printf( "factory entries before %d\n", (int)g_slist_length(m_factory->items) );
 441     printf( "menu shell entries before %d\n", (int)g_list_length( menu_shell->children ) );
 442 */
 443
 444     // unparent calls unref() and that would delete the widget so we raise
 445     // the ref count to 2 artificially before invoking unparent.
 446     gtk_widget_ref( menu->m_menu );
 447     gtk_widget_unparent( menu->m_menu );
 448
 449     gtk_widget_destroy( menu->m_owner );
 450
 451 /*
 452     printf( "factory entries after %d\n", (int)g_slist_length(m_factory->items) );
 453     printf( "menu shell entries after %d\n", (int)g_list_length( menu_shell->children ) );
 454 */
 455
 456     return menu;
 457 }
 458
 459 static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString, const wxString &itemString )
 460 {
 461     if (wxMenuItem::GetLabelFromText(menu->GetTitle()) == wxMenuItem::GetLabelFromText(menuString))
 462     {
 463         int res = menu->FindItem( itemString );
 464         if (res != wxNOT_FOUND)
 465             return res;
 466     }
 467
 468     wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
 469     while (node)
 470     {
 471         wxMenuItem *item = node->GetData();
 472         if (item->IsSubMenu())
 473             return FindMenuItemRecursive(item->GetSubMenu(), menuString, itemString);
 474
 475         node = node->GetNext();
 476     }
 477
 478     return wxNOT_FOUND;
 479 }
 480
 481 int wxMenuBar::FindMenuItem( const wxString &menuString, const wxString &itemString ) const
 482 {
 483     wxMenuList::Node *node = m_menus.GetFirst();
 484     while (node)
 485     {
 486         wxMenu *menu = node->GetData();
 487         int res = FindMenuItemRecursive( menu, menuString, itemString);
 488         if (res != -1)
 489             return res;
 490         node = node->GetNext();
 491     }
 492
 493     return wxNOT_FOUND;
 494 }
 495
 496 // Find a wxMenuItem using its id. Recurses down into sub-menus
 497 static wxMenuItem* FindMenuItemByIdRecursive(const wxMenu* menu, int id)
 498 {
 499     wxMenuItem* result = menu->FindChildItem(id);
 500
 501     wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst();
 502     while ( node && result == NULL )
 503     {
 504         wxMenuItem *item = node->GetData();
 505         if (item->IsSubMenu())
 506         {
 507             result = FindMenuItemByIdRecursive( item->GetSubMenu(), id );
 508         }
 509         node = node->GetNext();
 510     }
 511
 512     return result;
 513 }
 514
 515 wxMenuItem* wxMenuBar::FindItem( int id, wxMenu **menuForItem ) const
 516 {
 517     wxMenuItem* result = 0;
 518     wxMenuList::Node *node = m_menus.GetFirst();
 519     while (node && result == 0)
 520     {
 521         wxMenu *menu = node->GetData();
 522         result = FindMenuItemByIdRecursive( menu, id );
 523         node = node->GetNext();
 524     }
 525
 526     if ( menuForItem )
 527     {
 528         *menuForItem = result ? result->GetMenu() : (wxMenu *)NULL;
 529     }
 530
 531     return result;
 532 }
 533
 534 void wxMenuBar::EnableTop( size_t pos, bool flag )
 535 {
 536     wxMenuList::Node *node = m_menus.Item( pos );
 537
 538     wxCHECK_RET( node, wxT("menu not found") );
 539
 540     wxMenu* menu = node->GetData();
 541
 542     if (menu->m_owner)
 543         gtk_widget_set_sensitive( menu->m_owner, flag );
 544 }
 545
 546 wxString wxMenuBar::GetLabelTop( size_t pos ) const
 547 {
 548     wxMenuList::Node *node = m_menus.Item( pos );
 549
 550     wxCHECK_MSG( node, wxT("invalid"), wxT("menu not found") );
 551
 552     wxMenu* menu = node->GetData();
 553
 554     wxString label;
 555     wxString text( menu->GetTitle() );
 556 #if GTK_CHECK_VERSION(1, 2, 0)
 557     for ( const wxChar *pc = text.c_str(); *pc; pc++ )
 558     {
 559         if ( *pc == wxT('_') || *pc == wxT('&') )
 560         {
 561             // '_' is the escape character for GTK+ and '&' is the one for
 562             // wxWindows - skip both of them
 563             continue;
 564         }
 565
 566         label += *pc;
 567     }
 568 #else // GTK+ 1.0
 569     label = text;
 570 #endif // GTK+ 1.2/1.0
 571
 572     return label;
 573 }
 574
 575 void wxMenuBar::SetLabelTop( size_t pos, const wxString& label )
 576 {
 577     wxMenuList::Node *node = m_menus.Item( pos );
 578
 579     wxCHECK_RET( node, wxT("menu not found") );
 580
 581     wxMenu* menu = node->GetData();
 582
 583     wxString str( wxReplaceUnderscore( label ) );
 584
 585     menu->SetTitle( str );
 586
 587     if (menu->m_owner)
 588     {
 589         GtkLabel *label = GTK_LABEL( GTK_BIN(menu->m_owner)->child );
 590
 591         /* set new text */
 592         gtk_label_set( label, str.mb_str());
 593
 594         /* reparse key accel */
 595         (void)gtk_label_parse_uline (GTK_LABEL(label), str.mb_str() );
 596         gtk_accel_label_refetch( GTK_ACCEL_LABEL(label) );
 597     }
 598
 599 }
 600
 601 //-----------------------------------------------------------------------------
 602 // "activate"
 603 //-----------------------------------------------------------------------------
 604
 605 static void gtk_menu_clicked_callback( GtkWidget *widget, wxMenu *menu )
 606 {
 607     if (g_isIdle)
 608         wxapp_install_idle_handler();
 609
 610     int id = menu->FindMenuIdByMenuItem(widget);
 611
 612     /* should find it for normal (not popup) menu */
 613     wxASSERT_MSG( (id != -1) || (menu->GetInvokingWindow() != NULL),
 614                   _T("menu item not found in gtk_menu_clicked_callback") );
 615
 616     if (!menu->IsEnabled(id))
 617         return;
 618
 619     wxMenuItem* item = menu->FindChildItem( id );
 620     wxCHECK_RET( item, wxT("error in menu item callback") );
 621
 622     if (item->IsCheckable())
 623     {
 624         bool isReallyChecked = item->IsChecked();
 625         if ( item->wxMenuItemBase::IsChecked() == isReallyChecked )
 626         {
 627             /* the menu item has been checked by calling wxMenuItem->Check() */
 628             return;
 629         }
 630         else
 631         {
 632             /* the user pressed on the menu item -> report and make consistent
 633              * again */
 634             item->wxMenuItemBase::Check(isReallyChecked);
 635         }
 636     }
 637
 638     menu->SendEvent(item->GetId(), item->IsCheckable() ? item->IsChecked() : -1);
 639 }
 640
 641 //-----------------------------------------------------------------------------
 642 // "select"
 643 //-----------------------------------------------------------------------------
 644
 645 static void gtk_menu_hilight_callback( GtkWidget *widget, wxMenu *menu )
 646 {
 647     if (g_isIdle) wxapp_install_idle_handler();
 648
 649     int id = menu->FindMenuIdByMenuItem(widget);
 650
 651     wxASSERT( id != -1 ); // should find it!
 652
 653     if (!menu->IsEnabled(id))
 654         return;
 655
 656     wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, id );
 657     event.SetEventObject( menu );
 658
 659     if (menu->GetEventHandler()->ProcessEvent(event))
 660         return;
 661
 662     wxWindow *win = menu->GetInvokingWindow();
 663     if (win) win->GetEventHandler()->ProcessEvent( event );
 664 }
 665
 666 //-----------------------------------------------------------------------------
 667 // "deselect"
 668 //-----------------------------------------------------------------------------
 669
 670 static void gtk_menu_nolight_callback( GtkWidget *widget, wxMenu *menu )
 671 {
 672     if (g_isIdle) wxapp_install_idle_handler();
 673
 674     int id = menu->FindMenuIdByMenuItem(widget);
 675
 676     wxASSERT( id != -1 ); // should find it!
 677
 678     if (!menu->IsEnabled(id))
 679         return;
 680
 681     wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, -1 );
 682     event.SetEventObject( menu );
 683
 684     if (menu->GetEventHandler()->ProcessEvent(event))
 685         return;
 686
 687     wxWindow *win = menu->GetInvokingWindow();
 688     if (win)
 689         win->GetEventHandler()->ProcessEvent( event );
 690 }
 691
 692 //-----------------------------------------------------------------------------
 693 // wxMenuItem
 694 //-----------------------------------------------------------------------------
 695
 696 IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)
 697
 698 wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu,
 699                                 int id,
 700                                 const wxString& name,
 701                                 const wxString& help,
 702                                 wxItemKind kind,
 703                                 wxMenu *subMenu)
 704 {
 705     return new wxMenuItem(parentMenu, id, name, help, kind, subMenu);
 706 }
 707
 708 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
 709                        int id,
 710                        const wxString& text,
 711                        const wxString& help,
 712                        wxItemKind kind,
 713                        wxMenu *subMenu)
 714           : wxMenuItemBase(parentMenu, id, text, help, kind, subMenu)
 715 {
 716     Init(text);
 717 }
 718
 719 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
 720                        int id,
 721                        const wxString& text,
 722                        const wxString& help,
 723                        bool isCheckable,
 724                        wxMenu *subMenu)
 725           : wxMenuItemBase(parentMenu, id, text, help,
 726                            isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu)
 727 {
 728     Init(text);
 729 }
 730
 731 void wxMenuItem::Init(const wxString& text)
 732 {
 733     m_labelWidget = (GtkWidget *) NULL;
 734     m_menuItem = (GtkWidget *) NULL;
 735
 736     DoSetText(text);
 737 }
 738
 739 wxMenuItem::~wxMenuItem()
 740 {
 741    // don't delete menu items, the menus take care of that
 742 }
 743
 744 // return the menu item text without any menu accels
 745 /* static */
 746 wxString wxMenuItemBase::GetLabelFromText(const wxString& text)
 747 {
 748     wxString label;
 749
 750     for ( const wxChar *pc = text.c_str(); *pc; pc++ )
 751     {
 752         if ( *pc == wxT('_')  )
 753         {
 754             // wxGTK escapes "xxx_xxx" to "xxx__xxx"
 755             pc++;
 756             label += *pc;
 757             continue;
 758         }
 759
 760         if ( *pc == wxT('&') )
 761         {
 762             // wxMSW escapes &
 763             continue;
 764         }
 765
 766         label += *pc;
 767     }
 768
 769     return label;
 770 }
 771
 772 void wxMenuItem::SetText( const wxString& str )
 773 {
 774     DoSetText(str);
 775
 776     if (m_menuItem)
 777     {
 778         GtkLabel *label;
 779         if (m_labelWidget)
 780           label = (GtkLabel*) m_labelWidget;
 781         else
 782           label = GTK_LABEL( GTK_BIN(m_menuItem)->child );
 783
 784         /* set new text */
 785         gtk_label_set( label, m_text.mb_str());
 786
 787         /* reparse key accel */
 788         (void)gtk_label_parse_uline (GTK_LABEL(label), m_text.mb_str() );
 789         gtk_accel_label_refetch( GTK_ACCEL_LABEL(label) );
 790     }
 791 }
 792
 793 // it's valid for this function to be called even if m_menuItem == NULL
 794 void wxMenuItem::DoSetText( const wxString& str )
 795 {
 796     /* '\t' is the deliminator indicating a hot key */
 797     m_text.Empty();
 798     const wxChar *pc = str;
 799     for (; (*pc != wxT('\0')) && (*pc != wxT('\t')); pc++ )
 800     {
 801         if (*pc == wxT('&'))
 802         {
 803 #if GTK_CHECK_VERSION(1, 2, 0)
 804             m_text << wxT('_');
 805         }
 806         else if ( *pc == wxT('_') )    // escape underscores
 807         {
 808             m_text << wxT("__");
 809         }
 810         else if (*pc == wxT('/'))      /* we have to filter out slashes ... */
 811         {
 812             m_text << wxT('\\');  /* ... and replace them with back slashes */
 813 #endif // GTK+ 1.2.0+
 814         }
 815         else
 816             m_text << *pc;
 817     }
 818
 819     /* only GTK 1.2 knows about hot keys */
 820     m_hotKey = wxT("");
 821
 822 #if GTK_CHECK_VERSION(1, 2, 0)
 823     if(*pc == wxT('\t'))
 824     {
 825        pc++;
 826        m_hotKey = pc;
 827     }
 828 #endif // GTK+ 1.2.0+
 829 }
 830
 831 #if wxUSE_ACCEL
 832
 833 wxAcceleratorEntry *wxMenuItem::GetAccel() const
 834 {
 835     if ( !GetHotKey() )
 836     {
 837         // nothing
 838         return (wxAcceleratorEntry *)NULL;
 839     }
 840
 841     // as wxGetAccelFromString() looks for TAB, insert a dummy one here
 842     wxString label;
 843     label << wxT('\t') << GetHotKey();
 844
 845     return wxGetAccelFromString(label);
 846 }
 847
 848 #endif // wxUSE_ACCEL
 849
 850 void wxMenuItem::Check( bool check )
 851 {
 852     wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
 853
 854     if (check == m_isChecked)
 855         return;
 856
 857     wxMenuItemBase::Check( check );
 858
 859     switch ( GetKind() )
 860     {
 861         case wxITEM_CHECK:
 862         case wxITEM_RADIO:
 863             gtk_check_menu_item_set_state( (GtkCheckMenuItem*)m_menuItem, (gint)check );
 864             break;
 865
 866         default:
 867             wxFAIL_MSG( _T("can't check this item") );
 868     }
 869 }
 870
 871 void wxMenuItem::Enable( bool enable )
 872 {
 873     wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
 874
 875     gtk_widget_set_sensitive( m_menuItem, enable );
 876     wxMenuItemBase::Enable( enable );
 877 }
 878
 879 bool wxMenuItem::IsChecked() const
 880 {
 881     wxCHECK_MSG( m_menuItem, FALSE, wxT("invalid menu item") );
 882
 883     wxCHECK_MSG( IsCheckable(), FALSE,
 884                  wxT("can't get state of uncheckable item!") );
 885
 886     return ((GtkCheckMenuItem*)m_menuItem)->active != 0;
 887 }
 888
 889 wxString wxMenuItem::GetFactoryPath() const
 890 {
 891     /* in order to get the pointer to the item we need the item text
 892        _without_ underscores */
 893     wxString path( wxT("<main>/") );
 894
 895     for ( const wxChar *pc = m_text.c_str(); *pc; pc++ )
 896     {
 897         if ( *pc == wxT('_') || *pc == wxT('&') )
 898         {
 899             // remove '_' and '&' unconditionally
 900             continue;
 901         }
 902
 903         path += *pc;
 904     }
 905
 906     return path;
 907 }
 908
 909 //-----------------------------------------------------------------------------
 910 // wxMenu
 911 //-----------------------------------------------------------------------------
 912
 913 IMPLEMENT_DYNAMIC_CLASS(wxMenu,wxEvtHandler)
 914
 915 void wxMenu::Init()
 916 {
 917 #if GTK_CHECK_VERSION(1, 2, 0)
 918     m_accel = gtk_accel_group_new();
 919     m_factory = gtk_item_factory_new( GTK_TYPE_MENU, "<main>", m_accel );
 920     m_menu = gtk_item_factory_get_widget( m_factory, "<main>" );
 921 #else
 922     m_menu = gtk_menu_new();  // Do not show!
 923 #endif
 924
 925     m_owner = (GtkWidget*) NULL;
 926
 927 #if GTK_CHECK_VERSION(1, 2, 0)
 928     /* Tearoffs are entries, just like separators. So if we want this
 929        menu to be a tear-off one, we just append a tearoff entry
 930        immediately. */
 931     if(m_style & wxMENU_TEAROFF)
 932     {
 933        GtkItemFactoryEntry entry;
 934        entry.path = (char *)"/tearoff";
 935        entry.callback = (GtkItemFactoryCallback) NULL;
 936        entry.callback_action = 0;
 937        entry.item_type = (char *)"<Tearoff>";
 938        entry.accelerator = (gchar*) NULL;
 939        gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
 940        //GtkWidget *menuItem = gtk_item_factory_get_widget( m_factory, "<main>/tearoff" );
 941     }
 942 #endif // GTK+ 1.2.0+
 943
 944     // append the title as the very first entry if we have it
 945     if ( !!m_title )
 946     {
 947         Append(-2, m_title);
 948         AppendSeparator();
 949     }
 950 }
 951
 952 wxMenu::~wxMenu()
 953 {
 954    m_items.Clear();
 955
 956    gtk_widget_destroy( m_menu );
 957
 958    gtk_object_unref( GTK_OBJECT(m_factory) );
 959 }
 960
 961 bool wxMenu::GtkAppend(wxMenuItem *mitem)
 962 {
 963     GtkWidget *menuItem;
 964
 965 #if defined(USE_MENU_BITMAPS) || !GTK_CHECK_VERSION(1, 2, 0)
 966     bool appended = FALSE;
 967 #endif
 968
 969 #if GTK_CHECK_VERSION(1, 2, 0)
 970     // does this item terminate the current radio group?
 971     bool endOfRadioGroup = TRUE;
 972 #endif // GTK+ >= 1.2
 973
 974     if ( mitem->IsSeparator() )
 975     {
 976 #if GTK_CHECK_VERSION(1, 2, 0)
 977         GtkItemFactoryEntry entry;
 978         entry.path = (char *)"/sep";
 979         entry.callback = (GtkItemFactoryCallback) NULL;
 980         entry.callback_action = 0;
 981         entry.item_type = (char *)"<Separator>";
 982         entry.accelerator = (gchar*) NULL;
 983
 984         gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
 985
 986         /* this will be wrong for more than one separator. do we care? */
 987         menuItem = gtk_item_factory_get_widget( m_factory, "<main>/sep" );
 988
 989         // we might have a separator inside a radio group
 990         endOfRadioGroup = FALSE;
 991 #else // GTK+ 1.0
 992         menuItem = gtk_menu_item_new();
 993 #endif // GTK 1.2/1.0
 994     }
 995     else if ( mitem->IsSubMenu() )
 996     {
 997 #if GTK_CHECK_VERSION(1, 2, 0)
 998         /* text has "_" instead of "&" after mitem->SetText() */
 999         wxString text( mitem->GetText() );
1000
1001         /* local buffer in multibyte form */
1002         char buf[200];
1003         strcpy( buf, "/" );
1004         strcat( buf, text.mb_str() );
1005
1006         GtkItemFactoryEntry entry;
1007         entry.path = buf;
1008         entry.callback = (GtkItemFactoryCallback) 0;
1009         entry.callback_action = 0;
1010         entry.item_type = (char *)"<Branch>";
1011         entry.accelerator = (gchar*) NULL;
1012
1013         gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
1014
1015         wxString path( mitem->GetFactoryPath() );
1016         menuItem = gtk_item_factory_get_item( m_factory, path.mb_str() );
1017 #else // GTK+ 1.0
1018         menuItem = gtk_menu_item_new_with_label(mitem->GetText().mbc_str());
1019 #endif // GTK 1.2/1.0
1020
1021         gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem), mitem->GetSubMenu()->m_menu );
1022
1023         // if adding a submenu to a menu already existing in the menu bar, we
1024         // must set invoking window to allow processing events from this
1025         // submenu
1026         if ( m_invokingWindow )
1027             wxMenubarSetInvokingWindow(mitem->GetSubMenu(), m_invokingWindow);
1028     }
1029 #ifdef USE_MENU_BITMAPS
1030     else if (mitem->GetBitmap().Ok()) // An item with bitmap
1031     {
1032         wxString text( mitem->GetText() );
1033         const wxBitmap *bitmap = &mitem->GetBitmap();
1034
1035         menuItem = gtk_pixmap_menu_item_new ();
1036         GtkWidget *label = gtk_accel_label_new (text.mb_str());
1037         gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
1038         gtk_container_add (GTK_CONTAINER (menuItem), label);
1039         guint accel_key = gtk_label_parse_uline (GTK_LABEL(label), text.mb_str() );
1040         gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (label), menuItem);
1041         if (accel_key != GDK_VoidSymbol)
1042             {
1043             gtk_widget_add_accelerator (menuItem,
1044                                         "activate_item",
1045                                         gtk_menu_ensure_uline_accel_group (GTK_MENU (m_menu)),
1046                                         accel_key, 0,
1047                                         GTK_ACCEL_LOCKED);
1048         }
1049         gtk_widget_show (label);
1050
1051         mitem->SetLabelWidget(label);
1052
1053         GtkWidget* pixmap = gtk_pixmap_new( bitmap->GetPixmap(), bitmap->GetMask() ? bitmap->GetMask()->GetBitmap() : (GdkBitmap* )NULL);
1054         gtk_widget_show(pixmap);
1055         gtk_pixmap_menu_item_set_pixmap(GTK_PIXMAP_MENU_ITEM( menuItem ), pixmap);
1056
1057         gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
1058                             GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
1059                             (gpointer)this );
1060         gtk_menu_append( GTK_MENU(m_menu), menuItem );
1061         gtk_widget_show( menuItem );
1062
1063         appended = TRUE; // We've done this, don't do it again
1064     }
1065 #endif // USE_MENU_BITMAPS
1066     else // a normal item
1067     {
1068 #if GTK_CHECK_VERSION(1, 2, 0)
1069         /* text has "_" instead of "&" after mitem->SetText() */
1070         wxString text( mitem->GetText() );
1071
1072         /* local buffer in multibyte form */
1073         char buf[200];
1074         strcpy( buf, "/" );
1075         strncat( buf, text.mb_str(), WXSIZEOF(buf) - 2 );
1076         buf[WXSIZEOF(buf) - 1] = '\0';
1077
1078         GtkItemFactoryEntry entry;
1079         entry.path = buf;
1080         entry.callback = (GtkItemFactoryCallback) gtk_menu_clicked_callback;
1081         entry.callback_action = 0;
1082
1083         wxString pathRadio;
1084         const char *item_type;
1085         switch ( mitem->GetKind() )
1086         {
1087             case wxITEM_CHECK:
1088                 item_type = "<CheckItem>";
1089                 break;
1090
1091             case wxITEM_RADIO:
1092                 if ( m_pathLastRadio.empty() )
1093                 {
1094                     // start of a new radio group
1095                     item_type = "<RadioItem>";
1096                     m_pathLastRadio = buf + 1;
1097                 }
1098                 else // continue the radio group
1099                 {
1100                     pathRadio = m_pathLastRadio;
1101                     pathRadio.Replace("_", "");
1102                     pathRadio.Prepend("<main>/");
1103                     item_type = pathRadio;
1104                 }
1105
1106                 // continue the existing radio group, if any
1107                 endOfRadioGroup = FALSE;
1108                 break;
1109
1110             default:
1111                 wxFAIL_MSG( _T("unexpected menu item kind") );
1112                 // fall through
1113
1114             case wxITEM_NORMAL:
1115                 item_type = "<Item>";
1116                 break;
1117         }
1118
1119         entry.item_type = (char *)item_type; // cast needed for GTK+
1120         entry.accelerator = (gchar*) NULL;
1121
1122 #if wxUSE_ACCEL
1123         // due to an apparent bug in GTK+, we have to use a static buffer here -
1124         // otherwise GTK+ 1.2.2 manages to override the memory we pass to it
1125         // somehow! (VZ)
1126         static char s_accel[50]; // must be big enougg
1127         wxString tmp( GetHotKey(*mitem) );
1128         strncpy(s_accel, tmp.mb_str(), WXSIZEOF(s_accel));
1129         entry.accelerator = s_accel;
1130 #else // !wxUSE_ACCEL
1131         entry.accelerator = (char*) NULL;
1132 #endif // wxUSE_ACCEL/!wxUSE_ACCEL
1133
1134         gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
1135
1136         wxString path( mitem->GetFactoryPath() );
1137         menuItem = gtk_item_factory_get_widget( m_factory, path.mb_str() );
1138 #else // GTK+ 1.0
1139         menuItem = checkable ? gtk_check_menu_item_new_with_label( mitem->GetText().mb_str() )
1140                              : gtk_menu_item_new_with_label( mitem->GetText().mb_str() );
1141
1142         gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
1143                             GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
1144                             (gpointer)this );
1145 #endif // GTK+ 1.2/1.0
1146     }
1147
1148     if ( !mitem->IsSeparator() )
1149     {
1150         gtk_signal_connect( GTK_OBJECT(menuItem), "select",
1151                             GTK_SIGNAL_FUNC(gtk_menu_hilight_callback),
1152                             (gpointer)this );
1153
1154         gtk_signal_connect( GTK_OBJECT(menuItem), "deselect",
1155                             GTK_SIGNAL_FUNC(gtk_menu_nolight_callback),
1156                             (gpointer)this );
1157     }
1158
1159 #if !GTK_CHECK_VERSION(1, 2, 0)
1160     if (!appended)
1161     {
1162         gtk_menu_append( GTK_MENU(m_menu), menuItem );
1163         gtk_widget_show( menuItem );
1164     }
1165 #endif // GTK+ 1.0
1166
1167     mitem->SetMenuItem(menuItem);
1168
1169 #if GTK_CHECK_VERSION(1, 2, 0)
1170     if ( endOfRadioGroup )
1171     {
1172         m_pathLastRadio.clear();
1173     }
1174 #endif // GTK+ >= 1.2
1175
1176     return TRUE;
1177 }
1178
1179 bool wxMenu::DoAppend(wxMenuItem *mitem)
1180 {
1181     return GtkAppend(mitem) && wxMenuBase::DoAppend(mitem);
1182 }
1183
1184 bool wxMenu::DoInsert(size_t pos, wxMenuItem *item)
1185 {
1186     if ( !wxMenuBase::DoInsert(pos, item) )
1187         return FALSE;
1188
1189 #ifdef __WXGTK12__
1190     // GTK+ doesn't have a function to insert a menu using GtkItemFactory (as
1191     // of version 1.2.6), so we first append the item and then change its
1192     // index
1193     if ( !GtkAppend(item) )
1194         return FALSE;
1195
1196     if ( m_style & wxMENU_TEAROFF )
1197     {
1198         // change the position as the first item is the tear-off marker
1199         pos++;
1200     }
1201
1202     GtkMenuShell *menu_shell = GTK_MENU_SHELL(m_factory->widget);
1203     gpointer data = g_list_last(menu_shell->children)->data;
1204     menu_shell->children = g_list_remove(menu_shell->children, data);
1205     menu_shell->children = g_list_insert(menu_shell->children, data, pos);
1206
1207     return TRUE;
1208 #else // GTK < 1.2
1209     // this should be easy to do...
1210     wxFAIL_MSG( wxT("not implemented") );
1211
1212     return FALSE;
1213 #endif // GTK 1.2/1.0
1214 }
1215
1216 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
1217 {
1218     if ( !wxMenuBase::DoRemove(item) )
1219         return (wxMenuItem *)NULL;
1220
1221     // TODO: this code doesn't delete the item factory item and this seems
1222     //       impossible as of GTK 1.2.6.
1223     gtk_widget_destroy( item->GetMenuItem() );
1224
1225     return item;
1226 }
1227
1228 int wxMenu::FindMenuIdByMenuItem( GtkWidget *menuItem ) const
1229 {
1230     wxNode *node = m_items.First();
1231     while (node)
1232     {
1233         wxMenuItem *item = (wxMenuItem*)node->Data();
1234         if (item->GetMenuItem() == menuItem)
1235            return item->GetId();
1236         node = node->Next();
1237     }
1238
1239     return wxNOT_FOUND;
1240 }
1241
1242 // ----------------------------------------------------------------------------
1243 // helpers
1244 // ----------------------------------------------------------------------------
1245
1246 #if GTK_CHECK_VERSION(1, 2, 0) && wxUSE_ACCEL
1247
1248 static wxString GetHotKey( const wxMenuItem& item )
1249 {
1250     wxString hotkey;
1251
1252     wxAcceleratorEntry *accel = item.GetAccel();
1253     if ( accel )
1254     {
1255         int flags = accel->GetFlags();
1256         if ( flags & wxACCEL_ALT )
1257             hotkey += wxT("<alt>");
1258         if ( flags & wxACCEL_CTRL )
1259             hotkey += wxT("<control>");
1260         if ( flags & wxACCEL_SHIFT )
1261             hotkey += wxT("<shift>");
1262
1263         int code = accel->GetKeyCode();
1264         switch ( code )
1265         {
1266             case WXK_F1:
1267             case WXK_F2:
1268             case WXK_F3:
1269             case WXK_F4:
1270             case WXK_F5:
1271             case WXK_F6:
1272             case WXK_F7:
1273             case WXK_F8:
1274             case WXK_F9:
1275             case WXK_F10:
1276             case WXK_F11:
1277             case WXK_F12:
1278                 hotkey << wxT('F') << code - WXK_F1 + 1;
1279                 break;
1280
1281                 // TODO: we should use gdk_keyval_name() (a.k.a.
1282                 //       XKeysymToString) here as well as hardcoding the keysym
1283                 //       names this might be not portable
1284             case WXK_NUMPAD_INSERT:
1285                 hotkey << wxT("KP_Insert" );
1286                 break;
1287             case WXK_NUMPAD_DELETE:
1288                 hotkey << wxT("KP_Delete" );
1289                 break;
1290             case WXK_INSERT:
1291                 hotkey << wxT("Insert" );
1292                 break;
1293             case WXK_DELETE:
1294                 hotkey << wxT("Delete" );
1295                 break;
1296
1297                 // if there are any other keys wxGetAccelFromString() may
1298                 // return, we should process them here
1299
1300             default:
1301                 if ( code < 127 )
1302                 {
1303                     gchar *name = gdk_keyval_name((guint)code);
1304                     if ( name )
1305                     {
1306                         hotkey << name;
1307                         break;
1308                     }
1309                 }
1310
1311                 wxFAIL_MSG( wxT("unknown keyboard accel") );
1312         }
1313
1314         delete accel;
1315     }
1316
1317     return hotkey;
1318 }
1319
1320 #endif // wxUSE_ACCEL
1321
1322
1323 //-----------------------------------------------------------------------------
1324 // substitute for missing GtkPixmapMenuItem
1325 //-----------------------------------------------------------------------------
1326
1327 #ifdef USE_MENU_BITMAPS
1328
1329 /*
1330  * Copyright (C) 1998, 1999, 2000 Free Software Foundation
1331  * All rights reserved.
1332  *
1333  * This file is part of the Gnome Library.
1334  *
1335  * The Gnome Library is free software; you can redistribute it and/or
1336  * modify it under the terms of the GNU Library General Public License as
1337  * published by the Free Software Foundation; either version 2 of the
1338  * License, or (at your option) any later version.
1339  *
1340  * The Gnome Library is distributed in the hope that it will be useful,
1341  * but WITHOUT ANY WARRANTY; without even the implied warranty of
1342  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
1343  * Library General Public License for more details.
1344  *
1345  * You should have received a copy of the GNU Library General Public
1346  * License along with the Gnome Library; see the file COPYING.LIB.  If not,
1347  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
1348  * Boston, MA 02111-1307, USA.
1349  */
1350 /*
1351   @NOTATION@
1352  */
1353
1354 /* Author: Dietmar Maurer <dm@vlsivie.tuwien.ac.at> */
1355
1356 #include <gtk/gtkaccellabel.h>
1357 #include <gtk/gtksignal.h>
1358 #include <gtk/gtkmenuitem.h>
1359 #include <gtk/gtkmenu.h>
1360 #include <gtk/gtkcontainer.h>
1361
1362 extern "C"
1363 {
1364
1365 static void gtk_pixmap_menu_item_class_init    (GtkPixmapMenuItemClass *klass);
1366 static void gtk_pixmap_menu_item_init          (GtkPixmapMenuItem      *menu_item);
1367 static void gtk_pixmap_menu_item_draw          (GtkWidget              *widget,
1368                                                 GdkRectangle           *area);
1369 static gint gtk_pixmap_menu_item_expose        (GtkWidget              *widget,
1370                                                 GdkEventExpose         *event);
1371
1372 /* we must override the following functions */
1373
1374 static void gtk_pixmap_menu_item_map           (GtkWidget        *widget);
1375 static void gtk_pixmap_menu_item_size_allocate (GtkWidget        *widget,
1376                                                 GtkAllocation    *allocation);
1377 static void gtk_pixmap_menu_item_forall        (GtkContainer    *container,
1378                                                 gboolean         include_internals,
1379                                                 GtkCallback      callback,
1380                                                 gpointer         callback_data);
1381 static void gtk_pixmap_menu_item_size_request  (GtkWidget        *widget,
1382                                                 GtkRequisition   *requisition);
1383 static void gtk_pixmap_menu_item_remove        (GtkContainer *container,
1384                                                 GtkWidget    *child);
1385
1386 static void changed_have_pixmap_status         (GtkPixmapMenuItem *menu_item);
1387
1388 static GtkMenuItemClass *parent_class = NULL;
1389
1390 }
1391
1392 #define BORDER_SPACING  3
1393 #define PMAP_WIDTH 20
1394
1395 GtkType
1396 gtk_pixmap_menu_item_get_type (void)
1397 {
1398   static GtkType pixmap_menu_item_type = 0;
1399
1400   if (!pixmap_menu_item_type)
1401     {
1402       GtkTypeInfo pixmap_menu_item_info =
1403       {
1404         (char *)"GtkPixmapMenuItem",
1405         sizeof (GtkPixmapMenuItem),
1406         sizeof (GtkPixmapMenuItemClass),
1407         (GtkClassInitFunc) gtk_pixmap_menu_item_class_init,
1408         (GtkObjectInitFunc) gtk_pixmap_menu_item_init,
1409         /* reserved_1 */ NULL,
1410         /* reserved_2 */ NULL,
1411         (GtkClassInitFunc) NULL,
1412       };
1413
1414       pixmap_menu_item_type = gtk_type_unique (gtk_menu_item_get_type (),
1415                                                &pixmap_menu_item_info);
1416     }
1417
1418   return pixmap_menu_item_type;
1419 }
1420
1421 /**
1422  * gtk_pixmap_menu_item_new
1423  *
1424  * Creates a new pixmap menu item. Use gtk_pixmap_menu_item_set_pixmap()
1425  * to set the pixmap wich is displayed at the left side.
1426  *
1427  * Returns:
1428  * &GtkWidget pointer to new menu item
1429  **/
1430
1431 GtkWidget*
1432 gtk_pixmap_menu_item_new (void)
1433 {
1434   return GTK_WIDGET (gtk_type_new (gtk_pixmap_menu_item_get_type ()));
1435 }
1436
1437 static void
1438 gtk_pixmap_menu_item_class_init (GtkPixmapMenuItemClass *klass)
1439 {
1440   GtkObjectClass *object_class;
1441   GtkWidgetClass *widget_class;
1442   GtkMenuItemClass *menu_item_class;
1443   GtkContainerClass *container_class;
1444
1445   object_class = (GtkObjectClass*) klass;
1446   widget_class = (GtkWidgetClass*) klass;
1447   menu_item_class = (GtkMenuItemClass*) klass;
1448   container_class = (GtkContainerClass*) klass;
1449
1450   parent_class = (GtkMenuItemClass*) gtk_type_class (gtk_menu_item_get_type ());
1451
1452   widget_class->draw = gtk_pixmap_menu_item_draw;
1453   widget_class->expose_event = gtk_pixmap_menu_item_expose;
1454   widget_class->map = gtk_pixmap_menu_item_map;
1455   widget_class->size_allocate = gtk_pixmap_menu_item_size_allocate;
1456   widget_class->size_request = gtk_pixmap_menu_item_size_request;
1457
1458   container_class->forall = gtk_pixmap_menu_item_forall;
1459   container_class->remove = gtk_pixmap_menu_item_remove;
1460
1461   klass->orig_toggle_size = menu_item_class->toggle_size;
1462   klass->have_pixmap_count = 0;
1463 }
1464
1465 static void
1466 gtk_pixmap_menu_item_init (GtkPixmapMenuItem *menu_item)
1467 {
1468   GtkMenuItem *mi;
1469
1470   mi = GTK_MENU_ITEM (menu_item);
1471
1472   menu_item->pixmap = NULL;
1473 }
1474
1475 static void
1476 gtk_pixmap_menu_item_draw (GtkWidget    *widget,
1477                            GdkRectangle *area)
1478 {
1479   g_return_if_fail (widget != NULL);
1480   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (widget));
1481   g_return_if_fail (area != NULL);
1482
1483   if (GTK_WIDGET_CLASS (parent_class)->draw)
1484     (* GTK_WIDGET_CLASS (parent_class)->draw) (widget, area);
1485
1486   if (GTK_WIDGET_DRAWABLE (widget) &&
1487       GTK_PIXMAP_MENU_ITEM(widget)->pixmap) {
1488     gtk_widget_draw(GTK_WIDGET(GTK_PIXMAP_MENU_ITEM(widget)->pixmap),NULL);
1489   }
1490 }
1491
1492 static gint
1493 gtk_pixmap_menu_item_expose (GtkWidget      *widget,
1494                              GdkEventExpose *event)
1495 {
1496   g_return_val_if_fail (widget != NULL, FALSE);
1497   g_return_val_if_fail (GTK_IS_PIXMAP_MENU_ITEM (widget), FALSE);
1498   g_return_val_if_fail (event != NULL, FALSE);
1499
1500   if (GTK_WIDGET_CLASS (parent_class)->expose_event)
1501     (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
1502
1503   if (GTK_WIDGET_DRAWABLE (widget) &&
1504       GTK_PIXMAP_MENU_ITEM(widget)->pixmap) {
1505     gtk_widget_draw(GTK_WIDGET(GTK_PIXMAP_MENU_ITEM(widget)->pixmap),NULL);
1506   }
1507
1508   return FALSE;
1509 }
1510
1511 /**
1512  * gtk_pixmap_menu_item_set_pixmap
1513  * @menu_item: Pointer to the pixmap menu item
1514  * @pixmap: Pointer to a pixmap widget
1515  *
1516  * Set the pixmap of the menu item.
1517  *
1518  **/
1519
1520 void
1521 gtk_pixmap_menu_item_set_pixmap (GtkPixmapMenuItem *menu_item,
1522                                  GtkWidget         *pixmap)
1523 {
1524   g_return_if_fail (menu_item != NULL);
1525   g_return_if_fail (pixmap != NULL);
1526   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (menu_item));
1527   g_return_if_fail (GTK_IS_WIDGET (pixmap));
1528   g_return_if_fail (menu_item->pixmap == NULL);
1529
1530   gtk_widget_set_parent (pixmap, GTK_WIDGET (menu_item));
1531   menu_item->pixmap = pixmap;
1532
1533   if (GTK_WIDGET_REALIZED (pixmap->parent) &&
1534       !GTK_WIDGET_REALIZED (pixmap))
1535     gtk_widget_realize (pixmap);
1536
1537   if (GTK_WIDGET_VISIBLE (pixmap->parent)) {
1538     if (GTK_WIDGET_MAPPED (pixmap->parent) &&
1539         GTK_WIDGET_VISIBLE(pixmap) &&
1540         !GTK_WIDGET_MAPPED (pixmap))
1541       gtk_widget_map (pixmap);
1542   }
1543
1544   changed_have_pixmap_status(menu_item);
1545
1546   if (GTK_WIDGET_VISIBLE (pixmap) && GTK_WIDGET_VISIBLE (menu_item))
1547     gtk_widget_queue_resize (pixmap);
1548 }
1549
1550 static void
1551 gtk_pixmap_menu_item_map (GtkWidget *widget)
1552 {
1553   GtkPixmapMenuItem *menu_item;
1554
1555   g_return_if_fail (widget != NULL);
1556   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (widget));
1557
1558   menu_item = GTK_PIXMAP_MENU_ITEM(widget);
1559
1560   GTK_WIDGET_CLASS(parent_class)->map(widget);
1561
1562   if (menu_item->pixmap &&
1563       GTK_WIDGET_VISIBLE (menu_item->pixmap) &&
1564       !GTK_WIDGET_MAPPED (menu_item->pixmap))
1565     gtk_widget_map (menu_item->pixmap);
1566 }
1567
1568 static void
1569 gtk_pixmap_menu_item_size_allocate (GtkWidget        *widget,
1570                                     GtkAllocation    *allocation)
1571 {
1572   GtkPixmapMenuItem *pmenu_item;
1573
1574   pmenu_item = GTK_PIXMAP_MENU_ITEM(widget);
1575
1576   if (pmenu_item->pixmap && GTK_WIDGET_VISIBLE(pmenu_item))
1577     {
1578       GtkAllocation child_allocation;
1579       int border_width;
1580
1581       border_width = GTK_CONTAINER (widget)->border_width;
1582
1583       child_allocation.width = pmenu_item->pixmap->requisition.width;
1584       child_allocation.height = pmenu_item->pixmap->requisition.height;
1585       child_allocation.x = border_width + BORDER_SPACING;
1586       child_allocation.y = (border_width + BORDER_SPACING
1587                             + (((allocation->height - child_allocation.height) - child_allocation.x)
1588                                / 2)); /* center pixmaps vertically */
1589       gtk_widget_size_allocate (pmenu_item->pixmap, &child_allocation);
1590     }
1591
1592   if (GTK_WIDGET_CLASS (parent_class)->size_allocate)
1593     GTK_WIDGET_CLASS(parent_class)->size_allocate (widget, allocation);
1594 }
1595
1596 static void
1597 gtk_pixmap_menu_item_forall (GtkContainer    *container,
1598                              gboolean         include_internals,
1599                              GtkCallback      callback,
1600                              gpointer         callback_data)
1601 {
1602   GtkPixmapMenuItem *menu_item;
1603
1604   g_return_if_fail (container != NULL);
1605   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (container));
1606   g_return_if_fail (callback != NULL);
1607
1608   menu_item = GTK_PIXMAP_MENU_ITEM (container);
1609
1610   if (menu_item->pixmap)
1611     (* callback) (menu_item->pixmap, callback_data);
1612
1613   GTK_CONTAINER_CLASS(parent_class)->forall(container,include_internals,
1614                                             callback,callback_data);
1615 }
1616
1617 static void
1618 gtk_pixmap_menu_item_size_request (GtkWidget      *widget,
1619                                    GtkRequisition *requisition)
1620 {
1621   GtkPixmapMenuItem *menu_item;
1622   GtkRequisition req = {0, 0};
1623
1624   g_return_if_fail (widget != NULL);
1625   g_return_if_fail (GTK_IS_MENU_ITEM (widget));
1626   g_return_if_fail (requisition != NULL);
1627
1628   GTK_WIDGET_CLASS(parent_class)->size_request(widget,requisition);
1629
1630   menu_item = GTK_PIXMAP_MENU_ITEM (widget);
1631
1632   if (menu_item->pixmap)
1633     gtk_widget_size_request(menu_item->pixmap, &req);
1634
1635   requisition->height = MAX(req.height + GTK_CONTAINER(widget)->border_width + BORDER_SPACING, (unsigned int) requisition->height);
1636   requisition->width += (req.width + GTK_CONTAINER(widget)->border_width + BORDER_SPACING);
1637 }
1638
1639 static void
1640 gtk_pixmap_menu_item_remove (GtkContainer *container,
1641                              GtkWidget    *child)
1642 {
1643   GtkBin *bin;
1644   gboolean widget_was_visible;
1645
1646   g_return_if_fail (container != NULL);
1647   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (container));
1648   g_return_if_fail (child != NULL);
1649   g_return_if_fail (GTK_IS_WIDGET (child));
1650
1651   bin = GTK_BIN (container);
1652   g_return_if_fail ((bin->child == child ||
1653                      (GTK_PIXMAP_MENU_ITEM(container)->pixmap == child)));
1654
1655   widget_was_visible = GTK_WIDGET_VISIBLE (child);
1656
1657   gtk_widget_unparent (child);
1658   if (bin->child == child)
1659     bin->child = NULL;
1660   else {
1661     GTK_PIXMAP_MENU_ITEM(container)->pixmap = NULL;
1662     changed_have_pixmap_status(GTK_PIXMAP_MENU_ITEM(container));
1663   }
1664
1665   if (widget_was_visible)
1666     gtk_widget_queue_resize (GTK_WIDGET (container));
1667 }
1668
1669
1670 /* important to only call this if there was actually a _change_ in pixmap == NULL */
1671 static void
1672 changed_have_pixmap_status (GtkPixmapMenuItem *menu_item)
1673 {
1674   if (menu_item->pixmap != NULL) {
1675     GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count += 1;
1676
1677     if (GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count == 1) {
1678       /* Install pixmap toggle size */
1679       GTK_MENU_ITEM_GET_CLASS(menu_item)->toggle_size = MAX(GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->orig_toggle_size, PMAP_WIDTH);
1680     }
1681   } else {
1682     GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count -= 1;
1683
1684     if (GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count == 0) {
1685       /* Install normal toggle size */
1686       GTK_MENU_ITEM_GET_CLASS(menu_item)->toggle_size = GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->orig_toggle_size;
1687     }
1688   }
1689
1690   /* Note that we actually need to do this for _all_ GtkPixmapMenuItem
1691      whenever the klass->toggle_size changes; but by doing it anytime
1692      this function is called, we get the same effect, just because of
1693      how the preferences option to show pixmaps works. Bogus, broken.
1694   */
1695   if (GTK_WIDGET_VISIBLE(GTK_WIDGET(menu_item)))
1696     gtk_widget_queue_resize(GTK_WIDGET(menu_item));
1697 }
1698
1699 #endif // USE_MENU_BITMAPS
1700