X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..8e41796c6cb912b762276f14a75fbe014652b90b:/docs/latex/wx/menuevt.tex?ds=sidebyside diff --git a/docs/latex/wx/menuevt.tex b/docs/latex/wx/menuevt.tex index 65c864b9a0..d6cab4486b 100644 --- a/docs/latex/wx/menuevt.tex +++ b/docs/latex/wx/menuevt.tex @@ -1,13 +1,21 @@ \section{\class{wxMenuEvent}}\label{wxmenuevent} This class is used for a variety of menu-related events. Note that -these do not include menu command events. +these do not include menu command events, which are +handled using \helpref{wxCommandEvent}{wxcommandevent} objects. + +The handler \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays help +text in the first field of the status bar. \wxheading{Derived from} \helpref{wxEvent}{wxevent}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Event table macros} To process a menu event, use these event handler macros to direct input to member @@ -15,21 +23,19 @@ functions that take a wxMenuEvent argument. \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt -\twocolitem{{\bf EVT\_MENU\_CHAR(func)}}{Process a wxEVT\_MENU\_CHAR event (a keypress -when a menu is showing). Windows only. TODO} -\twocolitem{{\bf EVT\_MENU\_INIT(func)}}{Process a wxEVT\_MENU\_INIT event (the menu -is about to pop up). Windows only. TODO} -\twocolitem{{\bf EVT\_MENU\_HIGHLIGHT(func)}}{Process a wxEVT\_MENU\_HIGHLIGHT event (a menu -item is being highlighted). Windows only.} -\twocolitem{{\bf EVT\_POPUP\_MENU(func)}}{Process a wxEVT\_POPUP\_MENU event (a menu -item is being highlighted). Windows only. TODO} -\twocolitem{{\bf EVT\_CONTEXT\_MENU(func)}}{Process a wxEVT\_CONTEXT\_MENU event (F1 has -been pressed with a particular menu item highlighted). Windows only. TODO} +\twocolitem{{\bf EVT\_MENU\_OPEN(func)}}{A menu is about to be opened.} +\twocolitem{{\bf EVT\_MENU\_CLOSE(func)}}{A menu has been just closed.} +\twocolitem{{\bf EVT\_MENU\_HIGHLIGHT(id, func)}}{The menu item with the +specified id has been highlighted: used to show help prompts in the status bar +by \helpref{wxFrame}{wxframe}} +\twocolitem{{\bf EVT\_MENU\_HIGHLIGHT\_ALL(func)}}{A menu item has been +highlighted, i.e. the currently selected menu item has changed.} \end{twocollist}% \wxheading{See also} -\helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight}, \helpref{Event handling overview}{eventhandlingoverview} +\helpref{Command events}{wxcommandevent},\\ +\helpref{Event handling overview}{eventhandlingoverview} \latexignore{\rtfignore{\wxheading{Members}}} @@ -49,5 +55,16 @@ The relevant menu identifier. \constfunc{int}{GetMenuId}{\void} -Returns the menu identifier associated with the event. +Returns the menu identifier associated with the event. This method should be +only used with the {\tt HIGHLIGHT} events. + +\membersection{wxMenuEvent::IsPopup}\label{wxmenueventispopup} + +\constfunc{bool}{IsPopup}{\void} + +Returns {\tt true} if the menu which is being opened or closed is a popup menu, +{\tt false} if it is a normal one. + +This method should be only used with the {\tt OPEN} and {\tt CLOSE} events. +