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