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