X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..2e622163d05d0813bd6fa4223c18e0ec2f6dc074:/docs/latex/wx/menuevt.tex diff --git a/docs/latex/wx/menuevt.tex b/docs/latex/wx/menuevt.tex index 51cba035cf..6b20a2e9c3 100644 --- a/docs/latex/wx/menuevt.tex +++ b/docs/latex/wx/menuevt.tex @@ -1,7 +1,11 @@ \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 default handler for wxEVT\_MENU\_HIGHLIGHT displays help +text in the first field of the status bar. \wxheading{Derived from} @@ -19,21 +23,20 @@ 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; not yet implemented.} -\twocolitem{{\bf EVT\_MENU\_INIT(func)}}{Process a wxEVT\_MENU\_INIT event (the menu -is about to pop up). Windows only; not yet implemented.} -\twocolitem{{\bf EVT\_MENU\_HIGHLIGHT(func)}}{Process a wxEVT\_MENU\_HIGHLIGHT event (a menu -item is being highlighted). Windows only; not yet implemented.} -\twocolitem{{\bf EVT\_POPUP\_MENU(func)}}{Process a wxEVT\_POPUP\_MENU event (a menu -item is being highlighted). Windows only; not yet implemented.} -\twocolitem{{\bf EVT\_CONTEXT\_MENU(func)}}{Process a wxEVT\_CONTEXT\_MENU event (F1 has -been pressed with a particular menu item highlighted). Windows only; not yet implemented.} +\twocolitem{{\bf EVT\_MENU\_OPEN(func)}}{A menu is about to be opened. On Windows, +this is only sent once for each navigation of the menubar (up until all menus have closed).} +\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}}} @@ -53,5 +56,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. +