X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..0ddefeb07f03c1beac0dea55617ea50f3fdbcd8b:/docs/latex/wx/menuitem.tex diff --git a/docs/latex/wx/menuitem.tex b/docs/latex/wx/menuitem.tex index d780b742a7..f9f49bb8ae 100644 --- a/docs/latex/wx/menuitem.tex +++ b/docs/latex/wx/menuitem.tex @@ -95,6 +95,36 @@ Returns the help string associated with the menu item. Returns the menu item identifier. +\membersection{wxMenuItem::GetLabel}\label{wxmenuitemgetlabel} + +\constfunc{wxString}{GetLabel}{\void} + +Returns the text associated with the menu item without any accelerator +characaters it might contain. + +\wxheading{See also} + +\helpref{GetText}{wxmenuitemgettext}, +\helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext} + +\membersection{wxMenuItem::GetLabelFromText}\label{wxmenuitemgetlabelfromtext} + +\func{static wxString}{GetLabelFromText}{\param{const wxString\& }{text}} + +Strips all accelerator characeters and mnemonics from the given {\it text}. +For example, + +\begin{verbatim} +wxMenuItem::GetLabelFromText("&Hello\tCtrl-H"); +\end{verbatim} + +will return just {\tt "Hello"}. + +\wxheading{See also} + +\helpref{GetText}{wxmenuitemgettext}, +\helpref{GetLabel}{wxmenuitemgetlabel} + \membersection{wxMenuItem::GetMarginWidth}\label{wxmenuitemgetmarginwidth} \constfunc{int}{GetMarginWidth}{\void} @@ -107,6 +137,22 @@ Gets the width of the menu item checkmark bitmap (Windows only). Returns the text associated with the menu item. +{\bf NB:} this function is deprecated, please use +\helpref{GetText}{wxmenuitemgettext} or \helpref{GetLabel}{wxmenuitemgetlabel} +instead. + +\membersection{wxMenuItem::GetText}\label{wxmenuitemgettext} + +\constfunc{wxString}{GetText}{\void} + +Returns the text associated with the menu item, such as it was passed to the +wxMenuItem constructor, i.e. with any accelerator characters it may contain. + +\wxheading{See also} + +\helpref{GetLabel}{wxmenuitemgetlabel}, +\helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext} + \membersection{wxMenuItem::GetSubMenu}\label{wxmenuitemgetsubmenu} \constfunc{wxMenu*}{GetSubMenu}{\void} @@ -149,6 +195,13 @@ Returns TRUE if the item is a separator. Sets the background colour associated with the menu item (Windows only). +\membersection{wxMenuItem::SetBitmap}\label{wxmenuitemsetbitmap} + +\constfunc{void}{SetBitmap}{\param{const wxBitmap\& }{bmp}} + +Sets the bitmap for the menu item (Windows and GTK+ only). It is +equivalent to \helpref{SetBitmaps}{wxmenuitemsetbitmaps}(bmp, wxNullBitmap). + \membersection{wxMenuItem::SetBitmaps}\label{wxmenuitemsetbitmaps} \constfunc{void}{SetBitmaps}{\param{const wxBitmap\& }{checked}, @@ -187,9 +240,3 @@ Sets the text associated with the menu item. Sets the text colour associated with the menu item (Windows only). - - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "referenc" -%%% End: