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