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                                 bool isCheckable,
 703                                 wxMenu *subMenu)
 704 {
 705     return new wxMenuItem(parentMenu, id, name, help, isCheckable, subMenu);
 706 }
 707
 708 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
 709                        int id,
 710                        const wxString& text,
 711                        const wxString& help,
 712                        bool isCheckable,
 713                        wxMenu *subMenu)
 714 {
 715     m_id = id;
 716     m_isCheckable = isCheckable;
 717     m_isChecked = FALSE;
 718     m_isEnabled = TRUE;
 719     m_subMenu = subMenu;
 720     m_parentMenu = parentMenu;
 721     m_help = help;
 722
 723     m_labelWidget = (GtkWidget *) NULL;
 724     m_menuItem = (GtkWidget *) NULL;
 725
 726     DoSetText(text);
 727 }
 728
 729 wxMenuItem::~wxMenuItem()
 730 {
 731    // don't delete menu items, the menus take care of that
 732 }
 733
 734 // return the menu item text without any menu accels
 735 /* static */
 736 wxString wxMenuItemBase::GetLabelFromText(const wxString& text)
 737 {
 738     wxString label;
 739
 740     for ( const wxChar *pc = text.c_str(); *pc; pc++ )
 741     {
 742         if ( *pc == wxT('_')  )
 743         {
 744             // wxGTK escapes "xxx_xxx" to "xxx__xxx"
 745             pc++;
 746             label += *pc;
 747             continue;
 748         }
 749
 750         if ( *pc == wxT('&') )
 751         {
 752             // wxMSW escapes &
 753             continue;
 754         }
 755
 756         label += *pc;
 757     }
 758
 759     return label;
 760 }
 761
 762 void wxMenuItem::SetText( const wxString& str )
 763 {
 764     DoSetText(str);
 765
 766     if (m_menuItem)
 767     {
 768         GtkLabel *label;
 769         if (m_labelWidget)
 770           label = (GtkLabel*) m_labelWidget;
 771         else
 772           label = GTK_LABEL( GTK_BIN(m_menuItem)->child );
 773
 774         /* set new text */
 775         gtk_label_set( label, m_text.mb_str());
 776
 777         /* reparse key accel */
 778         (void)gtk_label_parse_uline (GTK_LABEL(label), m_text.mb_str() );
 779         gtk_accel_label_refetch( GTK_ACCEL_LABEL(label) );
 780     }
 781 }
 782
 783 // it's valid for this function to be called even if m_menuItem == NULL
 784 void wxMenuItem::DoSetText( const wxString& str )
 785 {
 786     /* '\t' is the deliminator indicating a hot key */
 787     m_text.Empty();
 788     const wxChar *pc = str;
 789     for (; (*pc != wxT('\0')) && (*pc != wxT('\t')); pc++ )
 790     {
 791         if (*pc == wxT('&'))
 792         {
 793 #if GTK_CHECK_VERSION(1, 2, 0)
 794             m_text << wxT('_');
 795         }
 796         else if ( *pc == wxT('_') )    // escape underscores
 797         {
 798             m_text << wxT("__");
 799         }
 800         else if (*pc == wxT('/'))      /* we have to filter out slashes ... */
 801         {
 802             m_text << wxT('\\');  /* ... and replace them with back slashes */
 803 #endif // GTK+ 1.2.0+
 804         }
 805         else
 806             m_text << *pc;
 807     }
 808
 809     /* only GTK 1.2 knows about hot keys */
 810     m_hotKey = wxT("");
 811
 812 #if GTK_CHECK_VERSION(1, 2, 0)
 813     if(*pc == wxT('\t'))
 814     {
 815        pc++;
 816        m_hotKey = pc;
 817     }
 818 #endif // GTK+ 1.2.0+
 819 }
 820
 821 #if wxUSE_ACCEL
 822
 823 wxAcceleratorEntry *wxMenuItem::GetAccel() const
 824 {
 825     if ( !GetHotKey() )
 826     {
 827         // nothing
 828         return (wxAcceleratorEntry *)NULL;
 829     }
 830
 831     // as wxGetAccelFromString() looks for TAB, insert a dummy one here
 832     wxString label;
 833     label << wxT('\t') << GetHotKey();
 834
 835     return wxGetAccelFromString(label);
 836 }
 837
 838 #endif // wxUSE_ACCEL
 839
 840 void wxMenuItem::Check( bool check )
 841 {
 842     wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
 843
 844     wxCHECK_RET( IsCheckable(), wxT("Can't check uncheckable item!") )
 845
 846     if (check == m_isChecked)
 847         return;
 848
 849     wxMenuItemBase::Check( check );
 850     gtk_check_menu_item_set_state( (GtkCheckMenuItem*)m_menuItem, (gint)check );
 851 }
 852
 853 void wxMenuItem::Enable( bool enable )
 854 {
 855     wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
 856
 857     gtk_widget_set_sensitive( m_menuItem, enable );
 858     wxMenuItemBase::Enable( enable );
 859 }
 860
 861 bool wxMenuItem::IsChecked() const
 862 {
 863     wxCHECK_MSG( m_menuItem, FALSE, wxT("invalid menu item") );
 864
 865     wxCHECK_MSG( IsCheckable(), FALSE,
 866                  wxT("can't get state of uncheckable item!") );
 867
 868     return ((GtkCheckMenuItem*)m_menuItem)->active != 0;
 869 }
 870
 871 wxString wxMenuItem::GetFactoryPath() const
 872 {
 873     /* in order to get the pointer to the item we need the item text
 874        _without_ underscores */
 875     wxString path( wxT("<main>/") );
 876
 877     for ( const wxChar *pc = m_text.c_str(); *pc; pc++ )
 878     {
 879         if ( *pc == wxT('_') || *pc == wxT('&') )
 880         {
 881             // remove '_' and '&' unconditionally
 882             continue;
 883         }
 884
 885         path += *pc;
 886     }
 887
 888     return path;
 889 }
 890
 891 //-----------------------------------------------------------------------------
 892 // wxMenu
 893 //-----------------------------------------------------------------------------
 894
 895 IMPLEMENT_DYNAMIC_CLASS(wxMenu,wxEvtHandler)
 896
 897 void wxMenu::Init()
 898 {
 899 #if GTK_CHECK_VERSION(1, 2, 0)
 900     m_accel = gtk_accel_group_new();
 901     m_factory = gtk_item_factory_new( GTK_TYPE_MENU, "<main>", m_accel );
 902     m_menu = gtk_item_factory_get_widget( m_factory, "<main>" );
 903 #else
 904     m_menu = gtk_menu_new();  // Do not show!
 905 #endif
 906
 907     m_owner = (GtkWidget*) NULL;
 908
 909 #if GTK_CHECK_VERSION(1, 2, 0)
 910     /* Tearoffs are entries, just like separators. So if we want this
 911        menu to be a tear-off one, we just append a tearoff entry
 912        immediately. */
 913     if(m_style & wxMENU_TEAROFF)
 914     {
 915        GtkItemFactoryEntry entry;
 916        entry.path = (char *)"/tearoff";
 917        entry.callback = (GtkItemFactoryCallback) NULL;
 918        entry.callback_action = 0;
 919        entry.item_type = (char *)"<Tearoff>";
 920        entry.accelerator = (gchar*) NULL;
 921        gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
 922        //GtkWidget *menuItem = gtk_item_factory_get_widget( m_factory, "<main>/tearoff" );
 923     }
 924 #endif // GTK+ 1.2.0+
 925
 926     // append the title as the very first entry if we have it
 927     if ( !!m_title )
 928     {
 929         Append(-2, m_title);
 930         AppendSeparator();
 931     }
 932 }
 933
 934 wxMenu::~wxMenu()
 935 {
 936    m_items.Clear();
 937
 938    gtk_widget_destroy( m_menu );
 939
 940    gtk_object_unref( GTK_OBJECT(m_factory) );
 941 }
 942
 943 bool wxMenu::GtkAppend(wxMenuItem *mitem)
 944 {
 945     GtkWidget *menuItem;
 946
 947 #if defined(USE_MENU_BITMAPS) || !GTK_CHECK_VERSION(1, 2, 0)
 948     bool appended = FALSE;
 949 #endif
 950
 951     if ( mitem->IsSeparator() )
 952     {
 953 #if GTK_CHECK_VERSION(1, 2, 0)
 954         GtkItemFactoryEntry entry;
 955         entry.path = (char *)"/sep";
 956         entry.callback = (GtkItemFactoryCallback) NULL;
 957         entry.callback_action = 0;
 958         entry.item_type = (char *)"<Separator>";
 959         entry.accelerator = (gchar*) NULL;
 960
 961         gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
 962
 963         /* this will be wrong for more than one separator. do we care? */
 964         menuItem = gtk_item_factory_get_widget( m_factory, "<main>/sep" );
 965 #else // GTK+ 1.0
 966         menuItem = gtk_menu_item_new();
 967 #endif // GTK 1.2/1.0
 968     }
 969     else if ( mitem->IsSubMenu() )
 970     {
 971 #if GTK_CHECK_VERSION(1, 2, 0)
 972         /* text has "_" instead of "&" after mitem->SetText() */
 973         wxString text( mitem->GetText() );
 974
 975         /* local buffer in multibyte form */
 976         char buf[200];
 977         strcpy( buf, "/" );
 978         strcat( buf, text.mb_str() );
 979
 980         GtkItemFactoryEntry entry;
 981         entry.path = buf;
 982         entry.callback = (GtkItemFactoryCallback) 0;
 983         entry.callback_action = 0;
 984         entry.item_type = (char *)"<Branch>";
 985         entry.accelerator = (gchar*) NULL;
 986
 987         gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
 988
 989         wxString path( mitem->GetFactoryPath() );
 990         menuItem = gtk_item_factory_get_item( m_factory, path.mb_str() );
 991 #else // GTK+ 1.0
 992         menuItem = gtk_menu_item_new_with_label(mitem->GetText().mbc_str());
 993 #endif // GTK 1.2/1.0
 994
 995         gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem), mitem->GetSubMenu()->m_menu );
 996
 997         // if adding a submenu to a menu already existing in the menu bar, we
 998         // must set invoking window to allow processing events from this
 999         // submenu
