1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/menu.cpp
3 // Purpose: wxMenu, wxMenuBar, wxMenuItem
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin
7 // Copyright: (c) Julian Smart
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
11 // ===========================================================================
13 // ===========================================================================
15 // ---------------------------------------------------------------------------
17 // ---------------------------------------------------------------------------
19 // For compilers that support precompilation, includes "wx.h".
20 #include "wx/wxprec.h"
39 #include "wx/ownerdrw.h"
42 #include "wx/scopedarray.h"
43 #include "wx/vector.h"
45 #include "wx/msw/private.h"
46 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
54 #if (_WIN32_WCE < 400) && !defined(__HANDHELDPC__)
58 #include "wx/msw/wince/missing.h"
62 // other standard headers
66 #include "wx/dynlib.h"
69 #ifndef MNS_CHECKORBMP
70 #define MNS_CHECKORBMP 0x04000000
73 #define MIM_STYLE 0x00000010
76 // ----------------------------------------------------------------------------
78 // ----------------------------------------------------------------------------
80 // ----------------------------------------------------------------------------
82 // ----------------------------------------------------------------------------
84 // the (popup) menu title has this special id
85 static const int idMenuTitle
= wxID_NONE
;
87 // ----------------------------------------------------------------------------
88 // private helper classes and functions
89 // ----------------------------------------------------------------------------
91 // Contains the data about the radio items groups in the given menu.
92 class wxMenuRadioItemsData
95 wxMenuRadioItemsData() { }
97 // Default copy ctor, assignment operator and dtor are all ok.
99 // Find the start and end of the group containing the given position or
100 // return false if it's not inside any range.
101 bool GetGroupRange(int pos
, int *start
, int *end
) const
103 // We use a simple linear search here because there are not that many
104 // items in a menu and hence even fewer radio items ranges anyhow, so
105 // normally there is no need to do anything fancy (like keeping the
106 // array sorted and using binary search).
107 for ( Ranges::const_iterator it
= m_ranges
.begin();
108 it
!= m_ranges
.end();
111 const Range
& r
= *it
;
113 if ( r
.start
<= pos
&& pos
<= r
.end
)
127 // Take into account the new radio item about to be added at the given
130 // Returns true if this item starts a new radio group, false if it extends
132 bool UpdateOnInsert(int pos
)
134 bool inExistingGroup
= false;
136 for ( Ranges::iterator it
= m_ranges
.begin();
137 it
!= m_ranges
.end();
144 // Item is inserted before this range, update its indices.
148 else if ( pos
<= r
.end
+ 1 )
150 // Item is inserted in the middle of this range or immediately
151 // after it in which case it extends this range so make it span
152 // one more item in any case.
155 inExistingGroup
= true;
157 //else: Item is inserted after this range, nothing to do for it.
160 if ( inExistingGroup
)
163 // Make a new range for the group this item will belong to.
167 m_ranges
.push_back(r
);
173 // Contains the inclusive positions of the range start and end.
180 typedef wxVector
<Range
> Ranges
;
187 // make the given menu item default
188 void SetDefaultMenuItem(HMENU
WXUNUSED_IN_WINCE(hmenu
),
189 UINT
WXUNUSED_IN_WINCE(id
))
192 WinStruct
<MENUITEMINFO
> mii
;
193 mii
.fMask
= MIIM_STATE
;
194 mii
.fState
= MFS_DEFAULT
;
196 if ( !::SetMenuItemInfo(hmenu
, id
, FALSE
, &mii
) )
198 wxLogLastError(wxT("SetMenuItemInfo"));
200 #endif // !__WXWINCE__
203 // make the given menu item owner-drawn
204 void SetOwnerDrawnMenuItem(HMENU
WXUNUSED_IN_WINCE(hmenu
),
205 UINT
WXUNUSED_IN_WINCE(id
),
206 ULONG_PTR
WXUNUSED_IN_WINCE(data
),
207 BOOL
WXUNUSED_IN_WINCE(byPositon
= FALSE
))
210 WinStruct
<MENUITEMINFO
> mii
;
211 mii
.fMask
= MIIM_FTYPE
| MIIM_DATA
;
212 mii
.fType
= MFT_OWNERDRAW
;
213 mii
.dwItemData
= data
;
215 if ( reinterpret_cast<wxMenuItem
*>(data
)->IsSeparator() )
216 mii
.fType
|= MFT_SEPARATOR
;
218 if ( !::SetMenuItemInfo(hmenu
, id
, byPositon
, &mii
) )
220 wxLogLastError(wxT("SetMenuItemInfo"));
222 #endif // !__WXWINCE__
226 UINT
GetMenuState(HMENU hMenu
, UINT id
, UINT flags
)
228 WinStruct
<MENUITEMINFO
> info
;
229 info
.fMask
= MIIM_STATE
;
230 // MF_BYCOMMAND is zero so test MF_BYPOSITION
231 if ( !::GetMenuItemInfo(hMenu
, id
, flags
& MF_BYPOSITION
? TRUE
: FALSE
, & info
) )
233 wxLogLastError(wxT("GetMenuItemInfo"));
237 #endif // __WXWINCE__
239 inline bool IsGreaterThanStdSize(const wxBitmap
& bmp
)
241 return bmp
.GetWidth() > ::GetSystemMetrics(SM_CXMENUCHECK
) ||
242 bmp
.GetHeight() > ::GetSystemMetrics(SM_CYMENUCHECK
);
245 } // anonymous namespace
247 // ============================================================================
249 // ============================================================================
251 // ---------------------------------------------------------------------------
252 // wxMenu construction, adding and removing menu items
253 // ---------------------------------------------------------------------------
255 // Construct a menu with optional title (then use append)
256 void wxMenu::InitNoCreate()
261 #if wxUSE_OWNER_DRAWN
262 m_ownerDrawn
= false;
263 m_maxBitmapWidth
= 0;
264 m_maxAccelWidth
= -1;
265 #endif // wxUSE_OWNER_DRAWN
273 m_hMenu
= (WXHMENU
)CreatePopupMenu();
276 wxLogLastError(wxT("CreatePopupMenu"));
279 // if we have a title, insert it in the beginning of the menu
280 if ( !m_title
.empty() )
282 const wxString title
= m_title
;
283 m_title
.clear(); // so that SetTitle() knows there was no title before
288 wxMenu::wxMenu(WXHMENU hMenu
)
294 // Ensure that our internal idea of how many items we have corresponds to
295 // the real number of items in the menu.
297 // We could also retrieve the real labels of the items here but it doesn't
298 // seem to be worth the trouble.
299 const int numExistingItems
= ::GetMenuItemCount(m_hMenu
);
300 for ( int n
= 0; n
< numExistingItems
; n
++ )
302 wxMenuBase::DoAppend(wxMenuItem::New(this, wxID_SEPARATOR
));
306 // The wxWindow destructor will take care of deleting the submenus.
309 // we should free Windows resources only if Windows doesn't do it for us
310 // which happens if we're attached to a menubar or a submenu of another
312 if ( !IsAttached() && !GetParent() )
314 if ( !::DestroyMenu(GetHmenu()) )
316 wxLogLastError(wxT("DestroyMenu"));
322 WX_CLEAR_ARRAY(m_accels
);
323 #endif // wxUSE_ACCEL
330 // this will take effect during the next call to Append()
336 int wxMenu::FindAccel(int id
) const
338 size_t n
, count
= m_accels
.GetCount();
339 for ( n
= 0; n
< count
; n
++ )
341 if ( m_accels
[n
]->m_command
== id
)
348 void wxMenu::UpdateAccel(wxMenuItem
*item
)
350 if ( item
->IsSubMenu() )
352 wxMenu
*submenu
= item
->GetSubMenu();
353 wxMenuItemList::compatibility_iterator node
= submenu
->GetMenuItems().GetFirst();
356 UpdateAccel(node
->GetData());
358 node
= node
->GetNext();
361 else if ( !item
->IsSeparator() )
363 // recurse upwards: we should only modify m_accels of the top level
364 // menus, not of the submenus as wxMenuBar doesn't look at them
365 // (alternative and arguable cleaner solution would be to recurse
366 // downwards in GetAccelCount() and CopyAccels())
369 GetParent()->UpdateAccel(item
);
373 // find the (new) accel for this item
374 wxAcceleratorEntry
*accel
= wxAcceleratorEntry::Create(item
->GetItemLabel());
376 accel
->m_command
= item
->GetId();
379 int n
= FindAccel(item
->GetId());
380 if ( n
== wxNOT_FOUND
)
382 // no old, add new if any
386 return; // skipping RebuildAccelTable() below
390 // replace old with new or just remove the old one if no new
395 m_accels
.RemoveAt(n
);
400 GetMenuBar()->RebuildAccelTable();
403 #if wxUSE_OWNER_DRAWN
404 ResetMaxAccelWidth();
407 //else: it is a separator, they can't have accels, nothing to do
410 #endif // wxUSE_ACCEL
415 // helper of DoInsertOrAppend(): returns the HBITMAP to use in MENUITEMINFO
416 HBITMAP
GetHBitmapForMenu(wxMenuItem
*pItem
, bool checked
= true)
418 // Under versions of Windows older than Vista we can't pass HBITMAP
419 // directly as hbmpItem for 2 reasons:
420 // 1. We can't draw it with transparency then (this is not
421 // very important now but would be with themed menu bg)
422 // 2. Worse, Windows inverts the bitmap for the selected
423 // item and this looks downright ugly
425 // So we prefer to instead draw it ourselves in MSWOnDrawItem().by using
426 // HBMMENU_CALLBACK when inserting it
428 // However under Vista using HBMMENU_CALLBACK causes the entire menu to be
429 // drawn using the classic theme instead of the current one and it does
430 // handle transparency just fine so do use the real bitmap there
432 if ( wxGetWinVersion() >= wxWinVersion_Vista
)
434 #if wxUSE_OWNER_DRAWN
435 wxBitmap bmp
= pItem
->GetBitmap(checked
);
438 // we must use PARGB DIB for the menu bitmaps so ensure that we do
439 wxImage
img(bmp
.ConvertToImage());
440 if ( !img
.HasAlpha() )
443 pItem
->SetBitmap(img
, checked
);
446 return GetHbitmapOf(pItem
->GetBitmap(checked
));
448 #endif // wxUSE_OWNER_DRAWN
449 //else: bitmap is not set
453 #endif // wxUSE_IMAGE
455 return HBMMENU_CALLBACK
;
458 } // anonymous namespace
460 bool wxMenu::MSWGetRadioGroupRange(int pos
, int *start
, int *end
) const
462 return m_radioData
&& m_radioData
->GetGroupRange(pos
, start
, end
);
465 // append a new item or submenu to the menu
466 bool wxMenu::DoInsertOrAppend(wxMenuItem
*pItem
, size_t pos
)
470 #endif // wxUSE_ACCEL
472 // we should support disabling the item even prior to adding it to the menu
473 UINT flags
= pItem
->IsEnabled() ? MF_ENABLED
: MF_GRAYED
;
475 // if "Break" has just been called, insert a menu break before this item
476 // (and don't forget to reset the flag)
478 flags
|= MF_MENUBREAK
;
482 if ( pItem
->IsSeparator() ) {
483 flags
|= MF_SEPARATOR
;
486 // id is the numeric id for normal menu items and HMENU for submenus as
487 // required by ::AppendMenu() API
489 wxMenu
*submenu
= pItem
->GetSubMenu();
490 if ( submenu
!= NULL
) {
491 wxASSERT_MSG( submenu
->GetHMenu(), wxT("invalid submenu") );
493 submenu
->SetParent(this);
495 id
= (UINT_PTR
)submenu
->GetHMenu();
500 id
= pItem
->GetMSWId();
504 // prepare to insert the item in the menu
505 wxString itemText
= pItem
->GetItemLabel();
506 LPCTSTR pData
= NULL
;
507 if ( pos
== (size_t)-1 )
509 // append at the end (note that the item is already appended to
510 // internal data structures)
511 pos
= GetMenuItemCount() - 1;
514 // Update radio groups data if we're inserting a new radio item.
516 // NB: If we supported inserting non-radio items in the middle of existing
517 // radio groups to break them into two subgroups, we'd need to update
518 // m_radioData in this case too but currently this is not supported.
519 bool checkInitially
= false;
520 if ( pItem
->GetKind() == wxITEM_RADIO
)
523 m_radioData
= new wxMenuRadioItemsData
;
525 if ( m_radioData
->UpdateOnInsert(pos
) )
526 checkInitially
= true;
529 // adjust position to account for the title of a popup menu, if any
530 if ( !GetMenuBar() && !m_title
.empty() )
531 pos
+= 2; // for the title itself and its separator
535 #if wxUSE_OWNER_DRAWN
536 // Under older systems mixing owner-drawn and non-owner-drawn items results
537 // in inconsistent margins, so we force this one to be owner-drawn if any
538 // other items already are.
540 pItem
->SetOwnerDrawn(true);
541 #endif // wxUSE_OWNER_DRAWN
543 // check if we have something more than a simple text item
544 #if wxUSE_OWNER_DRAWN
545 if ( pItem
->IsOwnerDrawn() )
549 if ( !m_ownerDrawn
&& !pItem
->IsSeparator() )
551 // MIIM_BITMAP only works under WinME/2000+ so we always use owner
552 // drawn item under the previous versions and we also have to use
553 // them in any case if the item has custom colours or font
554 static const wxWinVersion winver
= wxGetWinVersion();
555 bool mustUseOwnerDrawn
= winver
< wxWinVersion_98
||
556 pItem
->GetTextColour().IsOk() ||
557 pItem
->GetBackgroundColour().IsOk() ||
558 pItem
->GetFont().IsOk();
560 if ( !mustUseOwnerDrawn
)
562 const wxBitmap
& bmpUnchecked
= pItem
->GetBitmap(false),
563 bmpChecked
= pItem
->GetBitmap(true);
565 if ( (bmpUnchecked
.IsOk() && IsGreaterThanStdSize(bmpUnchecked
)) ||
566 (bmpChecked
.IsOk() && IsGreaterThanStdSize(bmpChecked
)) )
568 mustUseOwnerDrawn
= true;
572 // use InsertMenuItem() if possible as it's guaranteed to look
573 // correct while our owner-drawn code is not
574 if ( !mustUseOwnerDrawn
)
576 WinStruct
<MENUITEMINFO
> mii
;
577 mii
.fMask
= MIIM_STRING
| MIIM_DATA
;
579 // don't set hbmpItem for the checkable items as it would
580 // be used for both checked and unchecked state
581 if ( pItem
->IsCheckable() )
583 mii
.fMask
|= MIIM_CHECKMARKS
;
584 mii
.hbmpChecked
= GetHBitmapForMenu(pItem
, true);
585 mii
.hbmpUnchecked
= GetHBitmapForMenu(pItem
, false);
587 else if ( pItem
->GetBitmap().IsOk() )
589 mii
.fMask
|= MIIM_BITMAP
;
590 mii
.hbmpItem
= GetHBitmapForMenu(pItem
);
593 mii
.cch
= itemText
.length();
594 mii
.dwTypeData
= wxMSW_CONV_LPTSTR(itemText
);
596 if ( flags
& MF_POPUP
)
598 mii
.fMask
|= MIIM_SUBMENU
;
599 mii
.hSubMenu
= GetHmenuOf(pItem
->GetSubMenu());
603 mii
.fMask
|= MIIM_ID
;
607 mii
.dwItemData
= reinterpret_cast<ULONG_PTR
>(pItem
);
609 ok
= ::InsertMenuItem(GetHmenu(), pos
, TRUE
/* by pos */, &mii
);
612 wxLogLastError(wxT("InsertMenuItem()"));
614 else // InsertMenuItem() ok
616 // we need to remove the extra indent which is reserved for
617 // the checkboxes by default as it looks ugly unless check
618 // boxes are used together with bitmaps and this is not the
620 WinStruct
<MENUINFO
> mi
;
622 // don't call SetMenuInfo() directly, this would prevent
623 // the app from starting up under Windows 95/NT 4
624 typedef BOOL (WINAPI
*SetMenuInfo_t
)(HMENU
, MENUINFO
*);
626 wxDynamicLibrary
dllUser(wxT("user32"));
627 wxDYNLIB_FUNCTION(SetMenuInfo_t
, SetMenuInfo
, dllUser
);
628 if ( pfnSetMenuInfo
)
630 mi
.fMask
= MIM_STYLE
;
631 mi
.dwStyle
= MNS_CHECKORBMP
;
632 if ( !(*pfnSetMenuInfo
)(GetHmenu(), &mi
) )
634 wxLogLastError(wxT("SetMenuInfo(MNS_NOCHECK)"));
638 // tell the item that it's not really owner-drawn but only
639 // needs to draw its bitmap, the rest is done by Windows
640 pItem
->SetOwnerDrawn(false);
648 // item draws itself, pass pointer to it in data parameter
649 flags
|= MF_OWNERDRAW
;
650 pData
= (LPCTSTR
)pItem
;
652 bool updateAllMargins
= false;
654 // get size of bitmap always return valid value (0 for invalid bitmap),
655 // so we don't needed check if bitmap is valid ;)
656 int uncheckedW
= pItem
->GetBitmap(false).GetWidth();
657 int checkedW
= pItem
->GetBitmap(true).GetWidth();
659 if ( m_maxBitmapWidth
< uncheckedW
)
661 m_maxBitmapWidth
= uncheckedW
;
662 updateAllMargins
= true;
665 if ( m_maxBitmapWidth
< checkedW
)
667 m_maxBitmapWidth
= checkedW
;
668 updateAllMargins
= true;
671 // make other item ownerdrawn and update margin width for equals alignment
672 if ( !m_ownerDrawn
|| updateAllMargins
)
674 // we must use position in SetOwnerDrawnMenuItem because
675 // all separators have the same id
677 wxMenuItemList::compatibility_iterator node
= GetMenuItems().GetFirst();
680 wxMenuItem
* item
= node
->GetData();
682 if ( !item
->IsOwnerDrawn())
684 item
->SetOwnerDrawn(true);
685 SetOwnerDrawnMenuItem(GetHmenu(), pos
,
686 reinterpret_cast<ULONG_PTR
>(item
), TRUE
);
689 item
->SetMarginWidth(m_maxBitmapWidth
);
691 node
= node
->GetNext();
695 // set menu as ownerdrawn
698 ResetMaxAccelWidth();
700 // only update our margin for equals alignment to other item
701 else if ( !updateAllMargins
)
703 pItem
->SetMarginWidth(m_maxBitmapWidth
);
708 #endif // wxUSE_OWNER_DRAWN
710 // item is just a normal string (passed in data parameter)
714 itemText
= wxMenuItem::GetLabelText(itemText
);
717 pData
= itemText
.t_str();
720 // item might have already been inserted by InsertMenuItem() above
723 if ( !::InsertMenu(GetHmenu(), pos
, flags
| MF_BYPOSITION
, id
, pData
) )
725 wxLogLastError(wxT("InsertMenu[Item]()"));
732 // Check the item if it should be initially checked.
733 if ( checkInitially
)
736 // if we just appended the title, highlight it
737 if ( id
== (UINT_PTR
)idMenuTitle
)
739 // visually select the menu title
740 SetDefaultMenuItem(GetHmenu(), id
);
743 // if we're already attached to the menubar, we must update it
744 if ( IsAttached() && GetMenuBar()->IsAttached() )
746 GetMenuBar()->Refresh();
752 wxMenuItem
* wxMenu::DoAppend(wxMenuItem
*item
)
754 return wxMenuBase::DoAppend(item
) && DoInsertOrAppend(item
) ? item
: NULL
;
757 wxMenuItem
* wxMenu::DoInsert(size_t pos
, wxMenuItem
*item
)
759 if (wxMenuBase::DoInsert(pos
, item
) && DoInsertOrAppend(item
, pos
))
765 wxMenuItem
*wxMenu::DoRemove(wxMenuItem
*item
)
767 // we need to find the item's position in the child list
769 wxMenuItemList::compatibility_iterator node
= GetMenuItems().GetFirst();
770 for ( pos
= 0; node
; pos
++ )
772 if ( node
->GetData() == item
)
775 node
= node
->GetNext();
778 // DoRemove() (unlike Remove) can only be called for an existing item!
779 wxCHECK_MSG( node
, NULL
, wxT("bug in wxMenu::Remove logic") );
782 // remove the corresponding accel from the accel table
783 int n
= FindAccel(item
->GetId());
784 if ( n
!= wxNOT_FOUND
)
788 m_accels
.RemoveAt(n
);
790 #if wxUSE_OWNER_DRAWN
791 ResetMaxAccelWidth();
794 //else: this item doesn't have an accel, nothing to do
795 #endif // wxUSE_ACCEL
797 // remove the item from the menu
798 if ( !::RemoveMenu(GetHmenu(), (UINT
)pos
, MF_BYPOSITION
) )
800 wxLogLastError(wxT("RemoveMenu"));
803 if ( IsAttached() && GetMenuBar()->IsAttached() )
805 // otherwise, the change won't be visible
806 GetMenuBar()->Refresh();
809 // and from internal data structures
810 return wxMenuBase::DoRemove(item
);
813 // ---------------------------------------------------------------------------
814 // accelerator helpers
815 // ---------------------------------------------------------------------------
819 // create the wxAcceleratorEntries for our accels and put them into the provided
820 // array - return the number of accels we have
821 size_t wxMenu::CopyAccels(wxAcceleratorEntry
*accels
) const
823 size_t count
= GetAccelCount();
824 for ( size_t n
= 0; n
< count
; n
++ )
826 *accels
++ = *m_accels
[n
];
832 wxAcceleratorTable
*wxMenu::CreateAccelTable() const
834 const size_t count
= m_accels
.size();
835 wxScopedArray
<wxAcceleratorEntry
> accels(new wxAcceleratorEntry
[count
]);
836 CopyAccels(accels
.get());
838 return new wxAcceleratorTable(count
, accels
.get());
841 #endif // wxUSE_ACCEL
843 // ---------------------------------------------------------------------------
844 // ownerdrawn helpers
845 // ---------------------------------------------------------------------------
847 #if wxUSE_OWNER_DRAWN
849 void wxMenu::CalculateMaxAccelWidth()
851 wxASSERT_MSG( m_maxAccelWidth
== -1, wxT("it's really needed?") );
853 wxMenuItemList::compatibility_iterator node
= GetMenuItems().GetFirst();
856 wxMenuItem
* item
= node
->GetData();
858 if ( item
->IsOwnerDrawn() )
860 int width
= item
->MeasureAccelWidth();
861 if (width
> m_maxAccelWidth
)
862 m_maxAccelWidth
= width
;
865 node
= node
->GetNext();
869 #endif // wxUSE_OWNER_DRAWN
871 // ---------------------------------------------------------------------------
873 // ---------------------------------------------------------------------------
875 void wxMenu::SetTitle(const wxString
& label
)
877 bool hasNoTitle
= m_title
.empty();
880 HMENU hMenu
= GetHmenu();
884 if ( !label
.empty() )
886 if ( !::InsertMenu(hMenu
, 0u, MF_BYPOSITION
| MF_STRING
,
887 (UINT_PTR
)idMenuTitle
, m_title
.t_str()) ||
888 !::InsertMenu(hMenu
, 1u, MF_BYPOSITION
, (unsigned)-1, NULL
) )
890 wxLogLastError(wxT("InsertMenu"));
898 // remove the title and the separator after it
899 if ( !RemoveMenu(hMenu
, 0, MF_BYPOSITION
) ||
900 !RemoveMenu(hMenu
, 0, MF_BYPOSITION
) )
902 wxLogLastError(wxT("RemoveMenu"));
909 WinStruct
<MENUITEMINFO
> info
;
910 info
.fMask
= MIIM_TYPE
;
911 info
.fType
= MFT_STRING
;
912 info
.cch
= m_title
.length();
913 info
.dwTypeData
= wxMSW_CONV_LPTSTR(m_title
);
914 if ( !SetMenuItemInfo(hMenu
, 0, TRUE
, & info
) )
916 wxLogLastError(wxT("SetMenuItemInfo"));
919 if ( !ModifyMenu(hMenu
, 0u,
920 MF_BYPOSITION
| MF_STRING
,
921 (UINT_PTR
)idMenuTitle
, m_title
.t_str()) )
923 wxLogLastError(wxT("ModifyMenu"));
930 // put the title string in bold face
931 if ( !m_title
.empty() )
933 SetDefaultMenuItem(GetHmenu(), (UINT
)idMenuTitle
);
938 // ---------------------------------------------------------------------------
940 // ---------------------------------------------------------------------------
942 bool wxMenu::MSWCommand(WXUINT
WXUNUSED(param
), WXWORD id_
)
944 const int id
= (signed short)id_
;
946 // ignore commands from the menu title
947 if ( id
!= idMenuTitle
)
949 // Default value for uncheckable items.
952 // update the check item when it's clicked
953 wxMenuItem
* const item
= FindItem(id
);
954 if ( item
&& item
->IsCheckable() )
958 // Get the status of the menu item: note that it has been just changed
959 // by Toggle() above so here we already get the new state of the item.
961 // Also notice that we must pass unsigned id_ and not sign-extended id
962 // to ::GetMenuState() as this is what it expects.
963 UINT menuState
= ::GetMenuState(GetHmenu(), id_
, MF_BYCOMMAND
);
964 checked
= (menuState
& MF_CHECKED
) != 0;
967 SendEvent(id
, checked
);
973 // get the menu with given handle (recursively)
974 #if wxUSE_OWNER_DRAWN
975 wxMenu
* wxMenu::MSWGetMenu(WXHMENU hMenu
)
978 if ( GetHMenu() == hMenu
)
981 // recursively query submenus
982 for ( size_t n
= 0 ; n
< GetMenuItemCount(); ++n
)
984 wxMenuItem
* item
= FindItemByPosition(n
);
985 wxMenu
* submenu
= item
->GetSubMenu();
988 submenu
= submenu
->MSWGetMenu(hMenu
);
997 #endif // wxUSE_OWNER_DRAWN
999 // ---------------------------------------------------------------------------
1001 // ---------------------------------------------------------------------------
1003 void wxMenuBar::Init()
1005 m_eventHandler
= this;
1007 #if wxUSE_TOOLBAR && defined(__WXWINCE__)
1010 // Not using a combined wxToolBar/wxMenuBar? then use
1011 // a commandbar in WinCE .NET just to implement the
1013 #if defined(WINCE_WITH_COMMANDBAR)
1014 m_commandBar
= NULL
;
1015 m_adornmentsAdded
= false;
1019 wxMenuBar::wxMenuBar()
1024 wxMenuBar::wxMenuBar( long WXUNUSED(style
) )
1029 wxMenuBar::wxMenuBar(size_t count
, wxMenu
*menus
[], const wxString titles
[], long WXUNUSED(style
))
1033 for ( size_t i
= 0; i
< count
; i
++ )
1035 // We just want to store the menu title in the menu itself, not to
1036 // show it as a dummy item in the menu itself as we do with the popup
1037 // menu titles in overridden wxMenu::SetTitle().
1038 menus
[i
]->wxMenuBase::SetTitle(titles
[i
]);
1039 m_menus
.Append(menus
[i
]);
1041 menus
[i
]->Attach(this);
1045 wxMenuBar::~wxMenuBar()
1047 // In Windows CE (not .NET), the menubar is always associated
1048 // with a toolbar, which destroys the menu implicitly.
1049 #if defined(WINCE_WITHOUT_COMMANDBAR) && defined(__POCKETPC__)
1052 wxToolMenuBar
* toolMenuBar
= wxDynamicCast(GetToolBar(), wxToolMenuBar
);
1054 toolMenuBar
->SetMenuBar(NULL
);
1057 // we should free Windows resources only if Windows doesn't do it for us
1058 // which happens if we're attached to a frame
1059 if (m_hMenu
&& !IsAttached())
1061 #if defined(WINCE_WITH_COMMANDBAR)
1062 ::DestroyWindow((HWND
) m_commandBar
);
1063 m_commandBar
= (WXHWND
) NULL
;
1065 ::DestroyMenu((HMENU
)m_hMenu
);
1067 m_hMenu
= (WXHMENU
)NULL
;
1072 // ---------------------------------------------------------------------------
1073 // wxMenuBar helpers
1074 // ---------------------------------------------------------------------------
1076 void wxMenuBar::Refresh()
1081 wxCHECK_RET( IsAttached(), wxT("can't refresh unattached menubar") );
1083 #if defined(WINCE_WITHOUT_COMMANDBAR)
1086 CommandBar_DrawMenuBar((HWND
) GetToolBar()->GetHWND(), 0);
1088 #elif defined(WINCE_WITH_COMMANDBAR)
1090 DrawMenuBar((HWND
) m_commandBar
);
1092 DrawMenuBar(GetHwndOf(GetFrame()));
1096 WXHMENU
wxMenuBar::Create()
1098 // Note: this doesn't work at all on Smartphone,
1099 // since you have to use resources.
1100 // We'll have to find another way to add a menu
1101 // by changing/adding menu items to an existing menu.
1102 #if defined(WINCE_WITHOUT_COMMANDBAR)
1106 wxToolMenuBar
* const bar
= static_cast<wxToolMenuBar
*>(GetToolBar());
1110 HWND hCommandBar
= GetHwndOf(bar
);
1112 // notify comctl32.dll about the version of the headers we use before using
1113 // any other TB_XXX messages
1114 SendMessage(hCommandBar
, TB_BUTTONSTRUCTSIZE
, sizeof(TBBUTTON
), 0);
1117 wxZeroMemory(tbButton
);
1118 tbButton
.iBitmap
= I_IMAGENONE
;
1119 tbButton
.fsState
= TBSTATE_ENABLED
;
1120 tbButton
.fsStyle
= TBSTYLE_DROPDOWN
|
1121 TBSTYLE_NO_DROPDOWN_ARROW
|
1124 for ( unsigned i
= 0; i
< GetMenuCount(); i
++ )
1126 HMENU hPopupMenu
= (HMENU
) GetMenu(i
)->GetHMenu();
1127 tbButton
.dwData
= (DWORD
)hPopupMenu
;
1128 wxString label
= wxStripMenuCodes(GetMenuLabel(i
));
1129 tbButton
.iString
= (int) wxMSW_CONV_LPCTSTR(label
);
1131 tbButton
.idCommand
= NewControlId();
1132 if ( !::SendMessage(hCommandBar
, TB_INSERTBUTTON
, i
, (LPARAM
)&tbButton
) )
1134 wxLogLastError(wxT("TB_INSERTBUTTON"));
1138 m_hMenu
= bar
->GetHMenu();
1140 #else // !__WXWINCE__
1144 m_hMenu
= (WXHMENU
)::CreateMenu();
1148 wxLogLastError(wxT("CreateMenu"));
1152 for ( wxMenuList::iterator it
= m_menus
.begin();
1153 it
!= m_menus
.end();
1156 if ( !::AppendMenu((HMENU
)m_hMenu
, MF_POPUP
| MF_STRING
,
1157 (UINT_PTR
)(*it
)->GetHMenu(),
1158 (*it
)->GetTitle().t_str()) )
1160 wxLogLastError(wxT("AppendMenu"));
1166 #endif // __WXWINCE__/!__WXWINCE__
1169 int wxMenuBar::MSWPositionForWxMenu(wxMenu
*menu
, int wxpos
)
1172 wxASSERT(menu
->GetHMenu());
1175 #if defined(__WXWINCE__)
1176 int totalMSWItems
= GetMenuCount();
1178 int totalMSWItems
= GetMenuItemCount((HMENU
)m_hMenu
);
1181 int i
; // For old C++ compatibility
1182 for(i
=wxpos
; i
<totalMSWItems
; i
++)
1184 if(GetSubMenu((HMENU
)m_hMenu
,i
)==(HMENU
)menu
->GetHMenu())
1187 for(i
=0; i
<wxpos
; i
++)
1189 if(GetSubMenu((HMENU
)m_hMenu
,i
)==(HMENU
)menu
->GetHMenu())
1196 // ---------------------------------------------------------------------------
1197 // wxMenuBar functions to work with the top level submenus
1198 // ---------------------------------------------------------------------------
1200 // NB: we don't support owner drawn top level items for now, if we do these
1201 // functions would have to be changed to use wxMenuItem as well
1203 void wxMenuBar::EnableTop(size_t pos
, bool enable
)
1205 wxCHECK_RET( IsAttached(), wxT("doesn't work with unattached menubars") );
1206 wxCHECK_RET( pos
< GetMenuCount(), wxT("invalid menu index") );
1208 int flag
= enable
? MF_ENABLED
: MF_GRAYED
;
1210 EnableMenuItem((HMENU
)m_hMenu
, MSWPositionForWxMenu(GetMenu(pos
),pos
), MF_BYPOSITION
| flag
);
1215 bool wxMenuBar::IsEnabledTop(size_t pos
) const
1217 wxCHECK_MSG( pos
< GetMenuCount(), false, wxS("invalid menu index") );
1218 WinStruct
<MENUITEMINFO
> mii
;
1219 mii
.fMask
= MIIM_STATE
;
1220 if ( !::GetMenuItemInfo(GetHmenu(), pos
, TRUE
, &mii
) )
1222 wxLogLastError(wxS("GetMenuItemInfo(menubar)"));
1225 return !(mii
.fState
& MFS_GRAYED
);
1228 void wxMenuBar::SetMenuLabel(size_t pos
, const wxString
& label
)
1230 wxCHECK_RET( pos
< GetMenuCount(), wxT("invalid menu index") );
1232 m_menus
[pos
]->wxMenuBase::SetTitle(label
);
1234 if ( !IsAttached() )
1238 //else: have to modify the existing menu
1240 int mswpos
= MSWPositionForWxMenu(GetMenu(pos
),pos
);
1243 UINT flagsOld
= ::GetMenuState((HMENU
)m_hMenu
, mswpos
, MF_BYPOSITION
);
1244 if ( flagsOld
== 0xFFFFFFFF )
1246 wxLogLastError(wxT("GetMenuState"));
1251 if ( flagsOld
& MF_POPUP
)
1253 // HIBYTE contains the number of items in the submenu in this case
1255 id
= (UINT_PTR
)::GetSubMenu((HMENU
)m_hMenu
, mswpos
);
1263 WinStruct
<MENUITEMINFO
> info
;
1264 info
.fMask
= MIIM_TYPE
;
1265 info
.fType
= MFT_STRING
;
1266 info
.cch
= label
.length();
1267 info
.dwTypeData
= wxMSW_CONV_LPTSTR(label
);
1268 if ( !SetMenuItemInfo(GetHmenu(), id
, TRUE
, &info
) )
1270 wxLogLastError(wxT("SetMenuItemInfo"));
1274 if ( ::ModifyMenu(GetHmenu(), mswpos
, MF_BYPOSITION
| MF_STRING
| flagsOld
,
1275 id
, label
.t_str()) == (int)0xFFFFFFFF )
1277 wxLogLastError(wxT("ModifyMenu"));
1284 wxString
wxMenuBar::GetMenuLabel(size_t pos
) const
1286 wxCHECK_MSG( pos
< GetMenuCount(), wxEmptyString
,
1287 wxT("invalid menu index in wxMenuBar::GetMenuLabel") );
1289 return m_menus
[pos
]->GetTitle();
1292 // ---------------------------------------------------------------------------
1293 // wxMenuBar construction
1294 // ---------------------------------------------------------------------------
1296 wxMenu
*wxMenuBar::Replace(size_t pos
, wxMenu
*menu
, const wxString
& title
)
1298 wxMenu
*menuOld
= wxMenuBarBase::Replace(pos
, menu
, title
);
1302 menu
->wxMenuBase::SetTitle(title
);
1304 #if defined(WINCE_WITHOUT_COMMANDBAR)
1310 int mswpos
= MSWPositionForWxMenu(menuOld
,pos
);
1312 // can't use ModifyMenu() because it deletes the submenu it replaces
1313 if ( !::RemoveMenu(GetHmenu(), (UINT
)mswpos
, MF_BYPOSITION
) )
1315 wxLogLastError(wxT("RemoveMenu"));
1318 if ( !::InsertMenu(GetHmenu(), (UINT
)mswpos
,
1319 MF_BYPOSITION
| MF_POPUP
| MF_STRING
,
1320 (UINT_PTR
)GetHmenuOf(menu
), title
.t_str()) )
1322 wxLogLastError(wxT("InsertMenu"));
1326 if ( menuOld
->HasAccels() || menu
->HasAccels() )
1328 // need to rebuild accell table
1329 RebuildAccelTable();
1331 #endif // wxUSE_ACCEL
1340 bool wxMenuBar::Insert(size_t pos
, wxMenu
*menu
, const wxString
& title
)
1342 // Find out which MSW item before which we'll be inserting before
1343 // wxMenuBarBase::Insert is called and GetMenu(pos) is the new menu.
1344 // If IsAttached() is false this won't be used anyway
1346 #if defined(WINCE_WITHOUT_COMMANDBAR)
1352 int mswpos
= (!isAttached
|| (pos
== m_menus
.GetCount()))
1353 ? -1 // append the menu
1354 : MSWPositionForWxMenu(GetMenu(pos
),pos
);
1356 if ( !wxMenuBarBase::Insert(pos
, menu
, title
) )
1359 menu
->wxMenuBase::SetTitle(title
);
1363 #if defined(WINCE_WITHOUT_COMMANDBAR)
1367 memset(&tbButton
, 0, sizeof(TBBUTTON
));
1368 tbButton
.iBitmap
= I_IMAGENONE
;
1369 tbButton
.fsState
= TBSTATE_ENABLED
;
1370 tbButton
.fsStyle
= TBSTYLE_DROPDOWN
| TBSTYLE_NO_DROPDOWN_ARROW
| TBSTYLE_AUTOSIZE
;
1372 HMENU hPopupMenu
= (HMENU
) menu
->GetHMenu() ;
1373 tbButton
.dwData
= (DWORD
)hPopupMenu
;
1374 wxString label
= wxStripMenuCodes(title
);
1375 tbButton
.iString
= (int) wxMSW_CONV_LPCTSTR(label
);
1377 tbButton
.idCommand
= NewControlId();
1378 if (!::SendMessage((HWND
) GetToolBar()->GetHWND(), TB_INSERTBUTTON
, pos
, (LPARAM
)&tbButton
))
1380 wxLogLastError(wxT("TB_INSERTBUTTON"));
1383 wxUnusedVar(mswpos
);
1385 if ( !::InsertMenu(GetHmenu(), mswpos
,
1386 MF_BYPOSITION
| MF_POPUP
| MF_STRING
,
1387 (UINT_PTR
)GetHmenuOf(menu
), title
.t_str()) )
1389 wxLogLastError(wxT("InsertMenu"));
1393 if ( menu
->HasAccels() )
1395 // need to rebuild accell table
1396 RebuildAccelTable();
1398 #endif // wxUSE_ACCEL
1407 bool wxMenuBar::Append(wxMenu
*menu
, const wxString
& title
)
1409 WXHMENU submenu
= menu
? menu
->GetHMenu() : 0;
1410 wxCHECK_MSG( submenu
, false, wxT("can't append invalid menu to menubar") );
1412 if ( !wxMenuBarBase::Append(menu
, title
) )
1415 menu
->wxMenuBase::SetTitle(title
);
1417 #if defined(WINCE_WITHOUT_COMMANDBAR)
1423 #if defined(WINCE_WITHOUT_COMMANDBAR)
1427 memset(&tbButton
, 0, sizeof(TBBUTTON
));
1428 tbButton
.iBitmap
= I_IMAGENONE
;
1429 tbButton
.fsState
= TBSTATE_ENABLED
;
1430 tbButton
.fsStyle
= TBSTYLE_DROPDOWN
| TBSTYLE_NO_DROPDOWN_ARROW
| TBSTYLE_AUTOSIZE
;
1432 size_t pos
= GetMenuCount();
1433 HMENU hPopupMenu
= (HMENU
) menu
->GetHMenu() ;
1434 tbButton
.dwData
= (DWORD
)hPopupMenu
;
1435 wxString label
= wxStripMenuCodes(title
);
1436 tbButton
.iString
= (int) wxMSW_CONV_LPCTSTR(label
);
1438 tbButton
.idCommand
= NewControlId();
1439 if (!::SendMessage((HWND
) GetToolBar()->GetHWND(), TB_INSERTBUTTON
, pos
, (LPARAM
)&tbButton
))
1441 wxLogLastError(wxT("TB_INSERTBUTTON"));
1445 if ( !::AppendMenu(GetHmenu(), MF_POPUP
| MF_STRING
,
1446 (UINT_PTR
)submenu
, title
.t_str()) )
1448 wxLogLastError(wxT("AppendMenu"));
1453 if ( menu
->HasAccels() )
1455 // need to rebuild accelerator table
1456 RebuildAccelTable();
1458 #endif // wxUSE_ACCEL
1467 wxMenu
*wxMenuBar::Remove(size_t pos
)
1469 wxMenu
*menu
= wxMenuBarBase::Remove(pos
);
1473 #if defined(WINCE_WITHOUT_COMMANDBAR)
1479 #if defined(WINCE_WITHOUT_COMMANDBAR)
1482 if (!::SendMessage((HWND
) GetToolBar()->GetHWND(), TB_DELETEBUTTON
, (UINT
) pos
, (LPARAM
) 0))
1484 wxLogLastError(wxT("TB_DELETEBUTTON"));
1488 if ( !::RemoveMenu(GetHmenu(), (UINT
)MSWPositionForWxMenu(menu
,pos
), MF_BYPOSITION
) )
1490 wxLogLastError(wxT("RemoveMenu"));
1495 if ( menu
->HasAccels() )
1497 // need to rebuild accell table
1498 RebuildAccelTable();
1500 #endif // wxUSE_ACCEL
1511 void wxMenuBar::RebuildAccelTable()
1513 // merge the accelerators of all menus into one accel table
1514 size_t nAccelCount
= 0;
1515 size_t i
, count
= GetMenuCount();
1516 wxMenuList::iterator it
;
1517 for ( i
= 0, it
= m_menus
.begin(); i
< count
; i
++, it
++ )
1519 nAccelCount
+= (*it
)->GetAccelCount();
1524 wxAcceleratorEntry
*accelEntries
= new wxAcceleratorEntry
[nAccelCount
];
1527 for ( i
= 0, it
= m_menus
.begin(); i
< count
; i
++, it
++ )
1529 nAccelCount
+= (*it
)->CopyAccels(&accelEntries
[nAccelCount
]);
1532 SetAcceleratorTable(wxAcceleratorTable(nAccelCount
, accelEntries
));
1534 delete [] accelEntries
;
1536 else // No (more) accelerators.
1538 SetAcceleratorTable(wxAcceleratorTable());
1542 #endif // wxUSE_ACCEL
1544 void wxMenuBar::Attach(wxFrame
*frame
)
1546 wxMenuBarBase::Attach(frame
);
1548 #if defined(WINCE_WITH_COMMANDBAR)
1552 m_commandBar
= (WXHWND
) CommandBar_Create(wxGetInstance(), (HWND
) frame
->GetHWND(), NewControlId());
1557 if (!CommandBar_InsertMenubarEx((HWND
) m_commandBar
, NULL
, (LPTSTR
) m_hMenu
, 0))
1559 wxLogLastError(wxT("CommandBar_InsertMenubarEx"));
1566 RebuildAccelTable();
1567 #endif // wxUSE_ACCEL
1570 #if defined(WINCE_WITH_COMMANDBAR)
1571 bool wxMenuBar::AddAdornments(long style
)
1573 if (m_adornmentsAdded
|| !m_commandBar
)
1576 if (style
& wxCLOSE_BOX
)
1578 if (!CommandBar_AddAdornments((HWND
) m_commandBar
, 0, 0))
1580 wxLogLastError(wxT("CommandBar_AddAdornments"));
1591 void wxMenuBar::Detach()
1593 wxMenuBarBase::Detach();
1596 // get the menu with given handle (recursively)
1597 wxMenu
* wxMenuBar::MSWGetMenu(WXHMENU hMenu
)
1599 wxCHECK_MSG( GetHMenu() != hMenu
, NULL
,
1600 wxT("wxMenuBar::MSWGetMenu(): menu handle is wxMenuBar, not wxMenu") );
1602 #if wxUSE_OWNER_DRAWN
1604 for ( size_t n
= 0 ; n
< GetMenuCount(); ++n
)
1606 wxMenu
* menu
= GetMenu(n
)->MSWGetMenu(hMenu
);
1616 #endif // wxUSE_MENUS