1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxMenu, wxMenuBar, wxMenuItem
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // ===========================================================================
14 // ===========================================================================
16 // ---------------------------------------------------------------------------
18 // ---------------------------------------------------------------------------
21 #pragma implementation "menu.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
39 #include "wx/ownerdrw.h"
42 #include "wx/msw/private.h"
43 #include "wx/msw/menu.h"
44 #include "wx/menuitem.h"
47 // other standard headers
50 // ----------------------------------------------------------------------------
52 // ----------------------------------------------------------------------------
54 extern wxMenu
*wxCurrentPopupMenu
;
56 // ----------------------------------------------------------------------------
58 // ----------------------------------------------------------------------------
60 // the (popup) menu title has this special id
61 static const int idMenuTitle
= -2;
63 // ----------------------------------------------------------------------------
65 // ----------------------------------------------------------------------------
67 #if !USE_SHARED_LIBRARY
68 IMPLEMENT_DYNAMIC_CLASS(wxMenu
, wxEvtHandler
)
69 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar
, wxEvtHandler
)
72 // ============================================================================
74 // ============================================================================
76 // ---------------------------------------------------------------------------
77 // wxMenu construction, adding and removing menu items
78 // ---------------------------------------------------------------------------
80 // Construct a menu with optional title (then use append)
81 void wxMenu::Init(const wxString
& title
, const wxFunction func
)
85 m_eventHandler
= this;
86 m_pInvokingWindow
= NULL
;
90 m_hMenu
= (WXHMENU
) CreatePopupMenu();
92 m_topLevelMenu
= this;
93 m_clientData
= (void*) NULL
;
97 Append(idMenuTitle
, m_title
) ;
104 // The wxWindow destructor will take care of deleting the submenus.
107 // free Windows resources
110 ::DestroyMenu((HMENU
)m_hMenu
);
115 wxNode
*node
= m_menuItems
.First();
118 wxMenuItem
*item
= (wxMenuItem
*)node
->Data();
120 // Delete child menus.
121 // Beware: they must not be appended to children list!!!
122 // (because order of delete is significant)
123 if ( item
->IsSubMenu() )
124 item
->DeleteSubMenu();
126 wxNode
*next
= node
->Next();
138 // function appends a new item or submenu to the menu
139 void wxMenu::Append(wxMenuItem
*pItem
)
141 wxCHECK_RET( pItem
!= NULL
, wxT("can't append NULL item to the menu") );
144 wxAcceleratorEntry
*accel
= wxGetAccelFromString(pItem
->GetText());
148 #endif // wxUSE_ACCEL
152 // if "Break" has just been called, insert a menu break before this item
153 // (and don't forget to reset the flag)
155 flags
|= MF_MENUBREAK
;
159 if ( pItem
->IsSeparator() ) {
160 flags
|= MF_SEPARATOR
;
163 // id is the numeric id for normal menu items and HMENU for submenus as
164 // required by ::AppendMenu() API
166 wxMenu
*submenu
= pItem
->GetSubMenu();
167 if ( submenu
!= NULL
) {
168 wxASSERT( submenu
->GetHMenu() != (WXHMENU
) NULL
);
170 id
= (UINT
)submenu
->GetHMenu();
171 submenu
->m_topLevelMenu
= m_topLevelMenu
;
172 submenu
->m_parent
= this;
173 submenu
->m_savehMenu
= (WXHMENU
)id
;
174 submenu
->m_hMenu
= 0;
184 #if wxUSE_OWNER_DRAWN
185 if ( pItem
->IsOwnerDrawn() ) { // want to get {Measure|Draw}Item messages?
186 // item draws itself, pass pointer to it in data parameter
187 flags
|= MF_OWNERDRAW
;
188 pData
= (LPCTSTR
)pItem
;
193 // menu is just a normal string (passed in data parameter)
196 pData
= (char*)pItem
->GetText().c_str();
199 if ( !::AppendMenu(GetHmenu(), flags
, id
, pData
) )
201 wxLogLastError("AppendMenu");
206 if ( (int)id
== idMenuTitle
)
208 // visually select the menu title
210 mii
.cbSize
= sizeof(mii
);
211 mii
.fMask
= MIIM_STATE
;
212 mii
.fState
= MFS_DEFAULT
;
214 if ( !SetMenuItemInfo(GetHmenu(), (unsigned)id
, FALSE
, &mii
) )
216 wxLogLastError(wxT("SetMenuItemInfo"));
221 m_menuItems
.Append(pItem
);
226 void wxMenu::AppendSeparator()
228 Append(new wxMenuItem(this, ID_SEPARATOR
));
232 void wxMenu::Append(int id
,
233 const wxString
& label
,
235 const wxString
& helpString
)
237 Append(new wxMenuItem(this, id
, label
, helpString
, FALSE
, SubMenu
));
240 // Ordinary menu item
241 void wxMenu::Append(int id
,
242 const wxString
& label
,
243 const wxString
& helpString
,
246 // 'checkable' parameter is useless for Windows.
247 Append(new wxMenuItem(this, id
, label
, helpString
, checkable
));
251 void wxMenu::Delete(int id
)
253 wxMenuItem
*item
= NULL
;
256 for (pos
= 0, node
= m_menuItems
.First(); node
; node
= node
->Next(), pos
++)
258 item
= (wxMenuItem
*)node
->Data();
259 if ( item
->GetId() == id
)
263 wxCHECK_RET( node
, wxT("wxMenu::Delete(): item doesn't exist") );
265 HMENU menu
= GetHmenu();
267 wxMenu
*pSubMenu
= item
->GetSubMenu();
268 if ( pSubMenu
!= NULL
) {
269 RemoveMenu(menu
, (UINT
)pos
, MF_BYPOSITION
);
270 pSubMenu
->m_hMenu
= pSubMenu
->m_savehMenu
;
271 pSubMenu
->m_savehMenu
= 0;
272 pSubMenu
->m_parent
= NULL
;
273 // RemoveChild(item->subMenu);
274 pSubMenu
->m_topLevelMenu
= NULL
;
275 // TODO: Why isn't subMenu deleted here???
276 // Will put this in for now. Assuming this is supposed
277 // to delete the menu, not just remove it.
278 item
->DeleteSubMenu();
281 DeleteMenu(menu
, (UINT
)pos
, MF_BYPOSITION
);
284 m_menuItems
.DeleteNode(node
);
290 // ---------------------------------------------------------------------------
291 // accelerator helpers
292 // ---------------------------------------------------------------------------
294 // create the wxAcceleratorEntries for our accels and put them into provided
295 // array - return the number of accels we have
296 size_t wxMenu::CopyAccels(wxAcceleratorEntry
*accels
) const
298 size_t count
= GetAccelCount();
299 for ( size_t n
= 0; n
< count
; n
++ )
301 *accels
++ = *m_accels
[n
];
307 #endif // wxUSE_ACCEL
309 // ---------------------------------------------------------------------------
310 // wxMenu functions implemented in wxMenuItem
311 // ---------------------------------------------------------------------------
313 void wxMenu::Enable(int id
, bool Flag
)
315 wxMenuItem
*item
= FindItemForId(id
);
316 wxCHECK_RET( item
!= NULL
, wxT("can't enable non-existing menu item") );
321 bool wxMenu::IsEnabled(int id
) const
323 wxMenuItem
*item
= FindItemForId(id
);
324 wxCHECK_MSG( item
!= NULL
, FALSE
, wxT("invalid item id") );
326 return item
->IsEnabled();
329 void wxMenu::Check(int id
, bool Flag
)
331 wxMenuItem
*item
= FindItemForId(id
);
332 wxCHECK_RET( item
!= NULL
, wxT("can't get status of non-existing menu item") );
337 bool wxMenu::IsChecked(int id
) const
339 wxMenuItem
*item
= FindItemForId(id
);
340 wxCHECK_MSG( item
!= NULL
, FALSE
, wxT("invalid item id") );
342 return item
->IsChecked();
345 void wxMenu::SetLabel(int id
, const wxString
& label
)
347 wxMenuItem
*item
= FindItemForId(id
) ;
348 wxCHECK_RET( item
, wxT("wxMenu::SetLabel: no such item") );
350 item
->SetText(label
);
353 wxString
wxMenu::GetLabel(int id
) const
356 wxMenuItem
*pItem
= FindItemForId(id
) ;
358 label
= pItem
->GetText() ;
360 wxFAIL_MSG(wxT("wxMenu::GetLabel: item doesn't exist"));
365 void wxMenu::SetHelpString(int itemId
, const wxString
& helpString
)
367 wxMenuItem
*item
= FindItemForId (itemId
);
369 item
->SetHelp(helpString
);
371 wxFAIL_MSG(wxT("wxMenu::SetHelpString: item doesn't exist"));
374 wxString
wxMenu::GetHelpString (int itemId
) const
377 wxMenuItem
*item
= FindItemForId (itemId
);
379 help
= item
->GetHelp();
381 wxFAIL_MSG(wxT("wxMenu::GetHelpString: item doesn't exist"));
386 // ---------------------------------------------------------------------------
388 // ---------------------------------------------------------------------------
390 void wxMenu::SetTitle(const wxString
& label
)
392 bool hasNoTitle
= m_title
.IsEmpty();
395 HMENU hMenu
= GetHmenu();
399 if ( !label
.IsEmpty() )
401 if ( !InsertMenu(hMenu
, 0u, MF_BYPOSITION
| MF_STRING
,
402 (unsigned)idMenuTitle
, m_title
) ||
403 !InsertMenu(hMenu
, 1u, MF_BYPOSITION
, (unsigned)-1, NULL
) )
405 wxLogLastError(wxT("InsertMenu"));
411 if ( label
.IsEmpty() )
413 // remove the title and the separator after it
414 if ( !RemoveMenu(hMenu
, 0, MF_BYPOSITION
) ||
415 !RemoveMenu(hMenu
, 0, MF_BYPOSITION
) )
417 wxLogLastError("RemoveMenu");
423 if ( !ModifyMenu(hMenu
, 0u,
424 MF_BYPOSITION
| MF_STRING
,
425 (unsigned)idMenuTitle
, m_title
) )
427 wxLogLastError("ModifyMenu");
433 // put the title string in bold face
434 if ( !m_title
.IsEmpty() )
437 mii
.cbSize
= sizeof(mii
);
438 mii
.fMask
= MIIM_STATE
;
439 mii
.fState
= MFS_DEFAULT
;
441 if ( !SetMenuItemInfo(hMenu
, (unsigned)idMenuTitle
, FALSE
, &mii
) )
443 wxLogLastError("SetMenuItemInfo");
449 const wxString
wxMenu::GetTitle() const
454 // ---------------------------------------------------------------------------
456 // ---------------------------------------------------------------------------
458 bool wxMenu::MSWCommand(WXUINT
WXUNUSED(param
), WXWORD id
)
460 // ignore commands from the menu title
462 // NB: VC++ generates wrong assembler for `if ( id != idMenuTitle )'!!
463 if ( id
!= (WXWORD
)idMenuTitle
)
465 wxCommandEvent
event(wxEVT_COMMAND_MENU_SELECTED
);
466 event
.SetEventObject( this );
469 ProcessCommand(event
);
475 bool wxMenu::ProcessCommand(wxCommandEvent
& event
)
477 bool processed
= FALSE
;
482 (void)(*(m_callback
))(*this, event
);
486 // Try the menu's event handler
487 if ( !processed
&& GetEventHandler())
489 processed
= GetEventHandler()->ProcessEvent(event
);
492 // Try the window the menu was popped up from (and up through the
494 wxWindow
*win
= GetInvokingWindow();
495 if ( !processed
&& win
)
496 processed
= win
->GetEventHandler()->ProcessEvent(event
);
501 // ---------------------------------------------------------------------------
503 // ---------------------------------------------------------------------------
505 // Finds the item id matching the given string, -1 if not found.
506 int wxMenu::FindItem (const wxString
& itemString
) const
508 wxString itemLabel
= wxStripMenuCodes(itemString
);
509 for ( wxNode
*node
= m_menuItems
.First(); node
; node
= node
->Next() )
511 wxMenuItem
*item
= (wxMenuItem
*)node
->Data();
512 if ( item
->IsSubMenu() )
514 int ans
= item
->GetSubMenu()->FindItem(itemString
);
515 if ( ans
!= wxNOT_FOUND
)
518 else if ( !item
->IsSeparator() )
520 wxString label
= wxStripMenuCodes(item
->GetText());
521 if ( itemLabel
== label
)
522 return item
->GetId();
529 wxMenuItem
*wxMenu::FindItemForId(int itemId
, wxMenu
** itemMenu
) const
534 wxMenuItem
*item
= NULL
;
535 for ( wxNode
*node
= m_menuItems
.First(); node
&& !item
; node
= node
->Next() )
537 item
= (wxMenuItem
*)node
->Data();
539 if ( item
->GetId() == itemId
)
542 *itemMenu
= (wxMenu
*)this;
544 else if ( item
->IsSubMenu() )
546 item
= item
->GetSubMenu()->FindItemForId(itemId
, itemMenu
);
550 // don't exit the loop
558 // ---------------------------------------------------------------------------
560 // ---------------------------------------------------------------------------
562 void wxMenu::Attach(wxMenuBar
*menubar
)
564 // menu can be in at most one menubar because otherwise they would both
565 // delete the menu pointer
566 wxASSERT_MSG( !m_menuBar
, wxT("menu belongs to 2 menubars, expect a crash") );
569 m_savehMenu
= m_hMenu
;
573 void wxMenu::Detach()
575 wxASSERT_MSG( m_menuBar
, wxT("can't detach menu if it's not attached") );
577 m_hMenu
= m_savehMenu
;
581 // ---------------------------------------------------------------------------
583 // ---------------------------------------------------------------------------
585 void wxMenuBar::Init()
587 m_eventHandler
= this;
589 m_menuBarFrame
= NULL
;
593 wxMenuBar::wxMenuBar()
598 wxMenuBar::wxMenuBar( long WXUNUSED(style
) )
603 wxMenuBar::wxMenuBar(int count
, wxMenu
*menus
[], const wxString titles
[])
607 m_titles
.Alloc(count
);
609 for ( int i
= 0; i
< count
; i
++ )
611 m_menus
.Append(menus
[i
]);
612 m_titles
.Add(titles
[i
]);
614 menus
[i
]->Attach(this);
618 wxMenuBar::~wxMenuBar()
622 // ---------------------------------------------------------------------------
624 // ---------------------------------------------------------------------------
626 void wxMenuBar::Refresh()
628 wxCHECK_RET( m_menuBarFrame
, wxT("can't refresh a menubar withotu a frame") );
630 DrawMenuBar((HWND
)m_menuBarFrame
->GetHWND()) ;
633 WXHMENU
wxMenuBar::Create()
638 wxCHECK_MSG( !m_hMenu
, TRUE
, wxT("menubar already created") );
640 m_hMenu
= (WXHMENU
)::CreateMenu();
644 wxLogLastError("CreateMenu");
648 size_t count
= GetMenuCount();
649 for ( size_t i
= 0; i
< count
; i
++ )
651 if ( !::AppendMenu((HMENU
)m_hMenu
, MF_POPUP
| MF_STRING
,
652 (UINT
)m_menus
[i
]->GetHMenu(),
655 wxLogLastError("AppendMenu");
663 // ---------------------------------------------------------------------------
664 // wxMenuBar functions to work with the top level submenus
665 // ---------------------------------------------------------------------------
667 // NB: we don't support owner drawn top level items for now, if we do these
668 // functions would have to be changed to use wxMenuItem as well
670 void wxMenuBar::EnableTop(size_t pos
, bool enable
)
672 int flag
= enable
? MF_ENABLED
: MF_GRAYED
;;
674 EnableMenuItem((HMENU
)m_hMenu
, pos
, MF_BYPOSITION
| flag
);
679 void wxMenuBar::SetLabelTop(size_t pos
, const wxString
& label
)
682 UINT flagsOld
= ::GetMenuState((HMENU
)m_hMenu
, pos
, MF_BYPOSITION
);
683 if ( flagsOld
== 0xFFFFFFFF )
685 wxLogLastError(wxT("GetMenuState"));
690 if ( flagsOld
& MF_POPUP
)
692 // HIBYTE contains the number of items in the submenu in this case
694 id
= (UINT
)::GetSubMenu((HMENU
)m_hMenu
, pos
) ;
701 if ( ::ModifyMenu(GetHmenu(), pos
, MF_BYPOSITION
| MF_STRING
| flagsOld
,
702 id
, label
) == (int)0xFFFFFFFF )
704 wxLogLastError("ModifyMenu");
708 wxString
wxMenuBar::GetLabelTop(size_t pos
) const
710 int len
= ::GetMenuString((HMENU
)m_hMenu
, pos
, NULL
, 0, MF_BYCOMMAND
);
712 len
++; // for the NUL character
714 ::GetMenuString(GetHmenu(), pos
, label
.GetWriteBuf(len
), len
, MF_BYCOMMAND
);
715 label
.UngetWriteBuf();
720 // ---------------------------------------------------------------------------
721 // wxMenuBar notifications
722 // ---------------------------------------------------------------------------
724 bool wxMenuBar::OnDelete(wxMenu
*a_menu
, int pos
)
726 if ( !m_menuBarFrame
)
729 if ( ::RemoveMenu((HMENU
)m_hMenu
, (UINT
)pos
, MF_BYPOSITION
) )
731 // VZ: I'm not sure about what's going on here, so I leave an assert
732 wxASSERT_MSG( m_menus
[pos
] == a_menu
, wxT("what is this parameter for??") );
736 if ( m_menuBarFrame
)
743 wxLogLastError("RemoveMenu");
749 bool wxMenuBar::OnAppend(wxMenu
*a_menu
, const wxChar
*title
)
751 WXHMENU submenu
= a_menu
->GetHMenu();
755 if ( !m_menuBarFrame
)
758 a_menu
->Attach(this);
760 if ( !::AppendMenu(GetHmenu(), MF_POPUP
| MF_STRING
,
761 (UINT
)submenu
, title
) )
763 wxLogLastError(wxT("AppendMenu"));
771 // ---------------------------------------------------------------------------
772 // wxMenuBar construction
773 // ---------------------------------------------------------------------------
775 int wxMenuBar::FindMenu(const wxString
& title
)
777 wxString menuTitle
= wxStripMenuCodes(title
);
779 size_t count
= GetMenuCount();
780 for ( size_t i
= 0; i
< count
; i
++ )
782 wxString title
= wxStripMenuCodes(m_titles
[i
]);
783 if ( menuTitle
== title
)
791 wxMenu
*wxMenuBar::Replace(size_t pos
, wxMenu
*menu
, const wxString
& title
)
793 if ( m_menuBarFrame
)
795 wxFAIL_MSG(wxT("not implemented"));
801 wxMenu
*menuOld
= wxMenuBarBase::Replace(pos
, menu
, title
);
804 m_titles
[pos
] = title
;
811 bool wxMenuBar::Insert(size_t pos
, wxMenu
*menu
, const wxString
& title
)
813 if ( m_menuBarFrame
)
815 wxFAIL_MSG(wxT("not implemented"));
821 if ( !wxMenuBarBase::Insert(pos
, menu
, title
) )
824 m_titles
.Insert(title
, pos
);
830 bool wxMenuBar::Append(wxMenu
* menu
, const wxString
& title
)
832 if ( !wxMenuBarBase::Append(menu
, title
) )
835 // menu is already appended, ignore errors
836 (void)OnAppend(menu
, title
);
840 menu
->SetParent(this);
845 wxMenu
*wxMenuBar::Remove(size_t pos
)
847 wxMenu
*menu
= wxMenuBarBase::Remove(pos
);
851 menu
->SetParent(NULL
);
853 // the menu is deleted from the list anyhow, so we have to ignore all
854 // possible errors here
855 (void)OnDelete(menu
, pos
);
857 m_titles
.Remove(pos
);
862 void wxMenuBar::Attach(wxFrame
*frame
)
864 wxASSERT_MSG( !m_menuBarFrame
, wxT("menubar already attached!") );
866 m_menuBarFrame
= frame
;
869 // create the accel table - we consider that the menubar construction is
871 size_t nAccelCount
= 0;
872 size_t i
, count
= GetMenuCount();
873 for ( i
= 0; i
< count
; i
++ )
875 nAccelCount
+= m_menus
[i
]->GetAccelCount();
880 wxAcceleratorEntry
*accelEntries
= new wxAcceleratorEntry
[nAccelCount
];
883 for ( i
= 0; i
< count
; i
++ )
885 nAccelCount
+= m_menus
[i
]->CopyAccels(&accelEntries
[nAccelCount
]);
888 m_accelTable
= wxAcceleratorTable(nAccelCount
, accelEntries
);
890 delete [] accelEntries
;
892 #endif // wxUSE_ACCEL
895 void wxMenuBar::Detach()
897 // ::DestroyMenu((HMENU)m_hMenu);
898 m_hMenu
= (WXHMENU
)NULL
;
899 m_menuBarFrame
= NULL
;
903 // ---------------------------------------------------------------------------
904 // wxMenuBar searching for menu items
905 // ---------------------------------------------------------------------------
907 // Find the itemString in menuString, and return the item id or wxNOT_FOUND
908 int wxMenuBar::FindMenuItem(const wxString
& menuString
,
909 const wxString
& itemString
) const
911 wxString menuLabel
= wxStripMenuCodes(menuString
);
912 size_t count
= GetMenuCount();
913 for ( size_t i
= 0; i
< count
; i
++ )
915 wxString title
= wxStripMenuCodes(m_titles
[i
]);
916 if ( menuString
== title
)
917 return m_menus
[i
]->FindItem(itemString
);
923 wxMenuItem
*wxMenuBar::FindItem(int id
, wxMenu
**itemMenu
) const
928 wxMenuItem
*item
= NULL
;
929 size_t count
= GetMenuCount();
930 for ( size_t i
= 0; !item
&& (i
< count
); i
++ )
932 item
= m_menus
[i
]->FindItemForId(id
, itemMenu
);
939 // ----------------------------------------------------------------------------
941 // ----------------------------------------------------------------------------
943 wxWindow
*wxMenu::GetWindow() const
945 if ( m_pInvokingWindow
!= NULL
)
946 return m_pInvokingWindow
;
947 else if ( m_menuBar
!= NULL
)
948 return m_menuBar
->GetFrame();
953 WXHMENU
wxMenu::GetHMenu() const
957 else if ( m_savehMenu
!= 0 )
960 wxFAIL_MSG(wxT("wxMenu without HMENU"));
965 // Update a menu and all submenus recursively. source is the object that has
966 // the update event handlers defined for it. If NULL, the menu or associated
967 // window will be used.
968 void wxMenu::UpdateUI(wxEvtHandler
* source
)
970 if (!source
&& GetInvokingWindow())
971 source
= GetInvokingWindow()->GetEventHandler();
973 source
= GetEventHandler();
977 wxNode
* node
= GetItems().First();
980 wxMenuItem
* item
= (wxMenuItem
*) node
->Data();
981 if ( !item
->IsSeparator() )
983 wxWindowID id
= item
->GetId();
984 wxUpdateUIEvent
event(id
);
985 event
.SetEventObject( source
);
987 if (source
->ProcessEvent(event
))
989 if (event
.GetSetText())
990 SetLabel(id
, event
.GetText());
991 if (event
.GetSetChecked())
992 Check(id
, event
.GetChecked());
993 if (event
.GetSetEnabled())
994 Enable(id
, event
.GetEnabled());
997 if (item
->GetSubMenu())
998 item
->GetSubMenu()->UpdateUI(source
);
1000 node
= node
->Next();