src/common/menucmn.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        common/menucmn.cpp
   3 // Purpose:     wxMenu and wxMenuBar methods common to all ports
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     26.10.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWindows team
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  21     #pragma implementation "menubase.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #if wxUSE_MENUS
  32
  33 #include <ctype.h>
  34
  35 #ifndef WX_PRECOMP
  36     #include "wx/intl.h"
  37     #include "wx/log.h"
  38     #include "wx/menu.h"
  39 #endif
  40
  41 // ----------------------------------------------------------------------------
  42 // template lists
  43 // ----------------------------------------------------------------------------
  44
  45 #include "wx/listimpl.cpp"
  46
  47 WX_DEFINE_LIST(wxMenuList);
  48 WX_DEFINE_LIST(wxMenuItemList);
  49
  50 // ============================================================================
  51 // implementation
  52 // ============================================================================
  53
  54 // ----------------------------------------------------------------------------
  55 // wxMenuItem
  56 // ----------------------------------------------------------------------------
  57
  58 wxMenuItemBase::wxMenuItemBase(wxMenu *parentMenu,
  59                                int id,
  60                                const wxString& text,
  61                                const wxString& help,
  62                                wxItemKind kind,
  63                                wxMenu *subMenu)
  64               : m_text(text),
  65                 m_help(help)
  66 {
  67     wxASSERT_MSG( parentMenu != NULL, wxT("menuitem should have a menu") );
  68
  69     m_parentMenu  = parentMenu;
  70     m_subMenu     = subMenu;
  71     m_isEnabled   = TRUE;
  72     m_isChecked   = FALSE;
  73     m_id          = id;
  74     m_kind        = kind;
  75     if (m_id == wxID_ANY)
  76         m_id = wxNewId();
  77     if (m_id == wxID_SEPARATOR)
  78         m_kind = wxITEM_SEPARATOR;
  79 }
  80
  81 wxMenuItemBase::~wxMenuItemBase()
  82 {
  83     delete m_subMenu;
  84 }
  85
  86 #if wxUSE_ACCEL
  87
  88 static inline bool CompareAccelString(const wxString& str, const wxChar *accel)
  89 {
  90 #if wxUSE_INTL
  91     return str == accel || str == wxGetTranslation(accel);
  92 #else
  93     return str == accel;
  94 #endif
  95 }
  96
  97 // return wxAcceleratorEntry for the given menu string or NULL if none
  98 // specified
  99 wxAcceleratorEntry *wxGetAccelFromString(const wxString& label)
 100 {
 101     // wxPrintf( wxT("label %s\n"), label.c_str() );
 102
 103     // check for accelerators: they are given after '\t'
 104     int posTab = label.Find(wxT('\t'));
 105     if ( posTab != wxNOT_FOUND ) {
 106         // parse the accelerator string
 107         int keyCode = 0;
 108         int accelFlags = wxACCEL_NORMAL;
 109         wxString current;
 110         for ( size_t n = (size_t)posTab + 1; n < label.Len(); n++ ) {
 111             if ( (label[n] == '+') || (label[n] == '-') ) {
 112                 if ( CompareAccelString(current, wxTRANSLATE("ctrl")) )
 113                     accelFlags |= wxACCEL_CTRL;
 114                 else if ( CompareAccelString(current, wxTRANSLATE("alt")) )
 115                     accelFlags |= wxACCEL_ALT;
 116                 else if ( CompareAccelString(current, wxTRANSLATE("shift")) )
 117                     accelFlags |= wxACCEL_SHIFT;
 118                 else {
 119                     // we may have "Ctrl-+", for example, but we still want to
 120                     // catch typos like "Crtl-A" so only give the warning if we
 121                     // have something before the current '+' or '-', else take
 122                     // it as a literal symbol
 123                     if ( current.empty() )
 124                     {
 125                         current += label[n];
 126
 127                         // skip clearing it below
 128                         continue;
 129                     }
 130                     else
 131                     {
 132                         wxLogDebug(wxT("Unknown accel modifier: '%s'"),
 133                                    current.c_str());
 134                     }
 135                 }
 136
 137                 current.clear();
 138             }
 139             else {
 140                 current += (wxChar) wxTolower(label[n]);
 141             }
 142         }
 143
 144         if ( current.IsEmpty() ) {
 145             wxLogDebug(wxT("No accel key found, accel string ignored."));
 146         }
 147         else {
 148             if ( current.Len() == 1 ) {
 149                 // it's a letter
 150                 keyCode = current[0U];
 151
 152                 // Only call wxToupper if control, alt, or shift is held down,
 153                 // otherwise lower case accelerators won't work.
 154                 if (accelFlags != wxACCEL_NORMAL) {
 155                     keyCode = wxToupper(keyCode);
 156                 }
 157             }
 158             else {
 159                 // is it a function key?
 160                 if ( current[0U] == 'f' && wxIsdigit(current[1U]) &&
 161                      (current.Len() == 2 ||
 162                      (current.Len() == 3 && wxIsdigit(current[2U]))) ) {
 163                     int n;
 164                     wxSscanf(current.c_str() + 1, wxT("%d"), &n);
 165
 166                     keyCode = WXK_F1 + n - 1;
 167                 }
 168                 else {
 169                     // several special cases
 170                     current.MakeUpper();
 171                     if ( current == wxT("DEL") )
 172                         keyCode = WXK_DELETE;
 173                     else if ( current == wxT("DELETE") )
 174                         keyCode = WXK_DELETE;
 175                     else if ( current == wxT("BACK") )
 176                         keyCode = WXK_BACK;
 177                     else if ( current == wxT("INS") )
 178                         keyCode = WXK_INSERT;
 179                     else if ( current == wxT("INSERT") )
 180                         keyCode = WXK_INSERT;
 181                     else if ( current == wxT("ENTER") || current == wxT("RETURN") )
 182                         keyCode = WXK_RETURN;
 183                     else if ( current == wxT("PGUP") )
 184                         keyCode = WXK_PRIOR;
 185                     else if ( current == wxT("PGDN") )
 186                         keyCode = WXK_NEXT;
 187                     else if ( current == wxT("LEFT") )
 188                         keyCode = WXK_LEFT;
 189                     else if ( current == wxT("RIGHT") )
 190                         keyCode = WXK_RIGHT;
 191                     else if ( current == wxT("UP") )
 192                         keyCode = WXK_UP;
 193                     else if ( current == wxT("DOWN") )
 194                         keyCode = WXK_DOWN;
 195                     else if ( current == wxT("HOME") )
 196                         keyCode = WXK_HOME;
 197                     else if ( current == wxT("END") )
 198                         keyCode = WXK_END;
 199                     else if ( current == wxT("SPACE") )
 200                         keyCode = WXK_SPACE;
 201                     else if ( current == wxT("TAB") )
 202                         keyCode = WXK_TAB;
 203                     else if ( current == wxT("ESC") || current == wxT("ESCAPE") )
 204                         keyCode = WXK_ESCAPE;
 205                     else
 206                     {
 207                         wxLogDebug(wxT("Unrecognized accel key '%s', accel string ignored."),
 208                                    current.c_str());
 209                     }
 210                 }
 211             }
 212         }
 213
 214         if ( keyCode ) {
 215             // we do have something
 216             return new wxAcceleratorEntry(accelFlags, keyCode);
 217         }
 218     }
 219
 220     return (wxAcceleratorEntry *)NULL;
 221 }
 222
 223 wxAcceleratorEntry *wxMenuItemBase::GetAccel() const
 224 {
 225     return wxGetAccelFromString(GetText());
 226 }
 227
 228 void wxMenuItemBase::SetAccel(wxAcceleratorEntry *accel)
 229 {
 230     wxString text = m_text.BeforeFirst(wxT('\t'));
 231     if ( accel )
 232     {
 233         text += wxT('\t');
 234
 235         int flags = accel->GetFlags();
 236         if ( flags & wxACCEL_ALT )
 237             text += wxT("Alt-");
 238         if ( flags & wxACCEL_CTRL )
 239             text += wxT("Ctrl-");
 240         if ( flags & wxACCEL_SHIFT )
 241             text += wxT("Shift-");
 242
 243         int code = accel->GetKeyCode();
 244         switch ( code )
 245         {
 246             case WXK_F1:
 247             case WXK_F2:
 248             case WXK_F3:
 249             case WXK_F4:
 250             case WXK_F5:
 251             case WXK_F6:
 252             case WXK_F7:
 253             case WXK_F8:
 254             case WXK_F9:
 255             case WXK_F10:
 256             case WXK_F11:
 257             case WXK_F12:
 258                 text << wxT('F') << code - WXK_F1 + 1;
 259                 break;
 260
 261             // if there are any other keys wxGetAccelFromString() may return,
 262             // we should process them here
 263
 264             default:
 265                 if ( wxIsalnum(code) )
 266                 {
 267                     text << (wxChar)code;
 268
 269                     break;
 270                 }
 271
 272                 wxFAIL_MSG( wxT("unknown keyboard accel") );
 273         }
 274     }
 275
 276     SetText(text);
 277 }
 278
 279 #endif // wxUSE_ACCEL
 280
 281 bool wxMenuBase::ms_locked = true;
 282
 283 // ----------------------------------------------------------------------------
 284 // wxMenu ctor and dtor
 285 // ----------------------------------------------------------------------------
 286
 287 void wxMenuBase::Init(long style)
 288 {
 289     m_menuBar = (wxMenuBar *)NULL;
 290     m_menuParent = (wxMenu *)NULL;
 291
 292     m_invokingWindow = (wxWindow *)NULL;
 293     m_style = style;
 294     m_clientData = (void *)NULL;
 295     m_eventHandler = this;
 296 }
 297
 298 wxMenuBase::~wxMenuBase()
 299 {
 300     WX_CLEAR_LIST(wxMenuItemList, m_items);
 301
 302     // Actually, in GTK, the submenus have to get deleted first.
 303 }
 304
 305 // ----------------------------------------------------------------------------
 306 // wxMenu item adding/removing
 307 // ----------------------------------------------------------------------------
 308
 309 void wxMenuBase::AddSubMenu(wxMenu *submenu)
 310 {
 311     wxCHECK_RET( submenu, _T("can't add a NULL submenu") );
 312
 313     if ( m_menuBar )
 314     {
 315         submenu->Attach(m_menuBar);
 316     }
 317
 318     submenu->SetParent((wxMenu *)this);
 319 }
 320
 321 wxMenuItem* wxMenuBase::DoAppend(wxMenuItem *item)
 322 {
 323     wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Append()") );
 324
 325     m_items.Append(item);
 326     item->SetMenu((wxMenu*)this);
 327     if ( item->IsSubMenu() )
 328     {
 329         AddSubMenu(item->GetSubMenu());
 330     }
 331
 332     return item;
 333 }
 334
 335 wxMenuItem* wxMenuBase::Insert(size_t pos, wxMenuItem *item)
 336 {
 337     wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Insert") );
 338
 339     if ( pos == GetMenuItemCount() )
 340     {
 341         return DoAppend(item);
 342     }
 343     else
 344     {
 345         wxCHECK_MSG( pos < GetMenuItemCount(), FALSE,
 346                      wxT("invalid index in wxMenu::Insert") );
 347
 348         return DoInsert(pos, item);
 349     }
 350 }
 351
 352 wxMenuItem* wxMenuBase::DoInsert(size_t pos, wxMenuItem *item)
 353 {
 354     wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Insert()") );
 355
 356     wxMenuItemList::compatibility_iterator node = m_items.Item(pos);
 357     wxCHECK_MSG( node, FALSE, wxT("invalid index in wxMenu::Insert()") );
 358
 359     m_items.Insert(node, item);
 360     item->SetMenu((wxMenu*)this);
 361     if ( item->IsSubMenu() )
 362     {
 363         AddSubMenu(item->GetSubMenu());
 364     }
 365
 366     return item;
 367 }
 368
 369 wxMenuItem *wxMenuBase::Remove(wxMenuItem *item)
 370 {
 371     wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Remove") );
 372
 373     return DoRemove(item);
 374 }
 375
 376 wxMenuItem *wxMenuBase::DoRemove(wxMenuItem *item)
 377 {
 378     wxMenuItemList::compatibility_iterator node = m_items.Find(item);
 379
 380     // if we get here, the item is valid or one of Remove() functions is broken
 381     wxCHECK_MSG( node, NULL, wxT("bug in wxMenu::Remove logic") );
 382
 383     // we detach the item, but we do delete the list node (i.e. don't call
 384     // DetachNode() here!)
 385     m_items.Erase(node);
 386
 387     // item isn't attached to anything any more
 388     item->SetMenu((wxMenu *)NULL);
 389     wxMenu *submenu = item->GetSubMenu();
 390     if ( submenu )
 391     {
 392         submenu->SetParent((wxMenu *)NULL);
 393     }
 394
 395     return item;
 396 }
 397
 398 bool wxMenuBase::Delete(wxMenuItem *item)
 399 {
 400     wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Delete") );
 401
 402     return DoDelete(item);
 403 }
 404
 405 bool wxMenuBase::DoDelete(wxMenuItem *item)
 406 {
 407     wxMenuItem *item2 = DoRemove(item);
 408     wxCHECK_MSG( item2, FALSE, wxT("failed to delete menu item") );
 409
 410     // don't delete the submenu
 411     item2->SetSubMenu((wxMenu *)NULL);
 412
 413     delete item2;
 414
 415     return TRUE;
 416 }
 417
 418 bool wxMenuBase::Destroy(wxMenuItem *item)
 419 {
 420     wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Destroy") );
 421
 422     return DoDestroy(item);
 423 }
 424
 425 bool wxMenuBase::DoDestroy(wxMenuItem *item)
 426 {
 427     wxMenuItem *item2 = DoRemove(item);
 428     wxCHECK_MSG( item2, FALSE, wxT("failed to delete menu item") );
 429
 430     delete item2;
 431
 432     return TRUE;
 433 }
 434
 435 // ----------------------------------------------------------------------------
 436 // wxMenu searching for items
 437 // ----------------------------------------------------------------------------
 438
 439 // Finds the item id matching the given string, -1 if not found.
 440 int wxMenuBase::FindItem(const wxString& text) const
 441 {
 442     wxString label = wxMenuItem::GetLabelFromText(text);
 443     for ( wxMenuItemList::compatibility_iterator node = m_items.GetFirst();
 444           node;
 445           node = node->GetNext() )
 446     {
 447         wxMenuItem *item = node->GetData();
 448         if ( item->IsSubMenu() )
 449         {
 450             int rc = item->GetSubMenu()->FindItem(label);
 451             if ( rc != wxNOT_FOUND )
 452                 return rc;
 453         }
 454
 455         // we execute this code for submenus as well to alllow finding them by
 456         // name just like the ordinary items
 457         if ( !item->IsSeparator() )
 458         {
 459             if ( item->GetLabel() == label )
 460                 return item->GetId();
 461         }
 462     }
 463
 464     return wxNOT_FOUND;
 465 }
 466
 467 // recursive search for item by id
 468 wxMenuItem *wxMenuBase::FindItem(int itemId, wxMenu **itemMenu) const
 469 {
 470     if ( itemMenu )
 471         *itemMenu = NULL;
 472
 473     wxMenuItem *item = NULL;
 474     for ( wxMenuItemList::compatibility_iterator node = m_items.GetFirst();
 475           node && !item;
 476           node = node->GetNext() )
 477     {
 478         item = node->GetData();
 479
 480         if ( item->GetId() == itemId )
 481         {
 482             if ( itemMenu )
 483                 *itemMenu = (wxMenu *)this;
 484         }
 485         else if ( item->IsSubMenu() )
 486         {
 487             item = item->GetSubMenu()->FindItem(itemId, itemMenu);
 488         }
 489         else
 490         {
 491             // don't exit the loop
 492             item = NULL;
 493         }
 494     }
 495
 496     return item;
 497 }
 498
 499 // non recursive search
 500 wxMenuItem *wxMenuBase::FindChildItem(int id, size_t *ppos) const
 501 {
 502     wxMenuItem *item = (wxMenuItem *)NULL;
 503     wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
 504
 505     size_t pos;
 506     for ( pos = 0; node; pos++ )
 507     {
 508         if ( node->GetData()->GetId() == id )
 509         {
 510             item = node->GetData();
 511
 512             break;
 513         }
 514
 515         node = node->GetNext();
 516     }
 517
 518     if ( ppos )
 519     {
 520         *ppos = item ? pos : (size_t)wxNOT_FOUND;
 521     }
 522
 523     return item;
 524 }
 525
 526 // find by position
 527 wxMenuItem* wxMenuBase::FindItemByPosition(size_t position) const
 528 {
 529     wxCHECK_MSG( position < m_items.GetCount(), NULL,
 530                  _T("wxMenu::FindItemByPosition(): invalid menu index") );
 531
 532     return m_items.Item( position )->GetData();
 533 }
 534
 535 // ----------------------------------------------------------------------------
 536 // wxMenu helpers used by derived classes
 537 // ----------------------------------------------------------------------------
 538
 539 // Update a menu and all submenus recursively. source is the object that has
 540 // the update event handlers defined for it. If NULL, the menu or associated
 541 // window will be used.
 542 void wxMenuBase::UpdateUI(wxEvtHandler* source)
 543 {
 544     if (GetInvokingWindow())
 545     {
 546         // Don't update menus if the parent
 547         // frame is about to get deleted
 548         wxWindow *tlw = wxGetTopLevelParent( GetInvokingWindow() );
 549         if (tlw && wxPendingDelete.Member(tlw))
 550             return;
 551     }
 552
 553     if ( !source && GetInvokingWindow() )
 554         source = GetInvokingWindow()->GetEventHandler();
 555     if ( !source )
 556         source = GetEventHandler();
 557     if ( !source )
 558         source = this;
 559
 560     wxMenuItemList::compatibility_iterator  node = GetMenuItems().GetFirst();
 561     while ( node )
 562     {
 563         wxMenuItem* item = node->GetData();
 564         if ( !item->IsSeparator() )
 565         {
 566             wxWindowID id = item->GetId();
 567             wxUpdateUIEvent event(id);
 568             event.SetEventObject( source );
 569
 570             if ( source->ProcessEvent(event) )
 571             {
 572                 // if anything changed, update the changed attribute
 573                 if (event.GetSetText())
 574                     SetLabel(id, event.GetText());
 575                 if (event.GetSetChecked())
 576                     Check(id, event.GetChecked());
 577                 if (event.GetSetEnabled())
 578                     Enable(id, event.GetEnabled());
 579             }
 580
 581             // recurse to the submenus
 582             if ( item->GetSubMenu() )
 583                 item->GetSubMenu()->UpdateUI(source);
 584         }
 585         //else: item is a separator (which doesn't process update UI events)
 586
 587         node = node->GetNext();
 588     }
 589 }
 590
 591 bool wxMenuBase::SendEvent(int id, int checked)
 592 {
 593     wxCommandEvent event(wxEVT_COMMAND_MENU_SELECTED, id);
 594     event.SetEventObject(this);
 595     event.SetInt(checked);
 596
 597     bool processed = FALSE;
 598
 599     // Try the menu's event handler
 600     if ( !processed )
 601     {
 602         wxEvtHandler *handler = GetEventHandler();
 603         if ( handler )
 604             processed = handler->ProcessEvent(event);
 605     }
 606
 607     // Try the window the menu was popped up from (and up through the
 608     // hierarchy)
 609     if ( !processed )
 610     {
 611         const wxMenuBase *menu = this;
 612         while ( menu )
 613         {
 614             wxWindow *win = menu->GetInvokingWindow();
 615             if ( win )
 616             {
 617                 processed = win->GetEventHandler()->ProcessEvent(event);
 618                 break;
 619             }
 620
 621             menu = menu->GetParent();
 622         }
 623     }
 624
 625     return processed;
 626 }
 627
 628 // ----------------------------------------------------------------------------
 629 // wxMenu attaching/detaching to/from menu bar
 630 // ----------------------------------------------------------------------------
 631
 632 void wxMenuBase::Attach(wxMenuBarBase *menubar)
 633 {
 634     // use Detach() instead!
 635     wxASSERT_MSG( menubar, _T("menu can't be attached to NULL menubar") );
 636
 637     // use IsAttached() to prevent this from happening
 638     wxASSERT_MSG( !m_menuBar, _T("attaching menu twice?") );
 639
 640     m_menuBar = (wxMenuBar *)menubar;
 641 }
 642
 643 void wxMenuBase::Detach()
 644 {
 645     // use IsAttached() to prevent this from happening
 646     wxASSERT_MSG( m_menuBar, _T("detaching unattached menu?") );
 647
 648     m_menuBar = NULL;
 649 }
 650
 651 // ----------------------------------------------------------------------------
 652 // wxMenu functions forwarded to wxMenuItem
 653 // ----------------------------------------------------------------------------
 654
 655 void wxMenuBase::Enable( int id, bool enable )
 656 {
 657     wxMenuItem *item = FindItem(id);
 658
 659     wxCHECK_RET( item, wxT("wxMenu::Enable: no such item") );
 660
 661     item->Enable(enable);
 662 }
 663
 664 bool wxMenuBase::IsEnabled( int id ) const
 665 {
 666     wxMenuItem *item = FindItem(id);
 667
 668     wxCHECK_MSG( item, FALSE, wxT("wxMenu::IsEnabled: no such item") );
 669
 670     return item->IsEnabled();
 671 }
 672
 673 void wxMenuBase::Check( int id, bool enable )
 674 {
 675     wxMenuItem *item = FindItem(id);
 676
 677     wxCHECK_RET( item, wxT("wxMenu::Check: no such item") );
 678
 679     item->Check(enable);
 680 }
 681
 682 bool wxMenuBase::IsChecked( int id ) const
 683 {
 684     wxMenuItem *item = FindItem(id);
 685
 686     wxCHECK_MSG( item, FALSE, wxT("wxMenu::IsChecked: no such item") );
 687
 688     return item->IsChecked();
 689 }
 690
 691 void wxMenuBase::SetLabel( int id, const wxString &label )
 692 {
 693     wxMenuItem *item = FindItem(id);
 694
 695     wxCHECK_RET( item, wxT("wxMenu::SetLabel: no such item") );
 696
 697     item->SetText(label);
 698 }
 699
 700 wxString wxMenuBase::GetLabel( int id ) const
 701 {
 702     wxMenuItem *item = FindItem(id);
 703
 704     wxCHECK_MSG( item, wxT(""), wxT("wxMenu::GetLabel: no such item") );
 705
 706     return item->GetText();
 707 }
 708
 709 void wxMenuBase::SetHelpString( int id, const wxString& helpString )
 710 {
 711     wxMenuItem *item = FindItem(id);
 712
 713     wxCHECK_RET( item, wxT("wxMenu::SetHelpString: no such item") );
 714
 715     item->SetHelp( helpString );
 716 }
 717
 718 wxString wxMenuBase::GetHelpString( int id ) const
 719 {
 720     wxMenuItem *item = FindItem(id);
 721
 722     wxCHECK_MSG( item, wxT(""), wxT("wxMenu::GetHelpString: no such item") );
 723
 724     return item->GetHelp();
 725 }
 726
 727 // ----------------------------------------------------------------------------
 728 // wxMenuBarBase ctor and dtor
 729 // ----------------------------------------------------------------------------
 730
 731 wxMenuBarBase::wxMenuBarBase()
 732 {
 733     // not attached yet
 734     m_menuBarFrame = NULL;
 735 }
 736
 737 wxMenuBarBase::~wxMenuBarBase()
 738 {
 739     WX_CLEAR_LIST(wxMenuList, m_menus);
 740 }
 741
 742 // ----------------------------------------------------------------------------
 743 // wxMenuBar item access: the base class versions manage m_menus list, the
 744 // derived class should reflect the changes in the real menubar
 745 // ----------------------------------------------------------------------------
 746
 747 wxMenu *wxMenuBarBase::GetMenu(size_t pos) const
 748 {
 749     wxMenuList::compatibility_iterator node = m_menus.Item(pos);
 750     wxCHECK_MSG( node, NULL, wxT("bad index in wxMenuBar::GetMenu()") );
 751
 752     return node->GetData();
 753 }
 754
 755 bool wxMenuBarBase::Append(wxMenu *menu, const wxString& WXUNUSED(title))
 756 {
 757     wxCHECK_MSG( menu, FALSE, wxT("can't append NULL menu") );
 758
 759     m_menus.Append(menu);
 760     menu->Attach(this);
 761
 762     return TRUE;
 763 }
 764
 765 bool wxMenuBarBase::Insert(size_t pos, wxMenu *menu,
 766                            const wxString& title)
 767 {
 768     if ( pos == m_menus.GetCount() )
 769     {
 770         return wxMenuBarBase::Append(menu, title);
 771     }
 772     else // not at the end
 773     {
 774         wxCHECK_MSG( menu, FALSE, wxT("can't insert NULL menu") );
 775
 776         wxMenuList::compatibility_iterator node = m_menus.Item(pos);
 777         wxCHECK_MSG( node, FALSE, wxT("bad index in wxMenuBar::Insert()") );
 778
 779         m_menus.Insert(node, menu);
 780         menu->Attach(this);
 781
 782         return TRUE;
 783     }
 784 }
 785
 786 wxMenu *wxMenuBarBase::Replace(size_t pos, wxMenu *menu,
 787                                const wxString& WXUNUSED(title))
 788 {
 789     wxCHECK_MSG( menu, NULL, wxT("can't insert NULL menu") );
 790
 791     wxMenuList::compatibility_iterator node = m_menus.Item(pos);
 792     wxCHECK_MSG( node, NULL, wxT("bad index in wxMenuBar::Replace()") );
 793
 794     wxMenu *menuOld = node->GetData();
 795     node->SetData(menu);
 796
 797     menu->Attach(this);
 798     menuOld->Detach();
 799
 800     return menuOld;
 801 }
 802
 803 wxMenu *wxMenuBarBase::Remove(size_t pos)
 804 {
 805     wxMenuList::compatibility_iterator node = m_menus.Item(pos);
 806     wxCHECK_MSG( node, NULL, wxT("bad index in wxMenuBar::Remove()") );
 807
 808     wxMenu *menu = node->GetData();
 809     m_menus.Erase(node);
 810     menu->Detach();
 811
 812     return menu;
 813 }
 814
 815 int wxMenuBarBase::FindMenu(const wxString& title) const
 816 {
 817     wxString label = wxMenuItem::GetLabelFromText(title);
 818
 819     size_t count = GetMenuCount();
 820     for ( size_t i = 0; i < count; i++ )
 821     {
 822         wxString title2 = GetLabelTop(i);
 823         if ( (title2 == title) ||
 824              (wxMenuItem::GetLabelFromText(title2) == label) )
 825         {
 826             // found
 827             return (int)i;
 828         }
 829     }
 830
 831     return wxNOT_FOUND;
 832
 833 }
 834
 835 // ----------------------------------------------------------------------------
 836 // wxMenuBar attaching/detaching to/from the frame
 837 // ----------------------------------------------------------------------------
 838
 839 void wxMenuBarBase::Attach(wxFrame *frame)
 840 {
 841     wxASSERT_MSG( !IsAttached(), wxT("menubar already attached!") );
 842
 843     m_menuBarFrame = frame;
 844 }
 845
 846 void wxMenuBarBase::Detach()
 847 {
 848     wxASSERT_MSG( IsAttached(), wxT("detaching unattached menubar") );
 849
 850     m_menuBarFrame = NULL;
 851 }
 852
 853 // ----------------------------------------------------------------------------
 854 // wxMenuBar searching for items
 855 // ----------------------------------------------------------------------------
 856
 857 wxMenuItem *wxMenuBarBase::FindItem(int id, wxMenu **menu) const
 858 {
 859     if ( menu )
 860         *menu = NULL;
 861
 862     wxMenuItem *item = NULL;
 863     size_t count = GetMenuCount(), i;
 864     wxMenuList::const_iterator it;
 865     for ( i = 0, it = m_menus.begin(); !item && (i < count); i++, it++ )
 866     {
 867         item = (*it)->FindItem(id, menu);
 868     }
 869
 870     return item;
 871 }
 872
 873 int wxMenuBarBase::FindMenuItem(const wxString& menu, const wxString& item) const
 874 {
 875     wxString label = wxMenuItem::GetLabelFromText(menu);
 876
 877     int i = 0;
 878     wxMenuList::compatibility_iterator node;
 879     for ( node = m_menus.GetFirst(); node; node = node->GetNext(), i++ )
 880     {
 881         if ( label == wxMenuItem::GetLabelFromText(GetLabelTop(i)) )
 882             return node->GetData()->FindItem(item);
 883     }
 884
 885     return wxNOT_FOUND;
 886 }
 887
 888 // ---------------------------------------------------------------------------
 889 // wxMenuBar functions forwarded to wxMenuItem
 890 // ---------------------------------------------------------------------------
 891
 892 void wxMenuBarBase::Enable(int id, bool enable)
 893 {
 894     wxMenuItem *item = FindItem(id);
 895
 896     wxCHECK_RET( item, wxT("attempt to enable an item which doesn't exist") );
 897
 898     item->Enable(enable);
 899 }
 900
 901 void wxMenuBarBase::Check(int id, bool check)
 902 {
 903     wxMenuItem *item = FindItem(id);
 904
 905     wxCHECK_RET( item, wxT("attempt to check an item which doesn't exist") );
 906     wxCHECK_RET( item->IsCheckable(), wxT("attempt to check an uncheckable item") );
 907
 908     item->Check(check);
 909 }
 910
 911 bool wxMenuBarBase::IsChecked(int id) const
 912 {
 913     wxMenuItem *item = FindItem(id);
 914
 915     wxCHECK_MSG( item, FALSE, wxT("wxMenuBar::IsChecked(): no such item") );
 916
 917     return item->IsChecked();
 918 }
 919
 920 bool wxMenuBarBase::IsEnabled(int id) const
 921 {
 922     wxMenuItem *item = FindItem(id);
 923
 924     wxCHECK_MSG( item, FALSE, wxT("wxMenuBar::IsEnabled(): no such item") );
 925
 926     return item->IsEnabled();
 927 }
 928
 929 void wxMenuBarBase::SetLabel(int id, const wxString& label)
 930 {
 931     wxMenuItem *item = FindItem(id);
 932
 933     wxCHECK_RET( item, wxT("wxMenuBar::SetLabel(): no such item") );
 934
 935     item->SetText(label);
 936 }
 937
 938 wxString wxMenuBarBase::GetLabel(int id) const
 939 {
 940     wxMenuItem *item = FindItem(id);
 941
 942     wxCHECK_MSG( item, wxEmptyString,
 943                  wxT("wxMenuBar::GetLabel(): no such item") );
 944
 945     return item->GetText();
 946 }
 947
 948 void wxMenuBarBase::SetHelpString(int id, const wxString& helpString)
 949 {
 950     wxMenuItem *item = FindItem(id);
 951
 952     wxCHECK_RET( item, wxT("wxMenuBar::SetHelpString(): no such item") );
 953
 954     item->SetHelp(helpString);
 955 }
 956
 957 wxString wxMenuBarBase::GetHelpString(int id) const
 958 {
 959     wxMenuItem *item = FindItem(id);
 960
 961     wxCHECK_MSG( item, wxEmptyString,
 962                  wxT("wxMenuBar::GetHelpString(): no such item") );
 963
 964     return item->GetHelp();
 965 }
 966
 967 #endif // wxUSE_MENUS