src/msw/menu.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        menu.cpp
   3 // Purpose:     wxMenu, wxMenuBar, wxMenuItem
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Markus Holzem
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ===========================================================================
  13 // declarations
  14 // ===========================================================================
  15
  16 // ---------------------------------------------------------------------------
  17 // headers
  18 // ---------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "menu.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 #ifndef WX_PRECOMP
  32     #include "wx/frame.h"
  33     #include "wx/menu.h"
  34     #include "wx/utils.h"
  35     #include "wx/intl.h"
  36 #endif
  37
  38 #if wxUSE_OWNER_DRAWN
  39     #include "wx/ownerdrw.h"
  40 #endif
  41
  42 #include "wx/msw/private.h"
  43 #include "wx/msw/menu.h"
  44 #include "wx/menuitem.h"
  45 #include "wx/log.h"
  46
  47 // other standard headers
  48 #include <string.h>
  49
  50 // ----------------------------------------------------------------------------
  51 // global variables
  52 // ----------------------------------------------------------------------------
  53
  54 extern wxMenu *wxCurrentPopupMenu;
  55
  56 // ----------------------------------------------------------------------------
  57 // constants
  58 // ----------------------------------------------------------------------------
  59
  60 // the (popup) menu title has this special id
  61 static const int idMenuTitle = -2;
  62
  63 // ----------------------------------------------------------------------------
  64 // macros
  65 // ----------------------------------------------------------------------------
  66
  67 #if !USE_SHARED_LIBRARY
  68     IMPLEMENT_DYNAMIC_CLASS(wxMenu, wxEvtHandler)
  69     IMPLEMENT_DYNAMIC_CLASS(wxMenuBar, wxEvtHandler)
  70 #endif
  71
  72 // convenience macros
  73 #define GetHMENU()          ((HMENU)GetHMenu())
  74 #define GetHMenuOf(menu)    ((HMENU)menu->GetHMenu())
  75
  76 // ============================================================================
  77 // implementation
  78 // ============================================================================
  79
  80 // ---------------------------------------------------------------------------
  81 // wxMenu construction, adding and removing menu items
  82 // ---------------------------------------------------------------------------
  83
  84 // Construct a menu with optional title (then use append)
  85 wxMenu::wxMenu(const wxString& title, const wxFunction func)
  86       : m_title(title)
  87 {
  88     m_parent = NULL;
  89     m_eventHandler = this;
  90     m_pInvokingWindow = NULL;
  91     m_doBreak = FALSE ;
  92     m_noItems = 0;
  93     m_menuBar = NULL;
  94     m_hMenu = (WXHMENU) CreatePopupMenu();
  95     m_savehMenu = 0 ;
  96     m_topLevelMenu = this;
  97     m_clientData = (void*) NULL;
  98
  99     if ( !!m_title )
 100     {
 101         Append(idMenuTitle, m_title) ;
 102         AppendSeparator() ;
 103     }
 104
 105 #if WXWIN_COMPATIBILITY
 106     Callback(func);
 107 #endif
 108 }
 109
 110 // The wxWindow destructor will take care of deleting the submenus.
 111 wxMenu::~wxMenu()
 112 {
 113     // free Windows resources
 114     if ( m_hMenu )
 115     {
 116         ::DestroyMenu((HMENU)m_hMenu);
 117         m_hMenu = 0;
 118     }
 119
 120     // delete submenus
 121     wxNode *node = m_menuItems.First();
 122     while ( node )
 123     {
 124         wxMenuItem *item = (wxMenuItem *)node->Data();
 125
 126         // Delete child menus.
 127         // Beware: they must not be appended to children list!!!
 128         // (because order of delete is significant)
 129         if ( item->IsSubMenu() )
 130             item->DeleteSubMenu();
 131
 132         wxNode *next = node->Next();
 133         delete item;
 134         delete node;
 135         node = next;
 136     }
 137 }
 138
 139 void wxMenu::Break()
 140 {
 141     m_doBreak = TRUE;
 142 }
 143
 144 // function appends a new item or submenu to the menu
 145 void wxMenu::Append(wxMenuItem *pItem)
 146 {
 147     wxCHECK_RET( pItem != NULL, "can't append NULL item to the menu" );
 148
 149 #if wxUSE_ACCEL
 150     // check for accelerators: they are given after '\t'
 151     wxString label = pItem->GetName();
 152     int posTab = label.Find('\t');
 153     if ( posTab != wxNOT_FOUND ) {
 154         // parse the accelerator string
 155         int keyCode = 0;
 156         int accelFlags = wxACCEL_NORMAL;
 157         wxString current;
 158         for ( size_t n = (size_t)posTab + 1; n < label.Len(); n++ ) {
 159             if ( (label[n] == '+') || (label[n] == '-') ) {
 160                 if ( current == _("ctrl") )
 161                     accelFlags |= wxACCEL_CTRL;
 162                 else if ( current == _("alt") )
 163                     accelFlags |= wxACCEL_ALT;
 164                 else if ( current == _("shift") )
 165                     accelFlags |= wxACCEL_SHIFT;
 166                 else {
 167                     wxLogDebug(_T("Unknown accel modifier: '%s'"),
 168                                current.c_str());
 169                 }
 170
 171                 current.Empty();
 172             }
 173             else {
 174                 current += wxTolower(label[n]);
 175             }
 176         }
 177
 178         if ( current.IsEmpty() ) {
 179             wxLogDebug(_T("No accel key found, accel string ignored."));
 180         }
 181         else {
 182             if ( current.Len() == 1 ) {
 183                 // it's a letter
 184                 keyCode = wxToupper(current[0U]);
 185             }
 186             else {
 187                 // it should be a function key
 188                 if ( current[0U] == 'f' && isdigit(current[1U]) &&
 189                      (current.Len() == 2 ||
 190                      (current.Len() == 3 && isdigit(current[2U]))) ) {
 191                     int n;
 192                     sscanf(current.c_str() + 1, "%d", &n);
 193
 194                     keyCode = VK_F1 + n - 1;
 195                 }
 196                 else {
 197                     wxLogDebug(_T("Unrecognized accel key '%s', accel "
 198                                   "string ignored."), current.c_str());
 199                 }
 200             }
 201         }
 202
 203         if ( keyCode ) {
 204             // do add an entry
 205             m_accelKeyCodes.Add(keyCode);
 206             m_accelFlags.Add(accelFlags);
 207             m_accelIds.Add(pItem->GetId());
 208         }
 209     }
 210 #endif // wxUSE_ACCEL
 211
 212     UINT flags = 0;
 213
 214     // if "Break" has just been called, insert a menu break before this item
 215     // (and don't forget to reset the flag)
 216     if ( m_doBreak ) {
 217         flags |= MF_MENUBREAK;
 218         m_doBreak = FALSE;
 219     }
 220
 221     if ( pItem->IsSeparator() ) {
 222         flags |= MF_SEPARATOR;
 223     }
 224
 225     // id is the numeric id for normal menu items and HMENU for submenus as
 226     // required by ::AppendMenu() API
 227     UINT id;
 228     wxMenu *submenu = pItem->GetSubMenu();
 229     if ( submenu != NULL ) {
 230         wxASSERT( submenu->GetHMenu() != (WXHMENU) NULL );
 231
 232         id = (UINT)submenu->GetHMenu();
 233         submenu->m_topLevelMenu = m_topLevelMenu;
 234         submenu->m_parent       = this;
 235         submenu->m_savehMenu    = (WXHMENU)id;
 236         submenu->m_hMenu        = 0;
 237
 238         flags |= MF_POPUP;
 239     }
 240     else {
 241         id = pItem->GetId();
 242     }
 243
 244     LPCSTR pData;
 245
 246 #if wxUSE_OWNER_DRAWN
 247     if ( pItem->IsOwnerDrawn() ) {  // want to get {Measure|Draw}Item messages?
 248         // item draws itself, pass pointer to it in data parameter
 249         flags |= MF_OWNERDRAW;
 250         pData = (LPCSTR)pItem;
 251     }
 252     else
 253 #endif
 254     {
 255         // menu is just a normal string (passed in data parameter)
 256         flags |= MF_STRING;
 257         pData = label;
 258     }
 259
 260     if ( !::AppendMenu(GetHMENU(), flags, id, pData) )
 261     {
 262         wxLogLastError("AppendMenu");
 263     }
 264     else
 265     {
 266 #ifdef __WIN32__
 267         if ( id == idMenuTitle )
 268         {
 269             // visually select the menu title
 270             MENUITEMINFO mii;
 271             mii.cbSize = sizeof(mii);
 272             mii.fMask = MIIM_STATE;
 273             mii.fState = MFS_DEFAULT;
 274
 275             if ( !SetMenuItemInfo(GetHMENU(), (unsigned)id, FALSE, &mii) )
 276             {
 277                 wxLogLastError("SetMenuItemInfo");
 278             }
 279         }
 280 #endif // __WIN32__
 281
 282         m_menuItems.Append(pItem);
 283         m_noItems++;
 284     }
 285 }
 286
 287 void wxMenu::AppendSeparator()
 288 {
 289     Append(new wxMenuItem(this, ID_SEPARATOR));
 290 }
 291
 292 // Pullright item
 293 void wxMenu::Append(int id,
 294                     const wxString& label,
 295                     wxMenu *SubMenu,
 296                     const wxString& helpString)
 297 {
 298     Append(new wxMenuItem(this, id, label, helpString, FALSE, SubMenu));
 299 }
 300
 301 // Ordinary menu item
 302 void wxMenu::Append(int id,
 303                     const wxString& label,
 304                     const wxString& helpString,
 305                     bool checkable)
 306 {
 307     // 'checkable' parameter is useless for Windows.
 308     Append(new wxMenuItem(this, id, label, helpString, checkable));
 309 }
 310
 311 // delete item by id
 312 void wxMenu::Delete(int id)
 313 {
 314     wxMenuItem *item = NULL;
 315     int pos;
 316     wxNode *node;
 317     for (pos = 0, node = m_menuItems.First(); node; node = node->Next(), pos++)
 318     {
 319         item = (wxMenuItem *)node->Data();
 320         if ( item->GetId() == id )
 321             break;
 322     }
 323
 324     wxCHECK_RET( node, "wxMenu::Delete(): item doesn't exist" );
 325
 326     HMENU menu = GetHMENU();
 327
 328     wxMenu *pSubMenu = item->GetSubMenu();
 329     if ( pSubMenu != NULL ) {
 330         RemoveMenu(menu, (UINT)pos, MF_BYPOSITION);
 331         pSubMenu->m_hMenu = pSubMenu->m_savehMenu;
 332         pSubMenu->m_savehMenu = 0;
 333         pSubMenu->m_parent = NULL;
 334         //     RemoveChild(item->subMenu);
 335         pSubMenu->m_topLevelMenu = NULL;
 336         // TODO: Why isn't subMenu deleted here???
 337         // Will put this in for now. Assuming this is supposed
 338         // to delete the menu, not just remove it.
 339         item->DeleteSubMenu();
 340     }
 341     else {
 342         DeleteMenu(menu, (UINT)pos, MF_BYPOSITION);
 343     }
 344
 345     m_menuItems.DeleteNode(node);
 346     delete item;
 347 }
 348
 349 #if wxUSE_ACCEL
 350
 351 // ---------------------------------------------------------------------------
 352 // accelerator helpers
 353 // ---------------------------------------------------------------------------
 354
 355 // create the wxAcceleratorEntries for our accels and put them into provided
 356 // array - return the number of accels we have
 357 size_t wxMenu::CopyAccels(wxAcceleratorEntry *accels) const
 358 {
 359     size_t count = GetAccelCount();
 360     for ( size_t n = 0; n < count; n++ )
 361     {
 362         (*accels++).Set(m_accelFlags[n], m_accelKeyCodes[n], m_accelIds[n]);
 363     }
 364
 365     return count;
 366 }
 367
 368 #endif // wxUSE_ACCEL
 369
 370 // ---------------------------------------------------------------------------
 371 // wxMenu functions implemented in wxMenuItem
 372 // ---------------------------------------------------------------------------
 373
 374 void wxMenu::Enable(int id, bool Flag)
 375 {
 376     wxMenuItem *item = FindItemForId(id);
 377     wxCHECK_RET( item != NULL, "can't enable non-existing menu item" );
 378
 379     item->Enable(Flag);
 380 }
 381
 382 bool wxMenu::IsEnabled(int id) const
 383 {
 384     wxMenuItem *item = FindItemForId(id);
 385     wxCHECK_MSG( item != NULL, FALSE, "invalid item id" );
 386
 387     return item->IsEnabled();
 388 }
 389
 390 void wxMenu::Check(int id, bool Flag)
 391 {
 392     wxMenuItem *item = FindItemForId(id);
 393     wxCHECK_RET( item != NULL, "can't get status of non-existing menu item" );
 394
 395     item->Check(Flag);
 396 }
 397
 398 bool wxMenu::IsChecked(int id) const
 399 {
 400     wxMenuItem *item = FindItemForId(id);
 401     wxCHECK_MSG( item != NULL, FALSE, "invalid item id" );
 402
 403     return item->IsChecked();
 404 }
 405
 406 void wxMenu::SetLabel(int id, const wxString& label)
 407 {
 408     wxMenuItem *item = FindItemForId(id) ;
 409     wxCHECK_RET( item, "wxMenu::SetLabel: no such item" );
 410
 411     item->SetName(label);
 412 }
 413
 414 wxString wxMenu::GetLabel(int id) const
 415 {
 416     wxString label;
 417     wxMenuItem *pItem = FindItemForId(id) ;
 418     if (pItem)
 419         label = pItem->GetName() ;
 420     else
 421         wxFAIL_MSG("wxMenu::GetLabel: item doesn't exist");
 422
 423     return label;
 424 }
 425
 426 void wxMenu::SetHelpString(int itemId, const wxString& helpString)
 427 {
 428     wxMenuItem *item = FindItemForId (itemId);
 429     if (item)
 430         item->SetHelp(helpString);
 431     else
 432         wxFAIL_MSG("wxMenu::SetHelpString: item doesn't exist");
 433 }
 434
 435 wxString wxMenu::GetHelpString (int itemId) const
 436 {
 437     wxString help;
 438     wxMenuItem *item = FindItemForId (itemId);
 439     if (item)
 440         help = item->GetHelp();
 441     else
 442         wxFAIL_MSG("wxMenu::GetHelpString: item doesn't exist");
 443
 444     return help;
 445 }
 446
 447 // ---------------------------------------------------------------------------
 448 // wxMenu title
 449 // ---------------------------------------------------------------------------
 450
 451 void wxMenu::SetTitle(const wxString& label)
 452 {
 453     bool hasNoTitle = m_title.IsEmpty();
 454     m_title = label;
 455
 456     HMENU hMenu = GetHMENU();
 457
 458     if ( hasNoTitle )
 459     {
 460         if ( !label.IsEmpty() )
 461         {
 462             if ( !InsertMenu(hMenu, 0u, MF_BYPOSITION | MF_STRING,
 463                              (unsigned)idMenuTitle, m_title) ||
 464                  !InsertMenu(hMenu, 1u, MF_BYPOSITION, (unsigned)-1, NULL) )
 465             {
 466                 wxLogLastError("InsertMenu");
 467             }
 468         }
 469     }
 470     else
 471     {
 472         if ( label.IsEmpty() )
 473         {
 474             // remove the title and the separator after it
 475             if ( !RemoveMenu(hMenu, 0, MF_BYPOSITION) ||
 476                  !RemoveMenu(hMenu, 0, MF_BYPOSITION) )
 477             {
 478                 wxLogLastError("RemoveMenu");
 479             }
 480         }
 481         else
 482         {
 483             // modify the title
 484             if ( !ModifyMenu(hMenu, 0u,
 485                         MF_BYPOSITION | MF_STRING,
 486                         (unsigned)idMenuTitle, m_title) )
 487             {
 488                 wxLogLastError("ModifyMenu");
 489             }
 490         }
 491     }
 492
 493 #ifdef __WIN32__
 494     // put the title string in bold face
 495     if ( !m_title.IsEmpty() )
 496     {
 497         MENUITEMINFO mii;
 498         mii.cbSize = sizeof(mii);
 499         mii.fMask = MIIM_STATE;
 500         mii.fState = MFS_DEFAULT;
 501
 502         if ( !SetMenuItemInfo(hMenu, (unsigned)idMenuTitle, FALSE, &mii) )
 503         {
 504             wxLogLastError("SetMenuItemInfo");
 505         }
 506     }
 507 #endif
 508 }
 509
 510 const wxString wxMenu::GetTitle() const
 511 {
 512     return m_title;
 513 }
 514
 515 // ---------------------------------------------------------------------------
 516 // event processing
 517 // ---------------------------------------------------------------------------
 518
 519 bool wxMenu::MSWCommand(WXUINT WXUNUSED(param), WXWORD id)
 520 {
 521     // ignore commands from the menu title
 522
 523     // NB: VC++ generates wrong assembler for `if ( id != idMenuTitle )'!!
 524     if ( id != (WXWORD)idMenuTitle )
 525     {
 526         wxCommandEvent event(wxEVT_COMMAND_MENU_SELECTED);
 527         event.SetEventObject( this );
 528         event.SetId( id );
 529         event.SetInt( id );
 530         ProcessCommand(event);
 531     }
 532
 533     return TRUE;
 534 }
 535
 536 bool wxMenu::ProcessCommand(wxCommandEvent & event)
 537 {
 538     bool processed = FALSE;
 539
 540 #if WXWIN_COMPATIBILITY
 541     // Try a callback
 542     if (m_callback)
 543     {
 544         (void)(*(m_callback))(*this, event);
 545         processed = TRUE;
 546     }
 547 #endif // WXWIN_COMPATIBILITY
 548
 549     // Try the menu's event handler
 550     if ( !processed && GetEventHandler())
 551     {
 552         processed = GetEventHandler()->ProcessEvent(event);
 553     }
 554
 555     // Try the window the menu was popped up from (and up through the
 556     // hierarchy)
 557     wxWindow *win = GetInvokingWindow();
 558     if ( !processed && win )
 559         processed = win->GetEventHandler()->ProcessEvent(event);
 560
 561     return processed;
 562 }
 563
 564 // ---------------------------------------------------------------------------
 565 // Item search
 566 // ---------------------------------------------------------------------------
 567
 568 // Finds the item id matching the given string, -1 if not found.
 569 int wxMenu::FindItem (const wxString& itemString) const
 570 {
 571     wxString itemLabel = wxStripMenuCodes(itemString);
 572     for ( wxNode *node = m_menuItems.First(); node; node = node->Next() )
 573     {
 574         wxMenuItem *item = (wxMenuItem *)node->Data();
 575         if ( item->IsSubMenu() )
 576         {
 577             int ans = item->GetSubMenu()->FindItem(itemString);
 578             if ( ans != wxNOT_FOUND )
 579                 return ans;
 580         }
 581         else if ( !item->IsSeparator() )
 582         {
 583             wxString label = wxStripMenuCodes(item->GetName());
 584             if ( itemLabel == label )
 585                 return item->GetId();
 586         }
 587     }
 588
 589     return wxNOT_FOUND;
 590 }
 591
 592 wxMenuItem *wxMenu::FindItemForId(int itemId, wxMenu ** itemMenu) const
 593 {
 594     if ( itemMenu )
 595         *itemMenu = NULL;
 596
 597     wxMenuItem *item = NULL;
 598     for ( wxNode *node = m_menuItems.First(); node && !item; node = node->Next() )
 599     {
 600         item = (wxMenuItem *)node->Data();
 601
 602         if ( item->GetId() == itemId )
 603         {
 604             if (itemMenu)
 605                 *itemMenu = (wxMenu *)this;
 606         }
 607         else if ( item->IsSubMenu() )
 608         {
 609             item = item->GetSubMenu()->FindItemForId(itemId, itemMenu);
 610         }
 611         else
 612         {
 613             // don't exit the loop
 614             item = NULL;
 615         }
 616     }
 617
 618     return item;
 619 }
 620
 621 // ---------------------------------------------------------------------------
 622 // other
 623 // ---------------------------------------------------------------------------
 624
 625 bool wxWindow::PopupMenu(wxMenu *menu, int x, int y)
 626 {
 627     menu->SetInvokingWindow(this);
 628     menu->UpdateUI();
 629
 630     HWND hWnd = (HWND) GetHWND();
 631     HMENU hMenu = (HMENU)menu->GetHMenu();
 632     POINT point;
 633     point.x = x;
 634     point.y = y;
 635     ::ClientToScreen(hWnd, &point);
 636     wxCurrentPopupMenu = menu;
 637     ::TrackPopupMenu(hMenu, TPM_RIGHTBUTTON, point.x, point.y, 0, hWnd, NULL);
 638     wxYield();
 639     wxCurrentPopupMenu = NULL;
 640
 641     menu->SetInvokingWindow(NULL);
 642
 643     return TRUE;
 644 }
 645
 646 void wxMenu::Attach(wxMenuBar *menubar)
 647 {
 648     // menu can be in at most one menubar because otherwise they would both
 649     // delete the menu pointer
 650     wxASSERT_MSG( !m_menuBar, "menu belongs to 2 menubars, expect a crash" );
 651
 652     m_menuBar = menubar;
 653     m_savehMenu = m_hMenu;
 654     m_hMenu = 0;
 655 }
 656
 657 void wxMenu::Detach()
 658 {
 659     wxASSERT_MSG( m_menuBar, "can't detach menu if it's not attached" );
 660
 661     m_hMenu = m_savehMenu;
 662     m_savehMenu = 0;
 663 }
 664
 665 // ---------------------------------------------------------------------------
 666 // Menu Bar
 667 // ---------------------------------------------------------------------------
 668
 669 void wxMenuBar::Init()
 670 {
 671     m_eventHandler = this;
 672     m_menuCount = 0;
 673     m_menus = NULL;
 674     m_titles = NULL;
 675     m_menuBarFrame = NULL;
 676     m_hMenu = 0;
 677 }
 678
 679 wxMenuBar::wxMenuBar()
 680 {
 681     Init();
 682 }
 683
 684 wxMenuBar::wxMenuBar( long WXUNUSED(style) )
 685 {
 686     Init();
 687 }
 688
 689 wxMenuBar::wxMenuBar(int count, wxMenu *menus[], const wxString titles[])
 690 {
 691     Init();
 692
 693     m_menuCount = count;
 694     m_menus = menus;
 695     m_titles = new wxString[count];
 696
 697     int i;
 698     for ( i = 0; i < count; i++ )
 699         m_titles[i] = titles[i];
 700
 701     for ( i = 0; i < count; i++ )
 702         m_menus[i]->Attach(this);
 703 }
 704
 705 wxMenuBar::~wxMenuBar()
 706 {
 707     for ( int i = 0; i < m_menuCount; i++ )
 708     {
 709         delete m_menus[i];
 710     }
 711
 712     delete[] m_menus;
 713     delete[] m_titles;
 714 }
 715
 716 // ---------------------------------------------------------------------------
 717 // wxMenuBar helpers
 718 // ---------------------------------------------------------------------------
 719
 720 void wxMenuBar::Refresh()
 721 {
 722     wxCHECK_RET( m_menuBarFrame, "can't refresh a menubar withotu a frame" );
 723
 724     DrawMenuBar((HWND)m_menuBarFrame->GetHWND()) ;
 725 }
 726
 727 WXHMENU wxMenuBar::Create()
 728 {
 729     wxCHECK_MSG( !m_hMenu, TRUE, "menubar already created" );
 730
 731     m_hMenu = (WXHMENU)::CreateMenu();
 732
 733     if ( !m_hMenu )
 734     {
 735         wxLogLastError("CreateMenu");
 736     }
 737     else
 738     {
 739         for ( int i = 0; i < m_menuCount; i++ )
 740         {
 741             if ( !::AppendMenu((HMENU)m_hMenu, MF_POPUP | MF_STRING,
 742                                (UINT)m_menus[i]->GetHMenu(),
 743                                m_titles[i]) )
 744             {
 745                 wxLogLastError("AppendMenu");
 746             }
 747         }
 748     }
 749
 750     return m_hMenu;
 751 }
 752
 753 // ---------------------------------------------------------------------------
 754 // wxMenuBar functions forwarded to wxMenuItem
 755 // ---------------------------------------------------------------------------
 756
 757 // Must only be used AFTER menu has been attached to frame,
 758 // otherwise use individual menus to enable/disable items
 759 void wxMenuBar::Enable(int id, bool enable)
 760 {
 761     wxMenu *itemMenu = NULL;
 762     wxMenuItem *item = FindItemForId(id, &itemMenu) ;
 763
 764     wxCHECK_RET( item, "attempt to enable an item which doesn't exist" );
 765
 766     item->Enable(enable);
 767 }
 768
 769 void wxMenuBar::EnableTop(int pos, bool enable)
 770 {
 771     int flag = enable ? MF_ENABLED : MF_GRAYED;;
 772
 773     EnableMenuItem((HMENU)m_hMenu, pos, MF_BYPOSITION | flag);
 774 }
 775
 776 // Must only be used AFTER menu has been attached to frame,
 777 // otherwise use individual menus
 778 void wxMenuBar::Check(int id, bool check)
 779 {
 780     wxMenu *itemMenu = NULL;
 781     wxMenuItem *item = FindItemForId(id, &itemMenu) ;
 782
 783     wxCHECK_RET( item, "attempt to check an item which doesn't exist" );
 784     wxCHECK_RET( item->IsCheckable(), "attempt to check an uncheckable item" );
 785
 786     item->Check(check);
 787 }
 788
 789 bool wxMenuBar::IsChecked(int id) const
 790 {
 791     wxMenu *itemMenu = NULL;
 792     wxMenuItem *item = FindItemForId(id, &itemMenu) ;
 793
 794     wxCHECK_MSG( item, FALSE, "wxMenuBar::IsChecked(): no such item" );
 795
 796     int flag = ::GetMenuState(GetHMenuOf(itemMenu), id, MF_BYCOMMAND);
 797
 798     return (flag & MF_CHECKED) != 0;
 799 }
 800
 801 bool wxMenuBar::IsEnabled(int id) const
 802 {
 803     wxMenu *itemMenu = NULL;
 804     wxMenuItem *item = FindItemForId(id, &itemMenu) ;
 805
 806     wxCHECK_MSG( item, FALSE, "wxMenuBar::IsEnabled(): no such item" );
 807
 808     int flag = ::GetMenuState(GetHMenuOf(itemMenu), id, MF_BYCOMMAND) ;
 809
 810     return (flag & MF_ENABLED) != 0;
 811 }
 812
 813 void wxMenuBar::SetLabel(int id, const wxString& label)
 814 {
 815     wxMenu *itemMenu = NULL;
 816     wxMenuItem *item = FindItemForId(id, &itemMenu) ;
 817
 818     wxCHECK_RET( item, "wxMenuBar::SetLabel(): no such item" );
 819
 820     item->SetName(label);
 821 }
 822
 823 wxString wxMenuBar::GetLabel(int id) const
 824 {
 825     wxMenu *itemMenu = NULL;
 826     wxMenuItem *item = FindItemForId(id, &itemMenu) ;
 827
 828     wxCHECK_MSG( item, "", "wxMenuBar::GetLabel(): no such item" );
 829
 830     return item->GetName();
 831 }
 832
 833 void wxMenuBar::SetHelpString (int id, const wxString& helpString)
 834 {
 835     wxMenu *itemMenu = NULL;
 836     wxMenuItem *item = FindItemForId(id, &itemMenu) ;
 837
 838     wxCHECK_RET( item, "wxMenuBar::SetHelpString(): no such item" );
 839
 840     item->SetHelp(helpString);
 841 }
 842
 843 wxString wxMenuBar::GetHelpString (int id) const
 844 {
 845     wxMenu *itemMenu = NULL;
 846     wxMenuItem *item = FindItemForId(id, &itemMenu) ;
 847
 848     wxCHECK_MSG( item, "", "wxMenuBar::GetHelpString(): no such item" );
 849
 850     return item->GetHelp();
 851 }
 852
 853 // ---------------------------------------------------------------------------
 854 // wxMenuBar functions to work with the top level submenus
 855 // ---------------------------------------------------------------------------
 856
 857 // NB: we don't support owner drawn top level items for now, if we do these
 858 //     functions would have to be changed to use wxMenuItem as well
 859
 860 void wxMenuBar::SetLabelTop(int pos, const wxString& label)
 861 {
 862     UINT id;
 863     UINT flagsOld = ::GetMenuState((HMENU)m_hMenu, pos, MF_BYPOSITION);
 864     if ( flagsOld == 0xFFFFFFFF )
 865     {
 866         wxLogLastError("GetMenuState");
 867
 868         return;
 869     }
 870
 871     if ( flagsOld & MF_POPUP )
 872     {
 873         // HIBYTE contains the number of items in the submenu in this case
 874         flagsOld &= 0xff ;
 875         id = (UINT)::GetSubMenu((HMENU)m_hMenu, pos) ;
 876     }
 877     else
 878     {
 879         id = pos;
 880     }
 881
 882     if ( ::ModifyMenu(GetHMENU(), pos, MF_BYPOSITION | MF_STRING | flagsOld,
 883                       id, label) == 0xFFFFFFFF )
 884     {
 885         wxLogLastError("ModifyMenu");
 886     }
 887 }
 888
 889 wxString wxMenuBar::GetLabelTop(int pos) const
 890 {
 891     int len = ::GetMenuString((HMENU)m_hMenu, pos, NULL, 0, MF_BYCOMMAND);
 892
 893     len++;  // for the NUL character
 894     wxString label;
 895     ::GetMenuString(GetHMENU(), pos, label.GetWriteBuf(len), len, MF_BYCOMMAND);
 896     label.UngetWriteBuf();
 897
 898     return label;
 899 }
 900
 901 // ---------------------------------------------------------------------------
 902 // wxMenuBar notifications
 903 // ---------------------------------------------------------------------------
 904
 905 bool wxMenuBar::OnDelete(wxMenu *a_menu, int pos)
 906 {
 907     if ( !m_menuBarFrame )
 908         return TRUE;
 909
 910     if ( ::RemoveMenu((HMENU)m_hMenu, (UINT)pos, MF_BYPOSITION) )
 911     {
 912         // VZ: I'm not sure about what's going on here, so I leave an assert
 913         wxASSERT_MSG( m_menus[pos] == a_menu, "what is this parameter for??" );
 914
 915         a_menu->Detach();
 916
 917         if ( m_menuBarFrame )
 918             Refresh();
 919
 920         return TRUE;
 921     }
 922     else
 923     {
 924         wxLogLastError("RemoveMenu");
 925     }
 926
 927     return FALSE;
 928 }
 929
 930 bool wxMenuBar::OnAppend(wxMenu *a_menu, const char *title)
 931 {
 932     WXHMENU submenu = a_menu->GetHMenu();
 933     if ( !submenu )
 934         return FALSE;
 935
 936     if ( !m_menuBarFrame )
 937         return TRUE;
 938
 939     a_menu->Attach(this);
 940
 941     if ( !::AppendMenu(GetHMENU(), MF_POPUP | MF_STRING,
 942                        (UINT)submenu, title) )
 943     {
 944         wxLogLastError("AppendMenu");
 945     }
 946
 947     Refresh();
 948
 949     return TRUE;
 950 }
 951
 952 // ---------------------------------------------------------------------------
 953 // wxMenuBar construction
 954 // ---------------------------------------------------------------------------
 955
 956 void wxMenuBar::Append (wxMenu * menu, const wxString& title)
 957 {
 958     if (!OnAppend(menu, title))
 959         return;
 960
 961     m_menuCount ++;
 962     wxMenu **new_menus = new wxMenu *[m_menuCount];
 963     wxString *new_titles = new wxString[m_menuCount];
 964     int i;
 965
 966     for (i = 0; i < m_menuCount - 1; i++)
 967     {
 968         new_menus[i] = m_menus[i];
 969         m_menus[i] = NULL;
 970         new_titles[i] = m_titles[i];
 971         m_titles[i] = "";
 972     }
 973     if (m_menus)
 974     {
 975         delete[]m_menus;
 976         delete[]m_titles;
 977     }
 978     m_menus = new_menus;
 979     m_titles = new_titles;
 980
 981     m_menus[m_menuCount - 1] = (wxMenu *)menu;
 982     m_titles[m_menuCount - 1] = title;
 983
 984     menu->SetParent(this);
 985 }
 986
 987 void wxMenuBar::Delete(wxMenu * menu, int i)
 988 {
 989     int j;
 990     int ii = (int) i;
 991
 992     if (menu != 0) {
 993         for (ii = 0; ii < m_menuCount; ii++) {
 994             if (m_menus[ii] == menu)
 995                 break;
 996         }
 997         if (ii >= m_menuCount)
 998             return;
 999     } else {
1000         if (ii < 0 || ii >= m_menuCount)
1001             return;
1002         menu = m_menus[ii];
1003     }
1004
1005     if (!OnDelete(menu, ii))
1006         return;
1007
1008     menu->SetParent(NULL);
1009
1010     -- m_menuCount;
1011     for (j = ii; j < m_menuCount; j++) {
1012         m_menus[j] = m_menus[j + 1];
1013         m_titles[j] = m_titles[j + 1];
1014     }
1015 }
1016
1017 void wxMenuBar::Attach(wxFrame *frame)
1018 {
1019     wxASSERT_MSG( !m_menuBarFrame, _T("menubar already attached!") );
1020
1021     m_menuBarFrame = frame;
1022
1023 #if wxUSE_ACCEL
1024     // create the accel table - we consider that the menubar construction is
1025     // finished
1026     size_t nAccelCount = 0;
1027     int i;
1028     for ( i = 0; i < m_menuCount; i++ )
1029     {
1030         nAccelCount += m_menus[i]->GetAccelCount();
1031     }
1032
1033     if ( nAccelCount )
1034     {
1035         wxAcceleratorEntry *accelEntries = new wxAcceleratorEntry[nAccelCount];
1036
1037         nAccelCount = 0;
1038         for ( i = 0; i < m_menuCount; i++ )
1039         {
1040             nAccelCount += m_menus[i]->CopyAccels(&accelEntries[nAccelCount]);
1041         }
1042
1043         m_accelTable = wxAcceleratorTable(nAccelCount, accelEntries);
1044
1045         delete [] accelEntries;
1046     }
1047 #endif // wxUSE_ACCEL
1048 }
1049
1050 // ---------------------------------------------------------------------------
1051 // wxMenuBar searching for menu items
1052 // ---------------------------------------------------------------------------
1053
1054 // Find the itemString in menuString, and return the item id or wxNOT_FOUND
1055 int wxMenuBar::FindMenuItem(const wxString& menuString,
1056                             const wxString& itemString) const
1057 {
1058     wxString menuLabel = wxStripMenuCodes(menuString);
1059     for ( int i = 0; i < m_menuCount; i++ )
1060     {
1061         wxString title = wxStripMenuCodes(m_titles[i]);
1062         if ( menuString == title )
1063             return m_menus[i]->FindItem(itemString);
1064     }
1065
1066     return wxNOT_FOUND;
1067 }
1068
1069 wxMenuItem *wxMenuBar::FindItemForId (int id, wxMenu **itemMenu) const
1070 {
1071     if ( itemMenu )
1072         *itemMenu = NULL;
1073
1074     wxMenuItem *item = NULL;
1075     for ( int i = 0; !item && (i < m_menuCount); i++ )
1076     {
1077         item = m_menus[i]->FindItemForId(id, itemMenu);
1078     }
1079
1080     return item;
1081 }
1082
1083
1084 // ----------------------------------------------------------------------------
1085 // helper functions
1086 // ----------------------------------------------------------------------------
1087
1088 wxWindow *wxMenu::GetWindow() const
1089 {
1090     if ( m_pInvokingWindow != NULL )
1091         return m_pInvokingWindow;
1092     else if ( m_menuBar != NULL)
1093         return m_menuBar->GetFrame();
1094
1095     return NULL;
1096 }
1097
1098 WXHMENU wxMenu::GetHMenu() const
1099 {
1100     if ( m_hMenu != 0 )
1101         return m_hMenu;
1102     else if ( m_savehMenu != 0 )
1103         return m_savehMenu;
1104
1105     wxFAIL_MSG("wxMenu without HMENU");
1106
1107     return 0;
1108 }
1109
1110 // Update a menu and all submenus recursively. source is the object that has
1111 // the update event handlers defined for it. If NULL, the menu or associated
1112 // window will be used.
1113 void wxMenu::UpdateUI(wxEvtHandler* source)
1114 {
1115     if (!source && GetInvokingWindow())
1116         source = GetInvokingWindow()->GetEventHandler();
1117     if (!source)
1118         source = GetEventHandler();
1119     if (!source)
1120         source = this;
1121
1122     wxNode* node = GetItems().First();
1123     while (node)
1124     {
1125         wxMenuItem* item = (wxMenuItem*) node->Data();
1126         if ( !item->IsSeparator() )
1127         {
1128             wxWindowID id = item->GetId();
1129             wxUpdateUIEvent event(id);
1130             event.SetEventObject( source );
1131
1132             if (source->ProcessEvent(event))
1133             {
1134                 if (event.GetSetText())
1135                     SetLabel(id, event.GetText());
1136                 if (event.GetSetChecked())
1137                     Check(id, event.GetChecked());
1138                 if (event.GetSetEnabled())
1139                     Enable(id, event.GetEnabled());
1140             }
1141
1142             if (item->GetSubMenu())
1143                 item->GetSubMenu()->UpdateUI(source);
1144         }
1145         node = node->Next();
1146     }
1147 }