X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..43f06cfda107a4a74776b58dca3353a4414ecfb1:/docs/latex/wx/menuitem.tex diff --git a/docs/latex/wx/menuitem.tex b/docs/latex/wx/menuitem.tex index 9e2e331f48..a3e9a9a620 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 @@ -5,11 +16,11 @@ 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. +only implemented for Windows and GTK+. \wxheading{Derived from} -wxOwnerDrawn (Windows only)\\ +% add wxOwnerDrawn once it is documented \helpref{wxObject}{wxobject} \wxheading{Include files} @@ -22,11 +33,12 @@ wxOwnerDrawn (Windows only)\\ \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxMenuItem::wxMenuItem}\label{wxmenuitemconstr} -\func{}{wxMenuItem}{\param{wxMenu*}{ parentMenu = NULL}, \param{int}{ id = ID\_SEPARATOR}, +\membersection{wxMenuItem::wxMenuItem}\label{wxmenuitemctor} + +\func{}{wxMenuItem}{\param{wxMenu*}{ parentMenu = NULL}, \param{int}{ id = wxID\_SEPARATOR}, \param{const wxString\& }{text = ""}, \param{const wxString\& }{helpString = ""}, - \param{wxItemKind }{kind = wxITEM\_NORMAL}, \param{wxMenu*}{ subMenu = NULL}, } + \param{wxItemKind }{kind = wxITEM\_NORMAL}, \param{wxMenu*}{ subMenu = NULL}} Constructs a wxMenuItem object. @@ -34,7 +46,7 @@ Constructs a wxMenuItem object. \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. An accelerator key can be specified using the ampersand '\&' character. In order to embed an @@ -47,60 +59,65 @@ ampersand character in the menu item text, the ampersand must be doubled.} \docparam{subMenu}{If non-NULL, indicates that the menu item is a submenu.} -\membersection{wxMenuItem::\destruct{wxMenuItem}} + +\membersection{wxMenuItem::\destruct{wxMenuItem}}\label{wxmenuitemdtor} \func{}{\destruct{wxMenuItem}}{\void} Destructor. + \membersection{wxMenuItem::Check}\label{wxmenuitemcheck} -\func{void}{Check}{\param{bool}{ check}} +\func{void}{Check}{\param{bool}{ check = true}} Checks or unchecks the menu item. -\membersection{wxMenuItem::DeleteSubMenu}\label{wxmenuitemdeletesubmenu} - -\func{void}{DeleteSubMenu}{\void} +Note that this only works when the item is already appended to a menu. -Deletes the submenu, if any. \membersection{wxMenuItem::Enable}\label{wxmenuitemenable} -\func{void}{Enable}{\param{bool}{ enable}} +\func{void}{Enable}{\param{bool}{ enable = true}} Enables or disables the menu item. + \membersection{wxMenuItem::GetBackgroundColour}\label{wxmenuitemgetbackgroundcolour} \constfunc{wxColour\&}{GetBackgroundColour}{\void} Returns the background colour associated with the menu item (Windows only). + \membersection{wxMenuItem::GetBitmap}\label{wxmenuitemgetbitmap} \constfunc{wxBitmap\&}{GetBitmap}{\param{bool}{ checked = true}} Returns the checked or unchecked bitmap (Windows only). + \membersection{wxMenuItem::GetFont}\label{wxmenuitemgetfont} \constfunc{wxFont\&}{GetFont}{\void} Returns the font associated with the menu item (Windows only). + \membersection{wxMenuItem::GetHelp}\label{wxmenuitemgethelp} \constfunc{wxString}{GetHelp}{\void} Returns the help string associated with the menu item. + \membersection{wxMenuItem::GetId}\label{wxmenuitemgetid} \constfunc{int}{GetId}{\void} Returns the menu item identifier. + \membersection{wxMenuItem::GetKind}\label{wxmenuitemgetkind} \constfunc{wxItemKind}{GetKind}{\void} @@ -108,6 +125,7 @@ Returns the menu item identifier. 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} @@ -120,6 +138,7 @@ characters it might contain. \helpref{GetText}{wxmenuitemgettext}, \helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext} + \membersection{wxMenuItem::GetLabelFromText}\label{wxmenuitemgetlabelfromtext} \func{static wxString}{GetLabelFromText}{\param{const wxString\& }{text}} @@ -138,12 +157,21 @@ will return just {\tt "Hello"}. \helpref{GetText}{wxmenuitemgettext}, \helpref{GetLabel}{wxmenuitemgetlabel} + \membersection{wxMenuItem::GetMarginWidth}\label{wxmenuitemgetmarginwidth} \constfunc{int}{GetMarginWidth}{\void} 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} @@ -154,6 +182,7 @@ Returns the text associated with the menu item. \helpref{GetText}{wxmenuitemgettext} or \helpref{GetLabel}{wxmenuitemgetlabel} instead. + \membersection{wxMenuItem::GetText}\label{wxmenuitemgettext} \constfunc{wxString}{GetText}{\void} @@ -166,90 +195,125 @@ wxMenuItem constructor, i.e. with any accelerator characters it may contain. \helpref{GetLabel}{wxmenuitemgetlabel}, \helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext} + \membersection{wxMenuItem::GetSubMenu}\label{wxmenuitemgetsubmenu} \constfunc{wxMenu*}{GetSubMenu}{\void} Returns the submenu associated with the menu item, or NULL if there isn't one. + \membersection{wxMenuItem::GetTextColour}\label{wxmenuitemgettextcolour} \constfunc{wxColour\&}{GetTextColour}{\void} Returns the text colour associated with the menu item (Windows only). + \membersection{wxMenuItem::IsCheckable}\label{wxmenuitemischeckable} \constfunc{bool}{IsCheckable}{\void} Returns true if the item is checkable. + \membersection{wxMenuItem::IsChecked}\label{wxmenuitemischecked} \constfunc{bool}{IsChecked}{\void} Returns true if the item is checked. + \membersection{wxMenuItem::IsEnabled}\label{wxmenuitemisenabled} \constfunc{bool}{IsEnabled}{\void} Returns true if the item is enabled. + \membersection{wxMenuItem::IsSeparator}\label{wxmenuitemisseparator} \constfunc{bool}{IsSeparator}{\void} Returns true if the item is a separator. + +\membersection{wxMenuItem::IsSubMenu}\label{wxmenuitemissubmenu} + +\constfunc{bool}{IsSubMenu}{\void} + +Returns true if the item is a submenu. + + \membersection{wxMenuItem::SetBackgroundColour}\label{wxmenuitemsetbackgroundcolour} \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}} +\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). + \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 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::SetMarginWidth}\label{wxmenuitemsetmarginwidth} \constfunc{void}{SetMarginWidth}{\param{int}{ width}} 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. + \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).