[wxWidgets.git] / docs / latex / wx / notifevt.tex

\section{\class{wxNotifyEvent}}\label{wxnotifyevent}

This class is not used by the event handlers by itself, but is a base class
for other event classes (such as \helpref{wxNotebookEvent}{wxnotebookevent}).

It (or an object of a derived class) is sent when the controls state is being
changed and allows the program to \helpref{Veto()}{wxnotifyeventveto} this
change if it wants to prevent it from happening.

\wxheading{Derived from}

\helpref{wxCommandEvent}{wxcommandevent}\\
\helpref{wxEvent}{wxevent}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/event.h>

\wxheading{Event table macros}

None

\wxheading{See also}

\helpref{wxNotebookEvent}{wxnotebookevent}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxNotifyEvent::wxNotifyEvent}\label{wxnotifyeventconstr}

\func{}{wxNotifyEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL}, \param{int}{ id = 0}}

Constructor (used internally by wxWindows only).

\membersection{wxNotifyEvent::IsAllowed}\label{wxnotifyeventisallowed}

\constfunc{bool}{IsAllowed}{\void}

Returns TRUE if the change is allowed (\helpref{Veto()}{wxnotifyeventveto} 
hasn't been called) or FALSE otherwise (if it was).

\membersection{wxNotifyEvent::Veto}\label{wxnotifyeventveto}

\func{void}{Veto}{\void}

Prevents the change announced by this event from happening.

It is in general a good idea to notify the user about the reasons for vetoing
the change because otherwise the applications behaviour (which just refuses to
do what the user wants) might be quite surprising.
Commit	Line	Data
4d0f3cd6 VZ	1	\section{\class{wxNotifyEvent}}\label{wxnotifyevent}
	2
	3	This class is not used by the event handlers by itself, but is a base class
	4	for other event classes (such as \helpref{wxNotebookEvent}{wxnotebookevent}).
	5
	6	It (or an object of a derived class) is sent when the controls state is being
	7	changed and allows the program to \helpref{Veto()}{wxnotifyeventveto} this
	8	change if it wants to prevent it from happening.
	9
	10	\wxheading{Derived from}
	11
	12	\helpref{wxCommandEvent}{wxcommandevent}\\
	13	\helpref{wxEvent}{wxevent}\\
	14	\helpref{wxEvtHandler}{wxevthandler}\\
	15	\helpref{wxObject}{wxobject}
	16
	17	\wxheading{Include files}
	18
	19	<wx/event.h>
	20
	21	\wxheading{Event table macros}
	22
	23	None
	24
	25	\wxheading{See also}
	26
	27	\helpref{wxNotebookEvent}{wxnotebookevent}
	28
	29	\latexignore{\rtfignore{\wxheading{Members}}}
	30
	31	\membersection{wxNotifyEvent::wxNotifyEvent}\label{wxnotifyeventconstr}
	32
	33	\func{}{wxNotifyEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL}, \param{int}{ id = 0}}
	34
	35	Constructor (used internally by wxWindows only).
	36
	37	\membersection{wxNotifyEvent::IsAllowed}\label{wxnotifyeventisallowed}
	38
	39	\constfunc{bool}{IsAllowed}{\void}
	40
	41	Returns TRUE if the change is allowed (\helpref{Veto()}{wxnotifyeventveto}
	42	hasn't been called) or FALSE otherwise (if it was).
	43
	44	\membersection{wxNotifyEvent::Veto}\label{wxnotifyeventveto}
	45
	46	\func{void}{Veto}{\void}
	47
	48	Prevents the change announced by this event from happening.
	49
	50	It is in general a good idea to notify the user about the reasons for vetoing
	51	the change because otherwise the applications behaviour (which just refuses to
	52	do what the user wants) might be quite surprising.
22d6efa8	53