X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2f930c8501cd4e0f7b17bb59761cfbdd02d3b9f2..852b6c3ce7baa055da25f5254f6ee2eee0cd79b7:/docs/latex/wx/menuevt.tex?ds=sidebyside diff --git a/docs/latex/wx/menuevt.tex b/docs/latex/wx/menuevt.tex index 9f9c147393..58270d758e 100644 --- a/docs/latex/wx/menuevt.tex +++ b/docs/latex/wx/menuevt.tex @@ -4,7 +4,7 @@ This class is used for a variety of menu-related events. Note that these do not include menu command events, which are handled using \helpref{wxCommandEvent}{wxcommandevent} objects. -The handler \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays help +The default handler for wxEVT\_MENU\_HIGHLIGHT displays help text in the first field of the status bar. \wxheading{Derived from} @@ -19,7 +19,8 @@ text in the first field of the status bar. \wxheading{Event table macros} To process a menu event, use these event handler macros to direct input to member -functions that take a wxMenuEvent argument. +functions that take a wxMenuEvent argument. They can only be processed by +a menubar's frame. \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt @@ -31,7 +32,7 @@ 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} @@ -40,17 +41,22 @@ highlighted, i.e. the currently selected menu item has changed.} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxMenuEvent::wxMenuEvent} -\func{}{wxMenuEvent}{\param{WXTYPE }{id = 0}, \param{int }{id = 0}, \param{wxDC* }{dc = NULL}} +\membersection{wxMenuEvent::wxMenuEvent}\label{wxmenueventctor} + +\func{}{wxMenuEvent}{\param{WXTYPE }{id = 0}, \param{int }{id = 0}, \param{wxMenu* }{menu = NULL}} Constructor. -\membersection{wxMenuEvent::m\_menuId} -\member{int}{m\_menuId} +\membersection{wxMenuEvent::GetMenu}\label{wxmenueventgetmenu} + +\constfunc{wxMenu *}{GetMenu}{\void} + +Returns the menu which is being opened or closed. This method should only be +used with the \texttt{OPEN} and \texttt{CLOSE} events and even for them the +returned pointer may be \NULL in some ports. -The relevant menu identifier. \membersection{wxMenuEvent::GetMenuId}\label{wxmenueventgetmenuid} @@ -59,6 +65,7 @@ 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} @@ -66,6 +73,6 @@ only used with the {\tt HIGHLIGHT} events. 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. +This method should only be used with the {\tt OPEN} and {\tt CLOSE} events.