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