]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/menuevt.tex
applied wxPerl doc patches
[wxWidgets.git] / docs / latex / wx / menuevt.tex
... / ...
CommitLineData
1\section{\class{wxMenuEvent}}\label{wxmenuevent}
2
3This class is used for a variety of menu-related events. Note that
4these do not include menu command events.
5
6\wxheading{Derived from}
7
8\helpref{wxEvent}{wxevent}\\
9\helpref{wxObject}{wxobject}
10
11\wxheading{Include files}
12
13<wx/event.h>
14
15\wxheading{Event table macros}
16
17To process a menu event, use these event handler macros to direct input to member
18functions that take a wxMenuEvent argument.
19
20\twocolwidtha{7cm}
21\begin{twocollist}\itemsep=0pt
22\twocolitem{{\bf EVT\_MENU\_CHAR(func)}}{Process a wxEVT\_MENU\_CHAR event (a keypress
23when a menu is showing). Windows only; not yet implemented.}
24\twocolitem{{\bf EVT\_MENU\_INIT(func)}}{Process a wxEVT\_MENU\_INIT event (the menu
25is about to pop up). Windows only; not yet implemented.}
26\twocolitem{{\bf EVT\_MENU\_HIGHLIGHT(func)}}{Process a wxEVT\_MENU\_HIGHLIGHT event (a menu
27item is being highlighted). Windows only; not yet implemented.}
28\twocolitem{{\bf EVT\_POPUP\_MENU(func)}}{Process a wxEVT\_POPUP\_MENU event (a menu
29item is being highlighted). Windows only; not yet implemented.}
30\twocolitem{{\bf EVT\_CONTEXT\_MENU(func)}}{Process a wxEVT\_CONTEXT\_MENU event (F1 has
31been pressed with a particular menu item highlighted). Windows only; not yet implemented.}
32\end{twocollist}%
33
34\wxheading{See also}
35
36\helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight}, \helpref{Event handling overview}{eventhandlingoverview}
37
38\latexignore{\rtfignore{\wxheading{Members}}}
39
40\membersection{wxMenuEvent::wxMenuEvent}
41
42\func{}{wxMenuEvent}{\param{WXTYPE }{id = 0}, \param{int }{id = 0}, \param{wxDC* }{dc = NULL}}
43
44Constructor.
45
46\membersection{wxMenuEvent::m\_menuId}
47
48\member{int}{m\_menuId}
49
50The relevant menu identifier.
51
52\membersection{wxMenuEvent::GetMenuId}\label{wxmenueventgetmenuid}
53
54\constfunc{int}{GetMenuId}{\void}
55
56Returns the menu identifier associated with the event.
57