added wxHtmlHelpController::AddBook(wxFileName)

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

diff --git a/docs/latex/wx/menuitem.tex b/docs/latex/wx/menuitem.tex
index 00706c3f42a240a10f6f203f7c3a05d045d65475..16691f6bbb76dda85e835e45adbb8797357a3d59 100644 (file)
--- a/docs/latex/wx/menuitem.tex
+++ b/docs/latex/wx/menuitem.tex
@@ -1,17 +1,24 @@
 \section{\class{wxMenuItem}}\label{wxmenuitem}
 
-A menu item represents an item in a popup menu. Note that the majority of this
-class is only implemented under Windows so far, but everything except fonts, colours and
-bitmaps can be achieved via wxMenu on all platforms.
+A menu item represents an item in a menu. Note that you usually don't have to
+deal with it directly as \helpref{wxMenu}{wxmenu} methods usually construct an
+object of this class for you.
+
+Also please note that the methods related to fonts and bitmaps are currently
+only implemented for Windows.
 
 \wxheading{Derived from}
 
 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}}}
 
@@ -19,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{bool }{checkable = FALSE}, \param{wxMenu*}{ subMenu = NULL}, }
+ \param{wxItemKind }{kind = wxItem\_Normal}, \param{wxMenu*}{ subMenu = NULL}, }
 
 Constructs a wxMenuItem object.
 
@@ -29,11 +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{checkable}{TRUE if this menu item is checkable.}
+\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.}
 
@@ -91,6 +101,43 @@ Returns the help string associated with the menu item.
 
 Returns the menu item identifier.
 
+\membersection{wxMenuItem::GetKind}\label{wxmenuitemgetkind}
+
+\constfunc{wxItemKind}{GetKind}{\void}
+
+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
+characters 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 characters 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 +150,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}
@@ -145,6 +208,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},
@@ -171,9 +241,9 @@ Sets the help string.
 
 Sets the width of the menu item checkmark bitmap (Windows only).
 
-\membersection{wxMenuItem::SetName}\label{wxmenuitemsetname}
+\membersection{wxMenuItem::SetText}\label{wxmenuitemsettext}
 
-\constfunc{void}{SetName}{\param{const wxString\& }{text}}
+\constfunc{void}{SetText}{\param{const wxString\& }{text}}
 
 Sets the text associated with the menu item.
 
@@ -183,9 +253,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: