X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c436b310655047ec56f9f49668bf7dc7f98ac2cf..702a26fded8c16bf858631d929580441ba23fdc4:/docs/latex/wx/menuitem.tex?ds=sidebyside diff --git a/docs/latex/wx/menuitem.tex b/docs/latex/wx/menuitem.tex index 5cb61d9bd7..430d5e4e24 100644 --- a/docs/latex/wx/menuitem.tex +++ b/docs/latex/wx/menuitem.tex @@ -1,3 +1,14 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: menuitem.tex +%% Purpose: wxMenuItem documentation +%% Author: wxWidgets Team +%% Modified by: +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets Team +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxMenuItem}}\label{wxmenuitem} A menu item represents an item in a menu. Note that you usually don't have to @@ -9,13 +20,17 @@ only implemented for Windows and GTK+. \wxheading{Derived from} -wxOwnerDrawn (Windows only)\\ +% add wxOwnerDrawn once it is documented \helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{See also} \helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu} @@ -31,6 +46,37 @@ wxOwnerDrawn (Windows only)\\ Constructs a wxMenuItem object. +Menu items can be standard, or ``stock menu items'', or custom. For the +standard menu items (such as commands to open a file, exit the program and so +on, see \helpref{stock items}{stockitems} for the full list) it is enough to +specify just the stock ID and leave \arg{text} and \arg{helpString} empty. In +fact, leaving at least \arg{text} empty for the stock menu items is strongly +recommended as they will have appearance and keyboard interface (including +standard accelerators) familiar to the user. + +For the custom (non-stock) menu items, \arg{text} must be specified and while +\arg{helpString} may be left empty, it's recommended to pass the item +description (which is automatically shown by the library in the status bar when +the menu item is selected) in this parameter. + +Finally note that you can e.g. use a stock menu label without using its stock +help string: + +\begin{verbatim} +// use all stock properties: +helpMenu->Append(wxID_ABOUT); + +// use the stock label and the stock accelerator but not the stock help string: +helpMenu->Append(wxID_ABOUT, wxEmptyString, wxT("My custom help string")); + +// use all stock properties except for the bitmap: +wxMenuItem *mymenu = new wxMenuItem(helpMenu, wxID_ABOUT); +mymenu->SetBitmap(wxArtProvider::GetBitmap(wxART_WARNING)); +helpMenu->Append(mymenu); +\end{verbatim} + +that is, stock properties are set independently one from the other. + \wxheading{Parameters} \docparam{parentMenu}{Menu that the menu item belongs to.} @@ -107,6 +153,32 @@ Returns the help string associated with the menu item. Returns the menu item identifier. +\membersection{wxMenuItem::GetItemLabel}\label{wxmenuitemgetitemlabel} + +\constfunc{wxString}{GetItemLabel}{\void} + +Returns the text associated with the menu item including any accelerator +characters that were passed to the constructor or SetItemLabel. + +\wxheading{See also} + +\helpref{GetItemLabelText}{wxmenuitemgetitemlabeltext}, +\helpref{GetLabelText}{wxmenuitemgetlabeltext} + + +\membersection{wxMenuItem::GetItemLabelText}\label{wxmenuitemgetitemlabeltext} + +\constfunc{wxString}{GetItemLabelText}{\void} + +Returns the text associated with the menu item, without any accelerator +characters. + +\wxheading{See also} + +\helpref{GetItemLabel}{wxmenuitemgetitemlabel}, +\helpref{GetLabelText}{wxmenuitemgetlabeltext} + + \membersection{wxMenuItem::GetKind}\label{wxmenuitemgetkind} \constfunc{wxItemKind}{GetKind}{\void} @@ -122,11 +194,31 @@ Returns the item kind, one of {\tt wxITEM\_SEPARATOR}, {\tt wxITEM\_NORMAL}, Returns the text associated with the menu item without any accelerator characters it might contain. +This function is deprecated in favour of \helpref{GetItemLabelText}{wxmenuitemgetitemlabeltext}. + \wxheading{See also} \helpref{GetText}{wxmenuitemgettext}, \helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext} +\membersection{wxMenuItem::GetLabelText}\label{wxmenuitemgetlabeltext} + +\func{static wxString}{GetLabelText}{\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{GetItemLabelText}{wxmenuitemgetitemlabeltext}, +\helpref{GetItemLabel}{wxmenuitemgetitemlabel} + \membersection{wxMenuItem::GetLabelFromText}\label{wxmenuitemgetlabelfromtext} @@ -141,6 +233,8 @@ wxMenuItem::GetLabelFromText("&Hello\tCtrl-H"); will return just {\tt "Hello"}. +This function is deprecated; please use \helpref{wxMenuItem::GetLabelText}{wxmenuitemgetlabeltext} instead. + \wxheading{See also} \helpref{GetText}{wxmenuitemgettext}, @@ -154,6 +248,13 @@ will return just {\tt "Hello"}. Gets the width of the menu item checkmark bitmap (Windows only). +\membersection{wxMenuItem::GetMenu}\label{wxmenuitemgetmenu} + +\constfunc{wxMenu*}{GetMenu}{\void} + +Returns the menu this menu item is in, or NULL if this menu item is not attached. + + \membersection{wxMenuItem::GetName}\label{wxmenuitemgetname} \constfunc{wxString}{GetName}{\void} @@ -161,7 +262,7 @@ 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} +\helpref{GetItemLabel}{wxmenuitemgetitemlabel} or \helpref{GetItemLabelText}{wxmenuitemgetitemlabeltext} instead. @@ -172,6 +273,8 @@ instead. 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. +This function is deprecated in favour of \helpref{GetItemLabel}{wxmenuitemgetitemlabel}. + \wxheading{See also} \helpref{GetLabel}{wxmenuitemgetlabel}, @@ -236,7 +339,7 @@ Sets the background colour associated with the menu item (Windows only). \membersection{wxMenuItem::SetBitmap}\label{wxmenuitemsetbitmap} -\constfunc{void}{SetBitmap}{\param{const wxBitmap\& }{bmp}} +\func{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). @@ -244,7 +347,7 @@ equivalent to \helpref{SetBitmaps}{wxmenuitemsetbitmaps}(bmp, wxNullBitmap). \membersection{wxMenuItem::SetBitmaps}\label{wxmenuitemsetbitmaps} -\constfunc{void}{SetBitmaps}{\param{const wxBitmap\& }{checked}, +\func{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 @@ -253,18 +356,25 @@ is also used as the single bitmap for uncheckable menu items. \membersection{wxMenuItem::SetFont}\label{wxmenuitemsetfont} -\constfunc{void}{SetFont}{\param{const wxFont\& }{font}} +\func{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}} +\func{void}{SetHelp}{\param{const wxString\& }{helpString}} Sets the help string. +\membersection{wxMenuItem::SetItemLabel}\label{wxmenuitemsetitemlabel} + +\func{void}{SetItemLabel}{\param{const wxString\& }{label}} + +Sets the label associated with the menu item. + + \membersection{wxMenuItem::SetMarginWidth}\label{wxmenuitemsetmarginwidth} \constfunc{void}{SetMarginWidth}{\param{int}{ width}} @@ -272,16 +382,32 @@ Sets the help string. Sets the width of the menu item checkmark bitmap (Windows only). +\membersection{wxMenuItem::SetMenu}\label{wxmenuitemsetmenu} + +\func{void}{SetMenu}{\param{const wxMenu*}{menu}} + +Sets the parent menu which will contain this menu item. + + +\membersection{wxMenuItem::SetSubMenu}\label{wxmenuitemsetsubmenu} + +\func{void}{SetSubMenu}{\param{const wxMenu*}{menu}} + +Sets the submenu of this menu item. + + \membersection{wxMenuItem::SetText}\label{wxmenuitemsettext} -\constfunc{void}{SetText}{\param{const wxString\& }{text}} +\func{void}{SetText}{\param{const wxString\& }{text}} Sets the text associated with the menu item. +This function is deprecated in favour of \helpref{SetItemLabel}{wxmenuitemsetitemlabel}. + \membersection{wxMenuItem::SetTextColour}\label{wxmenuitemsettextcolour} -\constfunc{void}{SetTextColour}{\param{const wxColour\& }{colour}} +\func{void}{SetTextColour}{\param{const wxColour\& }{colour}} Sets the text colour associated with the menu item (Windows only).