]> git.saurik.com Git - wxWidgets.git/blame - src/msw/menu.cpp
Added some documentation :)
[wxWidgets.git] / src / msw / menu.cpp
CommitLineData
2bda0e17
KB
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$
6c9a19aa
JS
8// Copyright: (c) Julian Smart
9// Licence: wxWindows licence
2bda0e17
KB
10/////////////////////////////////////////////////////////////////////////////
11
c2dcfdef
VZ
12// ===========================================================================
13// declarations
14// ===========================================================================
15
16// ---------------------------------------------------------------------------
17// headers
18// ---------------------------------------------------------------------------
19
14f355c2 20#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
c626a8b7 21 #pragma implementation "menu.h"
2bda0e17
KB
22#endif
23
24// For compilers that support precompilation, includes "wx.h".
25#include "wx/wxprec.h"
26
27#ifdef __BORLANDC__
c626a8b7 28 #pragma hdrstop
2bda0e17
KB
29#endif
30
1e6feb95
VZ
31#if wxUSE_MENUS
32
2bda0e17 33#ifndef WX_PRECOMP
c626a8b7
VZ
34 #include "wx/frame.h"
35 #include "wx/menu.h"
36 #include "wx/utils.h"
0c589ad0 37 #include "wx/intl.h"
717a57c2 38 #include "wx/log.h"
2bda0e17
KB
39#endif
40
47d67540 41#if wxUSE_OWNER_DRAWN
c626a8b7 42 #include "wx/ownerdrw.h"
2bda0e17
KB
43#endif
44
45#include "wx/msw/private.h"
2bda0e17 46
39d2f9a7
JS
47#ifdef __WXWINCE__
48#include <windows.h>
49#include <windowsx.h>
50#include <tchar.h>
51#include <ole2.h>
eae4425d 52#include <shellapi.h>
39d2f9a7
JS
53#include <commctrl.h>
54#include <aygshell.h>
55
56#ifndef TBSTYLE_NO_DROPDOWN_ARROW
57#define TBSTYLE_NO_DROPDOWN_ARROW 0x0080
58#endif
59
60#endif
61
2bda0e17 62// other standard headers
2bda0e17
KB
63#include <string.h>
64
c626a8b7
VZ
65// ----------------------------------------------------------------------------
66// global variables
67// ----------------------------------------------------------------------------
68
69extern wxMenu *wxCurrentPopupMenu;
70
b8d3a4f1
VZ
71// ----------------------------------------------------------------------------
72// constants
73// ----------------------------------------------------------------------------
74
75// the (popup) menu title has this special id
76static const int idMenuTitle = -2;
77
78// ----------------------------------------------------------------------------
0472ece7 79// private functions
b8d3a4f1 80// ----------------------------------------------------------------------------
c626a8b7 81
0472ece7
VZ
82// make the given menu item default
83static void SetDefaultMenuItem(HMENU hmenu, UINT id)
84{
4676948b 85#ifndef __WXWINCE__
0472ece7
VZ
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 }
4676948b
JS
96#endif
97}
98
99#ifdef __WXWINCE__
100UINT 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;
0472ece7 109}
4676948b 110#endif
2bda0e17
KB
111
112// ============================================================================
113// implementation
114// ============================================================================
115
e70b4f10
SC
116#include <wx/listimpl.cpp>
117
118WX_DEFINE_LIST( wxMenuInfoList ) ;
119
120#if wxUSE_EXTENDED_RTTI
121
122WX_DEFINE_FLAGS( wxMenuStyle )
123
3ff066a4
SC
124wxBEGIN_FLAGS( wxMenuStyle )
125 wxFLAGS_MEMBER(wxMENU_TEAROFF)
126wxEND_FLAGS( wxMenuStyle )
e70b4f10
SC
127
128IMPLEMENT_DYNAMIC_CLASS_XTI(wxMenu, wxEvtHandler,"wx/menu.h")
129
3ff066a4 130wxCOLLECTION_TYPE_INFO( wxMenuItem * , wxMenuItemList ) ;
e70b4f10
SC
131
132template<> void wxCollectionToVariantArray( wxMenuItemList const &theList, wxxVariantArray &value)
133{
134 wxListCollectionToVariantArray<wxMenuItemList::compatibility_iterator>( theList , value ) ;
135}
136
3ff066a4
SC
137wxBEGIN_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"))
142wxEND_PROPERTIES_TABLE()
e70b4f10 143
3ff066a4
SC
144wxBEGIN_HANDLERS_TABLE(wxMenu)
145wxEND_HANDLERS_TABLE()
e70b4f10 146
3ff066a4 147wxDIRECT_CONSTRUCTOR_2( wxMenu , wxString , Title , long , MenuStyle )
e70b4f10
SC
148
149WX_DEFINE_FLAGS( wxMenuBarStyle )
150
3ff066a4
SC
151wxBEGIN_FLAGS( wxMenuBarStyle )
152 wxFLAGS_MEMBER(wxMB_DOCKABLE)
153wxEND_FLAGS( wxMenuBarStyle )
e70b4f10
SC
154
155// the negative id would lead the window (its superclass !) to vetoe streaming out otherwise
2341cf5f 156bool wxMenuBarStreamingCallback( const wxObject *WXUNUSED(object), wxWriter * , wxPersister * , wxxVariantArray & )
e70b4f10
SC
157{
158 return true ;
159}
160
161IMPLEMENT_DYNAMIC_CLASS_XTI_CALLBACK(wxMenuBar, wxWindow ,"wx/menu.h",wxMenuBarStreamingCallback)
162
163IMPLEMENT_DYNAMIC_CLASS_XTI(wxMenuInfo, wxObject , "wx/menu.h" )
164
3ff066a4
SC
165wxBEGIN_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"))
168wxEND_PROPERTIES_TABLE()
e70b4f10 169
3ff066a4
SC
170wxBEGIN_HANDLERS_TABLE(wxMenuInfo)
171wxEND_HANDLERS_TABLE()
e70b4f10 172
3ff066a4 173wxCONSTRUCTOR_2( wxMenuInfo , wxMenu* , Menu , wxString , Title )
e70b4f10 174
3ff066a4 175wxCOLLECTION_TYPE_INFO( wxMenuInfo * , wxMenuInfoList ) ;
e70b4f10
SC
176
177template<> void wxCollectionToVariantArray( wxMenuInfoList const &theList, wxxVariantArray &value)
178{
179 wxListCollectionToVariantArray<wxMenuInfoList::compatibility_iterator>( theList , value ) ;
180}
181
3ff066a4
SC
182wxBEGIN_PROPERTIES_TABLE(wxMenuBar)
183 wxPROPERTY_COLLECTION( MenuInfos , wxMenuInfoList , wxMenuInfo* , Append , GetMenuInfos , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
184wxEND_PROPERTIES_TABLE()
e70b4f10 185
3ff066a4
SC
186wxBEGIN_HANDLERS_TABLE(wxMenuBar)
187wxEND_HANDLERS_TABLE()
e70b4f10 188
3ff066a4 189wxCONSTRUCTOR_DUMMY( wxMenuBar )
e70b4f10
SC
190
191#else
0472ece7
VZ
192IMPLEMENT_DYNAMIC_CLASS(wxMenu, wxEvtHandler)
193IMPLEMENT_DYNAMIC_CLASS(wxMenuBar, wxWindow)
e70b4f10
SC
194IMPLEMENT_DYNAMIC_CLASS(wxMenuInfo, wxObject)
195#endif
0472ece7 196
e70b4f10
SC
197const 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}
066f1b7a 209
c2dcfdef
VZ
210// ---------------------------------------------------------------------------
211// wxMenu construction, adding and removing menu items
212// ---------------------------------------------------------------------------
2bda0e17
KB
213
214// Construct a menu with optional title (then use append)
717a57c2 215void wxMenu::Init()
c626a8b7 216{
ad9bb75f 217 m_doBreak = FALSE;
0472ece7 218 m_startRadioGroup = -1;
c626a8b7 219
717a57c2
VZ
220 // create the menu
221 m_hMenu = (WXHMENU)CreatePopupMenu();
222 if ( !m_hMenu )
223 {
f6bcfd97 224 wxLogLastError(wxT("CreatePopupMenu"));
717a57c2
VZ
225 }
226
227 // if we have a title, insert it in the beginning of the menu
c626a8b7
VZ
228 if ( !!m_title )
229 {
ad9bb75f
VZ
230 Append(idMenuTitle, m_title);
231 AppendSeparator();
c626a8b7 232 }
2bda0e17
KB
233}
234
235// The wxWindow destructor will take care of deleting the submenus.
b8d3a4f1 236wxMenu::~wxMenu()
2bda0e17 237{
717a57c2
VZ
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() )
c2dcfdef 242 {
ad9bb75f
VZ
243 if ( !::DestroyMenu(GetHmenu()) )
244 {
f6bcfd97 245 wxLogLastError(wxT("DestroyMenu"));
ad9bb75f 246 }
c2dcfdef 247 }
c626a8b7 248
ad9bb75f
VZ
249#if wxUSE_ACCEL
250 // delete accels
251 WX_CLEAR_ARRAY(m_accels);
252#endif // wxUSE_ACCEL
2bda0e17
KB
253}
254
b8d3a4f1 255void wxMenu::Break()
2bda0e17 256{
717a57c2 257 // this will take effect during the next call to Append()
c2dcfdef 258 m_doBreak = TRUE;
2bda0e17
KB
259}
260
0472ece7
VZ
261void wxMenu::Attach(wxMenuBarBase *menubar)
262{
263 wxMenuBase::Attach(menubar);
264
265 EndRadioGroup();
266}
267
717a57c2
VZ
268#if wxUSE_ACCEL
269
270int 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
282void wxMenu::UpdateAccel(wxMenuItem *item)
2bda0e17 283{
f6bcfd97 284 if ( item->IsSubMenu() )
717a57c2 285 {
f6bcfd97 286 wxMenu *submenu = item->GetSubMenu();
222ed1d6 287 wxMenuItemList::compatibility_iterator node = submenu->GetMenuItems().GetFirst();
f6bcfd97
BP
288 while ( node )
289 {
290 UpdateAccel(node->GetData());
291
292 node = node->GetNext();
293 }
717a57c2 294 }
f6bcfd97 295 else if ( !item->IsSeparator() )
717a57c2 296 {
f6bcfd97
BP
297 // find the (new) accel for this item
298 wxAcceleratorEntry *accel = wxGetAccelFromString(item->GetText());
717a57c2 299 if ( accel )
f6bcfd97
BP
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 }
717a57c2 312 else
f6bcfd97
BP
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
b54e41c5 319 m_accels.RemoveAt(n);
f6bcfd97 320 }
717a57c2 321
f6bcfd97
BP
322 if ( IsAttached() )
323 {
324 m_menuBar->RebuildAccelTable();
325 }
42e69d6b 326 }
f6bcfd97 327 //else: it is a separator, they can't have accels, nothing to do
717a57c2
VZ
328}
329
330#endif // wxUSE_ACCEL
331
332// append a new item or submenu to the menu
333bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
334{
335#if wxUSE_ACCEL
336 UpdateAccel(pItem);
d427503c 337#endif // wxUSE_ACCEL
42e69d6b 338
c626a8b7 339 UINT flags = 0;
2bda0e17 340
c2dcfdef
VZ
341 // if "Break" has just been called, insert a menu break before this item
342 // (and don't forget to reset the flag)
c626a8b7
VZ
343 if ( m_doBreak ) {
344 flags |= MF_MENUBREAK;
345 m_doBreak = FALSE;
346 }
347
348 if ( pItem->IsSeparator() ) {
349 flags |= MF_SEPARATOR;
350 }
2bda0e17 351
c2dcfdef
VZ
352 // id is the numeric id for normal menu items and HMENU for submenus as
353 // required by ::AppendMenu() API
c626a8b7 354 UINT id;
c2dcfdef
VZ
355 wxMenu *submenu = pItem->GetSubMenu();
356 if ( submenu != NULL ) {
717a57c2
VZ
357 wxASSERT_MSG( submenu->GetHMenu(), wxT("invalid submenu") );
358
359 submenu->SetParent(this);
2bda0e17 360
c2dcfdef 361 id = (UINT)submenu->GetHMenu();
2bda0e17 362
c626a8b7
VZ
363 flags |= MF_POPUP;
364 }
365 else {
366 id = pItem->GetId();
367 }
2bda0e17 368
39d2f9a7
JS
369#ifdef __WXWINCE__
370 wxString strippedString;
371#endif
372
837e5743 373 LPCTSTR pData;
2bda0e17 374
47d67540 375#if wxUSE_OWNER_DRAWN
c626a8b7
VZ
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;
837e5743 379 pData = (LPCTSTR)pItem;
c626a8b7
VZ
380 }
381 else
2bda0e17 382#endif
c626a8b7
VZ
383 {
384 // menu is just a normal string (passed in data parameter)
385 flags |= MF_STRING;
8fb3a512 386
39d2f9a7
JS
387#ifdef __WXWINCE__
388 strippedString = wxStripMenuCodes(pItem->GetText());
389 pData = (wxChar*)strippedString.c_str();
390#else
f5166ed4 391 pData = (wxChar*)pItem->GetText().c_str();
39d2f9a7 392#endif
c626a8b7 393 }
2bda0e17 394
717a57c2
VZ
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 )
c626a8b7 406 {
f6bcfd97 407 wxLogLastError(wxT("Insert or AppendMenu"));
717a57c2
VZ
408
409 return FALSE;
c626a8b7 410 }
42e69d6b 411
0472ece7
VZ
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 }
42e69d6b
VZ
419#endif // __WIN32__
420
0472ece7
VZ
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
430void wxMenu::EndRadioGroup()
431{
0472ece7
VZ
432 // we're not inside a radio group any longer
433 m_startRadioGroup = -1;
2bda0e17
KB
434}
435
717a57c2 436bool wxMenu::DoAppend(wxMenuItem *item)
2bda0e17 437{
0472ece7
VZ
438 wxCHECK_MSG( item, FALSE, _T("NULL item in wxMenu::DoAppend") );
439
be15b995
VZ
440 bool check = FALSE;
441
546bfbea 442 if ( item->GetKind() == wxITEM_RADIO )
0472ece7 443 {
be15b995
VZ
444 int count = GetMenuItemCount();
445
0472ece7
VZ
446 if ( m_startRadioGroup == -1 )
447 {
448 // start a new radio group
be15b995
VZ
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);
222ed1d6 462 wxMenuItemList::compatibility_iterator node = GetMenuItems().Item(m_startRadioGroup);
be15b995
VZ
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 }
0472ece7
VZ
472 }
473 }
474 else // not a radio item
475 {
476 EndRadioGroup();
477 }
478
be15b995
VZ
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;
2bda0e17
KB
491}
492
717a57c2 493bool wxMenu::DoInsert(size_t pos, wxMenuItem *item)
2bda0e17 494{
717a57c2 495 return wxMenuBase::DoInsert(pos, item) && DoInsertOrAppend(item, pos);
2bda0e17
KB
496}
497
717a57c2 498wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
2bda0e17 499{
717a57c2
VZ
500 // we need to find the items position in the child list
501 size_t pos;
222ed1d6 502 wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
717a57c2 503 for ( pos = 0; node; pos++ )
c626a8b7 504 {
717a57c2 505 if ( node->GetData() == item )
c626a8b7 506 break;
717a57c2
VZ
507
508 node = node->GetNext();
c626a8b7
VZ
509 }
510
717a57c2
VZ
511 // DoRemove() (unlike Remove) can only be called for existing item!
512 wxCHECK_MSG( node, NULL, wxT("bug in wxMenu::Remove logic") );
c626a8b7 513
717a57c2
VZ
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];
c626a8b7 520
b54e41c5 521 m_accels.RemoveAt(n);
c626a8b7 522 }
717a57c2
VZ
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 {
f6bcfd97 529 wxLogLastError(wxT("RemoveMenu"));
c626a8b7
VZ
530 }
531
4bc1afd5 532 if ( IsAttached() && m_menuBar->IsAttached() )
717a57c2
VZ
533 {
534 // otherwise, the chane won't be visible
535 m_menuBar->Refresh();
536 }
2bda0e17 537
717a57c2
VZ
538 // and from internal data structures
539 return wxMenuBase::DoRemove(item);
540}
d427503c 541
42e69d6b
VZ
542// ---------------------------------------------------------------------------
543// accelerator helpers
544// ---------------------------------------------------------------------------
545
717a57c2
VZ
546#if wxUSE_ACCEL
547
42e69d6b
VZ
548// create the wxAcceleratorEntries for our accels and put them into provided
549// array - return the number of accels we have
550size_t wxMenu::CopyAccels(wxAcceleratorEntry *accels) const
551{
552 size_t count = GetAccelCount();
553 for ( size_t n = 0; n < count; n++ )
554 {
974e8d94 555 *accels++ = *m_accels[n];
42e69d6b
VZ
556 }
557
558 return count;
559}
560
d427503c
VZ
561#endif // wxUSE_ACCEL
562
c2dcfdef 563// ---------------------------------------------------------------------------
717a57c2 564// set wxMenu title
c2dcfdef
VZ
565// ---------------------------------------------------------------------------
566
2bda0e17
KB
567void wxMenu::SetTitle(const wxString& label)
568{
c626a8b7
VZ
569 bool hasNoTitle = m_title.IsEmpty();
570 m_title = label;
b8d3a4f1 571
c50f1fb9 572 HMENU hMenu = GetHmenu();
b8d3a4f1 573
c626a8b7 574 if ( hasNoTitle )
b8d3a4f1 575 {
c626a8b7
VZ
576 if ( !label.IsEmpty() )
577 {
717a57c2
VZ
578 if ( !::InsertMenu(hMenu, 0u, MF_BYPOSITION | MF_STRING,
579 (unsigned)idMenuTitle, m_title) ||
580 !::InsertMenu(hMenu, 1u, MF_BYPOSITION, (unsigned)-1, NULL) )
c626a8b7 581 {
f6bcfd97 582 wxLogLastError(wxT("InsertMenu"));
c626a8b7
VZ
583 }
584 }
b8d3a4f1
VZ
585 }
586 else
587 {
c626a8b7
VZ
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 {
f6bcfd97 594 wxLogLastError(wxT("RemoveMenu"));
c626a8b7
VZ
595 }
596 }
597 else
598 {
599 // modify the title
4676948b
JS
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
c626a8b7 613 if ( !ModifyMenu(hMenu, 0u,
717a57c2
VZ
614 MF_BYPOSITION | MF_STRING,
615 (unsigned)idMenuTitle, m_title) )
c626a8b7 616 {
f6bcfd97 617 wxLogLastError(wxT("ModifyMenu"));
c626a8b7 618 }
4676948b 619#endif
c626a8b7 620 }
b8d3a4f1 621 }
b8d3a4f1 622
42e69d6b 623#ifdef __WIN32__
c626a8b7
VZ
624 // put the title string in bold face
625 if ( !m_title.IsEmpty() )
a3f4e9e8 626 {
0472ece7 627 SetDefaultMenuItem(GetHmenu(), (UINT)idMenuTitle);
a3f4e9e8 628 }
717a57c2 629#endif // Win32
2bda0e17
KB
630}
631
c2dcfdef
VZ
632// ---------------------------------------------------------------------------
633// event processing
634// ---------------------------------------------------------------------------
2bda0e17 635
debe6624 636bool wxMenu::MSWCommand(WXUINT WXUNUSED(param), WXWORD id)
2bda0e17 637{
a3f4e9e8
VZ
638 // ignore commands from the menu title
639
640 // NB: VC++ generates wrong assembler for `if ( id != idMenuTitle )'!!
641 if ( id != (WXWORD)idMenuTitle )
642 {
3ca6a5f0
BP
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
4676948b
JS
647 UINT menuState = ::GetMenuState(GetHmenu(), id, MF_BYCOMMAND) ;
648 SendEvent(id, menuState & MF_CHECKED);
a3f4e9e8
VZ
649 }
650
651 return TRUE;
2bda0e17
KB
652}
653
c2dcfdef
VZ
654// ---------------------------------------------------------------------------
655// other
656// ---------------------------------------------------------------------------
2bda0e17 657
717a57c2
VZ
658wxWindow *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;
c2dcfdef
VZ
666}
667
668// ---------------------------------------------------------------------------
2bda0e17 669// Menu Bar
c2dcfdef
VZ
670// ---------------------------------------------------------------------------
671
672void wxMenuBar::Init()
2bda0e17 673{
c626a8b7 674 m_eventHandler = this;
c626a8b7 675 m_hMenu = 0;
39d2f9a7
JS
676#ifdef __WXWINCE__
677 m_toolBar = NULL;
678#endif
cba2db0c 679}
2bda0e17 680
c2dcfdef
VZ
681wxMenuBar::wxMenuBar()
682{
683 Init();
684}
685
cba2db0c
JS
686wxMenuBar::wxMenuBar( long WXUNUSED(style) )
687{
c2dcfdef 688 Init();
2bda0e17
KB
689}
690
c2dcfdef 691wxMenuBar::wxMenuBar(int count, wxMenu *menus[], const wxString titles[])
2bda0e17 692{
c2dcfdef
VZ
693 Init();
694
a8cfd0cb 695 m_titles.Alloc(count);
c2dcfdef 696
a8cfd0cb
VZ
697 for ( int i = 0; i < count; i++ )
698 {
699 m_menus.Append(menus[i]);
700 m_titles.Add(titles[i]);
2bda0e17 701
a8cfd0cb
VZ
702 menus[i]->Attach(this);
703 }
2bda0e17
KB
704}
705
b8d3a4f1 706wxMenuBar::~wxMenuBar()
2bda0e17 707{
39d2f9a7
JS
708 // In Windows CE, the menubar is always associated
709 // with a toolbar, which destroys the menu implicitly.
bf95a04f
JS
710#ifdef __WXWINCE__
711 if (GetToolBar())
712 GetToolBar()->SetMenuBar(NULL);
713#else
7a0363dd
JS
714 // we should free Windows resources only if Windows doesn't do it for us
715 // which happens if we're attached to a frame
716 if (m_hMenu && !IsAttached())
717 {
718 ::DestroyMenu((HMENU)m_hMenu);
719 m_hMenu = (WXHMENU)NULL;
720 }
39d2f9a7 721#endif
c2dcfdef 722}
2bda0e17 723
c2dcfdef
VZ
724// ---------------------------------------------------------------------------
725// wxMenuBar helpers
726// ---------------------------------------------------------------------------
727
728void wxMenuBar::Refresh()
729{
065de612 730 wxCHECK_RET( IsAttached(), wxT("can't refresh unattached menubar") );
c2dcfdef 731
39d2f9a7
JS
732#ifdef __WXWINCE__
733 if (GetToolBar())
734 {
735 CommandBar_DrawMenuBar((HWND) GetToolBar()->GetHWND(), 0);
736 }
737#else
1e6feb95 738 DrawMenuBar(GetHwndOf(GetFrame()));
39d2f9a7 739#endif
c2dcfdef
VZ
740}
741
742WXHMENU wxMenuBar::Create()
743{
beb471b5
JS
744 // Note: this totally doesn't work on Smartphone,
745 // since you have to use resources.
746 // We'll have to find another way to add a menu
747 // by changing/adding menu items to an existing menu.
39d2f9a7
JS
748#ifdef __WXWINCE__
749 if ( m_hMenu != 0 )
750 return m_hMenu;
751
752 if (!GetToolBar())
753 return 0;
754
755 HWND hCommandBar = (HWND) GetToolBar()->GetHWND();
756 HMENU hMenu = (HMENU)::SendMessage(hCommandBar, SHCMBM_GETMENU, (WPARAM)0, (LPARAM)0);
757 if (hMenu)
758 {
759 TBBUTTON tbButton;
760 memset(&tbButton, 0, sizeof(TBBUTTON));
761 tbButton.iBitmap = I_IMAGENONE;
762 tbButton.fsState = TBSTATE_ENABLED;
763 tbButton.fsStyle = TBSTYLE_DROPDOWN | TBSTYLE_NO_DROPDOWN_ARROW | TBSTYLE_AUTOSIZE;
764
765 size_t i;
766 for (i = 0; i < GetMenuCount(); i++)
767 {
768 HMENU hPopupMenu = (HMENU) GetMenu(i)->GetHMenu() ;
769 tbButton.dwData = (DWORD)hPopupMenu;
770 wxString label = wxStripMenuCodes(GetLabelTop(i));
771 tbButton.iString = (int) label.c_str();
beb471b5
JS
772
773 int position = i;
39d2f9a7
JS
774
775 tbButton.idCommand = NewControlId();
beb471b5 776 if (!::SendMessage(hCommandBar, TB_INSERTBUTTON, position, (LPARAM)&tbButton))
39d2f9a7
JS
777 {
778 wxLogLastError(wxT("TB_INSERTBUTTON"));
779 }
780 }
781 }
782 m_hMenu = (WXHMENU) hMenu;
783 return m_hMenu;
784#else
3ca6a5f0 785 if ( m_hMenu != 0 )
717a57c2 786 return m_hMenu;
1cf27c63 787
c2dcfdef 788 m_hMenu = (WXHMENU)::CreateMenu();
2bda0e17 789
c2dcfdef 790 if ( !m_hMenu )
c626a8b7 791 {
f6bcfd97 792 wxLogLastError(wxT("CreateMenu"));
c626a8b7 793 }
c2dcfdef 794 else
c626a8b7 795 {
222ed1d6
MB
796 size_t count = GetMenuCount(), i;
797 wxMenuList::iterator it;
798 for ( i = 0, it = m_menus.begin(); i < count; i++, it++ )
c2dcfdef
VZ
799 {
800 if ( !::AppendMenu((HMENU)m_hMenu, MF_POPUP | MF_STRING,
222ed1d6 801 (UINT)(*it)->GetHMenu(),
c2dcfdef
VZ
802 m_titles[i]) )
803 {
f6bcfd97 804 wxLogLastError(wxT("AppendMenu"));
c2dcfdef
VZ
805 }
806 }
c626a8b7 807 }
c626a8b7 808
c2dcfdef 809 return m_hMenu;
39d2f9a7 810#endif
2bda0e17
KB
811}
812
c2dcfdef 813// ---------------------------------------------------------------------------
3dfac970 814// wxMenuBar functions to work with the top level submenus
c2dcfdef
VZ
815// ---------------------------------------------------------------------------
816
3dfac970
VZ
817// NB: we don't support owner drawn top level items for now, if we do these
818// functions would have to be changed to use wxMenuItem as well
2bda0e17 819
a8cfd0cb 820void wxMenuBar::EnableTop(size_t pos, bool enable)
2bda0e17 821{
717a57c2
VZ
822 wxCHECK_RET( IsAttached(), wxT("doesn't work with unattached menubars") );
823
824 int flag = enable ? MF_ENABLED : MF_GRAYED;
2bda0e17 825
c626a8b7 826 EnableMenuItem((HMENU)m_hMenu, pos, MF_BYPOSITION | flag);
adc6fb16
VZ
827
828 Refresh();
2bda0e17
KB
829}
830
a8cfd0cb 831void wxMenuBar::SetLabelTop(size_t pos, const wxString& label)
2bda0e17 832{
717a57c2
VZ
833 wxCHECK_RET( pos < GetMenuCount(), wxT("invalid menu index") );
834
835 m_titles[pos] = label;
836
837 if ( !IsAttached() )
838 {
839 return;
840 }
841 //else: have to modify the existing menu
842
8cd85069 843 UINT id;
c2dcfdef
VZ
844 UINT flagsOld = ::GetMenuState((HMENU)m_hMenu, pos, MF_BYPOSITION);
845 if ( flagsOld == 0xFFFFFFFF )
c626a8b7 846 {
223d09f6 847 wxLogLastError(wxT("GetMenuState"));
c2dcfdef
VZ
848
849 return;
850 }
851
852 if ( flagsOld & MF_POPUP )
853 {
854 // HIBYTE contains the number of items in the submenu in this case
ad9bb75f
VZ
855 flagsOld &= 0xff;
856 id = (UINT)::GetSubMenu((HMENU)m_hMenu, pos);
c626a8b7
VZ
857 }
858 else
8cd85069
VZ
859 {
860 id = pos;
861 }
862
4676948b
JS
863#ifdef __WXWINCE__
864 MENUITEMINFO info;
865 wxZeroMemory(info);
866 info.cbSize = sizeof(info);
867 info.fMask = MIIM_TYPE;
868 info.fType = MFT_STRING;
869 info.cch = label.Length();
870 info.dwTypeData = (LPTSTR) label.c_str();
871 if ( !SetMenuItemInfo(GetHmenu(), id, TRUE, & info) )
872 {
873 wxLogLastError(wxT("SetMenuItemInfo"));
874 }
875
876#else
c50f1fb9 877 if ( ::ModifyMenu(GetHmenu(), pos, MF_BYPOSITION | MF_STRING | flagsOld,
4676948b 878 id, label) == (int)0xFFFFFFFF )
c2dcfdef 879 {
f6bcfd97 880 wxLogLastError(wxT("ModifyMenu"));
c2dcfdef 881 }
4676948b 882#endif
717a57c2
VZ
883
884 Refresh();
2bda0e17
KB
885}
886
a8cfd0cb 887wxString wxMenuBar::GetLabelTop(size_t pos) const
2bda0e17 888{
717a57c2
VZ
889 wxCHECK_MSG( pos < GetMenuCount(), wxEmptyString,
890 wxT("invalid menu index in wxMenuBar::GetLabelTop") );
8cd85069 891
4a1c207c 892 return wxMenuItem::GetLabelFromText(m_titles[pos]);
2bda0e17
KB
893}
894
ad9bb75f
VZ
895// ---------------------------------------------------------------------------
896// wxMenuBar construction
897// ---------------------------------------------------------------------------
898
a8cfd0cb 899wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
1cf27c63 900{
ad9bb75f
VZ
901 wxMenu *menuOld = wxMenuBarBase::Replace(pos, menu, title);
902 if ( !menuOld )
f7f50f49
VZ
903 return NULL;
904
ad9bb75f 905 m_titles[pos] = title;
a8cfd0cb 906
ad9bb75f 907 if ( IsAttached() )
a8cfd0cb 908 {
ad9bb75f
VZ
909 // can't use ModifyMenu() because it deletes the submenu it replaces
910 if ( !::RemoveMenu(GetHmenu(), (UINT)pos, MF_BYPOSITION) )
a8cfd0cb 911 {
f6bcfd97 912 wxLogLastError(wxT("RemoveMenu"));
a8cfd0cb 913 }
1cf27c63 914
ad9bb75f
VZ
915 if ( !::InsertMenu(GetHmenu(), (UINT)pos,
916 MF_BYPOSITION | MF_POPUP | MF_STRING,
917 (UINT)GetHmenuOf(menu), title) )
918 {
f6bcfd97 919 wxLogLastError(wxT("InsertMenu"));
ad9bb75f
VZ
920 }
921
717a57c2
VZ
922#if wxUSE_ACCEL
923 if ( menuOld->HasAccels() || menu->HasAccels() )
924 {
925 // need to rebuild accell table
926 RebuildAccelTable();
927 }
928#endif // wxUSE_ACCEL
929
ad9bb75f 930 Refresh();
a8cfd0cb 931 }
ad9bb75f
VZ
932
933 return menuOld;
1cf27c63
UM
934}
935
a8cfd0cb 936bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
1cf27c63 937{
ad9bb75f 938 if ( !wxMenuBarBase::Insert(pos, menu, title) )
a8cfd0cb 939 return FALSE;
1cf27c63 940
ad9bb75f
VZ
941 m_titles.Insert(title, pos);
942
ad9bb75f
VZ
943 if ( IsAttached() )
944 {
39d2f9a7
JS
945#ifdef __WXWINCE__
946 if (!GetToolBar())
947 return FALSE;
948 TBBUTTON tbButton;
949 memset(&tbButton, 0, sizeof(TBBUTTON));
950 tbButton.iBitmap = I_IMAGENONE;
951 tbButton.fsState = TBSTATE_ENABLED;
952 tbButton.fsStyle = TBSTYLE_DROPDOWN | TBSTYLE_NO_DROPDOWN_ARROW | TBSTYLE_AUTOSIZE;
953
954 HMENU hPopupMenu = (HMENU) menu->GetHMenu() ;
955 tbButton.dwData = (DWORD)hPopupMenu;
956 wxString label = wxStripMenuCodes(title);
957 tbButton.iString = (int) label.c_str();
958
959 tbButton.idCommand = NewControlId();
960 if (!::SendMessage((HWND) GetToolBar()->GetHWND(), TB_INSERTBUTTON, pos, (LPARAM)&tbButton))
961 {
962 wxLogLastError(wxT("TB_INSERTBUTTON"));
963 return FALSE;
964 }
965#else
ad9bb75f
VZ
966 if ( !::InsertMenu(GetHmenu(), pos,
967 MF_BYPOSITION | MF_POPUP | MF_STRING,
968 (UINT)GetHmenuOf(menu), title) )
969 {
f6bcfd97 970 wxLogLastError(wxT("InsertMenu"));
ad9bb75f 971 }
39d2f9a7 972#endif
717a57c2
VZ
973#if wxUSE_ACCEL
974 if ( menu->HasAccels() )
975 {
976 // need to rebuild accell table
977 RebuildAccelTable();
978 }
979#endif // wxUSE_ACCEL
980
ad9bb75f 981 Refresh();
a8cfd0cb 982 }
ad9bb75f
VZ
983
984 return TRUE;
1cf27c63
UM
985}
986
ad9bb75f 987bool wxMenuBar::Append(wxMenu *menu, const wxString& title)
2bda0e17 988{
ad9bb75f
VZ
989 WXHMENU submenu = menu ? menu->GetHMenu() : 0;
990 wxCHECK_MSG( submenu, FALSE, wxT("can't append invalid menu to menubar") );
2bda0e17 991
717a57c2
VZ
992 if ( !wxMenuBarBase::Append(menu, title) )
993 return FALSE;
994
717a57c2
VZ
995 m_titles.Add(title);
996
ad9bb75f
VZ
997 if ( IsAttached() )
998 {
39d2f9a7
JS
999#ifdef __WXWINCE__
1000 if (!GetToolBar())
1001 return FALSE;
1002 TBBUTTON tbButton;
1003 memset(&tbButton, 0, sizeof(TBBUTTON));
1004 tbButton.iBitmap = I_IMAGENONE;
1005 tbButton.fsState = TBSTATE_ENABLED;
1006 tbButton.fsStyle = TBSTYLE_DROPDOWN | TBSTYLE_NO_DROPDOWN_ARROW | TBSTYLE_AUTOSIZE;
1007
1008 size_t pos = GetMenuCount();
1009 HMENU hPopupMenu = (HMENU) menu->GetHMenu() ;
1010 tbButton.dwData = (DWORD)hPopupMenu;
1011 wxString label = wxStripMenuCodes(title);
1012 tbButton.iString = (int) label.c_str();
1013
1014 tbButton.idCommand = NewControlId();
1015 if (!::SendMessage((HWND) GetToolBar()->GetHWND(), TB_INSERTBUTTON, pos, (LPARAM)&tbButton))
1016 {
1017 wxLogLastError(wxT("TB_INSERTBUTTON"));
1018 return FALSE;
1019 }
1020#else
ad9bb75f
VZ
1021 if ( !::AppendMenu(GetHmenu(), MF_POPUP | MF_STRING,
1022 (UINT)submenu, title) )
1023 {
1024 wxLogLastError(wxT("AppendMenu"));
1025 }
39d2f9a7 1026#endif
ad9bb75f 1027
717a57c2
VZ
1028#if wxUSE_ACCEL
1029 if ( menu->HasAccels() )
1030 {
39d2f9a7 1031 // need to rebuild accelerator table
717a57c2
VZ
1032 RebuildAccelTable();
1033 }
1034#endif // wxUSE_ACCEL
1035
ad9bb75f
VZ
1036 Refresh();
1037 }
2bda0e17 1038
a8cfd0cb 1039 return TRUE;
2bda0e17
KB
1040}
1041
a8cfd0cb 1042wxMenu *wxMenuBar::Remove(size_t pos)
2bda0e17 1043{
a8cfd0cb
VZ
1044 wxMenu *menu = wxMenuBarBase::Remove(pos);
1045 if ( !menu )
1046 return NULL;
c626a8b7 1047
ad9bb75f
VZ
1048 if ( IsAttached() )
1049 {
39d2f9a7
JS
1050#ifdef __WXWINCE__
1051 if (GetToolBar())
1052 {
1053 if (!::SendMessage((HWND) GetToolBar()->GetHWND(), TB_DELETEBUTTON, (UINT) pos, (LPARAM) 0))
1054 {
1055 wxLogLastError(wxT("TB_DELETEBUTTON"));
1056 }
1057 }
1058#else
ad9bb75f
VZ
1059 if ( !::RemoveMenu(GetHmenu(), (UINT)pos, MF_BYPOSITION) )
1060 {
f6bcfd97 1061 wxLogLastError(wxT("RemoveMenu"));
ad9bb75f 1062 }
39d2f9a7 1063#endif
717a57c2
VZ
1064#if wxUSE_ACCEL
1065 if ( menu->HasAccels() )
1066 {
1067 // need to rebuild accell table
1068 RebuildAccelTable();
1069 }
1070#endif // wxUSE_ACCEL
1071
ad9bb75f
VZ
1072 Refresh();
1073 }
2bda0e17 1074
ba8c1601 1075 m_titles.RemoveAt(pos);
2bda0e17 1076
a8cfd0cb 1077 return menu;
2bda0e17
KB
1078}
1079
d427503c 1080#if wxUSE_ACCEL
717a57c2
VZ
1081
1082void wxMenuBar::RebuildAccelTable()
1083{
1084 // merge the accelerators of all menus into one accel table
42e69d6b 1085 size_t nAccelCount = 0;
a8cfd0cb 1086 size_t i, count = GetMenuCount();
222ed1d6
MB
1087 wxMenuList::iterator it;
1088 for ( i = 0, it = m_menus.begin(); i < count; i++, it++ )
42e69d6b 1089 {
222ed1d6 1090 nAccelCount += (*it)->GetAccelCount();
42e69d6b
VZ
1091 }
1092
5df1250b 1093 if ( nAccelCount )
42e69d6b 1094 {
5df1250b 1095 wxAcceleratorEntry *accelEntries = new wxAcceleratorEntry[nAccelCount];
42e69d6b 1096
5df1250b 1097 nAccelCount = 0;
222ed1d6 1098 for ( i = 0, it = m_menus.begin(); i < count; i++, it++ )
5df1250b 1099 {
222ed1d6 1100 nAccelCount += (*it)->CopyAccels(&accelEntries[nAccelCount]);
5df1250b
VZ
1101 }
1102
1103 m_accelTable = wxAcceleratorTable(nAccelCount, accelEntries);
42e69d6b 1104
5df1250b
VZ
1105 delete [] accelEntries;
1106 }
717a57c2
VZ
1107}
1108
1109#endif // wxUSE_ACCEL
1110
1111void wxMenuBar::Attach(wxFrame *frame)
1112{
1e6feb95 1113 wxMenuBarBase::Attach(frame);
717a57c2 1114
717a57c2
VZ
1115#if wxUSE_ACCEL
1116 RebuildAccelTable();
d427503c 1117#endif // wxUSE_ACCEL
42e69d6b
VZ
1118}
1119
1cf27c63
UM
1120void wxMenuBar::Detach()
1121{
1e6feb95 1122 wxMenuBarBase::Detach();
2bda0e17
KB
1123}
1124
1e6feb95 1125#endif // wxUSE_MENUS