src/gtk1/menu.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        menu.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifdef __GNUG__
  11 #pragma implementation "menu.h"
  12 #pragma implementation "menuitem.h"
  13 #endif
  14
  15 #include "wx/menu.h"
  16 #include "wx/log.h"
  17 #include "wx/intl.h"
  18 #include "wx/app.h"
  19
  20 #include "gdk/gdk.h"
  21 #include "gtk/gtk.h"
  22
  23 //-----------------------------------------------------------------------------
  24 // idle system
  25 //-----------------------------------------------------------------------------
  26
  27 extern void wxapp_install_idle_handler();
  28 extern bool g_isIdle;
  29
  30 //-----------------------------------------------------------------------------
  31 // wxMenuBar
  32 //-----------------------------------------------------------------------------
  33
  34 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar,wxWindow)
  35
  36 wxMenuBar::wxMenuBar( long style )
  37 {
  38     /* the parent window is known after wxFrame::SetMenu() */
  39     m_needParent = FALSE;
  40     m_style = style;
  41
  42     PreCreation( (wxWindow *) NULL, -1, wxDefaultPosition, wxDefaultSize, style, "menu" );
  43
  44     m_menus.DeleteContents( TRUE );
  45
  46     /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
  47 #if (GTK_MINOR_VERSION > 0) && (GTK_MICRO_VERSION > 0)
  48     m_accel = gtk_accel_group_new();
  49     m_factory = gtk_item_factory_new( GTK_TYPE_MENU_BAR, "<main>", m_accel );
  50     m_menubar = gtk_item_factory_get_widget( m_factory, "<main>" );
  51 #else
  52     m_menubar = gtk_menu_bar_new();
  53 #endif
  54
  55     if (style & wxMB_DOCKABLE)
  56     {
  57         m_widget = gtk_handle_box_new();
  58         gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_menubar) );
  59         gtk_widget_show( GTK_WIDGET(m_menubar) );
  60     }
  61     else
  62     {
  63         m_widget = GTK_WIDGET(m_menubar);
  64     }
  65
  66     PostCreation();
  67 }
  68
  69 wxMenuBar::wxMenuBar()
  70 {
  71     /* the parent window is known after wxFrame::SetMenu() */
  72     m_needParent = FALSE;
  73     m_style = 0;
  74
  75     PreCreation( (wxWindow *) NULL, -1, wxDefaultPosition, wxDefaultSize, 0, "menu" );
  76
  77     m_menus.DeleteContents( TRUE );
  78
  79     /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
  80 #if (GTK_MINOR_VERSION > 0) && (GTK_MICRO_VERSION > 0)
  81     m_accel = gtk_accel_group_new();
  82     m_factory = gtk_item_factory_new( GTK_TYPE_MENU_BAR, "<main>", m_accel );
  83     m_menubar = gtk_item_factory_get_widget( m_factory, "<main>" );
  84 #else
  85     m_menubar = gtk_menu_bar_new();
  86 #endif
  87
  88     m_widget = GTK_WIDGET(m_menubar);
  89
  90     PostCreation();
  91 }
  92
  93 wxMenuBar::~wxMenuBar()
  94 {
  95    // how to destroy a GtkItemFactory ?
  96 }
  97
  98 static void wxMenubarUnsetInvokingWindow( wxMenu *menu, wxWindow *win )
  99 {
 100     menu->SetInvokingWindow( (wxWindow*) NULL );
 101
 102 #if (GTK_MINOR_VERSION > 0)
 103     wxWindow *top_frame = win;
 104     while (top_frame->GetParent()) top_frame = top_frame->GetParent();
 105
 106     /* support for native hot keys  */
 107     gtk_accel_group_detach( menu->m_accel, GTK_OBJECT(top_frame->m_widget) );
 108 #endif
 109
 110     wxNode *node = menu->GetItems().First();
 111     while (node)
 112     {
 113         wxMenuItem *menuitem = (wxMenuItem*)node->Data();
 114         if (menuitem->IsSubMenu())
 115             wxMenubarUnsetInvokingWindow( menuitem->GetSubMenu(), win );
 116         node = node->Next();
 117     }
 118 }
 119
 120 static void wxMenubarSetInvokingWindow( wxMenu *menu, wxWindow *win )
 121 {
 122     menu->SetInvokingWindow( win );
 123
 124 #if (GTK_MINOR_VERSION > 0)
 125     wxWindow *top_frame = win;
 126     while (top_frame->GetParent())
 127        top_frame = top_frame->GetParent();
 128
 129     /* support for native hot keys  */
 130     gtk_accel_group_attach( menu->m_accel, GTK_OBJECT(top_frame->m_widget) );
 131 #endif
 132
 133     wxNode *node = menu->GetItems().First();
 134     while (node)
 135     {
 136         wxMenuItem *menuitem = (wxMenuItem*)node->Data();
 137         if (menuitem->IsSubMenu())
 138             wxMenubarSetInvokingWindow( menuitem->GetSubMenu(), win );
 139         node = node->Next();
 140     }
 141 }
 142
 143 void wxMenuBar::SetInvokingWindow( wxWindow *win )
 144 {
 145 #if (GTK_MINOR_VERSION > 0) && (GTK_MICRO_VERSION > 0)
 146     wxWindow *top_frame = win;
 147     while (top_frame->GetParent())
 148        top_frame = top_frame->GetParent();
 149
 150     /* support for native key accelerators indicated by underscroes */
 151     gtk_accel_group_attach( m_accel, GTK_OBJECT(top_frame->m_widget) );
 152 #endif
 153
 154     wxNode *node = m_menus.First();
 155     while (node)
 156     {
 157         wxMenu *menu = (wxMenu*)node->Data();
 158         wxMenubarSetInvokingWindow( menu, win );
 159         node = node->Next();
 160     }
 161 }
 162
 163 void wxMenuBar::UnsetInvokingWindow( wxWindow *win )
 164 {
 165 #if (GTK_MINOR_VERSION > 0) && (GTK_MICRO_VERSION > 0)
 166     wxWindow *top_frame = win;
 167     while (top_frame->GetParent())
 168        top_frame = top_frame->GetParent();
 169
 170     /* support for native key accelerators indicated by underscroes */
 171     gtk_accel_group_detach( m_accel, GTK_OBJECT(top_frame->m_widget) );
 172 #endif
 173
 174     wxNode *node = m_menus.First();
 175     while (node)
 176     {
 177         wxMenu *menu = (wxMenu*)node->Data();
 178         wxMenubarUnsetInvokingWindow( menu, win );
 179         node = node->Next();
 180     }
 181 }
 182
 183 void wxMenuBar::Append( wxMenu *menu, const wxString &title )
 184 {
 185     m_menus.Append( menu );
 186
 187     const wxChar *pc;
 188
 189     /* GTK 1.2 wants to have "_" instead of "&" for accelerators */
 190     wxString str;
 191     for ( pc = title; *pc != _T('\0'); pc++ )
 192     {
 193         if (*pc == _T('&'))
 194         {
 195 #if (GTK_MINOR_VERSION > 0) && (GTK_MICRO_VERSION > 0)
 196             str << _T('_');
 197         } else
 198         if (*pc == _T('/'))
 199         {
 200             str << _T('\\');
 201 #endif
 202         }
 203         else
 204            str << *pc;
 205     }
 206
 207     /* this doesn't have much effect right now */
 208     menu->SetTitle( str );
 209
 210     /* GTK 1.2.0 doesn't have gtk_item_factory_get_item(), but GTK 1.2.1 has. */
 211 #if (GTK_MINOR_VERSION > 0) && (GTK_MICRO_VERSION > 0)
 212
 213     /* local buffer in multibyte form */
 214     wxString buf;
 215     buf << _T('/') << str.c_str();
 216
 217     char *cbuf = new char[buf.Length()];
 218     strcpy(cbuf, buf.mbc_str());
 219
 220     GtkItemFactoryEntry entry;
 221     entry.path = (gchar *)cbuf;  // const_cast
 222     entry.accelerator = (gchar*) NULL;
 223     entry.callback = (GtkItemFactoryCallback) NULL;
 224     entry.callback_action = 0;
 225     entry.item_type = "<Branch>";
 226
 227     gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
 228     /* in order to get the pointer to the item we need the item text _without_ underscores */
 229     wxString tmp = _T("<main>/");
 230     for ( pc = str; *pc != _T('\0'); pc++ )
 231     {
 232        if (*pc == _T('_')) pc++; /* skip it */
 233        tmp << *pc;
 234     }
 235     menu->m_owner = gtk_item_factory_get_item( m_factory, tmp.mb_str() );
 236     gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
 237     delete [] cbuf;
 238 #else
 239
 240     menu->m_owner = gtk_menu_item_new_with_label( str.mb_str() );
 241     gtk_widget_show( menu->m_owner );
 242     gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
 243
 244     gtk_menu_bar_append( GTK_MENU_BAR(m_menubar), menu->m_owner );
 245
 246 #endif
 247 }
 248
 249 static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString, const wxString &itemString )
 250 {
 251     if (menu->GetTitle() == menuString)
 252     {
 253         int res = menu->FindItem( itemString );
 254         if (res != wxNOT_FOUND)
 255             return res;
 256     }
 257
 258     wxNode *node = ((wxMenu *)menu)->GetItems().First();    // const_cast
 259     while (node)
 260     {
 261         wxMenuItem *item = (wxMenuItem*)node->Data();
 262         if (item->IsSubMenu())
 263             return FindMenuItemRecursive(item->GetSubMenu(), menuString, itemString);
 264
 265         node = node->Next();
 266     }
 267
 268     return wxNOT_FOUND;
 269 }
 270
 271 wxMenuItem *wxMenuBar::FindItemForId(int itemId, wxMenu **menuForItem ) const
 272 {
 273     if ( menuForItem )
 274     {
 275         // TODO return the pointer to the menu
 276
 277         *menuForItem = NULL;
 278     }
 279
 280     return FindItem(itemId);
 281 }
 282
 283 int wxMenuBar::FindMenuItem( const wxString &menuString, const wxString &itemString ) const
 284 {
 285     wxNode *node = m_menus.First();
 286     while (node)
 287     {
 288         wxMenu *menu = (wxMenu*)node->Data();
 289         int res = FindMenuItemRecursive( menu, menuString, itemString);
 290         if (res != -1) return res;
 291         node = node->Next();
 292     }
 293     return -1;
 294 }
 295
 296 // Find a wxMenuItem using its id. Recurses down into sub-menus
 297 static wxMenuItem* FindMenuItemByIdRecursive(const wxMenu* menu, int id)
 298 {
 299     wxMenuItem* result = menu->FindItem(id);
 300
 301     wxNode *node = ((wxMenu *)menu)->GetItems().First(); // const_cast
 302     while ( node && result == NULL )
 303     {
 304         wxMenuItem *item = (wxMenuItem*)node->Data();
 305         if (item->IsSubMenu())
 306         {
 307             result = FindMenuItemByIdRecursive( item->GetSubMenu(), id );
 308         }
 309         node = node->Next();
 310     }
 311
 312     return result;
 313 }
 314
 315 wxMenuItem* wxMenuBar::FindItem( int id ) const
 316 {
 317     wxMenuItem* result = 0;
 318     wxNode *node = m_menus.First();
 319     while (node && result == 0)
 320     {
 321         wxMenu *menu = (wxMenu*)node->Data();
 322         result = FindMenuItemByIdRecursive( menu, id );
 323         node = node->Next();
 324     }
 325
 326     return result;
 327 }
 328
 329 void wxMenuBar::Check( int id, bool check )
 330 {
 331     wxMenuItem* item = FindMenuItemById( id );
 332
 333     wxCHECK_RET( item, _T("wxMenuBar::Check: no such item") );
 334
 335     item->Check(check);
 336 }
 337
 338 bool wxMenuBar::IsChecked( int id ) const
 339 {
 340     wxMenuItem* item = FindMenuItemById( id );
 341
 342     wxCHECK_MSG( item, FALSE, _T("wxMenuBar::IsChecked: no such item") );
 343
 344     return item->IsChecked();
 345 }
 346
 347 void wxMenuBar::Enable( int id, bool enable )
 348 {
 349     wxMenuItem* item = FindMenuItemById( id );
 350
 351     wxCHECK_RET( item, _T("wxMenuBar::Enable: no such item") );
 352
 353     item->Enable(enable);
 354 }
 355
 356 bool wxMenuBar::IsEnabled( int id ) const
 357 {
 358     wxMenuItem* item = FindMenuItemById( id );
 359
 360     wxCHECK_MSG( item, FALSE, _T("wxMenuBar::IsEnabled: no such item") );
 361
 362     return item->IsEnabled();
 363 }
 364
 365 wxString wxMenuBar::GetLabel( int id ) const
 366 {
 367     wxMenuItem* item = FindMenuItemById( id );
 368
 369     wxCHECK_MSG( item, _T(""), _T("wxMenuBar::GetLabel: no such item") );
 370
 371     return item->GetText();
 372 }
 373
 374 void wxMenuBar::SetLabel( int id, const wxString &label )
 375 {
 376     wxMenuItem* item = FindMenuItemById( id );
 377
 378     wxCHECK_RET( item, _T("wxMenuBar::SetLabel: no such item") );
 379
 380     item->SetText( label );
 381 }
 382
 383 void wxMenuBar::EnableTop( int pos, bool flag )
 384 {
 385     wxNode *node = m_menus.Nth( pos );
 386
 387     wxCHECK_RET( node, _T("menu not found") );
 388
 389     wxMenu* menu = (wxMenu*)node->Data();
 390
 391     if (menu->m_owner)
 392         gtk_widget_set_sensitive( menu->m_owner, flag );
 393 }
 394
 395 wxString wxMenuBar::GetLabelTop( int pos ) const
 396 {
 397     wxNode *node = m_menus.Nth( pos );
 398
 399     wxCHECK_MSG( node, _T("invalid"), _T("menu not found") );
 400
 401     wxMenu* menu = (wxMenu*)node->Data();
 402
 403     return menu->GetTitle();
 404 }
 405
 406 void wxMenuBar::SetLabelTop( int pos, const wxString& label )
 407 {
 408     wxNode *node = m_menus.Nth( pos );
 409
 410     wxCHECK_RET( node, _T("menu not found") );
 411
 412     wxMenu* menu = (wxMenu*)node->Data();
 413
 414     menu->SetTitle( label );
 415 }
 416
 417 void wxMenuBar::SetHelpString( int id, const wxString& helpString )
 418 {
 419     wxMenuItem* item = FindMenuItemById( id );
 420
 421     wxCHECK_RET( item, _T("wxMenuBar::SetHelpString: no such item") );
 422
 423     item->SetHelp( helpString );
 424 }
 425
 426 wxString wxMenuBar::GetHelpString( int id ) const
 427 {
 428     wxMenuItem* item = FindMenuItemById( id );
 429
 430     wxCHECK_MSG( item, _T(""), _T("wxMenuBar::GetHelpString: no such item") );
 431
 432     return item->GetHelp();
 433 }
 434
 435 //-----------------------------------------------------------------------------
 436 // "activate"
 437 //-----------------------------------------------------------------------------
 438
 439 static void gtk_menu_clicked_callback( GtkWidget *widget, wxMenu *menu )
 440 {
 441     if (g_isIdle) wxapp_install_idle_handler();
 442
 443     int id = menu->FindMenuIdByMenuItem(widget);
 444
 445     /* should find it for normal (not popup) menu */
 446     wxASSERT( (id != -1) || (menu->GetInvokingWindow() != NULL) );
 447
 448     if (!menu->IsEnabled(id))
 449         return;
 450
 451     wxMenuItem* item = menu->FindItem( id );
 452     wxCHECK_RET( item, _T("error in menu item callback") );
 453
 454     if (item->IsCheckable())
 455     {
 456         if (item->GetCheckedFlag() == item->IsChecked())
 457         {
 458             /* the menu item has been checked by calling wxMenuItem->Check() */
 459             return;
 460         }
 461         else
 462         {
 463             /* the user pressed on the menu item -> report */
 464             item->SetCheckedFlag(item->IsChecked());  /* make consistent again */
 465         }
 466     }
 467
 468     wxCommandEvent event( wxEVT_COMMAND_MENU_SELECTED, id );
 469     event.SetEventObject( menu );
 470     event.SetInt(id );
 471
 472     if (menu->GetCallback())
 473     {
 474         (void) (*(menu->GetCallback())) (*menu, event);
 475         return;
 476     }
 477
 478     if (menu->GetEventHandler()->ProcessEvent(event))
 479         return;
 480
 481     wxWindow *win = menu->GetInvokingWindow();
 482     if (win)
 483         win->GetEventHandler()->ProcessEvent( event );
 484 }
 485
 486 //-----------------------------------------------------------------------------
 487 // "select"
 488 //-----------------------------------------------------------------------------
 489
 490 static void gtk_menu_hilight_callback( GtkWidget *widget, wxMenu *menu )
 491 {
 492     if (g_isIdle) wxapp_install_idle_handler();
 493
 494     int id = menu->FindMenuIdByMenuItem(widget);
 495
 496     wxASSERT( id != -1 ); // should find it!
 497
 498     if (!menu->IsEnabled(id))
 499         return;
 500
 501     wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, id );
 502     event.SetEventObject( menu );
 503
 504     if (menu->GetEventHandler()->ProcessEvent(event))
 505         return;
 506
 507     wxWindow *win = menu->GetInvokingWindow();
 508     if (win) win->GetEventHandler()->ProcessEvent( event );
 509 }
 510
 511 //-----------------------------------------------------------------------------
 512 // "deselect"
 513 //-----------------------------------------------------------------------------
 514
 515 static void gtk_menu_nolight_callback( GtkWidget *widget, wxMenu *menu )
 516 {
 517     if (g_isIdle) wxapp_install_idle_handler();
 518
 519     int id = menu->FindMenuIdByMenuItem(widget);
 520
 521     wxASSERT( id != -1 ); // should find it!
 522
 523     if (!menu->IsEnabled(id))
 524         return;
 525
 526     wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, -1 );
 527     event.SetEventObject( menu );
 528
 529     if (menu->GetEventHandler()->ProcessEvent(event))
 530         return;
 531
 532     wxWindow *win = menu->GetInvokingWindow();
 533     if (win)
 534         win->GetEventHandler()->ProcessEvent( event );
 535 }
 536
 537 //-----------------------------------------------------------------------------
 538 // wxMenuItem
 539 //-----------------------------------------------------------------------------
 540
 541 IMPLEMENT_DYNAMIC_CLASS(wxMenuItem,wxObject)
 542
 543 wxMenuItem::wxMenuItem()
 544 {
 545     m_id = ID_SEPARATOR;
 546     m_isCheckMenu = FALSE;
 547     m_isChecked = FALSE;
 548     m_isEnabled = TRUE;
 549     m_subMenu = (wxMenu *) NULL;
 550     m_menuItem = (GtkWidget *) NULL;
 551 }
 552
 553 // it's valid for this function to be called even if m_menuItem == NULL
 554 void wxMenuItem::SetName( const wxString& str )
 555 {
 556     /* '\t' is the deliminator indicating a hot key */
 557     m_text = _T("");
 558     const wxChar *pc = str;
 559     for (; (*pc != _T('\0')) && (*pc != _T('\t')); pc++ )
 560     {
 561         if (*pc == _T('&'))
 562         {
 563 #if (GTK_MINOR_VERSION > 0)
 564             m_text << _T('_');
 565         } else
 566         if (*pc == _T('/'))      /* we have to filter out slashes ... */
 567         {
 568             m_text << _T('\\');  /* ... and replace them with back slashes */
 569 #endif
 570         }
 571         else
 572            m_text << *pc;
 573     }
 574
 575     /* only GTK 1.2 knows about hot keys */
 576     m_hotKey = _T("");
 577 #if (GTK_MINOR_VERSION > 0)
 578     if(*pc == _T('\t'))
 579     {
 580        pc++;
 581        m_hotKey = pc;
 582     }
 583 #endif
 584
 585     if (m_menuItem)
 586     {
 587         GtkLabel *label = GTK_LABEL( GTK_BIN(m_menuItem)->child );
 588         gtk_label_set( label, m_text.mb_str());
 589     }
 590 }
 591
 592 void wxMenuItem::Check( bool check )
 593 {
 594     wxCHECK_RET( m_menuItem, _T("invalid menu item") );
 595
 596     wxCHECK_RET( IsCheckable(), _T("Can't check uncheckable item!") )
 597
 598     if (check == m_isChecked) return;
 599
 600     m_isChecked = check;
 601     gtk_check_menu_item_set_state( (GtkCheckMenuItem*)m_menuItem, (gint)check );
 602 }
 603
 604 void wxMenuItem::Enable( bool enable )
 605 {
 606     wxCHECK_RET( m_menuItem, _T("invalid menu item") );
 607
 608     gtk_widget_set_sensitive( m_menuItem, enable );
 609     m_isEnabled = enable;
 610 }
 611
 612 bool wxMenuItem::IsChecked() const
 613 {
 614     wxCHECK_MSG( m_menuItem, FALSE, _T("invalid menu item") );
 615
 616     wxCHECK( IsCheckable(), FALSE ); // can't get state of uncheckable item!
 617
 618     bool bIsChecked = ((GtkCheckMenuItem*)m_menuItem)->active != 0;
 619
 620     return bIsChecked;
 621 }
 622
 623 //-----------------------------------------------------------------------------
 624 // wxMenu
 625 //-----------------------------------------------------------------------------
 626
 627 IMPLEMENT_DYNAMIC_CLASS(wxMenu,wxEvtHandler)
 628
 629 void
 630 wxMenu::Init( const wxString& title,
 631               long style
 632 #ifdef WXWIN_COMPATIBILITY
 633               , const wxFunction func
 634 #endif
 635               )
 636 {
 637     m_title = title;
 638     m_items.DeleteContents( TRUE );
 639     m_invokingWindow = (wxWindow *) NULL;
 640     m_style = style;
 641
 642 #if (GTK_MINOR_VERSION > 0)
 643     m_accel = gtk_accel_group_new();
 644     m_factory = gtk_item_factory_new( GTK_TYPE_MENU, "<main>", m_accel );
 645     m_menu = gtk_item_factory_get_widget( m_factory, "<main>" );
 646 #else
 647     m_menu = gtk_menu_new();  // Do not show!
 648 #endif
 649
 650 #ifdef WXWIN_COMPATIBILITY
 651     m_callback = func;
 652 #endif
 653
 654     m_eventHandler = this;
 655     m_clientData = (void*) NULL;
 656
 657     if (m_title.IsNull()) m_title = _T("");
 658     if (m_title != _T(""))
 659     {
 660         Append(-2, m_title);
 661         AppendSeparator();
 662     }
 663
 664     m_owner = (GtkWidget*) NULL;
 665
 666 #if (GTK_MINOR_VERSION > 0)
 667     /* Tearoffs are entries, just like separators. So if we want this
 668        menu to be a tear-off one, we just append a tearoff entry
 669        immediately. */
 670     if(m_style & wxMENU_TEAROFF)
 671     {
 672        GtkItemFactoryEntry entry;
 673        entry.path = "/tearoff";
 674        entry.callback = (GtkItemFactoryCallback) NULL;
 675        entry.callback_action = 0;
 676        entry.item_type = "<Tearoff>";
 677        entry.accelerator = (gchar*) NULL;
 678        gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
 679        //GtkWidget *menuItem = gtk_item_factory_get_widget( m_factory, "<main>/tearoff" );
 680     }
 681 #endif
 682 }
 683
 684 wxMenu::~wxMenu()
 685 {
 686    /* how do we delete an item-factory ? */
 687    gtk_widget_destroy( m_menu );
 688
 689 }
 690
 691 void wxMenu::SetTitle( const wxString& title )
 692 {
 693     // TODO Waiting for something better
 694     m_title = title;
 695 }
 696
 697 const wxString wxMenu::GetTitle() const
 698 {
 699     return m_title;
 700 }
 701
 702 void wxMenu::AppendSeparator()
 703 {
 704     wxMenuItem *mitem = new wxMenuItem();
 705     mitem->SetId(ID_SEPARATOR);
 706
 707 #if (GTK_MINOR_VERSION > 0)
 708     GtkItemFactoryEntry entry;
 709     entry.path = "/sep";
 710     entry.callback = (GtkItemFactoryCallback) NULL;
 711     entry.callback_action = 0;
 712     entry.item_type = "<Separator>";
 713     entry.accelerator = (gchar*) NULL;
 714
 715     gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
 716
 717     /* this will be wrong for more than one separator. do we care? */
 718     GtkWidget *menuItem = gtk_item_factory_get_widget( m_factory, "<main>/sep" );
 719 #else
 720     GtkWidget *menuItem = gtk_menu_item_new();
 721     gtk_menu_append( GTK_MENU(m_menu), menuItem );
 722     gtk_widget_show( menuItem );
 723 #endif
 724
 725     mitem->SetMenuItem(menuItem);
 726     m_items.Append( mitem );
 727 }
 728
 729 static char* GetHotKey( const wxString &hotkey, char *hotbuf )
 730 {
 731     if (hotkey.IsEmpty()) return (char*) NULL;
 732
 733     switch (hotkey[0])
 734     {
 735         case _T('a'):   /* Alt */
 736         case _T('A'):
 737         case _T('m'):   /* Meta */
 738         case _T('M'):
 739         {
 740             strcpy( hotbuf, "<alt>" );
 741             wxString last = hotkey.Right(1);
 742             strcat( hotbuf, last.mb_str() );
 743             return hotbuf;
 744         }
 745         case _T('c'):    /* Ctrl */
 746         case _T('C'):
 747         case _T('s'):    /* Strg, yeah man, I'm German */
 748         case _T('S'):
 749         {
 750             strcpy( hotbuf, "<control>" );
 751             wxString last = hotkey.Right(1);
 752             strcat( hotbuf, last.mb_str() );
 753             return hotbuf;
 754         }
 755         case _T('F'):   /* function keys */
 756         {
 757             strcpy( hotbuf, hotkey.mb_str() );
 758             return hotbuf;
 759         }
 760         default:
 761         {
 762         }
 763     }
 764     return (char*) NULL;
 765 }
 766
 767 void wxMenu::Append( int id, const wxString &item, const wxString &helpStr, bool checkable )
 768 {
 769     wxMenuItem *mitem = new wxMenuItem();
 770     mitem->SetId(id);
 771     mitem->SetText(item);
 772     mitem->SetHelp(helpStr);
 773     mitem->SetCheckable(checkable);
 774
 775 #if (GTK_MINOR_VERSION > 0)
 776     /* text has "_" instead of "&" after mitem->SetText() */
 777     wxString text( mitem->GetText() );
 778
 779     /* local buffer in multibyte form */
 780     char buf[200];
 781     strcpy( buf, "/" );
 782     strcat( buf, text.mb_str() );
 783
 784     GtkItemFactoryEntry entry;
 785     entry.path = buf;
 786     entry.callback = (GtkItemFactoryCallback) gtk_menu_clicked_callback;
 787     entry.callback_action = 0;
 788     if (checkable)
 789         entry.item_type = "<CheckItem>";
 790     else
 791         entry.item_type = "<Item>";
 792
 793     char hotbuf[50];
 794     entry.accelerator = GetHotKey( mitem->GetHotKey(), hotbuf );
 795
 796     gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
 797
 798     /* in order to get the pointer to the item we need the item text _without_ underscores */
 799     wxString s = _T("<main>/");
 800     for ( const wxChar *pc = text; *pc != _T('\0'); pc++ )
 801     {
 802         if (*pc == _T('_')) pc++; /* skip it */
 803         s << *pc;
 804     }
 805
 806     GtkWidget *menuItem = gtk_item_factory_get_widget( m_factory, s.mb_str() );
 807
 808 #else
 809
 810     GtkWidget *menuItem = checkable ? gtk_check_menu_item_new_with_label( mitem->GetText().mb_str() )
 811                                     : gtk_menu_item_new_with_label( mitem->GetText().mb_str() );
 812
 813     gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
 814                         GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
 815                         (gpointer)this );
 816
 817     gtk_menu_append( GTK_MENU(m_menu), menuItem );
 818     gtk_widget_show( menuItem );
 819
 820 #endif
 821
 822     gtk_signal_connect( GTK_OBJECT(menuItem), "select",
 823                         GTK_SIGNAL_FUNC(gtk_menu_hilight_callback),
 824                         (gpointer)this );
 825
 826     gtk_signal_connect( GTK_OBJECT(menuItem), "deselect",
 827                         GTK_SIGNAL_FUNC(gtk_menu_nolight_callback),
 828                         (gpointer)this );
 829
 830     mitem->SetMenuItem(menuItem);
 831
 832     m_items.Append( mitem );
 833 }
 834
 835 void wxMenu::Append( int id, const wxString &item, wxMenu *subMenu, const wxString &helpStr )
 836 {
 837     wxMenuItem *mitem = new wxMenuItem();
 838     mitem->SetId(id);
 839     mitem->SetText(item);
 840     mitem->SetHelp(helpStr);
 841
 842 #if (GTK_MINOR_VERSION > 0)
 843     /* text has "_" instead of "&" after mitem->SetText() */
 844     wxString text( mitem->GetText() );
 845
 846     /* local buffer in multibyte form */
 847     char buf[200];
 848     strcpy( buf, "/" );
 849     strcat( buf, text.mb_str() );
 850
 851     GtkItemFactoryEntry entry;
 852     entry.path = buf;
 853     entry.callback = (GtkItemFactoryCallback) 0;
 854     entry.callback_action = 0;
 855     entry.item_type = "<Branch>";
 856
 857     gtk_item_factory_create_item( m_factory, &entry, (gpointer) this, 2 );  /* what is 2 ? */
 858
 859     /* in order to get the pointer to the item we need the item text _without_ underscores */
 860     wxString s = _T("<main>/");
 861     for ( const wxChar *pc = text; *pc != _T('\0'); pc++ )
 862     {
 863         if (*pc == _T('_')) pc++; /* skip it */
 864         s << *pc;
 865     }
 866
 867     GtkWidget *menuItem = gtk_item_factory_get_item( m_factory, s.mb_str() );
 868
 869 #else
 870
 871     GtkWidget *menuItem = gtk_menu_item_new_with_label(mitem->GetText().mbc_str());
 872
 873     gtk_menu_append( GTK_MENU(m_menu), menuItem );
 874     gtk_widget_show( menuItem );
 875
 876 #endif
 877
 878     gtk_signal_connect( GTK_OBJECT(menuItem), "select",
 879                         GTK_SIGNAL_FUNC(gtk_menu_hilight_callback),
 880                         (gpointer*)this );
 881
 882     gtk_signal_connect( GTK_OBJECT(menuItem), "deselect",
 883                         GTK_SIGNAL_FUNC(gtk_menu_nolight_callback),
 884                         (gpointer*)this );
 885
 886     gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem), subMenu->m_menu );
 887
 888     mitem->SetMenuItem(menuItem);
 889     mitem->SetSubMenu(subMenu);
 890
 891     m_items.Append( mitem );
 892 }
 893
 894 void wxMenu::Append( wxMenuItem *item )
 895 {
 896     m_items.Append( item );
 897
 898     GtkWidget *menuItem = (GtkWidget*) NULL;
 899
 900     if (item->IsSeparator())
 901         menuItem = gtk_menu_item_new();
 902     else if (item->IsSubMenu())
 903         menuItem = gtk_menu_item_new_with_label(item->GetText().mbc_str());
 904     else
 905         menuItem = item->IsCheckable() ? gtk_check_menu_item_new_with_label(item->GetText().mbc_str())
 906                                        : gtk_menu_item_new_with_label(item->GetText().mbc_str());
 907
 908     if (!item->IsSeparator())
 909     {
 910         gtk_signal_connect( GTK_OBJECT(menuItem), "select",
 911                             GTK_SIGNAL_FUNC(gtk_menu_hilight_callback),
 912                             (gpointer*)this );
 913
 914         gtk_signal_connect( GTK_OBJECT(menuItem), "deselect",
 915                             GTK_SIGNAL_FUNC(gtk_menu_nolight_callback),
 916                             (gpointer*)this );
 917
 918         if (!item->IsSubMenu())
 919         {
 920             gtk_signal_connect( GTK_OBJECT(menuItem), "activate",
 921                                 GTK_SIGNAL_FUNC(gtk_menu_clicked_callback),
 922                                 (gpointer*)this );
 923         }
 924     }
 925
 926     gtk_menu_append( GTK_MENU(m_menu), menuItem );
 927     gtk_widget_show( menuItem );
 928     item->SetMenuItem(menuItem);
 929 }
 930
 931 int wxMenu::FindItem( const wxString itemString ) const
 932 {
 933     wxString s = _T("");
 934     for ( const wxChar *pc = itemString; *pc != _T('\0'); pc++ )
 935     {
 936         if (*pc == _T('&'))
 937         {
 938             pc++; /* skip it */
 939 #if (GTK_MINOR_VERSION > 0)
 940             s << _T('_');
 941 #endif
 942         }
 943         s << *pc;
 944     }
 945
 946     wxNode *node = m_items.First();
 947     while (node)
 948     {
 949         wxMenuItem *item = (wxMenuItem*)node->Data();
 950         if (item->GetText() == s)
 951         {
 952             return item->GetId();
 953         }
 954         node = node->Next();
 955     }
 956
 957     return wxNOT_FOUND;
 958 }
 959
 960 void wxMenu::Enable( int id, bool enable )
 961 {
 962     wxMenuItem *item = FindItem(id);
 963
 964     wxCHECK_RET( item, _T("wxMenu::Enable: no such item") );
 965
 966     item->Enable(enable);
 967 }
 968
 969 bool wxMenu::IsEnabled( int id ) const
 970 {
 971     wxMenuItem *item = FindItem(id);
 972
 973     wxCHECK_MSG( item, FALSE, _T("wxMenu::IsEnabled: no such item") );
 974
 975     return item->IsEnabled();
 976 }
 977
 978 void wxMenu::Check( int id, bool enable )
 979 {
 980     wxMenuItem *item = FindItem(id);
 981
 982     wxCHECK_RET( item, _T("wxMenu::Check: no such item") );
 983
 984     item->Check(enable);
 985 }
 986
 987 bool wxMenu::IsChecked( int id ) const
 988 {
 989     wxMenuItem *item = FindItem(id);
 990
 991     wxCHECK_MSG( item, FALSE, _T("wxMenu::IsChecked: no such item") );
 992
 993     return item->IsChecked();
 994 }
 995
 996 void wxMenu::SetLabel( int id, const wxString &label )
 997 {
 998     wxMenuItem *item = FindItem(id);
 999
1000     wxCHECK_RET( item, _T("wxMenu::SetLabel: no such item") );
1001
1002     item->SetText(label);
1003 }
1004
1005 wxString wxMenu::GetLabel( int id ) const
1006 {
1007     wxMenuItem *item = FindItem(id);
1008
1009     wxCHECK_MSG( item, _T(""), _T("wxMenu::GetLabel: no such item") );
1010
1011     return item->GetText();
1012 }
1013
1014 void wxMenu::SetHelpString( int id, const wxString& helpString )
1015 {
1016     wxMenuItem *item = FindItem(id);
1017
1018     wxCHECK_RET( item, _T("wxMenu::SetHelpString: no such item") );
1019
1020     item->SetHelp( helpString );
1021 }
1022
1023 wxString wxMenu::GetHelpString( int id ) const
1024 {
1025     wxMenuItem *item = FindItem(id);
1026
1027     wxCHECK_MSG( item, _T(""), _T("wxMenu::GetHelpString: no such item") );
1028
1029     return item->GetHelp();
1030 }
1031
1032 int wxMenu::FindMenuIdByMenuItem( GtkWidget *menuItem ) const
1033 {
1034     wxNode *node = m_items.First();
1035     while (node)
1036     {
1037         wxMenuItem *item = (wxMenuItem*)node->Data();
1038         if (item->GetMenuItem() == menuItem)
1039            return item->GetId();
1040         node = node->Next();
1041     }
1042
1043     return wxNOT_FOUND;
1044 }
1045
1046 wxMenuItem *wxMenu::FindItem(int id) const
1047 {
1048     wxNode *node = m_items.First();
1049     while (node)
1050     {
1051         wxMenuItem *item = (wxMenuItem*)node->Data();
1052         if (item->GetId() == id)
1053         {
1054             return item;
1055         }
1056         node = node->Next();
1057     }
1058
1059     /* Not finding anything here can be correct
1060      * when search the entire menu system for
1061      * an entry -> no error message. */
1062
1063     return (wxMenuItem *) NULL;
1064 }
1065
1066 void wxMenu::SetInvokingWindow( wxWindow *win )
1067 {
1068     m_invokingWindow = win;
1069 }
1070
1071 wxWindow *wxMenu::GetInvokingWindow()
1072 {
1073     return m_invokingWindow;
1074 }
1075
1076 // Update a menu and all submenus recursively. source is the object that has
1077 // the update event handlers defined for it. If NULL, the menu or associated
1078 // window will be used.
1079 void wxMenu::UpdateUI(wxEvtHandler* source)
1080 {
1081   if (!source && GetInvokingWindow())
1082     source = GetInvokingWindow()->GetEventHandler();
1083   if (!source)
1084     source = GetEventHandler();
1085   if (!source)
1086     source = this;
1087
1088   wxNode* node = GetItems().First();
1089   while (node)
1090   {
1091     wxMenuItem* item = (wxMenuItem*) node->Data();
1092     if ( !item->IsSeparator() )
1093     {
1094       wxWindowID id = item->GetId();
1095       wxUpdateUIEvent event(id);
1096       event.SetEventObject( source );
1097
1098       if (source->ProcessEvent(event))
1099       {
1100         if (event.GetSetText())
1101           SetLabel(id, event.GetText());
1102         if (event.GetSetChecked())
1103           Check(id, event.GetChecked());
1104         if (event.GetSetEnabled())
1105           Enable(id, event.GetEnabled());
1106       }
1107
1108       if (item->GetSubMenu())
1109         item->GetSubMenu()->UpdateUI(source);
1110     }
1111     node = node->Next();
1112   }
1113 }
1114