X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ccef86c75da7844d15435f4093bf992f60786cea..13220cca727ed74c2998b4fb89a4d80aacf28e68:/docs/latex/wx/menuevt.tex diff --git a/docs/latex/wx/menuevt.tex b/docs/latex/wx/menuevt.tex index aa6f00b5c9..550c266082 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,14 +23,15 @@ functions that take a wxMenuEvent argument. \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt -\twocolitem{{\bf EVT\_MENU\_OPEN(func)}}{A menu is about to be opened.} +\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 -speicifed id has been highlighted: used to show help prompts in the status bar +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}% +\end{twocollist} \wxheading{See also} @@ -35,18 +40,29 @@ highlighted, i.e. the currently selected menu item has changed.} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxMenuEvent::wxMenuEvent} + +\membersection{wxMenuEvent::wxMenuEvent}\label{wxmenueventctor} \func{}{wxMenuEvent}{\param{WXTYPE }{id = 0}, \param{int }{id = 0}, \param{wxDC* }{dc = NULL}} Constructor. -\membersection{wxMenuEvent::m\_menuId} + +\membersection{wxMenuEvent::m\_menuId}\label{wxmenueventmmenuid} \member{int}{m\_menuId} The relevant menu identifier. + +\membersection{wxMenuEvent::GetMenu}\label{wxmenueventgetmenu} + +\constfunc{wxMenu *}{GetMenu}{\void} + +Returns the menu which is being opened or closed. This method should be only +used with the \texttt{OPEN} and \texttt{CLOSE} events. + + \membersection{wxMenuEvent::GetMenuId}\label{wxmenueventgetmenuid} \constfunc{int}{GetMenuId}{\void} @@ -54,12 +70,13 @@ The relevant menu identifier. 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. +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.