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
   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 "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 #if wxUSE_MENUS
  32
  33 #ifndef WX_PRECOMP
  34     #include "wx/frame.h"
  35     #include "wx/menu.h"
  36     #include "wx/utils.h"
  37     #include "wx/intl.h"
  38     #include "wx/log.h"
  39 #endif
  40
  41 #if wxUSE_OWNER_DRAWN
  42     #include "wx/ownerdrw.h"
  43 #endif
  44
  45 #include "wx/msw/private.h"
  46
  47 #ifdef __WXWINCE__
  48 #include <windows.h>
  49 #include <windowsx.h>
  50 #include <tchar.h>
  51 #include <ole2.h>
  52 #include <shellapi.h>
  53 #include <commctrl.h>
  54 #if (_WIN32_WCE < 400) && !defined(__HANDHELDPC__)
  55 #include <aygshell.h>
  56 #endif
  57
  58 #include "wx/msw/wince/missing.h"
  59
  60 #endif
  61
  62 // other standard headers
  63 #include <string.h>
  64
  65 // ----------------------------------------------------------------------------
  66 // global variables
  67 // ----------------------------------------------------------------------------
  68
  69 extern wxMenu *wxCurrentPopupMenu;
  70
  71 // ----------------------------------------------------------------------------
  72 // constants
  73 // ----------------------------------------------------------------------------
  74
  75 // the (popup) menu title has this special id
  76 static const int idMenuTitle = -3;
  77
  78 // ----------------------------------------------------------------------------
  79 // private functions
  80 // ----------------------------------------------------------------------------
  81
  82 // make the given menu item default
  83 static void SetDefaultMenuItem(HMENU hmenu, UINT id)
  84 {
  85 #ifndef __WXWINCE__
  86     MENUITEMINFO mii;
  87     wxZeroMemory(mii);
  88     mii.cbSize = sizeof(MENUITEMINFO);
  89     mii.fMask = MIIM_STATE;
  90     mii.fState = MFS_DEFAULT;
  91
  92     if ( !::SetMenuItemInfo(hmenu, id, FALSE, &mii) )
  93     {
  94         wxLogLastError(wxT("SetMenuItemInfo"));
  95     }
  96 #else
  97     wxUnusedVar(hmenu);
  98     wxUnusedVar(id);
  99 #endif
 100 }
 101
 102 #ifdef __WXWINCE__
 103 UINT GetMenuState(HMENU hMenu, UINT id, UINT flags)
 104 {
 105     MENUITEMINFO info;
 106     wxZeroMemory(info);
 107     info.cbSize = sizeof(info);
 108     info.fMask = MIIM_STATE;
 109     // MF_BYCOMMAND is zero so test MF_BYPOSITION
 110     if ( !::GetMenuItemInfo(hMenu, id, flags & MF_BYPOSITION ? TRUE : FALSE , & info) )
 111         wxLogLastError(wxT("GetMenuItemInfo"));
 112     return info.fState;
 113 }
 114 #endif
 115
 116 // ============================================================================
 117 // implementation
 118 // ============================================================================
 119
 120 #include <wx/listimpl.cpp>
 121
 122 WX_DEFINE_LIST( wxMenuInfoList ) ;
 123
 124 #if wxUSE_EXTENDED_RTTI
 125
 126 WX_DEFINE_FLAGS( wxMenuStyle )
 127
 128 wxBEGIN_FLAGS( wxMenuStyle )
 129     wxFLAGS_MEMBER(wxMENU_TEAROFF)
 130 wxEND_FLAGS( wxMenuStyle )
 131
 132 IMPLEMENT_DYNAMIC_CLASS_XTI(wxMenu, wxEvtHandler,"wx/menu.h")
 133
 134 wxCOLLECTION_TYPE_INFO( wxMenuItem * , wxMenuItemList ) ;
 135
 136 template<> void wxCollectionToVariantArray( wxMenuItemList const &theList, wxxVariantArray &value)
 137 {
 138     wxListCollectionToVariantArray<wxMenuItemList::compatibility_iterator>( theList , value ) ;
 139 }
 140
 141 wxBEGIN_PROPERTIES_TABLE(wxMenu)
 142     wxEVENT_PROPERTY( Select , wxEVT_COMMAND_MENU_SELECTED , wxCommandEvent)
 143     wxPROPERTY( Title, wxString , SetTitle, GetTitle, wxString(), 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
 144     wxREADONLY_PROPERTY_FLAGS( MenuStyle , wxMenuStyle , long , GetStyle , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
 145     wxPROPERTY_COLLECTION( MenuItems , wxMenuItemList , wxMenuItem* , Append , GetMenuItems , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 146 wxEND_PROPERTIES_TABLE()
 147
 148 wxBEGIN_HANDLERS_TABLE(wxMenu)
 149 wxEND_HANDLERS_TABLE()
 150
 151 wxDIRECT_CONSTRUCTOR_2( wxMenu , wxString , Title , long , MenuStyle  )
 152
 153 WX_DEFINE_FLAGS( wxMenuBarStyle )
 154
 155 wxBEGIN_FLAGS( wxMenuBarStyle )
 156     wxFLAGS_MEMBER(wxMB_DOCKABLE)
 157 wxEND_FLAGS( wxMenuBarStyle )
 158
 159 // the negative id would lead the window (its superclass !) to vetoe streaming out otherwise
 160 bool wxMenuBarStreamingCallback( const wxObject *WXUNUSED(object), wxWriter * , wxPersister * , wxxVariantArray & )
 161 {
 162     return true ;
 163 }
 164
 165 IMPLEMENT_DYNAMIC_CLASS_XTI_CALLBACK(wxMenuBar, wxWindow ,"wx/menu.h",wxMenuBarStreamingCallback)
 166
 167 IMPLEMENT_DYNAMIC_CLASS_XTI(wxMenuInfo, wxObject , "wx/menu.h" )
 168
 169 wxBEGIN_PROPERTIES_TABLE(wxMenuInfo)
 170     wxREADONLY_PROPERTY( Menu , wxMenu* , GetMenu , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 171     wxREADONLY_PROPERTY( Title , wxString , GetTitle , wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 172 wxEND_PROPERTIES_TABLE()
 173
 174 wxBEGIN_HANDLERS_TABLE(wxMenuInfo)
 175 wxEND_HANDLERS_TABLE()
 176
 177 wxCONSTRUCTOR_2( wxMenuInfo , wxMenu* , Menu , wxString , Title )
 178
 179 wxCOLLECTION_TYPE_INFO( wxMenuInfo * , wxMenuInfoList ) ;
 180
 181 template<> void wxCollectionToVariantArray( wxMenuInfoList const &theList, wxxVariantArray &value)
 182 {
 183     wxListCollectionToVariantArray<wxMenuInfoList::compatibility_iterator>( theList , value ) ;
 184 }
 185
 186 wxBEGIN_PROPERTIES_TABLE(wxMenuBar)
 187     wxPROPERTY_COLLECTION( MenuInfos , wxMenuInfoList , wxMenuInfo* , Append , GetMenuInfos , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 188 wxEND_PROPERTIES_TABLE()
 189
 190 wxBEGIN_HANDLERS_TABLE(wxMenuBar)
 191 wxEND_HANDLERS_TABLE()
 192
 193 wxCONSTRUCTOR_DUMMY( wxMenuBar )
 194
 195 #else
 196 IMPLEMENT_DYNAMIC_CLASS(wxMenu, wxEvtHandler)
 197 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar, wxWindow)
 198 IMPLEMENT_DYNAMIC_CLASS(wxMenuInfo, wxObject)
 199 #endif
 200
 201 const wxMenuInfoList& wxMenuBar::GetMenuInfos() const
 202 {
 203     wxMenuInfoList* list = const_cast< wxMenuInfoList* >( &m_menuInfos ) ;
 204     WX_CLEAR_LIST( wxMenuInfoList , *list ) ;
 205     for( size_t i = 0 ; i < GetMenuCount() ; ++i )
 206     {
 207         wxMenuInfo* info = new wxMenuInfo() ;
 208         info->Create( const_cast<wxMenuBar*>(this)->GetMenu(i) , GetLabelTop(i) ) ;
 209         list->Append( info ) ;
 210     }
 211     return m_menuInfos ;
 212 }
 213
 214 // ---------------------------------------------------------------------------
 215 // wxMenu construction, adding and removing menu items
 216 // ---------------------------------------------------------------------------
 217
 218 // Construct a menu with optional title (then use append)
 219 void wxMenu::Init()
 220 {
 221     m_doBreak = false;
 222     m_startRadioGroup = -1;
 223
 224     // create the menu
 225     m_hMenu = (WXHMENU)CreatePopupMenu();
 226     if ( !m_hMenu )
 227     {
 228         wxLogLastError(wxT("CreatePopupMenu"));
 229     }
 230
 231     // if we have a title, insert it in the beginning of the menu
 232     if ( !m_title.IsEmpty() )
 233     {
 234         Append(idMenuTitle, m_title);
 235         AppendSeparator();
 236     }
 237 }
 238
 239 // The wxWindow destructor will take care of deleting the submenus.
 240 wxMenu::~wxMenu()
 241 {
 242     // we should free Windows resources only if Windows doesn't do it for us
 243     // which happens if we're attached to a menubar or a submenu of another
 244     // menu
 245     if ( !IsAttached() && !GetParent() )
 246     {
 247         if ( !::DestroyMenu(GetHmenu()) )
 248         {
 249             wxLogLastError(wxT("DestroyMenu"));
 250         }
 251     }
 252
 253 #if wxUSE_ACCEL
 254     // delete accels
 255     WX_CLEAR_ARRAY(m_accels);
 256 #endif // wxUSE_ACCEL
 257 }
 258
 259 void wxMenu::Break()
 260 {
 261     // this will take effect during the next call to Append()
 262     m_doBreak = true;
 263 }
 264
 265 void wxMenu::Attach(wxMenuBarBase *menubar)
 266 {
 267     wxMenuBase::Attach(menubar);
 268
 269     EndRadioGroup();
 270 }
 271
 272 #if wxUSE_ACCEL
 273
 274 int wxMenu::FindAccel(int id) const
 275 {
 276     size_t n, count = m_accels.GetCount();
 277     for ( n = 0; n < count; n++ )
 278     {
 279         if ( m_accels[n]->m_command == id )
 280             return n;
 281     }
 282
 283     return wxNOT_FOUND;
 284 }
 285
 286 void wxMenu::UpdateAccel(wxMenuItem *item)
 287 {
 288     if ( item->IsSubMenu() )
 289     {
 290         wxMenu *submenu = item->GetSubMenu();
 291         wxMenuItemList::compatibility_iterator node = submenu->GetMenuItems().GetFirst();
 292         while ( node )
 293         {
 294             UpdateAccel(node->GetData());
 295
 296             node = node->GetNext();
 297         }
 298     }
 299     else if ( !item->IsSeparator() )
 300     {
 301         // find the (new) accel for this item
 302         wxAcceleratorEntry *accel = wxGetAccelFromString(item->GetText());
 303         if ( accel )
 304             accel->m_command = item->GetId();
 305
 306         // find the old one
 307         int n = FindAccel(item->GetId());
 308         if ( n == wxNOT_FOUND )
 309         {
 310             // no old, add new if any
 311             if ( accel )
 312                 m_accels.Add(accel);
 313             else
 314                 return;     // skipping RebuildAccelTable() below
 315         }
 316         else
 317         {
 318             // replace old with new or just remove the old one if no new
 319             delete m_accels[n];
 320             if ( accel )
 321                 m_accels[n] = accel;
 322             else
 323                 m_accels.RemoveAt(n);
 324         }
 325
 326         if ( IsAttached() )
 327         {
 328             GetMenuBar()->RebuildAccelTable();
 329         }
 330     }
 331     //else: it is a separator, they can't have accels, nothing to do
 332 }
 333
 334 #endif // wxUSE_ACCEL
 335
 336 // append a new item or submenu to the menu
 337 bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
 338 {
 339 #if wxUSE_ACCEL
 340     UpdateAccel(pItem);
 341 #endif // wxUSE_ACCEL
 342
 343     UINT flags = 0;
 344
 345     // if "Break" has just been called, insert a menu break before this item
 346     // (and don't forget to reset the flag)
 347     if ( m_doBreak ) {
 348         flags |= MF_MENUBREAK;
 349         m_doBreak = false;
 350     }
 351
 352     if ( pItem->IsSeparator() ) {
 353         flags |= MF_SEPARATOR;
 354     }
 355
 356     // id is the numeric id for normal menu items and HMENU for submenus as
 357     // required by ::AppendMenu() API
 358     UINT id;
 359     wxMenu *submenu = pItem->GetSubMenu();
 360     if ( submenu != NULL ) {
 361         wxASSERT_MSG( submenu->GetHMenu(), wxT("invalid submenu") );
 362
 363         submenu->SetParent(this);
 364
 365         id = (UINT)submenu->GetHMenu();
 366
 367         flags |= MF_POPUP;
 368     }
 369     else {
 370         id = pItem->GetId();
 371     }
 372
 373 #ifdef __WXWINCE__
 374     wxString strippedString;
 375 #endif
 376
 377     LPCTSTR pData;
 378
 379 #if wxUSE_OWNER_DRAWN
 380     if ( pItem->IsOwnerDrawn() ) {  // want to get {Measure|Draw}Item messages?
 381         // item draws itself, pass pointer to it in data parameter
 382         flags |= MF_OWNERDRAW;
 383         pData = (LPCTSTR)pItem;
 384     }
 385     else
 386 #endif
 387     {
 388         // menu is just a normal string (passed in data parameter)
 389         flags |= MF_STRING;
 390
 391 #ifdef __WXWINCE__
 392         strippedString = wxStripMenuCodes(pItem->GetText());
 393         pData = (wxChar*)strippedString.c_str();
 394 #else
 395         pData = (wxChar*)pItem->GetText().c_str();
 396 #endif
 397     }
 398
 399     BOOL ok;
 400     if ( pos == (size_t)-1 )
 401     {
 402         ok = ::AppendMenu(GetHmenu(), flags, id, pData);
 403     }
 404     else
 405     {
 406         ok = ::InsertMenu(GetHmenu(), pos, flags | MF_BYPOSITION, id, pData);
 407     }
 408
 409     if ( !ok )
 410     {
 411         wxLogLastError(wxT("Insert or AppendMenu"));
 412
 413         return false;
 414     }
 415
 416     // if we just appended the title, highlight it
 417 #ifdef __WIN32__
 418     if ( (int)id == idMenuTitle )
 419     {
 420         // visually select the menu title
 421         SetDefaultMenuItem(GetHmenu(), id);
 422     }
 423 #endif // __WIN32__
 424
 425     // if we're already attached to the menubar, we must update it
 426     if ( IsAttached() && GetMenuBar()->IsAttached() )
 427     {
 428         GetMenuBar()->Refresh();
 429     }
 430
 431     return true;
 432 }
 433
 434 void wxMenu::EndRadioGroup()
 435 {
 436     // we're not inside a radio group any longer
 437     m_startRadioGroup = -1;
 438 }
 439
 440 wxMenuItem* wxMenu::DoAppend(wxMenuItem *item)
 441 {
 442     wxCHECK_MSG( item, NULL, _T("NULL item in wxMenu::DoAppend") );
 443
 444     bool check = false;
 445
 446     if ( item->GetKind() == wxITEM_RADIO )
 447     {
 448         int count = GetMenuItemCount();
 449
 450         if ( m_startRadioGroup == -1 )
 451         {
 452             // start a new radio group
 453             m_startRadioGroup = count;
 454
 455             // for now it has just one element
 456             item->SetAsRadioGroupStart();
 457             item->SetRadioGroupEnd(m_startRadioGroup);
 458
 459             // ensure that we have a checked item in the radio group
 460             check = true;
 461         }
 462         else // extend the current radio group
 463         {
 464             // we need to update its end item
 465             item->SetRadioGroupStart(m_startRadioGroup);
 466             wxMenuItemList::compatibility_iterator node = GetMenuItems().Item(m_startRadioGroup);
 467
 468             if ( node )
 469             {
 470                 node->GetData()->SetRadioGroupEnd(count);
 471             }
 472             else
 473             {
 474                 wxFAIL_MSG( _T("where is the radio group start item?") );
 475             }
 476         }
 477     }
 478     else // not a radio item
 479     {
 480         EndRadioGroup();
 481     }
 482
 483     if ( !wxMenuBase::DoAppend(item) || !DoInsertOrAppend(item) )
 484     {
 485         return NULL;
 486     }
 487
 488     if ( check )
 489     {
 490         // check the item initially
 491         item->Check(true);
 492     }
 493
 494     return item;
 495 }
 496
 497 wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item)
 498 {
 499     if (wxMenuBase::DoInsert(pos, item) && DoInsertOrAppend(item, pos))
 500         return item;
 501     else
 502         return NULL;
 503 }
 504
 505 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
 506 {
 507     // we need to find the items position in the child list
 508     size_t pos;
 509     wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
 510     for ( pos = 0; node; pos++ )
 511     {
 512         if ( node->GetData() == item )
 513             break;
 514
 515         node = node->GetNext();
 516     }
 517
 518     // DoRemove() (unlike Remove) can only be called for existing item!
 519     wxCHECK_MSG( node, NULL, wxT("bug in wxMenu::Remove logic") );
 520
 521 #if wxUSE_ACCEL
 522     // remove the corresponding accel from the accel table
 523     int n = FindAccel(item->GetId());
 524     if ( n != wxNOT_FOUND )
 525     {
 526         delete m_accels[n];
 527
 528         m_accels.RemoveAt(n);
 529     }
 530     //else: this item doesn't have an accel, nothing to do
 531 #endif // wxUSE_ACCEL
 532
 533     // remove the item from the menu
 534     if ( !::RemoveMenu(GetHmenu(), (UINT)pos, MF_BYPOSITION) )
 535     {
 536         wxLogLastError(wxT("RemoveMenu"));
 537     }
 538
 539     if ( IsAttached() && GetMenuBar()->IsAttached() )
 540     {
 541         // otherwise, the chane won't be visible
 542         GetMenuBar()->Refresh();
 543     }
 544
 545     // and from internal data structures
 546     return wxMenuBase::DoRemove(item);
 547 }
 548
 549 // ---------------------------------------------------------------------------
 550 // accelerator helpers
 551 // ---------------------------------------------------------------------------
 552
 553 #if wxUSE_ACCEL
 554
 555 // create the wxAcceleratorEntries for our accels and put them into provided
 556 // array - return the number of accels we have
 557 size_t wxMenu::CopyAccels(wxAcceleratorEntry *accels) const
 558 {
 559     size_t count = GetAccelCount();
 560     for ( size_t n = 0; n < count; n++ )
 561     {
 562         *accels++ = *m_accels[n];
 563     }
 564
 565     return count;
 566 }
 567
 568 #endif // wxUSE_ACCEL
 569
 570 // ---------------------------------------------------------------------------
 571 // set wxMenu title
 572 // ---------------------------------------------------------------------------
 573
 574 void wxMenu::SetTitle(const wxString& label)
 575 {
 576     bool hasNoTitle = m_title.IsEmpty();
 577     m_title = label;
 578
 579     HMENU hMenu = GetHmenu();
 580
 581     if ( hasNoTitle )
 582     {
 583         if ( !label.IsEmpty() )
 584         {
 585             if ( !::InsertMenu(hMenu, 0u, MF_BYPOSITION | MF_STRING,
 586                                (unsigned)idMenuTitle, m_title) ||
 587                  !::InsertMenu(hMenu, 1u, MF_BYPOSITION, (unsigned)-1, NULL) )
 588             {
 589                 wxLogLastError(wxT("InsertMenu"));
 590             }
 591         }
 592     }
 593     else
 594     {
 595         if ( label.IsEmpty() )
 596         {
 597             // remove the title and the separator after it
 598             if ( !RemoveMenu(hMenu, 0, MF_BYPOSITION) ||
 599                  !RemoveMenu(hMenu, 0, MF_BYPOSITION) )
 600             {
 601                 wxLogLastError(wxT("RemoveMenu"));
 602             }
 603         }
 604         else
 605         {
 606             // modify the title
 607 #ifdef __WXWINCE__
 608             MENUITEMINFO info;
 609             wxZeroMemory(info);
 610             info.cbSize = sizeof(info);
 611             info.fMask = MIIM_TYPE;
 612             info.fType = MFT_STRING;
 613             info.cch = m_title.Length();
 614             info.dwTypeData = (LPTSTR) m_title.c_str();
 615             if ( !SetMenuItemInfo(hMenu, 0, TRUE, & info) )
 616             {
 617                 wxLogLastError(wxT("SetMenuItemInfo"));
 618             }
 619 #else
 620             if ( !ModifyMenu(hMenu, 0u,
 621                              MF_BYPOSITION | MF_STRING,
 622                              (unsigned)idMenuTitle, m_title) )
 623             {
 624                 wxLogLastError(wxT("ModifyMenu"));
 625             }
 626 #endif
 627         }
 628     }
 629
 630 #ifdef __WIN32__
 631     // put the title string in bold face
 632     if ( !m_title.IsEmpty() )
 633     {
 634         SetDefaultMenuItem(GetHmenu(), (UINT)idMenuTitle);
 635     }
 636 #endif // Win32
 637 }
 638
 639 // ---------------------------------------------------------------------------
 640 // event processing
 641 // ---------------------------------------------------------------------------
 642
 643 bool wxMenu::MSWCommand(WXUINT WXUNUSED(param), WXWORD id)
 644 {
 645     // ignore commands from the menu title
 646     if ( id != (WXWORD)idMenuTitle )
 647     {
 648         // get the checked status of the command: notice that menuState is the
 649         // old state of the menu, so the test for MF_CHECKED must be inversed
 650         UINT menuState = ::GetMenuState(GetHmenu(), id, MF_BYCOMMAND);
 651         SendEvent(id, !(menuState & MF_CHECKED));
 652     }
 653
 654     return true;
 655 }
 656
 657 // ---------------------------------------------------------------------------
 658 // other
 659 // ---------------------------------------------------------------------------
 660
 661 wxWindow *wxMenu::GetWindow() const
 662 {
 663     if ( m_invokingWindow != NULL )
 664         return m_invokingWindow;
 665     else if ( GetMenuBar() != NULL)
 666         return GetMenuBar()->GetFrame();
 667
 668     return NULL;
 669 }
 670
 671 // ---------------------------------------------------------------------------
 672 // Menu Bar
 673 // ---------------------------------------------------------------------------
 674
 675 void wxMenuBar::Init()
 676 {
 677     m_eventHandler = this;
 678     m_hMenu = 0;
 679 #if wxUSE_TOOLBAR && defined(__WXWINCE__)
 680     m_toolBar = NULL;
 681 #endif
 682     // Not using a combined wxToolBar/wxMenuBar? then use
 683     // a commandbar in WinCE .NET just to implement the
 684     // menubar.
 685 #if defined(WINCE_WITH_COMMANDBAR)
 686     m_commandBar = NULL;
 687     m_adornmentsAdded = false;
 688 #endif
 689 }
 690
 691 wxMenuBar::wxMenuBar()
 692 {
 693     Init();
 694 }
 695
 696 wxMenuBar::wxMenuBar( long WXUNUSED(style) )
 697 {
 698     Init();
 699 }
 700
 701 wxMenuBar::wxMenuBar(size_t count, wxMenu *menus[], const wxString titles[], long WXUNUSED(style))
 702 {
 703     Init();
 704
 705     m_titles.Alloc(count);
 706
 707     for ( size_t i = 0; i < count; i++ )
 708     {
 709         m_menus.Append(menus[i]);
 710         m_titles.Add(titles[i]);
 711
 712         menus[i]->Attach(this);
 713     }
 714 }
 715
 716 wxMenuBar::~wxMenuBar()
 717 {
 718     // In Windows CE (not .NET), the menubar is always associated
 719     // with a toolbar, which destroys the menu implicitly.
 720 #if defined(WINCE_WITHOUT_COMMANDBAR) && defined(__POCKETPC__)
 721     if (GetToolBar())
 722     {
 723         wxToolMenuBar* toolMenuBar = wxDynamicCast(GetToolBar(), wxToolMenuBar);
 724         if (toolMenuBar)
 725             toolMenuBar->SetMenuBar(NULL);
 726     }
 727 #else
 728     // we should free Windows resources only if Windows doesn't do it for us
 729     // which happens if we're attached to a frame
 730     if (m_hMenu && !IsAttached())
 731     {
 732 #if defined(WINCE_WITH_COMMANDBAR)
 733         ::DestroyWindow((HWND) m_commandBar);
 734         m_commandBar = (WXHWND) NULL;
 735 #else
 736         ::DestroyMenu((HMENU)m_hMenu);
 737 #endif
 738         m_hMenu = (WXHMENU)NULL;
 739     }
 740 #endif
 741 }
 742
 743 // ---------------------------------------------------------------------------
 744 // wxMenuBar helpers
 745 // ---------------------------------------------------------------------------
 746
 747 void wxMenuBar::Refresh()
 748 {
 749     wxCHECK_RET( IsAttached(), wxT("can't refresh unattached menubar") );
 750
 751 #if defined(WINCE_WITHOUT_COMMANDBAR)
 752     if (GetToolBar())
 753     {
 754         CommandBar_DrawMenuBar((HWND) GetToolBar()->GetHWND(), 0);
 755     }
 756 #elif defined(WINCE_WITH_COMMANDBAR)
 757     if (m_commandBar)
 758         DrawMenuBar((HWND) m_commandBar);
 759 #else
 760     DrawMenuBar(GetHwndOf(GetFrame()));
 761 #endif
 762 }
 763
 764 WXHMENU wxMenuBar::Create()
 765 {
 766     // Note: this totally doesn't work on Smartphone,
 767     // since you have to use resources.
 768     // We'll have to find another way to add a menu
 769     // by changing/adding menu items to an existing menu.
 770 #if defined(WINCE_WITHOUT_COMMANDBAR)
 771     if ( m_hMenu != 0 )
 772         return m_hMenu;
 773
 774     if (!GetToolBar())
 775         return 0;
 776
 777     HWND hCommandBar = (HWND) GetToolBar()->GetHWND();
 778     HMENU hMenu = (HMENU)::SendMessage(hCommandBar, SHCMBM_GETMENU, (WPARAM)0, (LPARAM)0);
 779     if (hMenu)
 780     {
 781         TBBUTTON tbButton;
 782         memset(&tbButton, 0, sizeof(TBBUTTON));
 783         tbButton.iBitmap = I_IMAGENONE;
 784         tbButton.fsState = TBSTATE_ENABLED;
 785         tbButton.fsStyle = TBSTYLE_DROPDOWN | TBSTYLE_NO_DROPDOWN_ARROW | TBSTYLE_AUTOSIZE;
 786
 787         size_t i;
 788         for (i = 0; i < GetMenuCount(); i++)
 789         {
 790             HMENU hPopupMenu = (HMENU) GetMenu(i)->GetHMenu() ;
 791             tbButton.dwData = (DWORD)hPopupMenu;
 792             wxString label = wxStripMenuCodes(GetLabelTop(i));
 793             tbButton.iString = (int) label.c_str();
 794
 795             int position = i;
 796
 797             tbButton.idCommand = NewControlId();
 798             if (!::SendMessage(hCommandBar, TB_INSERTBUTTON, position, (LPARAM)&tbButton))
 799             {
 800                 wxLogLastError(wxT("TB_INSERTBUTTON"));
 801             }
 802         }
 803     }
 804     m_hMenu = (WXHMENU) hMenu;
 805     return m_hMenu;
 806 #else
 807     if ( m_hMenu != 0 )
 808         return m_hMenu;
 809
 810     m_hMenu = (WXHMENU)::CreateMenu();
 811
 812     if ( !m_hMenu )
 813     {
 814         wxLogLastError(wxT("CreateMenu"));
 815     }
 816     else
 817     {
 818         size_t count = GetMenuCount(), i;
 819         wxMenuList::iterator it;
 820         for ( i = 0, it = m_menus.begin(); i < count; i++, it++ )
 821         {
 822             if ( !::AppendMenu((HMENU)m_hMenu, MF_POPUP | MF_STRING,
 823                                (UINT)(*it)->GetHMenu(),
 824                                m_titles[i]) )
 825             {
 826                 wxLogLastError(wxT("AppendMenu"));
 827             }
 828         }
 829     }
 830
 831     return m_hMenu;
 832 #endif
 833 }
 834
 835 int wxMenuBar::MSWPositionForWxMenu(wxMenu *menu, int wxpos)
 836 {
 837     wxASSERT(menu);
 838     wxASSERT(menu->GetHMenu());
 839     wxASSERT(m_hMenu);
 840
 841 #if defined(__WXWINCE__)
 842     int totalMSWItems = GetMenuCount();
 843 #else
 844     int totalMSWItems = GetMenuItemCount((HMENU)m_hMenu);
 845 #endif
 846
 847     int i; // For old C++ compatibility
 848     for(i=wxpos; i<totalMSWItems; i++)
 849     {
 850         if(GetSubMenu((HMENU)m_hMenu,i)==(HMENU)menu->GetHMenu())
 851             return i;
 852     }
 853     for(i=0; i<wxpos; i++)
 854     {
 855         if(GetSubMenu((HMENU)m_hMenu,i)==(HMENU)menu->GetHMenu())
 856             return i;
 857     }
 858     wxFAIL;
 859     return -1;
 860 }
 861
 862 // ---------------------------------------------------------------------------
 863 // wxMenuBar functions to work with the top level submenus
 864 // ---------------------------------------------------------------------------
 865
 866 // NB: we don't support owner drawn top level items for now, if we do these
 867 //     functions would have to be changed to use wxMenuItem as well
 868
 869 void wxMenuBar::EnableTop(size_t pos, bool enable)
 870 {
 871     wxCHECK_RET( IsAttached(), wxT("doesn't work with unattached menubars") );
 872     wxCHECK_RET( pos < GetMenuCount(), wxT("invalid menu index") );
 873
 874     int flag = enable ? MF_ENABLED : MF_GRAYED;
 875
 876     EnableMenuItem((HMENU)m_hMenu, MSWPositionForWxMenu(GetMenu(pos),pos), MF_BYPOSITION | flag);
 877
 878     Refresh();
 879 }
 880
 881 void wxMenuBar::SetLabelTop(size_t pos, const wxString& label)
 882 {
 883     wxCHECK_RET( pos < GetMenuCount(), wxT("invalid menu index") );
 884
 885     m_titles[pos] = label;
 886
 887     if ( !IsAttached() )
 888     {
 889         return;
 890     }
 891     //else: have to modify the existing menu
 892
 893     int mswpos = MSWPositionForWxMenu(GetMenu(pos),pos);
 894
 895     UINT id;
 896     UINT flagsOld = ::GetMenuState((HMENU)m_hMenu, mswpos, MF_BYPOSITION);
 897     if ( flagsOld == 0xFFFFFFFF )
 898     {
 899         wxLogLastError(wxT("GetMenuState"));
 900
 901         return;
 902     }
 903
 904     if ( flagsOld & MF_POPUP )
 905     {
 906         // HIBYTE contains the number of items in the submenu in this case
 907         flagsOld &= 0xff;
 908         id = (UINT)::GetSubMenu((HMENU)m_hMenu, mswpos);
 909     }
 910     else
 911     {
 912         id = pos;
 913     }
 914
 915 #ifdef __WXWINCE__
 916     MENUITEMINFO info;
 917     wxZeroMemory(info);
 918     info.cbSize = sizeof(info);
 919     info.fMask = MIIM_TYPE;
 920     info.fType = MFT_STRING;
 921     info.cch = label.Length();
 922     info.dwTypeData = (LPTSTR) label.c_str();
 923     if ( !SetMenuItemInfo(GetHmenu(), id, TRUE, & info) )
 924     {
 925         wxLogLastError(wxT("SetMenuItemInfo"));
 926     }
 927
 928 #else
 929     if ( ::ModifyMenu(GetHmenu(), mswpos, MF_BYPOSITION | MF_STRING | flagsOld,
 930         id, label) == (int)0xFFFFFFFF )
 931     {
 932         wxLogLastError(wxT("ModifyMenu"));
 933     }
 934 #endif
 935
 936     Refresh();
 937 }
 938
 939 wxString wxMenuBar::GetLabelTop(size_t pos) const
 940 {
 941     wxCHECK_MSG( pos < GetMenuCount(), wxEmptyString,
 942                  wxT("invalid menu index in wxMenuBar::GetLabelTop") );
 943
 944     return wxMenuItem::GetLabelFromText(m_titles[pos]);
 945 }
 946
 947 // ---------------------------------------------------------------------------
 948 // wxMenuBar construction
 949 // ---------------------------------------------------------------------------
 950
 951 wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
 952 {
 953     wxMenu *menuOld = wxMenuBarBase::Replace(pos, menu, title);
 954     if ( !menuOld )
 955         return NULL;
 956
 957     m_titles[pos] = title;
 958
 959     if ( IsAttached() )
 960     {
 961         int mswpos = MSWPositionForWxMenu(menuOld,pos);
 962
 963         // can't use ModifyMenu() because it deletes the submenu it replaces
 964         if ( !::RemoveMenu(GetHmenu(), (UINT)mswpos, MF_BYPOSITION) )
 965         {
 966             wxLogLastError(wxT("RemoveMenu"));
 967         }
 968
 969         if ( !::InsertMenu(GetHmenu(), (UINT)mswpos,
 970                            MF_BYPOSITION | MF_POPUP | MF_STRING,
 971                            (UINT)GetHmenuOf(menu), title) )
 972         {
 973             wxLogLastError(wxT("InsertMenu"));
 974         }
 975
 976 #if wxUSE_ACCEL
 977         if ( menuOld->HasAccels() || menu->HasAccels() )
 978         {
 979             // need to rebuild accell table
 980             RebuildAccelTable();
 981         }
 982 #endif // wxUSE_ACCEL
 983
 984         Refresh();
 985     }
 986
 987     return menuOld;
 988 }
 989
 990 bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
 991 {
 992     // Find out which MSW item before which we'll be inserting before
 993     // wxMenuBarBase::Insert is called and GetMenu(pos) is the new menu.
 994     // If IsAttached() is false this won't be used anyway
 995     int mswpos = (!IsAttached() || (pos == m_menus.GetCount()))
 996         ?   -1 // append the menu
 997         :   MSWPositionForWxMenu(GetMenu(pos),pos);
 998
 999     if ( !wxMenuBarBase::Insert(pos, menu, title) )
1000         return false;
1001
1002     m_titles.Insert(title, pos);
1003
1004     if ( IsAttached() )
1005     {
1006 #if defined(WINCE_WITHOUT_COMMANDAR)
1007         if (!GetToolBar())
1008             return false;
1009         TBBUTTON tbButton;
1010         memset(&tbButton, 0, sizeof(TBBUTTON));
1011         tbButton.iBitmap = I_IMAGENONE;
1012         tbButton.fsState = TBSTATE_ENABLED;
1013         tbButton.fsStyle = TBSTYLE_DROPDOWN | TBSTYLE_NO_DROPDOWN_ARROW | TBSTYLE_AUTOSIZE;
1014
1015         HMENU hPopupMenu = (HMENU) menu->GetHMenu() ;
1016         tbButton.dwData = (DWORD)hPopupMenu;
1017         wxString label = wxStripMenuCodes(title);
1018         tbButton.iString = (int) label.c_str();
1019
1020         tbButton.idCommand = NewControlId();
1021         if (!::SendMessage((HWND) GetToolBar()->GetHWND(), TB_INSERTBUTTON, pos, (LPARAM)&tbButton))
1022         {
1023             wxLogLastError(wxT("TB_INSERTBUTTON"));
1024             return false;
1025         }
1026 #else
1027         if ( !::InsertMenu(GetHmenu(), mswpos,
1028                            MF_BYPOSITION | MF_POPUP | MF_STRING,
1029                            (UINT)GetHmenuOf(menu), title) )
1030         {
1031             wxLogLastError(wxT("InsertMenu"));
1032         }
1033 #endif
1034 #if wxUSE_ACCEL
1035         if ( menu->HasAccels() )
1036         {
1037             // need to rebuild accell table
1038             RebuildAccelTable();
1039         }
1040 #endif // wxUSE_ACCEL
1041
1042         Refresh();
1043     }
1044
1045     return true;
1046 }
1047
1048 bool wxMenuBar::Append(wxMenu *menu, const wxString& title)
1049 {
1050     WXHMENU submenu = menu ? menu->GetHMenu() : 0;
1051     wxCHECK_MSG( submenu, false, wxT("can't append invalid menu to menubar") );
1052
1053     if ( !wxMenuBarBase::Append(menu, title) )
1054         return false;
1055
1056     m_titles.Add(title);
1057
1058     if ( IsAttached() )
1059     {
1060 #if defined(WINCE_WITHOUT_COMMANDAR)
1061         if (!GetToolBar())
1062             return false;
1063         TBBUTTON tbButton;
1064         memset(&tbButton, 0, sizeof(TBBUTTON));
1065         tbButton.iBitmap = I_IMAGENONE;
1066         tbButton.fsState = TBSTATE_ENABLED;
1067         tbButton.fsStyle = TBSTYLE_DROPDOWN | TBSTYLE_NO_DROPDOWN_ARROW | TBSTYLE_AUTOSIZE;
1068
1069         size_t pos = GetMenuCount();
1070         HMENU hPopupMenu = (HMENU) menu->GetHMenu() ;
1071         tbButton.dwData = (DWORD)hPopupMenu;
1072         wxString label = wxStripMenuCodes(title);
1073         tbButton.iString = (int) label.c_str();
1074
1075         tbButton.idCommand = NewControlId();
1076         if (!::SendMessage((HWND) GetToolBar()->GetHWND(), TB_INSERTBUTTON, pos, (LPARAM)&tbButton))
1077         {
1078             wxLogLastError(wxT("TB_INSERTBUTTON"));
1079             return false;
1080         }
1081 #else
1082         if ( !::AppendMenu(GetHmenu(), MF_POPUP | MF_STRING,
1083                            (UINT)submenu, title) )
1084         {
1085             wxLogLastError(wxT("AppendMenu"));
1086         }
1087 #endif
1088
1089 #if wxUSE_ACCEL
1090         if ( menu->HasAccels() )
1091         {
1092             // need to rebuild accelerator table
1093             RebuildAccelTable();
1094         }
1095 #endif // wxUSE_ACCEL
1096
1097         Refresh();
1098     }
1099
1100     return true;
1101 }
1102
1103 wxMenu *wxMenuBar::Remove(size_t pos)
1104 {
1105     wxMenu *menu = wxMenuBarBase::Remove(pos);
1106     if ( !menu )
1107         return NULL;
1108
1109     if ( IsAttached() )
1110     {
1111 #if defined(WINCE_WITHOUT_COMMANDAR)
1112         if (GetToolBar())
1113         {
1114             if (!::SendMessage((HWND) GetToolBar()->GetHWND(), TB_DELETEBUTTON, (UINT) pos, (LPARAM) 0))
1115             {
1116                 wxLogLastError(wxT("TB_DELETEBUTTON"));
1117             }
1118         }
1119 #else
1120         if ( !::RemoveMenu(GetHmenu(), (UINT)MSWPositionForWxMenu(menu,pos), MF_BYPOSITION) )
1121         {
1122             wxLogLastError(wxT("RemoveMenu"));
1123         }
1124 #endif
1125
1126 #if wxUSE_ACCEL
1127         if ( menu->HasAccels() )
1128         {
1129             // need to rebuild accell table
1130             RebuildAccelTable();
1131         }
1132 #endif // wxUSE_ACCEL
1133
1134         Refresh();
1135     }
1136
1137
1138     m_titles.RemoveAt(pos);
1139
1140     return menu;
1141 }
1142
1143 #if wxUSE_ACCEL
1144
1145 void wxMenuBar::RebuildAccelTable()
1146 {
1147     // merge the accelerators of all menus into one accel table
1148     size_t nAccelCount = 0;
1149     size_t i, count = GetMenuCount();
1150     wxMenuList::iterator it;
1151     for ( i = 0, it = m_menus.begin(); i < count; i++, it++ )
1152     {
1153         nAccelCount += (*it)->GetAccelCount();
1154     }
1155
1156     if ( nAccelCount )
1157     {
1158         wxAcceleratorEntry *accelEntries = new wxAcceleratorEntry[nAccelCount];
1159
1160         nAccelCount = 0;
1161         for ( i = 0, it = m_menus.begin(); i < count; i++, it++ )
1162         {
1163             nAccelCount += (*it)->CopyAccels(&accelEntries[nAccelCount]);
1164         }
1165
1166         m_accelTable = wxAcceleratorTable(nAccelCount, accelEntries);
1167
1168         delete [] accelEntries;
1169     }
1170 }
1171
1172 #endif // wxUSE_ACCEL
1173
1174 void wxMenuBar::Attach(wxFrame *frame)
1175 {
1176     wxMenuBarBase::Attach(frame);
1177
1178 #if defined(WINCE_WITH_COMMANDBAR)
1179     if (!m_hMenu)
1180         this->Create();
1181     if (!m_commandBar)
1182         m_commandBar = (WXHWND) CommandBar_Create(wxGetInstance(), (HWND) frame->GetHWND(), NewControlId());
1183     if (m_commandBar)
1184     {
1185         if (m_hMenu)
1186         {
1187             if (!CommandBar_InsertMenubarEx((HWND) m_commandBar, NULL, (LPTSTR) m_hMenu, 0))
1188             {
1189                 wxLogLastError(wxT("CommandBar_InsertMenubarEx"));
1190             }
1191         }
1192     }
1193 #endif
1194
1195 #if wxUSE_ACCEL
1196     RebuildAccelTable();
1197 #endif // wxUSE_ACCEL
1198 }
1199
1200 #if defined(WINCE_WITH_COMMANDBAR)
1201 bool wxMenuBar::AddAdornments(long style)
1202 {
1203     if (m_adornmentsAdded || !m_commandBar)
1204         return false;
1205
1206     if (style & wxCLOSE_BOX)
1207     {
1208         if (!CommandBar_AddAdornments((HWND) m_commandBar, 0, 0))
1209             wxLogLastError(wxT("CommandBar_AddAdornments"));
1210         else
1211             return true;
1212     }
1213     return false;
1214 }
1215 #endif
1216
1217 void wxMenuBar::Detach()
1218 {
1219     wxMenuBarBase::Detach();
1220 }
1221
1222 #endif // wxUSE_MENUS