git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	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, which are
	5	handled using \helpref{wxCommandEvent}{wxcommandevent} objects.
	6
	7	The default handler for wxEVT\_MENU\_HIGHLIGHT displays help
	8	text in the first field of the status bar.
	9
	10	\wxheading{Derived from}
	11
	12	\helpref{wxEvent}{wxevent}\\
	13	\helpref{wxObject}{wxobject}
	14
	15	\wxheading{Include files}
	16
	17	<wx/event.h>
	18
	19	\wxheading{Event table macros}
	20
	21	To process a menu event, use these event handler macros to direct input to member
	22	functions that take a wxMenuEvent argument.
	23
	24	\twocolwidtha{7cm}
	25	\begin{twocollist}\itemsep=0pt
	26	\twocolitem{{\bf EVT\_MENU\_OPEN(func)}}{A menu is about to be opened. On Windows,
	27	this is only sent once for each navigation of the menubar (up until all menus have closed).}
	28	\twocolitem{{\bf EVT\_MENU\_CLOSE(func)}}{A menu has been just closed.}
	29	\twocolitem{{\bf EVT\_MENU\_HIGHLIGHT(id, func)}}{The menu item with the
	30	specified id has been highlighted: used to show help prompts in the status bar
	31	by \helpref{wxFrame}{wxframe}}
	32	\twocolitem{{\bf EVT\_MENU\_HIGHLIGHT\_ALL(func)}}{A menu item has been
	33	highlighted, i.e. the currently selected menu item has changed.}
	34	\end{twocollist}
	35
	36	\wxheading{See also}
	37
	38	\helpref{Command events}{wxcommandevent},\\
	39	\helpref{Event handling overview}{eventhandlingoverview}
	40
	41	\latexignore{\rtfignore{\wxheading{Members}}}
	42
	43
	44	\membersection{wxMenuEvent::wxMenuEvent}\label{wxmenueventctor}
	45
	46	\func{}{wxMenuEvent}{\param{WXTYPE }{id = 0}, \param{int }{id = 0}, \param{wxDC* }{dc = NULL}}
	47
	48	Constructor.
	49
	50
	51	\membersection{wxMenuEvent::m\_menuId}\label{wxmenueventmmenuid}
	52
	53	\member{int}{m\_menuId}
	54
	55	The relevant menu identifier.
	56
	57
	58	\membersection{wxMenuEvent::GetMenu}\label{wxmenueventgetmenu}
	59
	60	\constfunc{wxMenu *}{GetMenu}{\void}
	61
	62	Returns the menu which is being opened or closed. This method should be only
	63	used with the \texttt{OPEN} and \texttt{CLOSE} events.
	64
	65
	66	\membersection{wxMenuEvent::GetMenuId}\label{wxmenueventgetmenuid}
	67
	68	\constfunc{int}{GetMenuId}{\void}
	69
	70	Returns the menu identifier associated with the event. This method should be
	71	only used with the {\tt HIGHLIGHT} events.
	72
	73
	74	\membersection{wxMenuEvent::IsPopup}\label{wxmenueventispopup}
	75
	76	\constfunc{bool}{IsPopup}{\void}
	77
	78	Returns {\tt true} if the menu which is being opened or closed is a popup menu,
	79	{\tt false} if it is a normal one.
	80
	81	This method should be only used with the {\tt OPEN} and {\tt CLOSE} events.
	82
	83