X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4e6978c3febe33c51f13b14202f56bb1692f1106..fa10c70ceb3a08a11302c00c9f0e29941174a21b:/docs/latex/wx/menuitem.tex diff --git a/docs/latex/wx/menuitem.tex b/docs/latex/wx/menuitem.tex index 5143834903..9e2e331f48 100644 --- a/docs/latex/wx/menuitem.tex +++ b/docs/latex/wx/menuitem.tex @@ -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.} @@ -77,7 +79,7 @@ Returns the background colour associated with the menu item (Windows only). \membersection{wxMenuItem::GetBitmap}\label{wxmenuitemgetbitmap} -\constfunc{wxBitmap\&}{GetBitmap}{\param{bool}{ checked = TRUE}} +\constfunc{wxBitmap\&}{GetBitmap}{\param{bool}{ checked = true}} Returns the checked or unchecked bitmap (Windows only). @@ -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} @@ -180,25 +182,25 @@ Returns the text colour associated with the menu item (Windows only). \constfunc{bool}{IsCheckable}{\void} -Returns TRUE if the item is checkable. +Returns true if the item is checkable. \membersection{wxMenuItem::IsChecked}\label{wxmenuitemischecked} \constfunc{bool}{IsChecked}{\void} -Returns TRUE if the item is checked. +Returns true if the item is checked. \membersection{wxMenuItem::IsEnabled}\label{wxmenuitemisenabled} \constfunc{bool}{IsEnabled}{\void} -Returns TRUE if the item is enabled. +Returns true if the item is enabled. \membersection{wxMenuItem::IsSeparator}\label{wxmenuitemisseparator} \constfunc{bool}{IsSeparator}{\void} -Returns TRUE if the item is a separator. +Returns true if the item is a separator. \membersection{wxMenuItem::SetBackgroundColour}\label{wxmenuitemsetbackgroundcolour}