X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3b59cdbfaf7df79499424c92ff6177736429ff8a..6dbb903bb9410e2a2a977ad349ba7b4b3b12ac78:/docs/latex/wx/menuitem.tex diff --git a/docs/latex/wx/menuitem.tex b/docs/latex/wx/menuitem.tex index f224111716..f59dbd68f8 100644 --- a/docs/latex/wx/menuitem.tex +++ b/docs/latex/wx/menuitem.tex @@ -1,8 +1,11 @@ \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} @@ -23,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. @@ -37,7 +40,8 @@ Constructs a wxMenuItem object. \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.} @@ -95,6 +99,13 @@ 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} @@ -104,7 +115,7 @@ characaters it might contain. \wxheading{See also} -\helpref{GetText}{wxmenuitemgettext}, +\helpref{GetText}{wxmenuitemgettext}, \helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext} \membersection{wxMenuItem::GetLabelFromText}\label{wxmenuitemgetlabelfromtext} @@ -122,7 +133,7 @@ will return just {\tt "Hello"}. \wxheading{See also} -\helpref{GetText}{wxmenuitemgettext}, +\helpref{GetText}{wxmenuitemgettext}, \helpref{GetLabel}{wxmenuitemgetlabel} \membersection{wxMenuItem::GetMarginWidth}\label{wxmenuitemgetmarginwidth} @@ -150,7 +161,7 @@ wxMenuItem constructor, i.e. with any accelerator characters it may contain. \wxheading{See also} -\helpref{GetLabel}{wxmenuitemgetlabel}, +\helpref{GetLabel}{wxmenuitemgetlabel}, \helpref{GetLabelFromText}{wxmenuitemgetlabelfromtext} \membersection{wxMenuItem::GetSubMenu}\label{wxmenuitemgetsubmenu} @@ -195,6 +206,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}, @@ -233,9 +251,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: