mention that Check() doesn't work before the item is attached to a menu
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@29210 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -22,6 +22,7 @@ wxOwnerDrawn (Windows only)\\
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxMenuItem::wxMenuItem}\label{wxmenuitemconstr}
|
||||
|
||||
\func{}{wxMenuItem}{\param{wxMenu*}{ parentMenu = NULL}, \param{int}{ id = wxID\_SEPARATOR},
|
||||
@@ -47,54 +48,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}}
|
||||
|
||||
\func{}{\destruct{wxMenuItem}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
||||
\membersection{wxMenuItem::Check}\label{wxmenuitemcheck}
|
||||
|
||||
\func{void}{Check}{\param{bool}{ check}}
|
||||
|
||||
Checks or unchecks the menu item.
|
||||
|
||||
Note that this only works when the item is already appended to a menu.
|
||||
|
||||
|
||||
\membersection{wxMenuItem::Enable}\label{wxmenuitemenable}
|
||||
|
||||
\func{void}{Enable}{\param{bool}{ enable}}
|
||||
|
||||
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}
|
||||
@@ -102,6 +114,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}
|
||||
@@ -114,6 +127,7 @@ characters it might contain.
|
||||
\helpref{GetText}{wxmenuitemgettext},
|
||||
\helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext}
|
||||
|
||||
|
||||
\membersection{wxMenuItem::GetLabelFromText}\label{wxmenuitemgetlabelfromtext}
|
||||
|
||||
\func{static wxString}{GetLabelFromText}{\param{const wxString\& }{text}}
|
||||
@@ -132,12 +146,14 @@ 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::GetName}\label{wxmenuitemgetname}
|
||||
|
||||
\constfunc{wxString}{GetName}{\void}
|
||||
@@ -148,6 +164,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}
|
||||
@@ -160,48 +177,56 @@ 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::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}}
|
||||
@@ -209,6 +234,7 @@ Sets the background colour associated with the menu item (Windows only).
|
||||
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},
|
||||
@@ -217,30 +243,35 @@ equivalent to \helpref{SetBitmaps}{wxmenuitemsetbitmaps}(bmp, 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}}
|
||||
|
||||
Sets the font associated with the menu item (Windows only).
|
||||
|
||||
|
||||
\membersection{wxMenuItem::SetHelp}\label{wxmenuitemsethelp}
|
||||
|
||||
\constfunc{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::SetText}\label{wxmenuitemsettext}
|
||||
|
||||
\constfunc{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}}
|
||||
|
Reference in New Issue
Block a user