documented wxInitialize and wxUnitialize

[wxWidgets.git] / docs / latex / wx / menuitem.tex

diff --git a/docs/latex/wx/menuitem.tex b/docs/latex/wx/menuitem.tex
index 35204ef6cfa525e8be1096d1d1a7af5aaf78e4e1..f9f49bb8aeebded964c69a8e181df295b643c461 100644 (file)
--- a/docs/latex/wx/menuitem.tex
+++ b/docs/latex/wx/menuitem.tex
@@ -9,9 +9,13 @@ bitmaps can be achieved via wxMenu on all platforms.
 wxOwnerDrawn (Windows only)\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/menuitem.h>
+
 \wxheading{See also}
 
-\helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}, \helpref{wxOwnerDrawn}{wxownerdrawn}
+\helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -91,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}
@@ -103,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}
@@ -141,27 +191,34 @@ Returns TRUE if the item is a separator.
 
 \membersection{wxMenuItem::SetBackgroundColour}\label{wxmenuitemsetbackgroundcolour}
 
-\constfunc{void}{SetBackgroundColour}{\param{const wxColour& }{colour}}
+\constfunc{void}{SetBackgroundColour}{\param{const wxColour\& }{colour}}
 
 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},
- \param{const wxBitmap& }{unchecked = wxNullBitmap}}
+\constfunc{void}{SetBitmaps}{\param{const wxBitmap\& }{checked},
+ \param{const wxBitmap\& }{unchecked = wxNullBitmap}}
 
 Sets the checked/unchecked bitmaps for the menu item (Windows only). The first bitmap
 is also used as the single bitmap for uncheckable menu items.
 
 \membersection{wxMenuItem::SetFont}\label{wxmenuitemsetfont}
 
-\constfunc{void}{SetFont}{\param{const wxFont& }{font}}
+\constfunc{void}{SetFont}{\param{const wxFont\& }{font}}
 
 Sets the font associated with the menu item (Windows only).
 
 \membersection{wxMenuItem::SetHelp}\label{wxmenuitemsethelp}
 
-\constfunc{void}{SetHelp}{\param{const wxString& }{helpString}}
+\constfunc{void}{SetHelp}{\param{const wxString\& }{helpString}}
 
 Sets the help string.
 
@@ -173,14 +230,13 @@ Sets the width of the menu item checkmark bitmap (Windows only).
 
 \membersection{wxMenuItem::SetName}\label{wxmenuitemsetname}
 
-\constfunc{void}{SetName}{\param{const wxString& }{text}}
+\constfunc{void}{SetName}{\param{const wxString\& }{text}}
 
 Sets the text associated with the menu item.
 
 \membersection{wxMenuItem::SetTextColour}\label{wxmenuitemsettextcolour}
 
-\constfunc{void}{SetTextColour}{\param{const wxColour& }{colour}}
+\constfunc{void}{SetTextColour}{\param{const wxColour\& }{colour}}
 
 Sets the text colour associated with the menu item (Windows only).
 
-