wxMGL compilation fixes

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

diff --git a/docs/latex/wx/menuitem.tex b/docs/latex/wx/menuitem.tex
index 35204ef6cfa525e8be1096d1d1a7af5aaf78e4e1..1484e46c9bd571f2bc5b13ad63a2b4c654622cef 100644 (file)
--- a/docs/latex/wx/menuitem.tex
+++ b/docs/latex/wx/menuitem.tex
@@ -1,25 +1,32 @@
 \section{\class{wxMenuItem}}\label{wxmenuitem}
 
 \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{Derived from}
 
 wxOwnerDrawn (Windows only)\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/menuitem.h>
+

 \wxheading{See also}
 
 \wxheading{See also}
 

-\helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}, \helpref{wxOwnerDrawn}{wxownerdrawn}
+\helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxMenuItem::wxMenuItem}\label{wxmenuitemconstr}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxMenuItem::wxMenuItem}\label{wxmenuitemconstr}
 

-\func{}{wxMenuItem}{\param{wxMenu*}{ parentMenu = NULL}, \param{int}{ id = ID\_SEPARATOR},
+\func{}{wxMenuItem}{\param{wxMenu*}{ parentMenu = NULL}, \param{int}{ id = wxID\_SEPARATOR},

  \param{const wxString\& }{text = ""},  \param{const wxString\& }{helpString = ""},
  \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.
 
 
 Constructs a wxMenuItem object.
 


@@ -27,13 +34,16 @@ Constructs a wxMenuItem object.
 
 \docparam{parentMenu}{Menu that the menu item belongs to.}
 
 
 \docparam{parentMenu}{Menu that the menu item belongs to.}
 

-\docparam{id}{Identifier for this menu item, or ID\_SEPARATOR to indicate a separator.}
+\docparam{id}{Identifier for this menu item, or wxID\_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{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.}
 
 
 \docparam{subMenu}{If non-NULL, indicates that the menu item is a submenu.}
 


@@ -69,7 +79,7 @@ Returns the background colour associated with the menu item (Windows only).
 
 \membersection{wxMenuItem::GetBitmap}\label{wxmenuitemgetbitmap}
 
 
 \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).
 
 
 Returns the checked or unchecked bitmap (Windows only).
 


@@ -91,6 +101,43 @@ Returns the help string associated with the menu item.
 
 Returns the menu item identifier.
 
 
 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}
 \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.
 
 
 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}
 \membersection{wxMenuItem::GetSubMenu}\label{wxmenuitemgetsubmenu}
 
 \constfunc{wxMenu*}{GetSubMenu}{\void}


@@ -119,49 +182,56 @@ Returns the text colour associated with the menu item (Windows only).
 
 \constfunc{bool}{IsCheckable}{\void}
 
 
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \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).
 
 
 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}
 
 \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}
 
 
 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}
 
 
 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.
 
 
 Sets the help string.
 


@@ -171,16 +241,15 @@ Sets the help string.
 
 Sets the width of the menu item checkmark bitmap (Windows only).
 
 
 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.
 
 \membersection{wxMenuItem::SetTextColour}\label{wxmenuitemsettextcolour}
 
 
 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).
 
 
 Sets the text colour associated with the menu item (Windows only).
 

-