]>
Commit | Line | Data |
---|---|---|
1 | /////////////////////////////////////////////////////////////////////////////// | |
2 | // Name: src/msw/menuitem.cpp | |
3 | // Purpose: wxMenuItem implementation | |
4 | // Author: Vadim Zeitlin | |
5 | // Modified by: | |
6 | // Created: 11.11.97 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr> | |
9 | // Licence: wxWindows licence | |
10 | /////////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | // =========================================================================== | |
13 | // declarations | |
14 | // =========================================================================== | |
15 | ||
16 | // --------------------------------------------------------------------------- | |
17 | // headers | |
18 | // --------------------------------------------------------------------------- | |
19 | ||
20 | // For compilers that support precompilation, includes "wx.h". | |
21 | #include "wx/wxprec.h" | |
22 | ||
23 | #ifdef __BORLANDC__ | |
24 | #pragma hdrstop | |
25 | #endif | |
26 | ||
27 | #if wxUSE_MENUS | |
28 | ||
29 | #include "wx/menuitem.h" | |
30 | #include "wx/stockitem.h" | |
31 | ||
32 | #ifndef WX_PRECOMP | |
33 | #include "wx/font.h" | |
34 | #include "wx/bitmap.h" | |
35 | #include "wx/settings.h" | |
36 | #include "wx/window.h" | |
37 | #include "wx/accel.h" | |
38 | #include "wx/string.h" | |
39 | #include "wx/log.h" | |
40 | #include "wx/menu.h" | |
41 | #endif | |
42 | ||
43 | #if wxUSE_ACCEL | |
44 | #include "wx/accel.h" | |
45 | #endif // wxUSE_ACCEL | |
46 | ||
47 | #include "wx/msw/private.h" | |
48 | ||
49 | #ifdef __WXWINCE__ | |
50 | // Implemented in menu.cpp | |
51 | UINT GetMenuState(HMENU hMenu, UINT id, UINT flags) ; | |
52 | #endif | |
53 | ||
54 | // --------------------------------------------------------------------------- | |
55 | // macro | |
56 | // --------------------------------------------------------------------------- | |
57 | ||
58 | // hide the ugly cast | |
59 | #define GetHMenuOf(menu) ((HMENU)menu->GetHMenu()) | |
60 | ||
61 | // conditional compilation | |
62 | #if wxUSE_OWNER_DRAWN | |
63 | #define OWNER_DRAWN_ONLY( code ) if ( IsOwnerDrawn() ) code | |
64 | #else // !wxUSE_OWNER_DRAWN | |
65 | #define OWNER_DRAWN_ONLY( code ) | |
66 | #endif // wxUSE_OWNER_DRAWN/!wxUSE_OWNER_DRAWN | |
67 | ||
68 | // ============================================================================ | |
69 | // implementation | |
70 | // ============================================================================ | |
71 | ||
72 | // ---------------------------------------------------------------------------- | |
73 | // dynamic classes implementation | |
74 | // ---------------------------------------------------------------------------- | |
75 | ||
76 | #if wxUSE_EXTENDED_RTTI | |
77 | ||
78 | bool wxMenuItemStreamingCallback( const wxObject *object, wxWriter * , wxPersister * , wxxVariantArray & ) | |
79 | { | |
80 | const wxMenuItem * mitem = dynamic_cast<const wxMenuItem*>(object) ; | |
81 | if ( mitem->GetMenu() && !mitem->GetMenu()->GetTitle().empty() ) | |
82 | { | |
83 | // we don't stream out the first two items for menus with a title, they will be reconstructed | |
84 | if ( mitem->GetMenu()->FindItemByPosition(0) == mitem || mitem->GetMenu()->FindItemByPosition(1) == mitem ) | |
85 | return false ; | |
86 | } | |
87 | return true ; | |
88 | } | |
89 | ||
90 | wxBEGIN_ENUM( wxItemKind ) | |
91 | wxENUM_MEMBER( wxITEM_SEPARATOR ) | |
92 | wxENUM_MEMBER( wxITEM_NORMAL ) | |
93 | wxENUM_MEMBER( wxITEM_CHECK ) | |
94 | wxENUM_MEMBER( wxITEM_RADIO ) | |
95 | wxEND_ENUM( wxItemKind ) | |
96 | ||
97 | IMPLEMENT_DYNAMIC_CLASS_XTI_CALLBACK(wxMenuItem, wxObject,"wx/menuitem.h",wxMenuItemStreamingCallback) | |
98 | ||
99 | wxBEGIN_PROPERTIES_TABLE(wxMenuItem) | |
100 | wxPROPERTY( Parent,wxMenu*, SetMenu, GetMenu, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") ) | |
101 | wxPROPERTY( Id,int, SetId, GetId, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") ) | |
102 | wxPROPERTY( Text, wxString , SetText, GetText, wxString(), 0 /*flags*/ , wxT("Helpstring") , wxT("group") ) | |
103 | wxPROPERTY( Help, wxString , SetHelp, GetHelp, wxString(), 0 /*flags*/ , wxT("Helpstring") , wxT("group") ) | |
104 | wxREADONLY_PROPERTY( Kind, wxItemKind , GetKind , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") ) | |
105 | wxPROPERTY( SubMenu,wxMenu*, SetSubMenu, GetSubMenu, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") ) | |
106 | wxPROPERTY( Enabled , bool , Enable , IsEnabled , wxxVariant((bool)true) , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) | |
107 | wxPROPERTY( Checked , bool , Check , IsChecked , wxxVariant((bool)false) , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) | |
108 | wxPROPERTY( Checkable , bool , SetCheckable , IsCheckable , wxxVariant((bool)false) , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) | |
109 | wxEND_PROPERTIES_TABLE() | |
110 | ||
111 | wxBEGIN_HANDLERS_TABLE(wxMenuItem) | |
112 | wxEND_HANDLERS_TABLE() | |
113 | ||
114 | wxDIRECT_CONSTRUCTOR_6( wxMenuItem , wxMenu* , Parent , int , Id , wxString , Text , wxString , Help , wxItemKind , Kind , wxMenu* , SubMenu ) | |
115 | #else | |
116 | IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject) | |
117 | #endif | |
118 | ||
119 | // ---------------------------------------------------------------------------- | |
120 | // wxMenuItem | |
121 | // ---------------------------------------------------------------------------- | |
122 | ||
123 | // ctor & dtor | |
124 | // ----------- | |
125 | ||
126 | wxMenuItem::wxMenuItem(wxMenu *pParentMenu, | |
127 | int id, | |
128 | const wxString& text, | |
129 | const wxString& strHelp, | |
130 | wxItemKind kind, | |
131 | wxMenu *pSubMenu) | |
132 | : wxMenuItemBase(pParentMenu, id, text, strHelp, kind, pSubMenu) | |
133 | #if wxUSE_OWNER_DRAWN | |
134 | , wxOwnerDrawn(text, kind == wxITEM_CHECK, true) | |
135 | #endif // owner drawn | |
136 | { | |
137 | Init(); | |
138 | } | |
139 | ||
140 | #if WXWIN_COMPATIBILITY_2_8 | |
141 | wxMenuItem::wxMenuItem(wxMenu *parentMenu, | |
142 | int id, | |
143 | const wxString& text, | |
144 | const wxString& help, | |
145 | bool isCheckable, | |
146 | wxMenu *subMenu) | |
147 | : wxMenuItemBase(parentMenu, id, text, help, | |
148 | isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu) | |
149 | #if wxUSE_OWNER_DRAWN | |
150 | , wxOwnerDrawn(text, isCheckable, true) | |
151 | #endif // owner drawn | |
152 | { | |
153 | Init(); | |
154 | } | |
155 | #endif | |
156 | ||
157 | void wxMenuItem::Init() | |
158 | { | |
159 | m_radioGroup.start = -1; | |
160 | m_isRadioGroupStart = false; | |
161 | ||
162 | #if wxUSE_OWNER_DRAWN | |
163 | ||
164 | // when the color is not valid, wxOwnerDraw takes the default ones. | |
165 | // If we set the colors here and they are changed by the user during | |
166 | // the execution, then the colors are not updated until the application | |
167 | // is restarted and our menus look bad | |
168 | SetTextColour(wxNullColour); | |
169 | SetBackgroundColour(wxNullColour); | |
170 | ||
171 | // setting default colors switched ownerdraw on: switch it off again | |
172 | ResetOwnerDrawn(); | |
173 | ||
174 | // switch ownerdraw back on if using a non default margin | |
175 | if ( !IsSeparator() ) | |
176 | SetMarginWidth(GetMarginWidth()); | |
177 | ||
178 | // tell the owner drawing code to show the accel string as well | |
179 | SetAccelString(m_text.AfterFirst(wxT('\t'))); | |
180 | #endif // wxUSE_OWNER_DRAWN | |
181 | } | |
182 | ||
183 | wxMenuItem::~wxMenuItem() | |
184 | { | |
185 | } | |
186 | ||
187 | // misc | |
188 | // ---- | |
189 | ||
190 | // return the id for calling Win32 API functions | |
191 | WXWPARAM wxMenuItem::GetMSWId() const | |
192 | { | |
193 | // we must use ids in unsigned short range with Windows functions, if we | |
194 | // pass ids > USHRT_MAX to them they get very confused (e.g. start | |
195 | // generating WM_COMMAND messages with negative high word of wParam), so | |
196 | // use the cast to ensure the id is in range | |
197 | return m_subMenu ? wxPtrToUInt(m_subMenu->GetHMenu()) | |
198 | : static_cast<unsigned short>(GetId()); | |
199 | } | |
200 | ||
201 | // get item state | |
202 | // -------------- | |
203 | ||
204 | bool wxMenuItem::IsChecked() const | |
205 | { | |
206 | // fix that RTTI is always getting the correct state (separators cannot be | |
207 | // checked, but the Windows call below returns true | |
208 | if ( IsSeparator() ) | |
209 | return false; | |
210 | ||
211 | // the item might not be attached to a menu yet | |
212 | // | |
213 | // TODO: shouldn't we just always call the base class version? It seems | |
214 | // like it ought to always be in sync | |
215 | if ( !m_parentMenu ) | |
216 | return wxMenuItemBase::IsChecked(); | |
217 | ||
218 | HMENU hmenu = GetHMenuOf(m_parentMenu); | |
219 | int flag = ::GetMenuState(hmenu, GetMSWId(), MF_BYCOMMAND); | |
220 | ||
221 | return (flag & MF_CHECKED) != 0; | |
222 | } | |
223 | ||
224 | // radio group stuff | |
225 | // ----------------- | |
226 | ||
227 | void wxMenuItem::SetAsRadioGroupStart() | |
228 | { | |
229 | m_isRadioGroupStart = true; | |
230 | } | |
231 | ||
232 | void wxMenuItem::SetRadioGroupStart(int start) | |
233 | { | |
234 | wxASSERT_MSG( !m_isRadioGroupStart, | |
235 | wxT("should only be called for the next radio items") ); | |
236 | ||
237 | m_radioGroup.start = start; | |
238 | } | |
239 | ||
240 | void wxMenuItem::SetRadioGroupEnd(int end) | |
241 | { | |
242 | wxASSERT_MSG( m_isRadioGroupStart, | |
243 | wxT("should only be called for the first radio item") ); | |
244 | ||
245 | m_radioGroup.end = end; | |
246 | } | |
247 | ||
248 | // change item state | |
249 | // ----------------- | |
250 | ||
251 | void wxMenuItem::Enable(bool enable) | |
252 | { | |
253 | if ( m_isEnabled == enable ) | |
254 | return; | |
255 | ||
256 | if ( m_parentMenu ) | |
257 | { | |
258 | long rc = EnableMenuItem(GetHMenuOf(m_parentMenu), | |
259 | GetMSWId(), | |
260 | MF_BYCOMMAND | | |
261 | (enable ? MF_ENABLED : MF_GRAYED)); | |
262 | ||
263 | if ( rc == -1 ) | |
264 | { | |
265 | wxLogLastError(wxT("EnableMenuItem")); | |
266 | } | |
267 | } | |
268 | ||
269 | wxMenuItemBase::Enable(enable); | |
270 | } | |
271 | ||
272 | void wxMenuItem::Check(bool check) | |
273 | { | |
274 | wxCHECK_RET( IsCheckable(), wxT("only checkable items may be checked") ); | |
275 | ||
276 | if ( m_isChecked == check ) | |
277 | return; | |
278 | ||
279 | if ( m_parentMenu ) | |
280 | { | |
281 | int flags = check ? MF_CHECKED : MF_UNCHECKED; | |
282 | HMENU hmenu = GetHMenuOf(m_parentMenu); | |
283 | ||
284 | if ( GetKind() == wxITEM_RADIO ) | |
285 | { | |
286 | // it doesn't make sense to uncheck a radio item -- what would this | |
287 | // do? | |
288 | if ( !check ) | |
289 | return; | |
290 | ||
291 | // get the index of this item in the menu | |
292 | const wxMenuItemList& items = m_parentMenu->GetMenuItems(); | |
293 | int pos = items.IndexOf(this); | |
294 | wxCHECK_RET( pos != wxNOT_FOUND, | |
295 | wxT("menuitem not found in the menu items list?") ); | |
296 | ||
297 | // get the radio group range | |
298 | int start, | |
299 | end; | |
300 | ||
301 | if ( m_isRadioGroupStart ) | |
302 | { | |
303 | // we already have all information we need | |
304 | start = pos; | |
305 | end = m_radioGroup.end; | |
306 | } | |
307 | else // next radio group item | |
308 | { | |
309 | // get the radio group end from the start item | |
310 | start = m_radioGroup.start; | |
311 | end = items.Item(start)->GetData()->m_radioGroup.end; | |
312 | } | |
313 | ||
314 | #ifdef __WIN32__ | |
315 | // calling CheckMenuRadioItem() with such parameters hangs my system | |
316 | // (NT4 SP6) and I suspect this could happen to the others as well, | |
317 | // so don't do it! | |
318 | wxCHECK_RET( start != -1 && end != -1, | |
319 | wxT("invalid ::CheckMenuRadioItem() parameter(s)") ); | |
320 | ||
321 | if ( !::CheckMenuRadioItem(hmenu, | |
322 | start, // the first radio group item | |
323 | end, // the last one | |
324 | pos, // the one to check | |
325 | MF_BYPOSITION) ) | |
326 | { | |
327 | wxLogLastError(wxT("CheckMenuRadioItem")); | |
328 | } | |
329 | #endif // __WIN32__ | |
330 | ||
331 | // also uncheck all the other items in this radio group | |
332 | wxMenuItemList::compatibility_iterator node = items.Item(start); | |
333 | for ( int n = start; n <= end && node; n++ ) | |
334 | { | |
335 | if ( n != pos ) | |
336 | { | |
337 | node->GetData()->m_isChecked = false; | |
338 | } | |
339 | ||
340 | node = node->GetNext(); | |
341 | } | |
342 | } | |
343 | else // check item | |
344 | { | |
345 | if ( ::CheckMenuItem(hmenu, | |
346 | GetMSWId(), | |
347 | MF_BYCOMMAND | flags) == (DWORD)-1 ) | |
348 | { | |
349 | wxFAIL_MSG(wxT("CheckMenuItem() failed, item not in the menu?")); | |
350 | } | |
351 | } | |
352 | } | |
353 | ||
354 | wxMenuItemBase::Check(check); | |
355 | } | |
356 | ||
357 | void wxMenuItem::SetItemLabel(const wxString& txt) | |
358 | { | |
359 | wxString text = txt; | |
360 | ||
361 | // don't do anything if label didn't change | |
362 | if ( m_text == txt ) | |
363 | return; | |
364 | ||
365 | // wxMenuItemBase will do stock ID checks | |
366 | wxMenuItemBase::SetItemLabel(text); | |
367 | ||
368 | // m_text could now be different from 'text' if we are a stock menu item, | |
369 | // so use only m_text below | |
370 | ||
371 | OWNER_DRAWN_ONLY( wxOwnerDrawn::SetName(m_text) ); | |
372 | #if wxUSE_OWNER_DRAWN | |
373 | // tell the owner drawing code to to show the accel string as well | |
374 | SetAccelString(m_text.AfterFirst(wxT('\t'))); | |
375 | #endif | |
376 | ||
377 | // the item can be not attached to any menu yet and SetItemLabel() is still | |
378 | // valid to call in this case and should do nothing else | |
379 | if ( !m_parentMenu ) | |
380 | return; | |
381 | ||
382 | #if wxUSE_ACCEL | |
383 | m_parentMenu->UpdateAccel(this); | |
384 | #endif // wxUSE_ACCEL | |
385 | ||
386 | const UINT id = GetMSWId(); | |
387 | HMENU hMenu = GetHMenuOf(m_parentMenu); | |
388 | if ( !hMenu || ::GetMenuState(hMenu, id, MF_BYCOMMAND) == (UINT)-1 ) | |
389 | return; | |
390 | ||
391 | #if wxUSE_OWNER_DRAWN | |
392 | if ( IsOwnerDrawn() ) | |
393 | { | |
394 | // we don't need to do anything for owner drawn items, they will redraw | |
395 | // themselves using the new text the next time they're displayed | |
396 | return; | |
397 | } | |
398 | #endif // owner drawn | |
399 | ||
400 | // update the text of the native menu item | |
401 | WinStruct<MENUITEMINFO> info; | |
402 | ||
403 | // surprisingly, calling SetMenuItemInfo() with just MIIM_STRING doesn't | |
404 | // work as it resets the menu bitmap, so we need to first get the old item | |
405 | // state and then modify it | |
406 | const bool isLaterThanWin95 = wxGetWinVersion() > wxWinVersion_95; | |
407 | info.fMask = MIIM_STATE | | |
408 | MIIM_ID | | |
409 | MIIM_SUBMENU | | |
410 | MIIM_CHECKMARKS | | |
411 | MIIM_DATA; | |
412 | if ( isLaterThanWin95 ) | |
413 | info.fMask |= MIIM_BITMAP | MIIM_FTYPE; | |
414 | else | |
415 | info.fMask |= MIIM_TYPE; | |
416 | if ( !::GetMenuItemInfo(hMenu, id, FALSE, &info) ) | |
417 | { | |
418 | wxLogLastError(wxT("GetMenuItemInfo")); | |
419 | return; | |
420 | } | |
421 | ||
422 | if ( isLaterThanWin95 ) | |
423 | info.fMask |= MIIM_STRING; | |
424 | //else: MIIM_TYPE already specified | |
425 | info.dwTypeData = (LPTSTR)m_text.wx_str(); | |
426 | info.cch = m_text.length(); | |
427 | if ( !::SetMenuItemInfo(hMenu, id, FALSE, &info) ) | |
428 | { | |
429 | wxLogLastError(wxT("SetMenuItemInfo")); | |
430 | } | |
431 | } | |
432 | ||
433 | void wxMenuItem::SetCheckable(bool checkable) | |
434 | { | |
435 | wxMenuItemBase::SetCheckable(checkable); | |
436 | OWNER_DRAWN_ONLY( wxOwnerDrawn::SetCheckable(checkable) ); | |
437 | } | |
438 | ||
439 | // ---------------------------------------------------------------------------- | |
440 | // wxMenuItemBase | |
441 | // ---------------------------------------------------------------------------- | |
442 | ||
443 | wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu, | |
444 | int id, | |
445 | const wxString& name, | |
446 | const wxString& help, | |
447 | wxItemKind kind, | |
448 | wxMenu *subMenu) | |
449 | { | |
450 | return new wxMenuItem(parentMenu, id, name, help, kind, subMenu); | |
451 | } | |
452 | ||
453 | #endif // wxUSE_MENUS |