]> git.saurik.com Git - wxWidgets.git/blob - src/msw/menu.cpp
Put dialog in more sensible place in Forty, got a bit further
[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 if ( m_startRadioGroup == -1 )
303 {
304 // nothing to do
305 return;
306 }
307
308 wxMenuItemList::Node *nodeStart = GetMenuItems().Item(m_startRadioGroup);
309 wxCHECK_RET( nodeStart, _T("where is the radio group start item?") );
310
311 int endRadioGroup = GetMenuItemCount();
312
313 wxMenuItemList::Node *node = nodeStart;
314 for ( int n = m_startRadioGroup; n < endRadioGroup && node; n++ )
315 {
316 wxMenuItem *item = (wxMenuItem *)node->GetData();
317 item->SetRadioGroup(m_startRadioGroup, endRadioGroup - 1);
318
319 node = node->GetNext();
320 }
321
322 nodeStart->GetData()->Check(TRUE);
323
324 // we're not inside a radio group any longer
325 m_startRadioGroup = -1;
326 }
327
328 bool wxMenu::DoAppend(wxMenuItem *item)
329 {
330 wxCHECK_MSG( item, FALSE, _T("NULL item in wxMenu::DoAppend") );
331
332 if ( item->GetKind() == wxItem_Radio )
333 {
334 if ( m_startRadioGroup == -1 )
335 {
336 // start a new radio group
337 m_startRadioGroup = GetMenuItemCount();
338 }
339 }
340 else // not a radio item
341 {
342 EndRadioGroup();
343 }
344
345 return wxMenuBase::DoAppend(item) && DoInsertOrAppend(item);
346 }
347
348 bool wxMenu::DoInsert(size_t pos, wxMenuItem *item)
349 {
350 return wxMenuBase::DoInsert(pos, item) && DoInsertOrAppend(item, pos);
351 }
352
353 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
354 {
355 // we need to find the items position in the child list
356 size_t pos;
357 wxMenuItemList::Node *node = GetMenuItems().GetFirst();
358 for ( pos = 0; node; pos++ )
359 {
360 if ( node->GetData() == item )
361 break;
362
363 node = node->GetNext();
364 }
365
366 // DoRemove() (unlike Remove) can only be called for existing item!
367 wxCHECK_MSG( node, NULL, wxT("bug in wxMenu::Remove logic") );
368
369 #if wxUSE_ACCEL
370 // remove the corresponding accel from the accel table
371 int n = FindAccel(item->GetId());
372 if ( n != wxNOT_FOUND )
373 {
374 delete m_accels[n];
375
376 m_accels.RemoveAt(n);
377 }
378 //else: this item doesn't have an accel, nothing to do
379 #endif // wxUSE_ACCEL
380
381 // remove the item from the menu
382 if ( !::RemoveMenu(GetHmenu(), (UINT)pos, MF_BYPOSITION) )
383 {
384 wxLogLastError(wxT("RemoveMenu"));
385 }
386
387 if ( IsAttached() && m_menuBar->IsAttached() )
388 {
389 // otherwise, the chane won't be visible
390 m_menuBar->Refresh();
391 }
392
393 // and from internal data structures
394 return wxMenuBase::DoRemove(item);
395 }
396
397 // ---------------------------------------------------------------------------
398 // accelerator helpers
399 // ---------------------------------------------------------------------------
400
401 #if wxUSE_ACCEL
402
403 // create the wxAcceleratorEntries for our accels and put them into provided
404 // array - return the number of accels we have
405 size_t wxMenu::CopyAccels(wxAcceleratorEntry *accels) const
406 {
407 size_t count = GetAccelCount();
408 for ( size_t n = 0; n < count; n++ )
409 {
410 *accels++ = *m_accels[n];
411 }
412
413 return count;
414 }
415
416 #endif // wxUSE_ACCEL
417
418 // ---------------------------------------------------------------------------
419 // set wxMenu title
420 // ---------------------------------------------------------------------------
421
422 void wxMenu::SetTitle(const wxString& label)
423 {
424 bool hasNoTitle = m_title.IsEmpty();
425 m_title = label;
426
427 HMENU hMenu = GetHmenu();
428
429 if ( hasNoTitle )
430 {
431 if ( !label.IsEmpty() )
432 {
433 if ( !::InsertMenu(hMenu, 0u, MF_BYPOSITION | MF_STRING,
434 (unsigned)idMenuTitle, m_title) ||
435 !::InsertMenu(hMenu, 1u, MF_BYPOSITION, (unsigned)-1, NULL) )
436 {
437 wxLogLastError(wxT("InsertMenu"));
438 }
439 }
440 }
441 else
442 {
443 if ( label.IsEmpty() )
444 {
445 // remove the title and the separator after it
446 if ( !RemoveMenu(hMenu, 0, MF_BYPOSITION) ||
447 !RemoveMenu(hMenu, 0, MF_BYPOSITION) )
448 {
449 wxLogLastError(wxT("RemoveMenu"));
450 }
451 }
452 else
453 {
454 // modify the title
455 if ( !ModifyMenu(hMenu, 0u,
456 MF_BYPOSITION | MF_STRING,
457 (unsigned)idMenuTitle, m_title) )
458 {
459 wxLogLastError(wxT("ModifyMenu"));
460 }
461 }
462 }
463
464 #ifdef __WIN32__
465 // put the title string in bold face
466 if ( !m_title.IsEmpty() )
467 {
468 SetDefaultMenuItem(GetHmenu(), (UINT)idMenuTitle);
469 }
470 #endif // Win32
471 }
472
473 // ---------------------------------------------------------------------------
474 // event processing
475 // ---------------------------------------------------------------------------
476
477 bool wxMenu::MSWCommand(WXUINT WXUNUSED(param), WXWORD id)
478 {
479 // ignore commands from the menu title
480
481 // NB: VC++ generates wrong assembler for `if ( id != idMenuTitle )'!!
482 if ( id != (WXWORD)idMenuTitle )
483 {
484 // VZ: previosuly, the command int was set to id too which was quite
485 // useless anyhow (as it could be retrieved using GetId()) and
486 // uncompatible with wxGTK, so now we use the command int instead
487 // to pass the checked status
488 SendEvent(id, ::GetMenuState(GetHmenu(), id, MF_BYCOMMAND) & MF_CHECKED);
489 }
490
491 return TRUE;
492 }
493
494 // ---------------------------------------------------------------------------
495 // other
496 // ---------------------------------------------------------------------------
497
498 wxWindow *wxMenu::GetWindow() const
499 {
500 if ( m_invokingWindow != NULL )
501 return m_invokingWindow;
502 else if ( m_menuBar != NULL)
503 return m_menuBar->GetFrame();
504
505 return NULL;
506 }
507
508 // ---------------------------------------------------------------------------
509 // Menu Bar
510 // ---------------------------------------------------------------------------
511
512 void wxMenuBar::Init()
513 {
514 m_eventHandler = this;
515 m_hMenu = 0;
516 }
517
518 wxMenuBar::wxMenuBar()
519 {
520 Init();
521 }
522
523 wxMenuBar::wxMenuBar( long WXUNUSED(style) )
524 {
525 Init();
526 }
527
528 wxMenuBar::wxMenuBar(int count, wxMenu *menus[], const wxString titles[])
529 {
530 Init();
531
532 m_titles.Alloc(count);
533
534 for ( int i = 0; i < count; i++ )
535 {
536 m_menus.Append(menus[i]);
537 m_titles.Add(titles[i]);
538
539 menus[i]->Attach(this);
540 }
541 }
542
543 wxMenuBar::~wxMenuBar()
544 {
545 }
546
547 // ---------------------------------------------------------------------------
548 // wxMenuBar helpers
549 // ---------------------------------------------------------------------------
550
551 void wxMenuBar::Refresh()
552 {
553 wxCHECK_RET( IsAttached(), wxT("can't refresh unattached menubar") );
554
555 DrawMenuBar(GetHwndOf(GetFrame()));
556 }
557
558 WXHMENU wxMenuBar::Create()
559 {
560 if ( m_hMenu != 0 )
561 return m_hMenu;
562
563 m_hMenu = (WXHMENU)::CreateMenu();
564
565 if ( !m_hMenu )
566 {
567 wxLogLastError(wxT("CreateMenu"));
568 }
569 else
570 {
571 size_t count = GetMenuCount();
572 for ( size_t i = 0; i < count; i++ )
573 {
574 if ( !::AppendMenu((HMENU)m_hMenu, MF_POPUP | MF_STRING,
575 (UINT)m_menus[i]->GetHMenu(),
576 m_titles[i]) )
577 {
578 wxLogLastError(wxT("AppendMenu"));
579 }
580 }
581 }
582
583 return m_hMenu;
584 }
585
586 // ---------------------------------------------------------------------------
587 // wxMenuBar functions to work with the top level submenus
588 // ---------------------------------------------------------------------------
589
590 // NB: we don't support owner drawn top level items for now, if we do these
591 // functions would have to be changed to use wxMenuItem as well
592
593 void wxMenuBar::EnableTop(size_t pos, bool enable)
594 {
595 wxCHECK_RET( IsAttached(), wxT("doesn't work with unattached menubars") );
596
597 int flag = enable ? MF_ENABLED : MF_GRAYED;
598
599 EnableMenuItem((HMENU)m_hMenu, pos, MF_BYPOSITION | flag);
600
601 Refresh();
602 }
603
604 void wxMenuBar::SetLabelTop(size_t pos, const wxString& label)
605 {
606 wxCHECK_RET( pos < GetMenuCount(), wxT("invalid menu index") );
607
608 m_titles[pos] = label;
609
610 if ( !IsAttached() )
611 {
612 return;
613 }
614 //else: have to modify the existing menu
615
616 UINT id;
617 UINT flagsOld = ::GetMenuState((HMENU)m_hMenu, pos, MF_BYPOSITION);
618 if ( flagsOld == 0xFFFFFFFF )
619 {
620 wxLogLastError(wxT("GetMenuState"));
621
622 return;
623 }
624
625 if ( flagsOld & MF_POPUP )
626 {
627 // HIBYTE contains the number of items in the submenu in this case
628 flagsOld &= 0xff;
629 id = (UINT)::GetSubMenu((HMENU)m_hMenu, pos);
630 }
631 else
632 {
633 id = pos;
634 }
635
636 if ( ::ModifyMenu(GetHmenu(), pos, MF_BYPOSITION | MF_STRING | flagsOld,
637 id, label) == (int)0xFFFFFFFF )
638 {
639 wxLogLastError(wxT("ModifyMenu"));
640 }
641
642 Refresh();
643 }
644
645 wxString wxMenuBar::GetLabelTop(size_t pos) const
646 {
647 wxCHECK_MSG( pos < GetMenuCount(), wxEmptyString,
648 wxT("invalid menu index in wxMenuBar::GetLabelTop") );
649
650 return m_titles[pos];
651 }
652
653 // ---------------------------------------------------------------------------
654 // wxMenuBar construction
655 // ---------------------------------------------------------------------------
656
657 wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
658 {
659 wxMenu *menuOld = wxMenuBarBase::Replace(pos, menu, title);
660 if ( !menuOld )
661 return FALSE;
662 m_titles[pos] = title;
663
664 if ( IsAttached() )
665 {
666 // can't use ModifyMenu() because it deletes the submenu it replaces
667 if ( !::RemoveMenu(GetHmenu(), (UINT)pos, MF_BYPOSITION) )
668 {
669 wxLogLastError(wxT("RemoveMenu"));
670 }
671
672 if ( !::InsertMenu(GetHmenu(), (UINT)pos,
673 MF_BYPOSITION | MF_POPUP | MF_STRING,
674 (UINT)GetHmenuOf(menu), title) )
675 {
676 wxLogLastError(wxT("InsertMenu"));
677 }
678
679 #if wxUSE_ACCEL
680 if ( menuOld->HasAccels() || menu->HasAccels() )
681 {
682 // need to rebuild accell table
683 RebuildAccelTable();
684 }
685 #endif // wxUSE_ACCEL
686
687 Refresh();
688 }
689
690 return menuOld;
691 }
692
693 bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
694 {
695 if ( !wxMenuBarBase::Insert(pos, menu, title) )
696 return FALSE;
697
698 m_titles.Insert(title, pos);
699
700 if ( IsAttached() )
701 {
702 if ( !::InsertMenu(GetHmenu(), pos,
703 MF_BYPOSITION | MF_POPUP | MF_STRING,
704 (UINT)GetHmenuOf(menu), title) )
705 {
706 wxLogLastError(wxT("InsertMenu"));
707 }
708
709 #if wxUSE_ACCEL
710 if ( menu->HasAccels() )
711 {
712 // need to rebuild accell table
713 RebuildAccelTable();
714 }
715 #endif // wxUSE_ACCEL
716
717 Refresh();
718 }
719
720 return TRUE;
721 }
722
723 bool wxMenuBar::Append(wxMenu *menu, const wxString& title)
724 {
725 WXHMENU submenu = menu ? menu->GetHMenu() : 0;
726 wxCHECK_MSG( submenu, FALSE, wxT("can't append invalid menu to menubar") );
727
728 if ( !wxMenuBarBase::Append(menu, title) )
729 return FALSE;
730
731 m_titles.Add(title);
732
733 if ( IsAttached() )
734 {
735 if ( !::AppendMenu(GetHmenu(), MF_POPUP | MF_STRING,
736 (UINT)submenu, title) )
737 {
738 wxLogLastError(wxT("AppendMenu"));
739 }
740
741 #if wxUSE_ACCEL
742 if ( menu->HasAccels() )
743 {
744 // need to rebuild accell table
745 RebuildAccelTable();
746 }
747 #endif // wxUSE_ACCEL
748
749 Refresh();
750 }
751
752 return TRUE;
753 }
754
755 wxMenu *wxMenuBar::Remove(size_t pos)
756 {
757 wxMenu *menu = wxMenuBarBase::Remove(pos);
758 if ( !menu )
759 return NULL;
760
761 if ( IsAttached() )
762 {
763 if ( !::RemoveMenu(GetHmenu(), (UINT)pos, MF_BYPOSITION) )
764 {
765 wxLogLastError(wxT("RemoveMenu"));
766 }
767
768 #if wxUSE_ACCEL
769 if ( menu->HasAccels() )
770 {
771 // need to rebuild accell table
772 RebuildAccelTable();
773 }
774 #endif // wxUSE_ACCEL
775
776 Refresh();
777 }
778
779 m_titles.Remove(pos);
780
781 return menu;
782 }
783
784 #if wxUSE_ACCEL
785
786 void wxMenuBar::RebuildAccelTable()
787 {
788 // merge the accelerators of all menus into one accel table
789 size_t nAccelCount = 0;
790 size_t i, count = GetMenuCount();
791 for ( i = 0; i < count; i++ )
792 {
793 nAccelCount += m_menus[i]->GetAccelCount();
794 }
795
796 if ( nAccelCount )
797 {
798 wxAcceleratorEntry *accelEntries = new wxAcceleratorEntry[nAccelCount];
799
800 nAccelCount = 0;
801 for ( i = 0; i < count; i++ )
802 {
803 nAccelCount += m_menus[i]->CopyAccels(&accelEntries[nAccelCount]);
804 }
805
806 m_accelTable = wxAcceleratorTable(nAccelCount, accelEntries);
807
808 delete [] accelEntries;
809 }
810 }
811
812 #endif // wxUSE_ACCEL
813
814 void wxMenuBar::Attach(wxFrame *frame)
815 {
816 wxMenuBarBase::Attach(frame);
817
818 #if wxUSE_ACCEL
819 RebuildAccelTable();
820 #endif // wxUSE_ACCEL
821 }
822
823 void wxMenuBar::Detach()
824 {
825 m_hMenu = (WXHMENU)NULL;
826
827 wxMenuBarBase::Detach();
828 }
829
830 #endif // wxUSE_MENUS