]>
git.saurik.com Git - wxWidgets.git/blob - interface/menuitem.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxMenuItem
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
13 A menu item represents an item in a menu. Note that you usually don't have to
14 deal with it directly as wxMenu methods usually construct an
15 object of this class for you.
17 Also please note that the methods related to fonts and bitmaps are currently
18 only implemented for Windows and GTK+.
23 @see wxMenuBar, wxMenu
25 class wxMenuItem
: public wxObject
29 Constructs a wxMenuItem object.
30 Menu items can be standard, or "stock menu items", or custom. For the
31 standard menu items (such as commands to open a file, exit the program and so
32 on, see @ref page_stockitems "Stock Items" for the full list) it is enough
33 to specify just the stock ID and leave @a text and @a helpString empty. In
34 fact, leaving at least @a text empty for the stock menu items is strongly
35 recommended as they will have appearance and keyboard interface (including
36 standard accelerators) familiar to the user.
37 For the custom (non-stock) menu items, @a text must be specified and while
38 @a helpString may be left empty, it's recommended to pass the item
39 description (which is automatically shown by the library in the status bar when
40 the menu item is selected) in this parameter.
41 Finally note that you can e.g. use a stock menu label without using its stock
42 help string; that is, stock properties are set independently one from the other.
45 Menu that the menu item belongs to. Can be @NULL if the item is
46 going to be added to the menu later.
48 Identifier for this menu item. May be @c wxID_SEPARATOR, in which
49 case the given kind is ignored and taken to be @c wxITEM_SEPARATOR
52 Text for the menu item, as shown on the menu. An accelerator
53 key can be specified using the ampersand " character. In order to embed an
54 ampersand character in the menu item text, the ampersand must be doubled.
56 Optional help string that will be shown on the status bar.
58 May be @c wxITEM_SEPARATOR, @c wxITEM_NORMAL, @c wxITEM_CHECK or @c
61 If non-@NULL, indicates that the menu item is a submenu.
63 wxMenuItem(wxMenu
* parentMenu
= NULL
, int id
= wxID_SEPARATOR
,
64 const wxString
& text
= "",
65 const wxString
& helpString
= "",
66 wxItemKind kind
= wxITEM_NORMAL
,
67 wxMenu
* subMenu
= NULL
);
75 Checks or unchecks the menu item.
76 Note that this only works when the item is already appended to a menu.
78 void Check(bool check
= true);
81 Enables or disables the menu item.
83 void Enable(bool enable
= true);
86 Returns the background colour associated with the menu item (Windows only).
88 wxColour
GetBackgroundColour() const;
91 Returns the checked or unchecked bitmap (Windows only).
93 wxBitmap
GetBitmap(bool checked
= true) const;
96 Returns the font associated with the menu item (Windows only).
98 wxFont
GetFont() const;
101 Returns the help string associated with the menu item.
103 wxString
GetHelp() const;
106 Returns the menu item identifier.
111 Returns the text associated with the menu item including any accelerator
112 characters that were passed to the constructor or SetItemLabel.
114 @see GetItemLabelText(), GetLabelText()
116 wxString
GetItemLabel() const;
119 Returns the text associated with the menu item, without any accelerator
122 @see GetItemLabel(), GetLabelText()
124 wxString
GetItemLabelText() const;
127 Returns the item kind, one of @c wxITEM_SEPARATOR, @c wxITEM_NORMAL,
128 @c wxITEM_CHECK or @c wxITEM_RADIO.
130 wxItemKind
GetKind() const;
133 Returns the text associated with the menu item without any accelerator
134 characters it might contain.
135 @deprecated This function is deprecated in favour of GetItemLabelText().
136 @see GetText(), GetLabelFromText()
138 wxString
GetLabel() const;
141 @deprecated This function is deprecated; please use GetLabelText() instead.
142 @see GetText(), GetLabel()
144 static wxString
GetLabelFromText(const wxString
& text
);
147 Strips all accelerator characters and mnemonics from the given @e text.
151 wxMenuItem::GetLabelfromText( "&Hello\tCtrl-h");
154 will return just @c "Hello".
156 @see GetItemLabelText(), GetItemLabel()
158 static wxString
GetLabelText(const wxString
& text
);
161 Gets the width of the menu item checkmark bitmap (Windows only).
163 int GetMarginWidth() const;
166 Returns the menu this menu item is in, or @NULL if this menu item is not
169 wxMenu
* GetMenu() const;
172 Returns the text associated with the menu item.
173 @deprecated This function is deprecated. Please use
174 GetItemLabel() or GetItemLabelText() instead.
176 wxString
GetName() const;
179 Returns the submenu associated with the menu item, or @NULL if there isn't one.
181 wxMenu
* GetSubMenu() const;
184 Returns the text associated with the menu item, such as it was passed to the
185 wxMenuItem constructor, i.e. with any accelerator characters it may contain.
186 @deprecated This function is deprecated in favour of GetItemLabel().
187 @see GetLabel(), GetLabelFromText()
189 wxString
GetText() const;
192 Returns the text colour associated with the menu item (Windows only).
194 wxColour
GetTextColour() const;
197 Returns @true if the item is checkable.
199 bool IsCheckable() const;
202 Returns @true if the item is checked.
204 bool IsChecked() const;
207 Returns @true if the item is enabled.
209 bool IsEnabled() const;
212 Returns @true if the item is a separator.
214 bool IsSeparator() const;
217 Returns @true if the item is a submenu.
219 bool IsSubMenu() const;
222 Sets the background colour associated with the menu item (Windows only).
224 void SetBackgroundColour(const wxColour
& colour
) const;
227 Sets the bitmap for the menu item (Windows and GTK+ only). It is
228 equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap).
230 void SetBitmap(const wxBitmap
& bmp
);
233 Sets the checked/unchecked bitmaps for the menu item (Windows only). The first
235 is also used as the single bitmap for uncheckable menu items.
237 void SetBitmaps(const wxBitmap
& checked
,
238 const wxBitmap
& unchecked
= wxNullBitmap
);
241 Sets the font associated with the menu item (Windows only).
243 void SetFont(const wxFont
& font
);
246 Sets the help string.
248 void SetHelp(const wxString
& helpString
);
251 Sets the label associated with the menu item.
253 void SetItemLabel(const wxString
& label
);
256 Sets the width of the menu item checkmark bitmap (Windows only).
258 void SetMarginWidth(int width
) const;
261 Sets the parent menu which will contain this menu item.
263 void SetMenu(const wxMenu
* menu
);
266 Sets the submenu of this menu item.
268 void SetSubMenu(const wxMenu
* menu
);
271 Sets the text associated with the menu item.
272 @deprecated This function is deprecated in favour of SetItemLabel().
274 void SetText(const wxString
& text
);
277 Sets the text colour associated with the menu item (Windows only).
279 void SetTextColour(const wxColour
& colour
);