1000         if ( m_invokingWindow )
1001             wxMenubarSetInvokingWindow(mitem->GetSubMenu(), m_invokingWindow);
1002     }
1003 #ifdef USE_MENU_BITMAPS
1004     else if (mitem->GetBitmap().Ok()) // An item with bitmap
1005     {
1006         wxString text( mitem->GetText() );
1007         const wxBitmap *bitmap = &mitem->GetBitmap();
1008
1009         menuItem = gtk_pixmap_menu_item_new ();
1010         GtkWidget *label = gtk_accel_label_new (text.mb_str());
1011         gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
1012         gtk_container_add (GTK_CONTAINER (menuItem), label);
1013         guint accel_key = gtk_label_parse_uline (GTK_LABEL(label), text.mb_str() );
1014         gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (label), menuItem);
1015         if (accel_key != GDK_VoidSymbol)
1016             {
1017             gtk_widget_add_accelerator (menuItem,
1018                                         "activate_item",
1019                                         gtk_menu_ensure_uline_accel_group (GTK_MENU (m_menu)),
1020                                         accel_key, 0,
1021                                         GTK_ACCEL_LOCKED);
1022         }
1023         gtk_widget_show (label);
1024
1025         mitem->SetLabelWidget(label);
1026
1027         GtkWidget* pixmap = gtk_pixmap_new( bitmap->GetPixmap(), bitmap->GetMask() ? bitmap->GetMask()->GetBitmap() : (GdkBitmap* )NULL);
1028         gtk_widget_show(pixmap);
1029         gtk_pixmap_menu_item_set_pixmap(GTK_PIXMAP_MENU_ITEM( menuItem ), pixmap);
1030
1031         gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
1032                             GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
1033                             (gpointer)this );
1034         gtk_menu_append( GTK_MENU(m_menu), menuItem );
1035         gtk_widget_show( menuItem );
1036
1037         appended = TRUE; // We've done this, don't do it again
1038     }
1039 #endif // USE_MENU_BITMAPS
1040     else // a normal item
1041     {
1042 #if GTK_CHECK_VERSION(1, 2, 0)
1043         /* text has "_" instead of "&" after mitem->SetText() */
1044         wxString text( mitem->GetText() );
1045
1046         /* local buffer in multibyte form */
1047         char buf[200];
1048         strcpy( buf, "/" );
1049         strcat( buf, text.mb_str() );
1050
1051         GtkItemFactoryEntry entry;
1052         entry.path = buf;
1053         entry.callback = (GtkItemFactoryCallback) gtk_menu_clicked_callback;
1054         entry.callback_action = 0;
1055         if ( mitem->IsCheckable() )
1056             entry.item_type = (char *)"<CheckItem>";
1057         else
1058             entry.item_type = (char *)"<Item>";
1059         entry.accelerator = (gchar*) NULL;
1060
1061 #if wxUSE_ACCEL
1062         // due to an apparent bug in GTK+, we have to use a static buffer here -
1063         // otherwise GTK+ 1.2.2 manages to override the memory we pass to it
1064         // somehow! (VZ)
1065         static char s_accel[50]; // must be big enougg
1066         wxString tmp( GetHotKey(*mitem) );
1067         strncpy(s_accel, tmp.mb_str(), WXSIZEOF(s_accel));
1068         entry.accelerator = s_accel;
1069 #else // !wxUSE_ACCEL
1070         entry.accelerator = (char*) NULL;
1071 #endif // wxUSE_ACCEL/!wxUSE_ACCEL
1072
1073         gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
1074
1075         wxString path( mitem->GetFactoryPath() );
1076         menuItem = gtk_item_factory_get_widget( m_factory, path.mb_str() );
1077 #else // GTK+ 1.0
1078         menuItem = checkable ? gtk_check_menu_item_new_with_label( mitem->GetText().mb_str() )
1079                              : gtk_menu_item_new_with_label( mitem->GetText().mb_str() );
1080
1081         gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
1082                             GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
1083                             (gpointer)this );
1084 #endif // GTK+ 1.2/1.0
1085     }
1086
1087     if ( !mitem->IsSeparator() )
1088     {
1089         gtk_signal_connect( GTK_OBJECT(menuItem), "select",
1090                             GTK_SIGNAL_FUNC(gtk_menu_hilight_callback),
1091                             (gpointer)this );
1092
1093         gtk_signal_connect( GTK_OBJECT(menuItem), "deselect",
1094                             GTK_SIGNAL_FUNC(gtk_menu_nolight_callback),
1095                             (gpointer)this );
1096     }
1097
1098 #if !GTK_CHECK_VERSION(1, 2, 0)
1099     if (!appended)
1100     {
1101         gtk_menu_append( GTK_MENU(m_menu), menuItem );
1102         gtk_widget_show( menuItem );
1103     }
1104 #endif // GTK+ 1.0
1105
1106     mitem->SetMenuItem(menuItem);
1107
1108     return TRUE;
1109 }
1110
1111 bool wxMenu::DoAppend(wxMenuItem *mitem)
1112 {
1113     return GtkAppend(mitem) && wxMenuBase::DoAppend(mitem);
1114 }
1115
1116 bool wxMenu::DoInsert(size_t pos, wxMenuItem *item)
1117 {
1118     if ( !wxMenuBase::DoInsert(pos, item) )
1119         return FALSE;
1120
1121 #ifdef __WXGTK12__
1122     // GTK+ doesn't have a function to insert a menu using GtkItemFactory (as
1123     // of version 1.2.6), so we first append the item and then change its
1124     // index
1125     if ( !GtkAppend(item) )
1126         return FALSE;
1127
1128     if ( m_style & wxMENU_TEAROFF )
1129     {
1130         // change the position as the first item is the tear-off marker
1131         pos++;
1132     }
1133
1134     GtkMenuShell *menu_shell = GTK_MENU_SHELL(m_factory->widget);
1135     gpointer data = g_list_last(menu_shell->children)->data;
1136     menu_shell->children = g_list_remove(menu_shell->children, data);
1137     menu_shell->children = g_list_insert(menu_shell->children, data, pos);
1138
1139     return TRUE;
1140 #else // GTK < 1.2
1141     // this should be easy to do...
1142     wxFAIL_MSG( wxT("not implemented") );
1143
1144     return FALSE;
1145 #endif // GTK 1.2/1.0
1146 }
1147
1148 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
1149 {
1150     if ( !wxMenuBase::DoRemove(item) )
1151         return (wxMenuItem *)NULL;
1152
1153     // TODO: this code doesn't delete the item factory item and this seems
1154     //       impossible as of GTK 1.2.6.
1155     gtk_widget_destroy( item->GetMenuItem() );
1156
1157     return item;
1158 }
1159
1160 int wxMenu::FindMenuIdByMenuItem( GtkWidget *menuItem ) const
1161 {
1162     wxNode *node = m_items.First();
1163     while (node)
1164     {
1165         wxMenuItem *item = (wxMenuItem*)node->Data();
1166         if (item->GetMenuItem() == menuItem)
1167            return item->GetId();
1168         node = node->Next();
1169     }
1170
1171     return wxNOT_FOUND;
1172 }
1173
1174 // ----------------------------------------------------------------------------
1175 // helpers
1176 // ----------------------------------------------------------------------------
1177
1178 #if GTK_CHECK_VERSION(1, 2, 0) && wxUSE_ACCEL
1179
1180 static wxString GetHotKey( const wxMenuItem& item )
1181 {
1182     wxString hotkey;
1183
1184     wxAcceleratorEntry *accel = item.GetAccel();
1185     if ( accel )
1186     {
1187         int flags = accel->GetFlags();
1188         if ( flags & wxACCEL_ALT )
1189             hotkey += wxT("<alt>");
1190         if ( flags & wxACCEL_CTRL )
1191             hotkey += wxT("<control>");
1192         if ( flags & wxACCEL_SHIFT )
1193             hotkey += wxT("<shift>");
1194
1195         int code = accel->GetKeyCode();
1196         switch ( code )
1197         {
1198             case WXK_F1:
1199             case WXK_F2:
1200             case WXK_F3:
1201             case WXK_F4:
1202             case WXK_F5:
1203             case WXK_F6:
1204             case WXK_F7:
1205             case WXK_F8:
1206             case WXK_F9:
1207             case WXK_F10:
1208             case WXK_F11:
1209             case WXK_F12:
1210                 hotkey << wxT('F') << code - WXK_F1 + 1;
1211                 break;
1212
1213                 // TODO: we should use gdk_keyval_name() (a.k.a.
1214                 //       XKeysymToString) here as well as hardcoding the keysym
1215                 //       names this might be not portable
1216             case WXK_NUMPAD_INSERT:
1217                 hotkey << wxT("KP_Insert" );
1218                 break;
1219             case WXK_NUMPAD_DELETE:
1220                 hotkey << wxT("KP_Delete" );
1221                 break;
1222             case WXK_INSERT:
1223                 hotkey << wxT("Insert" );
1224                 break;
1225             case WXK_DELETE:
1226                 hotkey << wxT("Delete" );
1227                 break;
1228
1229                 // if there are any other keys wxGetAccelFromString() may
1230                 // return, we should process them here
1231
1232             default:
1233                 if ( code < 127 )
1234                 {
1235                     gchar *name = gdk_keyval_name((guint)code);
1236                     if ( name )
1237                     {
1238                         hotkey << name;
1239                         break;
1240                     }
1241                 }
1242
1243                 wxFAIL_MSG( wxT("unknown keyboard accel") );
1244         }
1245
1246         delete accel;
1247     }
1248
1249     return hotkey;
1250 }
1251
1252 #endif // wxUSE_ACCEL
1253
1254
1255 //-----------------------------------------------------------------------------
1256 // substitute for missing GtkPixmapMenuItem
1257 //-----------------------------------------------------------------------------
1258
1259 #ifdef USE_MENU_BITMAPS
1260
1261 /*
1262  * Copyright (C) 1998, 1999, 2000 Free Software Foundation
1263  * All rights reserved.
1264  *
1265  * This file is part of the Gnome Library.
1266  *
1267  * The Gnome Library is free software; you can redistribute it and/or
1268  * modify it under the terms of the GNU Library General Public License as
1269  * published by the Free Software Foundation; either version 2 of the
1270  * License, or (at your option) any later version.
1271  *
1272  * The Gnome Library is distributed in the hope that it will be useful,
1273  * but WITHOUT ANY WARRANTY; without even the implied warranty of
1274  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
1275  * Library General Public License for more details.
1276  *
1277  * You should have received a copy of the GNU Library General Public
1278  * License along with the Gnome Library; see the file COPYING.LIB.  If not,
1279  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
1280  * Boston, MA 02111-1307, USA.
1281  */
1282 /*
1283   @NOTATION@
1284  */
1285
1286 /* Author: Dietmar Maurer <dm@vlsivie.tuwien.ac.at> */
1287
1288 #include <gtk/gtkaccellabel.h>
1289 #include <gtk/gtksignal.h>
1290 #include <gtk/gtkmenuitem.h>
1291 #include <gtk/gtkmenu.h>
1292 #include <gtk/gtkcontainer.h>
1293
1294 extern "C"
1295 {
1296
1297 static void gtk_pixmap_menu_item_class_init    (GtkPixmapMenuItemClass *klass);
1298 static void gtk_pixmap_menu_item_init          (GtkPixmapMenuItem      *menu_item);
1299 static void gtk_pixmap_menu_item_draw          (GtkWidget              *widget,
1300                                                 GdkRectangle           *area);
1301 static gint gtk_pixmap_menu_item_expose        (GtkWidget              *widget,
1302                                                 GdkEventExpose         *event);
1303
1304 /* we must override the following functions */
1305
1306 static void gtk_pixmap_menu_item_map           (GtkWidget        *widget);
1307 static void gtk_pixmap_menu_item_size_allocate (GtkWidget        *widget,
1308                                                 GtkAllocation    *allocation);
1309 static void gtk_pixmap_menu_item_forall        (GtkContainer    *container,
1310                                                 gboolean         include_internals,
1311                                                 GtkCallback      callback,
1312                                                 gpointer         callback_data);
1313 static void gtk_pixmap_menu_item_size_request  (GtkWidget        *widget,
1314                                                 GtkRequisition   *requisition);
1315 static void gtk_pixmap_menu_item_remove        (GtkContainer *container,
1316                                                 GtkWidget    *child);
1317
1318 static void changed_have_pixmap_status         (GtkPixmapMenuItem *menu_item);
1319
1320 static GtkMenuItemClass *parent_class = NULL;
1321
1322 }
1323
1324 #define BORDER_SPACING  3
1325 #define PMAP_WIDTH 20
1326
1327 GtkType
1328 gtk_pixmap_menu_item_get_type (void)
1329 {
1330   static GtkType pixmap_menu_item_type = 0;
1331
1332   if (!pixmap_menu_item_type)
1333     {
1334       GtkTypeInfo pixmap_menu_item_info =
1335       {
1336         (char *)"GtkPixmapMenuItem",
1337         sizeof (GtkPixmapMenuItem),
1338         sizeof (GtkPixmapMenuItemClass),
1339         (GtkClassInitFunc) gtk_pixmap_menu_item_class_init,
1340         (GtkObjectInitFunc) gtk_pixmap_menu_item_init,
1341         /* reserved_1 */ NULL,
1342         /* reserved_2 */ NULL,
1343         (GtkClassInitFunc) NULL,
1344       };
1345
1346       pixmap_menu_item_type = gtk_type_unique (gtk_menu_item_get_type (),
1347                                                &pixmap_menu_item_info);
1348     }
1349
1350   return pixmap_menu_item_type;
1351 }
1352
1353 /**
1354  * gtk_pixmap_menu_item_new
1355  *
1356  * Creates a new pixmap menu item. Use gtk_pixmap_menu_item_set_pixmap()
1357  * to set the pixmap wich is displayed at the left side.
1358  *
1359  * Returns:
1360  * &GtkWidget pointer to new menu item
1361  **/
1362
1363 GtkWidget*
1364 gtk_pixmap_menu_item_new (void)
1365 {
1366   return GTK_WIDGET (gtk_type_new (gtk_pixmap_menu_item_get_type ()));
1367 }
1368
1369 static void
1370 gtk_pixmap_menu_item_class_init (GtkPixmapMenuItemClass *klass)
1371 {
1372   GtkObjectClass *object_class;
1373   GtkWidgetClass *widget_class;
1374   GtkMenuItemClass *menu_item_class;
1375   GtkContainerClass *container_class;
1376
1377   object_class = (GtkObjectClass*) klass;
1378   widget_class = (GtkWidgetClass*) klass;
1379   menu_item_class = (GtkMenuItemClass*) klass;
1380   container_class = (GtkContainerClass*) klass;
1381
1382   parent_class = (GtkMenuItemClass*) gtk_type_class (gtk_menu_item_get_type ());
1383
1384   widget_class->draw = gtk_pixmap_menu_item_draw;
1385   widget_class->expose_event = gtk_pixmap_menu_item_expose;
1386   widget_class->map = gtk_pixmap_menu_item_map;
1387   widget_class->size_allocate = gtk_pixmap_menu_item_size_allocate;
1388   widget_class->size_request = gtk_pixmap_menu_item_size_request;
1389
1390   container_class->forall = gtk_pixmap_menu_item_forall;
1391   container_class->remove = gtk_pixmap_menu_item_remove;
1392
1393   klass->orig_toggle_size = menu_item_class->toggle_size;
1394   klass->have_pixmap_count = 0;
1395 }
1396
1397 static void
1398 gtk_pixmap_menu_item_init (GtkPixmapMenuItem *menu_item)
1399 {
1400   GtkMenuItem *mi;
1401
1402   mi = GTK_MENU_ITEM (menu_item);
1403
1404   menu_item->pixmap = NULL;
1405 }
1406
1407 static void
1408 gtk_pixmap_menu_item_draw (GtkWidget    *widget,
1409                            GdkRectangle *area)
1410 {
1411   g_return_if_fail (widget != NULL);
1412   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (widget));
1413   g_return_if_fail (area != NULL);
1414
1415   if (GTK_WIDGET_CLASS (parent_class)->draw)
1416     (* GTK_WIDGET_CLASS (parent_class)->draw) (widget, area);
1417
1418   if (GTK_WIDGET_DRAWABLE (widget) &&
1419       GTK_PIXMAP_MENU_ITEM(widget)->pixmap) {
1420     gtk_widget_draw(GTK_WIDGET(GTK_PIXMAP_MENU_ITEM(widget)->pixmap),NULL);
1421   }
1422 }
1423
1424 static gint
1425 gtk_pixmap_menu_item_expose (GtkWidget      *widget,
1426                              GdkEventExpose *event)
1427 {
1428   g_return_val_if_fail (widget != NULL, FALSE);
1429   g_return_val_if_fail (GTK_IS_PIXMAP_MENU_ITEM (widget), FALSE);
1430   g_return_val_if_fail (event != NULL, FALSE);
1431
1432   if (GTK_WIDGET_CLASS (parent_class)->expose_event)
1433     (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
1434
1435   if (GTK_WIDGET_DRAWABLE (widget) &&
1436       GTK_PIXMAP_MENU_ITEM(widget)->pixmap) {
1437     gtk_widget_draw(GTK_WIDGET(GTK_PIXMAP_MENU_ITEM(widget)->pixmap),NULL);
1438   }
1439
1440   return FALSE;
1441 }
1442
1443 /**
1444  * gtk_pixmap_menu_item_set_pixmap
1445  * @menu_item: Pointer to the pixmap menu item
1446  * @pixmap: Pointer to a pixmap widget
1447  *
1448  * Set the pixmap of the menu item.
1449  *
1450  **/
1451
1452 void
1453 gtk_pixmap_menu_item_set_pixmap (GtkPixmapMenuItem *menu_item,
1454                                  GtkWidget         *pixmap)
1455 {
1456   g_return_if_fail (menu_item != NULL);
1457   g_return_if_fail (pixmap != NULL);
1458   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (menu_item));
1459   g_return_if_fail (GTK_IS_WIDGET (pixmap));
1460   g_return_if_fail (menu_item->pixmap == NULL);
1461
1462   gtk_widget_set_parent (pixmap, GTK_WIDGET (menu_item));
1463   menu_item->pixmap = pixmap;
1464
1465   if (GTK_WIDGET_REALIZED (pixmap->parent) &&
1466       !GTK_WIDGET_REALIZED (pixmap))
1467     gtk_widget_realize (pixmap);
1468
1469   if (GTK_WIDGET_VISIBLE (pixmap->parent)) {
1470     if (GTK_WIDGET_MAPPED (pixmap->parent) &&
1471         GTK_WIDGET_VISIBLE(pixmap) &&
1472         !GTK_WIDGET_MAPPED (pixmap))
1473       gtk_widget_map (pixmap);
1474   }
1475
1476   changed_have_pixmap_status(menu_item);
1477
1478   if (GTK_WIDGET_VISIBLE (pixmap) && GTK_WIDGET_VISIBLE (menu_item))
1479     gtk_widget_queue_resize (pixmap);
1480 }
1481
1482 static void
1483 gtk_pixmap_menu_item_map (GtkWidget *widget)
1484 {
1485   GtkPixmapMenuItem *menu_item;
1486
1487   g_return_if_fail (widget != NULL);
1488   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (widget));
1489
1490   menu_item = GTK_PIXMAP_MENU_ITEM(widget);
1491
1492   GTK_WIDGET_CLASS(parent_class)->map(widget);
1493
1494   if (menu_item->pixmap &&
1495       GTK_WIDGET_VISIBLE (menu_item->pixmap) &&
1496       !GTK_WIDGET_MAPPED (menu_item->pixmap))
1497     gtk_widget_map (menu_item->pixmap);
1498 }
1499
1500 static void
1501 gtk_pixmap_menu_item_size_allocate (GtkWidget        *widget,
1502                                     GtkAllocation    *allocation)
1503 {
1504   GtkPixmapMenuItem *pmenu_item;
1505
1506   pmenu_item = GTK_PIXMAP_MENU_ITEM(widget);
1507
1508   if (pmenu_item->pixmap && GTK_WIDGET_VISIBLE(pmenu_item))
1509     {
1510       GtkAllocation child_allocation;
1511       int border_width;
1512
1513       border_width = GTK_CONTAINER (widget)->border_width;
1514
1515       child_allocation.width = pmenu_item->pixmap->requisition.width;
1516       child_allocation.height = pmenu_item->pixmap->requisition.height;
1517       child_allocation.x = border_width + BORDER_SPACING;
1518       child_allocation.y = (border_width + BORDER_SPACING
1519                             + (((allocation->height - child_allocation.height) - child_allocation.x)
1520                                / 2)); /* center pixmaps vertically */
1521       gtk_widget_size_allocate (pmenu_item->pixmap, &child_allocation);
1522     }
1523
1524   if (GTK_WIDGET_CLASS (parent_class)->size_allocate)
1525     GTK_WIDGET_CLASS(parent_class)->size_allocate (widget, allocation);
1526 }
1527
1528 static void
1529 gtk_pixmap_menu_item_forall (GtkContainer    *container,
1530                              gboolean         include_internals,
1531                              GtkCallback      callback,
1532                              gpointer         callback_data)
1533 {
1534   GtkPixmapMenuItem *menu_item;
1535
1536   g_return_if_fail (container != NULL);
1537   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (container));
1538   g_return_if_fail (callback != NULL);
1539
1540   menu_item = GTK_PIXMAP_MENU_ITEM (container);
1541
1542   if (menu_item->pixmap)
1543     (* callback) (menu_item->pixmap, callback_data);
1544
1545   GTK_CONTAINER_CLASS(parent_class)->forall(container,include_internals,
1546                                             callback,callback_data);
1547 }
1548
1549 static void
1550 gtk_pixmap_menu_item_size_request (GtkWidget      *widget,
1551                                    GtkRequisition *requisition)
1552 {
1553   GtkPixmapMenuItem *menu_item;
1554   GtkRequisition req = {0, 0};
1555
1556   g_return_if_fail (widget != NULL);
1557   g_return_if_fail (GTK_IS_MENU_ITEM (widget));
1558   g_return_if_fail (requisition != NULL);
1559
1560   GTK_WIDGET_CLASS(parent_class)->size_request(widget,requisition);
1561
1562   menu_item = GTK_PIXMAP_MENU_ITEM (widget);
1563
1564   if (menu_item->pixmap)
1565     gtk_widget_size_request(menu_item->pixmap, &req);
1566
1567   requisition->height = MAX(req.height + GTK_CONTAINER(widget)->border_width + BORDER_SPACING, (unsigned int) requisition->height);
1568   requisition->width += (req.width + GTK_CONTAINER(widget)->border_width + BORDER_SPACING);
1569 }
1570
1571 static void
1572 gtk_pixmap_menu_item_remove (GtkContainer *container,
1573                              GtkWidget    *child)
1574 {
1575   GtkBin *bin;
1576   gboolean widget_was_visible;
1577
1578   g_return_if_fail (container != NULL);
1579   g_return_if_fail (GTK_IS_PIXMAP_MENU_ITEM (container));
1580   g_return_if_fail (child != NULL);
1581   g_return_if_fail (GTK_IS_WIDGET (child));
1582
1583   bin = GTK_BIN (container);
1584   g_return_if_fail ((bin->child == child ||
1585                      (GTK_PIXMAP_MENU_ITEM(container)->pixmap == child)));
1586
1587   widget_was_visible = GTK_WIDGET_VISIBLE (child);
1588
1589   gtk_widget_unparent (child);
1590   if (bin->child == child)
1591     bin->child = NULL;
1592   else {
1593     GTK_PIXMAP_MENU_ITEM(container)->pixmap = NULL;
1594     changed_have_pixmap_status(GTK_PIXMAP_MENU_ITEM(container));
1595   }
1596
1597   if (widget_was_visible)
1598     gtk_widget_queue_resize (GTK_WIDGET (container));
1599 }
1600
1601
1602 /* important to only call this if there was actually a _change_ in pixmap == NULL */
1603 static void
1604 changed_have_pixmap_status (GtkPixmapMenuItem *menu_item)
1605 {
1606   if (menu_item->pixmap != NULL) {
1607     GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count += 1;
1608
1609     if (GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count == 1) {
1610       /* Install pixmap toggle size */
1611       GTK_MENU_ITEM_GET_CLASS(menu_item)->toggle_size = MAX(GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->orig_toggle_size, PMAP_WIDTH);
1612     }
1613   } else {
1614     GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count -= 1;
1615
1616     if (GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->have_pixmap_count == 0) {
1617       /* Install normal toggle size */
1618       GTK_MENU_ITEM_GET_CLASS(menu_item)->toggle_size = GTK_PIXMAP_MENU_ITEM_GET_CLASS(menu_item)->orig_toggle_size;
1619     }
1620   }
1621
1622   /* Note that we actually need to do this for _all_ GtkPixmapMenuItem
1623      whenever the klass->toggle_size changes; but by doing it anytime
1624      this function is called, we get the same effect, just because of
1625      how the preferences option to show pixmaps works. Bogus, broken.
1626   */
1627   if (GTK_WIDGET_VISIBLE(GTK_WIDGET(menu_item)))
1628     gtk_widget_queue_resize(GTK_WIDGET(menu_item));
1629 }
1630
1631 #endif // USE_MENU_BITMAPS
1632