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