]> git.saurik.com Git - wxWidgets.git/blob - src/msw/menu.cpp
some wxArtProv docs
[wxWidgets.git] / src / msw / menu.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: menu.cpp
3 // Purpose: wxMenu, wxMenuBar, wxMenuItem
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin
6 // Created: 04/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ===========================================================================
13 // declarations
14 // ===========================================================================
15
16 // ---------------------------------------------------------------------------
17 // headers
18 // ---------------------------------------------------------------------------
19
20 #ifdef __GNUG__
21 #pragma implementation "menu.h"
22 #endif
23
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
26
27 #ifdef __BORLANDC__
28 #pragma hdrstop
29 #endif
30
31 #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 // other standard headers
48 #include <string.h>
49
50 // ----------------------------------------------------------------------------
51 // global variables
52 // ----------------------------------------------------------------------------
53
54 extern wxMenu *wxCurrentPopupMenu;
55
56 // ----------------------------------------------------------------------------
57 // constants
58 // ----------------------------------------------------------------------------
59
60 // the (popup) menu title has this special id
61 static const int idMenuTitle = -2;
62
63 // ----------------------------------------------------------------------------
64 // private functions
65 // ----------------------------------------------------------------------------
66
67 // make the given menu item default
68 static void SetDefaultMenuItem(HMENU hmenu, UINT id)
69 {
70 MENUITEMINFO mii;
71 wxZeroMemory(mii);
72 mii.cbSize = sizeof(MENUITEMINFO);
73 mii.fMask = MIIM_STATE;
74 mii.fState = MFS_DEFAULT;
75
76 if ( !::SetMenuItemInfo(hmenu, id, FALSE, &mii) )
77 {
78 wxLogLastError(wxT("SetMenuItemInfo"));
79 }
80 }
81
82 // ============================================================================
83 // implementation
84 // ============================================================================
85
86 IMPLEMENT_DYNAMIC_CLASS(wxMenu, wxEvtHandler)
87 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar, wxWindow)
88
89 // ---------------------------------------------------------------------------
90 // wxMenu construction, adding and removing menu items
91 // ---------------------------------------------------------------------------
92
93 // Construct a menu with optional title (then use append)
94 void wxMenu::Init()
95 {
96 m_doBreak = FALSE;
97 m_startRadioGroup = -1;
98
99 // create the menu
100 m_hMenu = (WXHMENU)CreatePopupMenu();
101 if ( !m_hMenu )
102 {
103 wxLogLastError(wxT("CreatePopupMenu"));
104 }
105
106 // if we have a title, insert it in the beginning of the menu
107 if ( !!m_title )
108 {
109 Append(idMenuTitle, m_title);
110 AppendSeparator();
111 }
112 }
113
114 // The wxWindow destructor will take care of deleting the submenus.
115 wxMenu::~wxMenu()
116 {
117 // we should free Windows resources only if Windows doesn't do it for us
118 // which happens if we're attached to a menubar or a submenu of another
119 // menu
120 if ( !IsAttached() && !GetParent() )
121 {
122 if ( !::DestroyMenu(GetHmenu()) )
123 {
124 wxLogLastError(wxT("DestroyMenu"));
125 }
126 }
127
128 #if wxUSE_ACCEL
129 // delete accels
130 WX_CLEAR_ARRAY(m_accels);
131 #endif // wxUSE_ACCEL
132 }
133
134 void wxMenu::Break()
135 {
136 // this will take effect during the next call to Append()
137 m_doBreak = TRUE;
138 }
139
140 void wxMenu::Attach(wxMenuBarBase *menubar)
141 {
142 wxMenuBase::Attach(menubar);
143
144 EndRadioGroup();
145 }
146
147 #if wxUSE_ACCEL
148
149 int wxMenu::FindAccel(int id) const
150 {
151 size_t n, count = m_accels.GetCount();
152 for ( n = 0; n < count; n++ )
153 {
154 if ( m_accels[n]->m_command == id )
155 return n;
156 }
157
158 return wxNOT_FOUND;
159 }
160
161 void wxMenu::UpdateAccel(wxMenuItem *item)
162 {
163 if ( item->IsSubMenu() )
164 {
165 wxMenu *submenu = item->GetSubMenu();
166 wxMenuItemList::Node *node = submenu->GetMenuItems().GetFirst();
167 while ( node )
168 {
169 UpdateAccel(node->GetData());
170
171 node = node->GetNext();
172 }
173 }
174 else if ( !item->IsSeparator() )
175 {
176 // find the (new) accel for this item
177 wxAcceleratorEntry *accel = wxGetAccelFromString(item->GetText());
178 if ( accel )
179 accel->m_command = item->GetId();
180
181 // find the old one
182 int n = FindAccel(item->GetId());
183 if ( n == wxNOT_FOUND )
184 {
185 // no old, add new if any
186 if ( accel )
187 m_accels.Add(accel);
188 else
189 return; // skipping RebuildAccelTable() below
190 }
191 else
192 {
193 // replace old with new or just remove the old one if no new
194 delete m_accels[n];
195 if ( accel )
196 m_accels[n] = accel;
197 else
198 m_accels.RemoveAt(n);
199 }
200
201 if ( IsAttached() )
202 {
203 m_menuBar->RebuildAccelTable();
204 }
205 }
206 //else: it is a separator, they can't have accels, nothing to do
207 }
208
209 #endif // wxUSE_ACCEL
210
211 // append a new item or submenu to the menu
212 bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
213 {
214 #if wxUSE_ACCEL
215 UpdateAccel(pItem);
216 #endif // wxUSE_ACCEL
217
218 UINT flags = 0;
219
220 // if "Break" has just been called, insert a menu break before this item
221 // (and don't forget to reset the flag)
222 if ( m_doBreak ) {
223 flags |= MF_MENUBREAK;
224 m_doBreak = FALSE;
225 }
226
227 if ( pItem->IsSeparator() ) {
228 flags |= MF_SEPARATOR;
229 }
230
231 // id is the numeric id for normal menu items and HMENU for submenus as
232 // required by ::AppendMenu() API
233 UINT id;
234 wxMenu *submenu = pItem->GetSubMenu();
235 if ( submenu != NULL ) {
236 wxASSERT_MSG( submenu->GetHMenu(), wxT("invalid submenu") );
237
238 submenu->SetParent(this);
239
240 id = (UINT)submenu->GetHMenu();
241
242 flags |= MF_POPUP;
243 }
244 else {
245 id = pItem->GetId();
246 }
247
248 LPCTSTR pData;
249
250 #if wxUSE_OWNER_DRAWN
251 if ( pItem->IsOwnerDrawn() ) { // want to get {Measure|Draw}Item messages?
252 // item draws itself, pass pointer to it in data parameter
253 flags |= MF_OWNERDRAW;
254 pData = (LPCTSTR)pItem;
255 }
256 else
257 #endif
258 {
259 // menu is just a normal string (passed in data parameter)
260 flags |= MF_STRING;
261
262 pData = (wxChar*)pItem->GetText().c_str();
263 }
264
265 BOOL ok;
266 if ( pos == (size_t)-1 )
267 {
268 ok = ::AppendMenu(GetHmenu(), flags, id, pData);
269 }
270 else
271 {
272 ok = ::InsertMenu(GetHmenu(), pos, flags | MF_BYPOSITION, id, pData);
273 }
274
275 if ( !ok )
276 {
277 wxLogLastError(wxT("Insert or AppendMenu"));
278
279 return FALSE;
280 }
281
282 // if we just appended the title, highlight it
283 #ifdef __WIN32__
284 if ( (int)id == idMenuTitle )
285 {
286 // visually select the menu title
287 SetDefaultMenuItem(GetHmenu(), id);
288 }
289 #endif // __WIN32__
290
291 // if we're already attached to the menubar, we must update it
292 if ( IsAttached() && m_menuBar->IsAttached() )
293 {
294 m_menuBar->Refresh();
295 }
296
297 return TRUE;
298 }
299
300 void wxMenu::EndRadioGroup()
301 {
302 // we're not inside a radio group any longer
303 m_startRadioGroup = -1;
304 }
305
306 bool wxMenu::DoAppend(wxMenuItem *item)
307 {
308 wxCHECK_MSG( item, FALSE, _T("NULL item in wxMenu::DoAppend") );
309
310 bool check = FALSE;
311
312 if ( item->GetKind() == wxITEM_RADIO )
313 {
314 int count = GetMenuItemCount();
315
316 if ( m_startRadioGroup == -1 )
317 {
318 // start a new radio group
319 m_startRadioGroup = count;
320
321 // for now it has just one element
322 item->SetAsRadioGroupStart();
323 item->SetRadioGroupEnd(m_startRadioGroup);
324
325 // ensure that we have a checked item in the radio group
326 check = TRUE;
327 }
328 else // extend the current radio group
329 {
330 // we need to update its end item
331 item->SetRadioGroupStart(m_startRadioGroup);
332 wxMenuItemList::Node *node = GetMenuItems().Item(m_startRadioGroup);
333
334 if ( node )
335 {
336 node->GetData()->SetRadioGroupEnd(count);
337 }
338 else
339 {
340 wxFAIL_MSG( _T("where is the radio group start item?") );
341 }
342 }
343 }
344 else // not a radio item
345 {
346 EndRadioGroup();
347 }
348
349 if ( !wxMenuBase::DoAppend(item) || !DoInsertOrAppend(item) )
350 {
351 return FALSE;
352 }
353
354 if ( check )
355 {
356 // check the item initially
357 item->Check(TRUE);
358 }
359
360 return TRUE;
361 }
362
363 bool wxMenu::DoInsert(size_t pos, wxMenuItem *item)
364 {
365 return wxMenuBase::DoInsert(pos, item) && DoInsertOrAppend(item, pos);
366 }
367
368 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
369 {
370 // we need to find the items position in the child list
371 size_t pos;
372 wxMenuItemList::Node *node = GetMenuItems().GetFirst();
373 for ( pos = 0; node; pos++ )
374 {
375 if ( node->GetData() == item )
376 break;
377
378 node = node->GetNext();
379 }
380
381 // DoRemove() (unlike Remove) can only be called for existing item!
382 wxCHECK_MSG( node, NULL, wxT("bug in wxMenu::Remove logic") );
383
384 #if wxUSE_ACCEL
385 // remove the corresponding accel from the accel table
386 int n = FindAccel(item->GetId());
387 if ( n != wxNOT_FOUND )
388 {
389 delete m_accels[n];
390
391 m_accels.RemoveAt(n);
392 }
393 //else: this item doesn't have an accel, nothing to do
394 #endif // wxUSE_ACCEL
395
396 // remove the item from the menu
397 if ( !::RemoveMenu(GetHmenu(), (UINT)pos, MF_BYPOSITION) )
398 {
399 wxLogLastError(wxT("RemoveMenu"));
400 }
401
402 if ( IsAttached() && m_menuBar->IsAttached() )
403 {
404 // otherwise, the chane won't be visible
405 m_menuBar->Refresh();
406 }
407
408 // and from internal data structures
409 return wxMenuBase::DoRemove(item);
410 }
411
412 // ---------------------------------------------------------------------------
413 // accelerator helpers
414 // ---------------------------------------------------------------------------
415
416 #if wxUSE_ACCEL
417
418 // create the wxAcceleratorEntries for our accels and put them into provided
419 // array - return the number of accels we have
420 size_t wxMenu::CopyAccels(wxAcceleratorEntry *accels) const
421 {
422 size_t count = GetAccelCount();
423 for ( size_t n = 0; n < count; n++ )
424 {
425 *accels++ = *m_accels[n];
426 }
427
428 return count;
429 }
430
431 #endif // wxUSE_ACCEL
432
433 // ---------------------------------------------------------------------------
434 // set wxMenu title
435 // ---------------------------------------------------------------------------
436
437 void wxMenu::SetTitle(const wxString& label)
438 {
439 bool hasNoTitle = m_title.IsEmpty();
440 m_title = label;
441
442 HMENU hMenu = GetHmenu();
443
444 if ( hasNoTitle )
445 {
446 if ( !label.IsEmpty() )
447 {
448 if ( !::InsertMenu(hMenu, 0u, MF_BYPOSITION | MF_STRING,
449 (unsigned)idMenuTitle, m_title) ||
450 !::InsertMenu(hMenu, 1u, MF_BYPOSITION, (unsigned)-1, NULL) )
451 {
452 wxLogLastError(wxT("InsertMenu"));
453 }
454 }
455 }
456 else
457 {
458 if ( label.IsEmpty() )
459 {
460 // remove the title and the separator after it
461 if ( !RemoveMenu(hMenu, 0, MF_BYPOSITION) ||
462 !RemoveMenu(hMenu, 0, MF_BYPOSITION) )
463 {
464 wxLogLastError(wxT("RemoveMenu"));
465 }
466 }
467 else
468 {
469 // modify the title
470 if ( !ModifyMenu(hMenu, 0u,
471 MF_BYPOSITION | MF_STRING,
472 (unsigned)idMenuTitle, m_title) )
473 {
474 wxLogLastError(wxT("ModifyMenu"));
475 }
476 }
477 }
478
479 #ifdef __WIN32__
480 // put the title string in bold face
481 if ( !m_title.IsEmpty() )
482 {
483 SetDefaultMenuItem(GetHmenu(), (UINT)idMenuTitle);
484 }
485 #endif // Win32
486 }
487
488 // ---------------------------------------------------------------------------
489 // event processing
490 // ---------------------------------------------------------------------------
491
492 bool wxMenu::MSWCommand(WXUINT WXUNUSED(param), WXWORD id)
493 {
494 // ignore commands from the menu title
495
496 // NB: VC++ generates wrong assembler for `if ( id != idMenuTitle )'!!
497 if ( id != (WXWORD)idMenuTitle )
498 {
499 // VZ: previosuly, the command int was set to id too which was quite
500 // useless anyhow (as it could be retrieved using GetId()) and
501 // uncompatible with wxGTK, so now we use the command int instead
502 // to pass the checked status
503 SendEvent(id, ::GetMenuState(GetHmenu(), id, MF_BYCOMMAND) & MF_CHECKED);
504 }
505
506 return TRUE;
507 }
508
509 // ---------------------------------------------------------------------------
510 // other
511 // ---------------------------------------------------------------------------
512
513 wxWindow *wxMenu::GetWindow() const
514 {
515 if ( m_invokingWindow != NULL )
516 return m_invokingWindow;
517 else if ( m_menuBar != NULL)
518 return m_menuBar->GetFrame();
519
520 return NULL;
521 }
522
523 // ---------------------------------------------------------------------------
524 // Menu Bar
525 // ---------------------------------------------------------------------------
526
527 void wxMenuBar::Init()
528 {
529 m_eventHandler = this;
530 m_hMenu = 0;
531 }
532
533 wxMenuBar::wxMenuBar()
534 {
535 Init();
536 }
537
538 wxMenuBar::wxMenuBar( long WXUNUSED(style) )
539 {
540 Init();
541 }
542
543 wxMenuBar::wxMenuBar(int count, wxMenu *menus[], const wxString titles[])
544 {
545 Init();
546
547 m_titles.Alloc(count);
548
549 for ( int i = 0; i < count; i++ )
550 {
551 m_menus.Append(menus[i]);
552 m_titles.Add(titles[i]);
553
554 menus[i]->Attach(this);
555 }
556 }
557
558 wxMenuBar::~wxMenuBar()
559 {
560 }
561
562 // ---------------------------------------------------------------------------
563 // wxMenuBar helpers
564 // ---------------------------------------------------------------------------
565
566 void wxMenuBar::Refresh()
567 {
568 wxCHECK_RET( IsAttached(), wxT("can't refresh unattached menubar") );
569
570 DrawMenuBar(GetHwndOf(GetFrame()));
571 }
572
573 WXHMENU wxMenuBar::Create()
574 {
575 if ( m_hMenu != 0 )
576 return m_hMenu;
577
578 m_hMenu = (WXHMENU)::CreateMenu();
579
580 if ( !m_hMenu )
581 {
582 wxLogLastError(wxT("CreateMenu"));
583 }
584 else
585 {
586 size_t count = GetMenuCount();
587 for ( size_t i = 0; i < count; i++ )
588 {
589 if ( !::AppendMenu((HMENU)m_hMenu, MF_POPUP | MF_STRING,
590 (UINT)m_menus[i]->GetHMenu(),
591 m_titles[i]) )
592 {
593 wxLogLastError(wxT("AppendMenu"));
594 }
595 }
596 }
597
598 return m_hMenu;
599 }
600
601 // ---------------------------------------------------------------------------
602 // wxMenuBar functions to work with the top level submenus
603 // ---------------------------------------------------------------------------
604
605 // NB: we don't support owner drawn top level items for now, if we do these
606 // functions would have to be changed to use wxMenuItem as well
607
608 void wxMenuBar::EnableTop(size_t pos, bool enable)
609 {
610 wxCHECK_RET( IsAttached(), wxT("doesn't work with unattached menubars") );
611
612 int flag = enable ? MF_ENABLED : MF_GRAYED;
613
614 EnableMenuItem((HMENU)m_hMenu, pos, MF_BYPOSITION | flag);
615
616 Refresh();
617 }
618
619 void wxMenuBar::SetLabelTop(size_t pos, const wxString& label)
620 {
621 wxCHECK_RET( pos < GetMenuCount(), wxT("invalid menu index") );
622
623 m_titles[pos] = label;
624
625 if ( !IsAttached() )
626 {
627 return;
628 }
629 //else: have to modify the existing menu
630
631 UINT id;
632 UINT flagsOld = ::GetMenuState((HMENU)m_hMenu, pos, MF_BYPOSITION);
633 if ( flagsOld == 0xFFFFFFFF )
634 {
635 wxLogLastError(wxT("GetMenuState"));
636
637 return;
638 }
639
640 if ( flagsOld & MF_POPUP )
641 {
642 // HIBYTE contains the number of items in the submenu in this case
643 flagsOld &= 0xff;
644 id = (UINT)::GetSubMenu((HMENU)m_hMenu, pos);
645 }
646 else
647 {
648 id = pos;
649 }
650
651 if ( ::ModifyMenu(GetHmenu(), pos, MF_BYPOSITION | MF_STRING | flagsOld,
652 id, label) == (int)0xFFFFFFFF )
653 {
654 wxLogLastError(wxT("ModifyMenu"));
655 }
656
657 Refresh();
658 }
659
660 wxString wxMenuBar::GetLabelTop(size_t pos) const
661 {
662 wxCHECK_MSG( pos < GetMenuCount(), wxEmptyString,
663 wxT("invalid menu index in wxMenuBar::GetLabelTop") );
664
665 return m_titles[pos];
666 }
667
668 // ---------------------------------------------------------------------------
669 // wxMenuBar construction
670 // ---------------------------------------------------------------------------
671
672 wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
673 {
674 wxMenu *menuOld = wxMenuBarBase::Replace(pos, menu, title);
675 if ( !menuOld )
676 return NULL;
677
678 m_titles[pos] = title;
679
680 if ( IsAttached() )
681 {
682 // can't use ModifyMenu() because it deletes the submenu it replaces
683 if ( !::RemoveMenu(GetHmenu(), (UINT)pos, MF_BYPOSITION) )
684 {
685 wxLogLastError(wxT("RemoveMenu"));
686 }
687
688 if ( !::InsertMenu(GetHmenu(), (UINT)pos,
689 MF_BYPOSITION | MF_POPUP | MF_STRING,
690 (UINT)GetHmenuOf(menu), title) )
691 {
692 wxLogLastError(wxT("InsertMenu"));
693 }
694
695 #if wxUSE_ACCEL
696 if ( menuOld->HasAccels() || menu->HasAccels() )
697 {
698 // need to rebuild accell table
699 RebuildAccelTable();
700 }
701 #endif // wxUSE_ACCEL
702
703 Refresh();
704 }
705
706 return menuOld;
707 }
708
709 bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
710 {
711 if ( !wxMenuBarBase::Insert(pos, menu, title) )
712 return FALSE;
713
714 m_titles.Insert(title, pos);
715
716 if ( IsAttached() )
717 {
718 if ( !::InsertMenu(GetHmenu(), pos,
719 MF_BYPOSITION | MF_POPUP | MF_STRING,
720 (UINT)GetHmenuOf(menu), title) )
721 {
722 wxLogLastError(wxT("InsertMenu"));
723 }
724
725 #if wxUSE_ACCEL
726 if ( menu->HasAccels() )
727 {
728 // need to rebuild accell table
729 RebuildAccelTable();
730 }
731 #endif // wxUSE_ACCEL
732
733 Refresh();
734 }
735
736 return TRUE;
737 }
738
739 bool wxMenuBar::Append(wxMenu *menu, const wxString& title)
740 {
741 WXHMENU submenu = menu ? menu->GetHMenu() : 0;
742 wxCHECK_MSG( submenu, FALSE, wxT("can't append invalid menu to menubar") );
743
744 if ( !wxMenuBarBase::Append(menu, title) )
745 return FALSE;
746
747 m_titles.Add(title);
748
749 if ( IsAttached() )
750 {
751 if ( !::AppendMenu(GetHmenu(), MF_POPUP | MF_STRING,
752 (UINT)submenu, title) )
753 {
754 wxLogLastError(wxT("AppendMenu"));
755 }
756
757 #if wxUSE_ACCEL
758 if ( menu->HasAccels() )
759 {
760 // need to rebuild accell table
761 RebuildAccelTable();
762 }
763 #endif // wxUSE_ACCEL
764
765 Refresh();
766 }
767
768 return TRUE;
769 }
770
771 wxMenu *wxMenuBar::Remove(size_t pos)
772 {
773 wxMenu *menu = wxMenuBarBase::Remove(pos);
774 if ( !menu )
775 return NULL;
776
777 if ( IsAttached() )
778 {
779 if ( !::RemoveMenu(GetHmenu(), (UINT)pos, MF_BYPOSITION) )
780 {
781 wxLogLastError(wxT("RemoveMenu"));
782 }
783
784 #if wxUSE_ACCEL
785 if ( menu->HasAccels() )
786 {
787 // need to rebuild accell table
788 RebuildAccelTable();
789 }
790 #endif // wxUSE_ACCEL
791
792 Refresh();
793 }
794
795 m_titles.Remove(pos);
796
797 return menu;
798 }
799
800 #if wxUSE_ACCEL
801
802 void wxMenuBar::RebuildAccelTable()
803 {
804 // merge the accelerators of all menus into one accel table
805 size_t nAccelCount = 0;
806 size_t i, count = GetMenuCount();
807 for ( i = 0; i < count; i++ )
808 {
809 nAccelCount += m_menus[i]->GetAccelCount();
810 }
811
812 if ( nAccelCount )
813 {
814 wxAcceleratorEntry *accelEntries = new wxAcceleratorEntry[nAccelCount];
815
816 nAccelCount = 0;
817 for ( i = 0; i < count; i++ )
818 {
819 nAccelCount += m_menus[i]->CopyAccels(&accelEntries[nAccelCount]);
820 }
821
822 m_accelTable = wxAcceleratorTable(nAccelCount, accelEntries);
823
824 delete [] accelEntries;
825 }
826 }
827
828 #endif // wxUSE_ACCEL
829
830 void wxMenuBar::Attach(wxFrame *frame)
831 {
832 wxMenuBarBase::Attach(frame);
833
834 #if wxUSE_ACCEL
835 RebuildAccelTable();
836 #endif // wxUSE_ACCEL
837 }
838
839 void wxMenuBar::Detach()
840 {
841 m_hMenu = (WXHMENU)NULL;
842
843 wxMenuBarBase::Detach();
844 }
845
846 #endif // wxUSE_MENUS