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) wxWidgets 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                         return NULL;
 210                     }
 211                 }
 212             }
 213         }
 214
 215         if ( keyCode ) {
 216             // we do have something
 217             return new wxAcceleratorEntry(accelFlags, keyCode);
 218         }
 219     }
 220
 221     return (wxAcceleratorEntry *)NULL;
 222 }
 223
 224 wxAcceleratorEntry *wxMenuItemBase::GetAccel() const
 225 {
 226     return wxGetAccelFromString(GetText());
 227 }
 228
 229 void wxMenuItemBase::SetAccel(wxAcceleratorEntry *accel)
 230 {
 231     wxString text = m_text.BeforeFirst(wxT('\t'));
 232     if ( accel )
 233     {
 234         text += wxT('\t');
 235
 236         int flags = accel->GetFlags();
 237         if ( flags & wxACCEL_ALT )
 238             text += wxT("Alt-");
 239         if ( flags & wxACCEL_CTRL )
 240             text += wxT("Ctrl-");
 241         if ( flags & wxACCEL_SHIFT )
 242             text += wxT("Shift-");
 243
 244         int code = accel->GetKeyCode();
 245         switch ( code )
 246         {
 247             case WXK_F1:
 248             case WXK_F2:
 249             case WXK_F3:
 250             case WXK_F4:
 251             case WXK_F5:
 252             case WXK_F6:
 253             case WXK_F7:
 254             case WXK_F8:
 255             case WXK_F9:
 256             case WXK_F10:
 257             case WXK_F11:
 258             case WXK_F12:
 259                 text << wxT('F') << code - WXK_F1 + 1;
 260                 break;
 261
 262             // if there are any other keys wxGetAccelFromString() may return,
 263             // we should process them here
 264
 265             default:
 266                 if ( wxIsalnum(code) )
 267                 {
 268                     text << (wxChar)code;
 269
 270                     break;
 271                 }
 272
 273                 wxFAIL_MSG( wxT("unknown keyboard accel") );
 274         }
 275     }
 276
 277     SetText(text);
 278 }
 279
 280 #endif // wxUSE_ACCEL
 281
 282 bool wxMenuBase::ms_locked = true;
 283
 284 // ----------------------------------------------------------------------------
 285 // wxMenu ctor and dtor
 286 // ----------------------------------------------------------------------------
 287
 288 void wxMenuBase::Init(long style)
 289 {
 290     m_menuBar = (wxMenuBar *)NULL;
 291     m_menuParent = (wxMenu *)NULL;
 292
 293     m_invokingWindow = (wxWindow *)NULL;
 294     m_style = style;
 295     m_clientData = (void *)NULL;
 296     m_eventHandler = this;
 297 }
 298
 299 wxMenuBase::~wxMenuBase()
 300 {
 301     WX_CLEAR_LIST(wxMenuItemList, m_items);
 302
 303     // Actually, in GTK, the submenus have to get deleted first.
 304 }
 305
 306 // ----------------------------------------------------------------------------
 307 // wxMenu item adding/removing
 308 // ----------------------------------------------------------------------------
 309
 310 void wxMenuBase::AddSubMenu(wxMenu *submenu)
 311 {
 312     wxCHECK_RET( submenu, _T("can't add a NULL submenu") );
 313
 314     submenu->SetParent((wxMenu *)this);
 315 }
 316
 317 wxMenuItem* wxMenuBase::DoAppend(wxMenuItem *item)
 318 {
 319     wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Append()") );
 320
 321     m_items.Append(item);
 322     item->SetMenu((wxMenu*)this);
 323     if ( item->IsSubMenu() )
 324     {
 325         AddSubMenu(item->GetSubMenu());
 326     }
 327
 328     return item;
 329 }
 330
 331 wxMenuItem* wxMenuBase::Insert(size_t pos, wxMenuItem *item)
 332 {
 333     wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Insert") );
 334
 335     if ( pos == GetMenuItemCount() )
 336     {
 337         return DoAppend(item);
 338     }
 339     else
 340     {
 341         wxCHECK_MSG( pos < GetMenuItemCount(), NULL,
 342                      wxT("invalid index in wxMenu::Insert") );
 343
 344         return DoInsert(pos, item);
 345     }
 346 }
 347
 348 wxMenuItem* wxMenuBase::DoInsert(size_t pos, wxMenuItem *item)
 349 {
 350     wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Insert()") );
 351
 352     wxMenuItemList::compatibility_iterator node = m_items.Item(pos);
 353     wxCHECK_MSG( node, NULL, wxT("invalid index in wxMenu::Insert()") );
 354
 355     m_items.Insert(node, item);
 356     item->SetMenu((wxMenu*)this);
 357     if ( item->IsSubMenu() )
 358     {
 359         AddSubMenu(item->GetSubMenu());
 360     }
 361
 362     return item;
 363 }
 364
 365 wxMenuItem *wxMenuBase::Remove(wxMenuItem *item)
 366 {
 367     wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Remove") );
 368
 369     return DoRemove(item);
 370 }
 371
 372 wxMenuItem *wxMenuBase::DoRemove(wxMenuItem *item)
 373 {
 374     wxMenuItemList::compatibility_iterator node = m_items.Find(item);
 375
 376     // if we get here, the item is valid or one of Remove() functions is broken
 377     wxCHECK_MSG( node, NULL, wxT("bug in wxMenu::Remove logic") );
 378
 379     // we detach the item, but we do delete the list node (i.e. don't call
 380     // DetachNode() here!)
 381     m_items.Erase(node);
 382
 383     // item isn't attached to anything any more
 384     item->SetMenu((wxMenu *)NULL);
 385     wxMenu *submenu = item->GetSubMenu();
 386     if ( submenu )
 387     {
 388         submenu->SetParent((wxMenu *)NULL);
 389         if ( submenu->IsAttached() )
 390             submenu->Detach();
 391     }
 392
 393     return item;
 394 }
 395
 396 bool wxMenuBase::Delete(wxMenuItem *item)
 397 {
 398     wxCHECK_MSG( item, false, wxT("invalid item in wxMenu::Delete") );
 399
 400     return DoDelete(item);
 401 }
 402
 403 bool wxMenuBase::DoDelete(wxMenuItem *item)
 404 {
 405     wxMenuItem *item2 = DoRemove(item);
 406     wxCHECK_MSG( item2, false, wxT("failed to delete menu item") );
 407
 408     // don't delete the submenu
 409     item2->SetSubMenu((wxMenu *)NULL);
 410
 411     delete item2;
 412
 413     return true;
 414 }
 415
 416 bool wxMenuBase::Destroy(wxMenuItem *item)
 417 {
 418     wxCHECK_MSG( item, false, wxT("invalid item in wxMenu::Destroy") );
 419
 420     return DoDestroy(item);
 421 }
 422
 423 bool wxMenuBase::DoDestroy(wxMenuItem *item)
 424 {
 425     wxMenuItem *item2 = DoRemove(item);
 426     wxCHECK_MSG( item2, false, wxT("failed to delete menu item") );
 427
 428     delete item2;
 429
 430     return true;
 431 }
 432
 433 // ----------------------------------------------------------------------------
 434 // wxMenu searching for items
 435 // ----------------------------------------------------------------------------
 436
 437 // Finds the item id matching the given string, wxNOT_FOUND if not found.
 438 int wxMenuBase::FindItem(const wxString& text) const
 439 {
 440     wxString label = wxMenuItem::GetLabelFromText(text);
 441     for ( wxMenuItemList::compatibility_iterator node = m_items.GetFirst();
 442           node;
 443           node = node->GetNext() )
 444     {
 445         wxMenuItem *item = node->GetData();
 446         if ( item->IsSubMenu() )
 447         {
 448             int rc = item->GetSubMenu()->FindItem(label);
 449             if ( rc != wxNOT_FOUND )
 450                 return rc;
 451         }
 452
 453         // we execute this code for submenus as well to alllow finding them by
 454         // name just like the ordinary items
 455         if ( !item->IsSeparator() )
 456         {
 457             if ( item->GetLabel() == label )
 458                 return item->GetId();
 459         }
 460     }
 461
 462     return wxNOT_FOUND;
 463 }
 464
 465 // recursive search for item by id
 466 wxMenuItem *wxMenuBase::FindItem(int itemId, wxMenu **itemMenu) const
 467 {
 468     if ( itemMenu )
 469         *itemMenu = NULL;
 470
 471     wxMenuItem *item = NULL;
 472     for ( wxMenuItemList::compatibility_iterator node = m_items.GetFirst();
 473           node && !item;
 474           node = node->GetNext() )
 475     {
 476         item = node->GetData();
 477
 478         if ( item->GetId() == itemId )
 479         {
 480             if ( itemMenu )
 481                 *itemMenu = (wxMenu *)this;
 482         }
 483         else if ( item->IsSubMenu() )
 484         {
 485             item = item->GetSubMenu()->FindItem(itemId, itemMenu);
 486         }
 487         else
 488         {
 489             // don't exit the loop
 490             item = NULL;
 491         }
 492     }
 493
 494     return item;
 495 }
 496
 497 // non recursive search
 498 wxMenuItem *wxMenuBase::FindChildItem(int id, size_t *ppos) const
 499 {
 500     wxMenuItem *item = (wxMenuItem *)NULL;
 501     wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
 502
 503     size_t pos;
 504     for ( pos = 0; node; pos++ )
 505     {
 506         if ( node->GetData()->GetId() == id )
 507         {
 508             item = node->GetData();
 509
 510             break;
 511         }
 512
 513         node = node->GetNext();
 514     }
 515
 516     if ( ppos )
 517     {
 518         *ppos = item ? pos : (size_t)wxNOT_FOUND;
 519     }
 520
 521     return item;
 522 }
 523
 524 // find by position
 525 wxMenuItem* wxMenuBase::FindItemByPosition(size_t position) const
 526 {
 527     wxCHECK_MSG( position < m_items.GetCount(), NULL,
 528                  _T("wxMenu::FindItemByPosition(): invalid menu index") );
 529
 530     return m_items.Item( position )->GetData();
 531 }
 532
 533 // ----------------------------------------------------------------------------
 534 // wxMenu helpers used by derived classes
 535 // ----------------------------------------------------------------------------
 536
 537 // Update a menu and all submenus recursively. source is the object that has
 538 // the update event handlers defined for it. If NULL, the menu or associated
 539 // window will be used.
 540 void wxMenuBase::UpdateUI(wxEvtHandler* source)
 541 {
 542     if (GetInvokingWindow())
 543     {
 544         // Don't update menus if the parent
 545         // frame is about to get deleted
 546         wxWindow *tlw = wxGetTopLevelParent( GetInvokingWindow() );
 547         if (tlw && wxPendingDelete.Member(tlw))
 548             return;
 549     }
 550
 551     if ( !source && GetInvokingWindow() )
 552         source = GetInvokingWindow()->GetEventHandler();
 553     if ( !source )
 554         source = GetEventHandler();
 555     if ( !source )
 556         source = this;
 557
 558     wxMenuItemList::compatibility_iterator  node = GetMenuItems().GetFirst();
 559     while ( node )
 560     {
 561         wxMenuItem* item = node->GetData();
 562         if ( !item->IsSeparator() )
 563         {
 564             wxWindowID id = item->GetId();
 565             wxUpdateUIEvent event(id);
 566             event.SetEventObject( source );
 567
 568             if ( source->ProcessEvent(event) )
 569             {
 570                 // if anything changed, update the changed attribute
 571                 if (event.GetSetText())
 572                     SetLabel(id, event.GetText());
 573                 if (event.GetSetChecked())
 574                     Check(id, event.GetChecked());
 575                 if (event.GetSetEnabled())
 576                     Enable(id, event.GetEnabled());
 577             }
 578
 579             // recurse to the submenus
 580             if ( item->GetSubMenu() )
 581                 item->GetSubMenu()->UpdateUI(source);
 582         }
 583         //else: item is a separator (which doesn't process update UI events)
 584
 585         node = node->GetNext();
 586     }
 587 }
 588
 589 bool wxMenuBase::SendEvent(int id, int checked)
 590 {
 591     wxCommandEvent event(wxEVT_COMMAND_MENU_SELECTED, id);
 592     event.SetEventObject(this);
 593     event.SetInt(checked);
 594
 595     bool processed = false;
 596
 597     // Try the menu's event handler
 598     if ( !processed )
 599     {
 600         wxEvtHandler *handler = GetEventHandler();
 601         if ( handler )
 602             processed = handler->ProcessEvent(event);
 603     }
 604
 605     // Try the window the menu was popped up from (and up through the
 606     // hierarchy)
 607     if ( !processed )
 608     {
 609         const wxMenuBase *menu = this;
 610         while ( menu )
 611         {
 612             wxWindow *win = menu->GetInvokingWindow();
 613             if ( win )
 614             {
 615                 processed = win->GetEventHandler()->ProcessEvent(event);
 616                 break;
 617             }
 618
 619             menu = menu->GetParent();
 620         }
 621     }
 622
 623     return processed;
 624 }
 625
 626 // ----------------------------------------------------------------------------
 627 // wxMenu attaching/detaching to/from menu bar
 628 // ----------------------------------------------------------------------------
 629
 630 wxMenuBar* wxMenuBase::GetMenuBar() const
 631 {
 632     if(GetParent())
 633         return GetParent()->GetMenuBar();
 634     return m_menuBar;
 635 }
 636
 637 void wxMenuBase::Attach(wxMenuBarBase *menubar)
 638 {
 639     // use Detach() instead!
 640     wxASSERT_MSG( menubar, _T("menu can't be attached to NULL menubar") );
 641
 642     // use IsAttached() to prevent this from happening
 643     wxASSERT_MSG( !m_menuBar, _T("attaching menu twice?") );
 644
 645     m_menuBar = (wxMenuBar *)menubar;
 646 }
 647
 648 void wxMenuBase::Detach()
 649 {
 650     // use IsAttached() to prevent this from happening
 651     wxASSERT_MSG( m_menuBar, _T("detaching unattached menu?") );
 652
 653     m_menuBar = NULL;
 654 }
 655
 656 // ----------------------------------------------------------------------------
 657 // wxMenu functions forwarded to wxMenuItem
 658 // ----------------------------------------------------------------------------
 659
 660 void wxMenuBase::Enable( int id, bool enable )
 661 {
 662     wxMenuItem *item = FindItem(id);
 663
 664     wxCHECK_RET( item, wxT("wxMenu::Enable: no such item") );
 665
 666     item->Enable(enable);
 667 }
 668
 669 bool wxMenuBase::IsEnabled( int id ) const
 670 {
 671     wxMenuItem *item = FindItem(id);
 672
 673     wxCHECK_MSG( item, false, wxT("wxMenu::IsEnabled: no such item") );
 674
 675     return item->IsEnabled();
 676 }
 677
 678 void wxMenuBase::Check( int id, bool enable )
 679 {
 680     wxMenuItem *item = FindItem(id);
 681
 682     wxCHECK_RET( item, wxT("wxMenu::Check: no such item") );
 683
 684     item->Check(enable);
 685 }
 686
 687 bool wxMenuBase::IsChecked( int id ) const
 688 {
 689     wxMenuItem *item = FindItem(id);
 690
 691     wxCHECK_MSG( item, false, wxT("wxMenu::IsChecked: no such item") );
 692
 693     return item->IsChecked();
 694 }
 695
 696 void wxMenuBase::SetLabel( int id, const wxString &label )
 697 {
 698     wxMenuItem *item = FindItem(id);
 699
 700     wxCHECK_RET( item, wxT("wxMenu::SetLabel: no such item") );
 701
 702     item->SetText(label);
 703 }
 704
 705 wxString wxMenuBase::GetLabel( int id ) const
 706 {
 707     wxMenuItem *item = FindItem(id);
 708
 709     wxCHECK_MSG( item, wxT(""), wxT("wxMenu::GetLabel: no such item") );
 710
 711     return item->GetText();
 712 }
 713
 714 void wxMenuBase::SetHelpString( int id, const wxString& helpString )
 715 {
 716     wxMenuItem *item = FindItem(id);
 717
 718     wxCHECK_RET( item, wxT("wxMenu::SetHelpString: no such item") );
 719
 720     item->SetHelp( helpString );
 721 }
 722
 723 wxString wxMenuBase::GetHelpString( int id ) const
 724 {
 725     wxMenuItem *item = FindItem(id);
 726
 727     wxCHECK_MSG( item, wxT(""), wxT("wxMenu::GetHelpString: no such item") );
 728
 729     return item->GetHelp();
 730 }
 731
 732 // ----------------------------------------------------------------------------
 733 // wxMenuBarBase ctor and dtor
 734 // ----------------------------------------------------------------------------
 735
 736 wxMenuBarBase::wxMenuBarBase()
 737 {
 738     // not attached yet
 739     m_menuBarFrame = NULL;
 740 }
 741
 742 wxMenuBarBase::~wxMenuBarBase()
 743 {
 744     WX_CLEAR_LIST(wxMenuList, m_menus);
 745 }
 746
 747 // ----------------------------------------------------------------------------
 748 // wxMenuBar item access: the base class versions manage m_menus list, the
 749 // derived class should reflect the changes in the real menubar
 750 // ----------------------------------------------------------------------------
 751
 752 wxMenu *wxMenuBarBase::GetMenu(size_t pos) const
 753 {
 754     wxMenuList::compatibility_iterator node = m_menus.Item(pos);
 755     wxCHECK_MSG( node, NULL, wxT("bad index in wxMenuBar::GetMenu()") );
 756
 757     return node->GetData();
 758 }
 759
 760 bool wxMenuBarBase::Append(wxMenu *menu, const wxString& WXUNUSED(title))
 761 {
 762     wxCHECK_MSG( menu, false, wxT("can't append NULL menu") );
 763
 764     m_menus.Append(menu);
 765     menu->Attach(this);
 766
 767     return true;
 768 }
 769
 770 bool wxMenuBarBase::Insert(size_t pos, wxMenu *menu,
 771                            const wxString& title)
 772 {
 773     if ( pos == m_menus.GetCount() )
 774     {
 775         return wxMenuBarBase::Append(menu, title);
 776     }
 777     else // not at the end
 778     {
 779         wxCHECK_MSG( menu, false, wxT("can't insert NULL menu") );
 780
 781         wxMenuList::compatibility_iterator node = m_menus.Item(pos);
 782         wxCHECK_MSG( node, false, wxT("bad index in wxMenuBar::Insert()") );
 783
 784         m_menus.Insert(node, menu);
 785         menu->Attach(this);
 786
 787         return true;
 788     }
 789 }
 790
 791 wxMenu *wxMenuBarBase::Replace(size_t pos, wxMenu *menu,
 792                                const wxString& WXUNUSED(title))
 793 {
 794     wxCHECK_MSG( menu, NULL, wxT("can't insert NULL menu") );
 795
 796     wxMenuList::compatibility_iterator node = m_menus.Item(pos);
 797     wxCHECK_MSG( node, NULL, wxT("bad index in wxMenuBar::Replace()") );
 798
 799     wxMenu *menuOld = node->GetData();
 800     node->SetData(menu);
 801
 802     menu->Attach(this);
 803     menuOld->Detach();
 804
 805     return menuOld;
 806 }
 807
 808 wxMenu *wxMenuBarBase::Remove(size_t pos)
 809 {
 810     wxMenuList::compatibility_iterator node = m_menus.Item(pos);
 811     wxCHECK_MSG( node, NULL, wxT("bad index in wxMenuBar::Remove()") );
 812
 813     wxMenu *menu = node->GetData();
 814     m_menus.Erase(node);
 815     menu->Detach();
 816
 817     return menu;
 818 }
 819
 820 int wxMenuBarBase::FindMenu(const wxString& title) const
 821 {
 822     wxString label = wxMenuItem::GetLabelFromText(title);
 823
 824     size_t count = GetMenuCount();
 825     for ( size_t i = 0; i < count; i++ )
 826     {
 827         wxString title2 = GetLabelTop(i);
 828         if ( (title2 == title) ||
 829              (wxMenuItem::GetLabelFromText(title2) == label) )
 830         {
 831             // found
 832             return (int)i;
 833         }
 834     }
 835
 836     return wxNOT_FOUND;
 837
 838 }
 839
 840 // ----------------------------------------------------------------------------
 841 // wxMenuBar attaching/detaching to/from the frame
 842 // ----------------------------------------------------------------------------
 843
 844 void wxMenuBarBase::Attach(wxFrame *frame)
 845 {
 846     wxASSERT_MSG( !IsAttached(), wxT("menubar already attached!") );
 847
 848     m_menuBarFrame = frame;
 849 }
 850
 851 void wxMenuBarBase::Detach()
 852 {
 853     wxASSERT_MSG( IsAttached(), wxT("detaching unattached menubar") );
 854
 855     m_menuBarFrame = NULL;
 856 }
 857
 858 // ----------------------------------------------------------------------------
 859 // wxMenuBar searching for items
 860 // ----------------------------------------------------------------------------
 861
 862 wxMenuItem *wxMenuBarBase::FindItem(int id, wxMenu **menu) const
 863 {
 864     if ( menu )
 865         *menu = NULL;
 866
 867     wxMenuItem *item = NULL;
 868     size_t count = GetMenuCount(), i;
 869     wxMenuList::const_iterator it;
 870     for ( i = 0, it = m_menus.begin(); !item && (i < count); i++, it++ )
 871     {
 872         item = (*it)->FindItem(id, menu);
 873     }
 874
 875     return item;
 876 }
 877
 878 int wxMenuBarBase::FindMenuItem(const wxString& menu, const wxString& item) const
 879 {
 880     wxString label = wxMenuItem::GetLabelFromText(menu);
 881
 882     int i = 0;
 883     wxMenuList::compatibility_iterator node;
 884     for ( node = m_menus.GetFirst(); node; node = node->GetNext(), i++ )
 885     {
 886         if ( label == wxMenuItem::GetLabelFromText(GetLabelTop(i)) )
 887             return node->GetData()->FindItem(item);
 888     }
 889
 890     return wxNOT_FOUND;
 891 }
 892
 893 // ---------------------------------------------------------------------------
 894 // wxMenuBar functions forwarded to wxMenuItem
 895 // ---------------------------------------------------------------------------
 896
 897 void wxMenuBarBase::Enable(int id, bool enable)
 898 {
 899     wxMenuItem *item = FindItem(id);
 900
 901     wxCHECK_RET( item, wxT("attempt to enable an item which doesn't exist") );
 902
 903     item->Enable(enable);
 904 }
 905
 906 void wxMenuBarBase::Check(int id, bool check)
 907 {
 908     wxMenuItem *item = FindItem(id);
 909
 910     wxCHECK_RET( item, wxT("attempt to check an item which doesn't exist") );
 911     wxCHECK_RET( item->IsCheckable(), wxT("attempt to check an uncheckable item") );
 912
 913     item->Check(check);
 914 }
 915
 916 bool wxMenuBarBase::IsChecked(int id) const
 917 {
 918     wxMenuItem *item = FindItem(id);
 919
 920     wxCHECK_MSG( item, false, wxT("wxMenuBar::IsChecked(): no such item") );
 921
 922     return item->IsChecked();
 923 }
 924
 925 bool wxMenuBarBase::IsEnabled(int id) const
 926 {
 927     wxMenuItem *item = FindItem(id);
 928
 929     wxCHECK_MSG( item, false, wxT("wxMenuBar::IsEnabled(): no such item") );
 930
 931     return item->IsEnabled();
 932 }
 933
 934 void wxMenuBarBase::SetLabel(int id, const wxString& label)
 935 {
 936     wxMenuItem *item = FindItem(id);
 937
 938     wxCHECK_RET( item, wxT("wxMenuBar::SetLabel(): no such item") );
 939
 940     item->SetText(label);
 941 }
 942
 943 wxString wxMenuBarBase::GetLabel(int id) const
 944 {
 945     wxMenuItem *item = FindItem(id);
 946
 947     wxCHECK_MSG( item, wxEmptyString,
 948                  wxT("wxMenuBar::GetLabel(): no such item") );
 949
 950     return item->GetText();
 951 }
 952
 953 void wxMenuBarBase::SetHelpString(int id, const wxString& helpString)
 954 {
 955     wxMenuItem *item = FindItem(id);
 956
 957     wxCHECK_RET( item, wxT("wxMenuBar::SetHelpString(): no such item") );
 958
 959     item->SetHelp(helpString);
 960 }
 961
 962 wxString wxMenuBarBase::GetHelpString(int id) const
 963 {
 964     wxMenuItem *item = FindItem(id);
 965
 966     wxCHECK_MSG( item, wxEmptyString,
 967                  wxT("wxMenuBar::GetHelpString(): no such item") );
 968
 969     return item->GetHelp();
 970 }
 971
 972 #endif // wxUSE_MENUS