]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/menuitem.tex
Please add classes in alphabetical order
[wxWidgets.git] / docs / latex / wx / menuitem.tex
... / ...
CommitLineData
1\section{\class{wxMenuItem}}\label{wxmenuitem}
2
3A menu item represents an item in a popup menu. Note that the majority of this
4class is only implemented under Windows so far, but everything except fonts, colours and
5bitmaps can be achieved via wxMenu on all platforms.
6
7\wxheading{Derived from}
8
9wxOwnerDrawn (Windows only)\\
10\helpref{wxObject}{wxobject}
11
12\wxheading{Include files}
13
14<wx/menuitem.h>
15
16\wxheading{See also}
17
18\helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}
19
20\latexignore{\rtfignore{\wxheading{Members}}}
21
22\membersection{wxMenuItem::wxMenuItem}\label{wxmenuitemconstr}
23
24\func{}{wxMenuItem}{\param{wxMenu*}{ parentMenu = NULL}, \param{int}{ id = ID\_SEPARATOR},
25 \param{const wxString\& }{text = ""}, \param{const wxString\& }{helpString = ""},
26 \param{bool }{checkable = FALSE}, \param{wxMenu*}{ subMenu = NULL}, }
27
28Constructs a wxMenuItem object.
29
30\wxheading{Parameters}
31
32\docparam{parentMenu}{Menu that the menu item belongs to.}
33
34\docparam{id}{Identifier for this menu item, or ID\_SEPARATOR to indicate a separator.}
35
36\docparam{text}{Text for the menu item, as shown on the menu.}
37
38\docparam{helpString}{Optional help string that will be shown on the status bar.}
39
40\docparam{checkable}{TRUE if this menu item is checkable.}
41
42\docparam{subMenu}{If non-NULL, indicates that the menu item is a submenu.}
43
44\membersection{wxMenuItem::\destruct{wxMenuItem}}
45
46\func{}{\destruct{wxMenuItem}}{\void}
47
48Destructor.
49
50\membersection{wxMenuItem::Check}\label{wxmenuitemcheck}
51
52\func{void}{Check}{\param{bool}{ check}}
53
54Checks or unchecks the menu item.
55
56\membersection{wxMenuItem::DeleteSubMenu}\label{wxmenuitemdeletesubmenu}
57
58\func{void}{DeleteSubMenu}{\void}
59
60Deletes the submenu, if any.
61
62\membersection{wxMenuItem::Enable}\label{wxmenuitemenable}
63
64\func{void}{Enable}{\param{bool}{ enable}}
65
66Enables or disables the menu item.
67
68\membersection{wxMenuItem::GetBackgroundColour}\label{wxmenuitemgetbackgroundcolour}
69
70\constfunc{wxColour\&}{GetBackgroundColour}{\void}
71
72Returns the background colour associated with the menu item (Windows only).
73
74\membersection{wxMenuItem::GetBitmap}\label{wxmenuitemgetbitmap}
75
76\constfunc{wxBitmap\&}{GetBitmap}{\param{bool}{ checked = TRUE}}
77
78Returns the checked or unchecked bitmap (Windows only).
79
80\membersection{wxMenuItem::GetFont}\label{wxmenuitemgetfont}
81
82\constfunc{wxFont\&}{GetFont}{\void}
83
84Returns the font associated with the menu item (Windows only).
85
86\membersection{wxMenuItem::GetHelp}\label{wxmenuitemgethelp}
87
88\constfunc{wxString}{GetHelp}{\void}
89
90Returns the help string associated with the menu item.
91
92\membersection{wxMenuItem::GetId}\label{wxmenuitemgetid}
93
94\constfunc{int}{GetId}{\void}
95
96Returns the menu item identifier.
97
98\membersection{wxMenuItem::GetLabel}\label{wxmenuitemgetlabel}
99
100\constfunc{wxString}{GetLabel}{\void}
101
102Returns the text associated with the menu item without any accelerator
103characaters it might contain.
104
105\wxheading{See also}
106
107\helpref{GetText}{wxmenuitemgettext},
108\helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext}
109
110\membersection{wxMenuItem::GetLabelFromText}\label{wxmenuitemgetlabelfromtext}
111
112\func{static wxString}{GetLabelFromText}{\param{const wxString\& }{text}}
113
114Strips all accelerator characeters and mnemonics from the given {\it text}.
115For example,
116
117\begin{verbatim}
118wxMenuItem::GetLabelFromText("&Hello\tCtrl-H");
119\end{verbatim}
120
121will return just {\tt "Hello"}.
122
123\wxheading{See also}
124
125\helpref{GetText}{wxmenuitemgettext},
126\helpref{GetLabel}{wxmenuitemgetlabel}
127
128\membersection{wxMenuItem::GetMarginWidth}\label{wxmenuitemgetmarginwidth}
129
130\constfunc{int}{GetMarginWidth}{\void}
131
132Gets the width of the menu item checkmark bitmap (Windows only).
133
134\membersection{wxMenuItem::GetName}\label{wxmenuitemgetname}
135
136\constfunc{wxString}{GetName}{\void}
137
138Returns the text associated with the menu item.
139
140{\bf NB:} this function is deprecated, please use
141\helpref{GetText}{wxmenuitemgettext} or \helpref{GetLabel}{wxmenuitemgetlabel}
142instead.
143
144\membersection{wxMenuItem::GetText}\label{wxmenuitemgettext}
145
146\constfunc{wxString}{GetText}{\void}
147
148Returns the text associated with the menu item, such as it was passed to the
149wxMenuItem constructor, i.e. with any accelerator characters it may contain.
150
151\wxheading{See also}
152
153\helpref{GetLabel}{wxmenuitemgetlabel},
154\helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext}
155
156\membersection{wxMenuItem::GetSubMenu}\label{wxmenuitemgetsubmenu}
157
158\constfunc{wxMenu*}{GetSubMenu}{\void}
159
160Returns the submenu associated with the menu item, or NULL if there isn't one.
161
162\membersection{wxMenuItem::GetTextColour}\label{wxmenuitemgettextcolour}
163
164\constfunc{wxColour\&}{GetTextColour}{\void}
165
166Returns the text colour associated with the menu item (Windows only).
167
168\membersection{wxMenuItem::IsCheckable}\label{wxmenuitemischeckable}
169
170\constfunc{bool}{IsCheckable}{\void}
171
172Returns TRUE if the item is checkable.
173
174\membersection{wxMenuItem::IsChecked}\label{wxmenuitemischecked}
175
176\constfunc{bool}{IsChecked}{\void}
177
178Returns TRUE if the item is checked.
179
180\membersection{wxMenuItem::IsEnabled}\label{wxmenuitemisenabled}
181
182\constfunc{bool}{IsEnabled}{\void}
183
184Returns TRUE if the item is enabled.
185
186\membersection{wxMenuItem::IsSeparator}\label{wxmenuitemisseparator}
187
188\constfunc{bool}{IsSeparator}{\void}
189
190Returns TRUE if the item is a separator.
191
192\membersection{wxMenuItem::SetBackgroundColour}\label{wxmenuitemsetbackgroundcolour}
193
194\constfunc{void}{SetBackgroundColour}{\param{const wxColour\& }{colour}}
195
196Sets the background colour associated with the menu item (Windows only).
197
198\membersection{wxMenuItem::SetBitmaps}\label{wxmenuitemsetbitmaps}
199
200\constfunc{void}{SetBitmaps}{\param{const wxBitmap\& }{checked},
201 \param{const wxBitmap\& }{unchecked = wxNullBitmap}}
202
203Sets the checked/unchecked bitmaps for the menu item (Windows only). The first bitmap
204is also used as the single bitmap for uncheckable menu items.
205
206\membersection{wxMenuItem::SetFont}\label{wxmenuitemsetfont}
207
208\constfunc{void}{SetFont}{\param{const wxFont\& }{font}}
209
210Sets the font associated with the menu item (Windows only).
211
212\membersection{wxMenuItem::SetHelp}\label{wxmenuitemsethelp}
213
214\constfunc{void}{SetHelp}{\param{const wxString\& }{helpString}}
215
216Sets the help string.
217
218\membersection{wxMenuItem::SetMarginWidth}\label{wxmenuitemsetmarginwidth}
219
220\constfunc{void}{SetMarginWidth}{\param{int}{ width}}
221
222Sets the width of the menu item checkmark bitmap (Windows only).
223
224\membersection{wxMenuItem::SetName}\label{wxmenuitemsetname}
225
226\constfunc{void}{SetName}{\param{const wxString\& }{text}}
227
228Sets the text associated with the menu item.
229
230\membersection{wxMenuItem::SetTextColour}\label{wxmenuitemsettextcolour}
231
232\constfunc{void}{SetTextColour}{\param{const wxColour\& }{colour}}
233
234Sets the text colour associated with the menu item (Windows only).
235
236
237
238%%% Local Variables:
239%%% mode: latex
240%%% TeX-master: "referenc"
241%%% End: