]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/menuitem.tex
documented UngetWriteBuf overload
[wxWidgets.git] / docs / latex / wx / menuitem.tex
index 514383490313e8fec0ba393895433ca0bd257535..e371fda96d9cf9390c55d8d516c22a6b3b3f42ac 100644 (file)
@@ -26,7 +26,7 @@ wxOwnerDrawn (Windows only)\\
 
 \func{}{wxMenuItem}{\param{wxMenu*}{ parentMenu = NULL}, \param{int}{ id = ID\_SEPARATOR},
  \param{const wxString\& }{text = ""},  \param{const wxString\& }{helpString = ""},
- \param{wxItemKind }{kind = wxItem\_Normal}, \param{wxMenu*}{ subMenu = NULL}, }
+ \param{wxItemKind }{kind = wxITEM\_NORMAL}, \param{wxMenu*}{ subMenu = NULL}, }
 
 Constructs a wxMenuItem object.
 
@@ -36,12 +36,14 @@ Constructs a wxMenuItem object.
 
 \docparam{id}{Identifier for this menu item, or ID\_SEPARATOR to indicate a separator.}
 
-\docparam{text}{Text for the menu item, as shown on the menu.}
+\docparam{text}{Text for the menu item, as shown on the menu. An accelerator
+key can be specified using the ampersand '\&' character. In order to embed an
+ampersand character in the menu item text, the ampersand must be doubled.}
 
 \docparam{helpString}{Optional help string that will be shown on the status bar.}
 
-\docparam{kind}{May be {\tt wxItem\_Separator}, {\tt wxItem\_Normal}, 
-{\tt wxItem\_Check} or {\tt wxItem\_Radio}}
+\docparam{kind}{May be {\tt wxITEM\_SEPARATOR}, {\tt wxITEM\_NORMAL}, 
+{\tt wxITEM\_CHECK} or {\tt wxITEM\_RADIO}}
 
 \docparam{subMenu}{If non-NULL, indicates that the menu item is a submenu.}
 
@@ -103,15 +105,15 @@ Returns the menu item identifier.
 
 \constfunc{wxItemKind}{GetKind}{\void}
 
-Returns the item kind, one of {\tt wxItem\_Separator}, {\tt wxItem\_Normal}, 
-{\tt wxItem\_Check} or {\tt wxItem\_Radio}.
+Returns the item kind, one of {\tt wxITEM\_SEPARATOR}, {\tt wxITEM\_NORMAL}, 
+{\tt wxITEM\_CHECK} or {\tt wxITEM\_RADIO}.
 
 \membersection{wxMenuItem::GetLabel}\label{wxmenuitemgetlabel}
 
 \constfunc{wxString}{GetLabel}{\void}
 
 Returns the text associated with the menu item without any accelerator
-characaters it might contain.
+characters it might contain.
 
 \wxheading{See also}
 
@@ -122,7 +124,7 @@ characaters it might contain.
 
 \func{static wxString}{GetLabelFromText}{\param{const wxString\& }{text}}
 
-Strips all accelerator characeters and mnemonics from the given {\it text}.
+Strips all accelerator characters and mnemonics from the given {\it text}.
 For example,
 
 \begin{verbatim}