| | 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 wxWidgets only). |
| | 36 | |
| | 37 | \membersection{wxNotifyEvent::Allow}\label{wxnotifyeventallow} |
| | 38 | |
| | 39 | \func{void}{Allow}{\void} |
| | 40 | |
| | 41 | This is the opposite of \helpref{Veto()}{wxnotifyeventveto}: it explicitly |
| | 42 | allows the event to be processed. For most events it is not necessary to call |
| | 43 | this method as the events are allowed anyhow but some are forbidden by default |
| | 44 | (this will be mentioned in the corresponding event description). |
| | 45 | |
| | 46 | \membersection{wxNotifyEvent::IsAllowed}\label{wxnotifyeventisallowed} |
| | 47 | |
| | 48 | \constfunc{bool}{IsAllowed}{\void} |
| | 49 | |
| | 50 | Returns true if the change is allowed (\helpref{Veto()}{wxnotifyeventveto} |
| | 51 | hasn't been called) or false otherwise (if it was). |
| | 52 | |
| | 53 | \membersection{wxNotifyEvent::Veto}\label{wxnotifyeventveto} |
| | 54 | |
| | 55 | \func{void}{Veto}{\void} |
| | 56 | |
| | 57 | Prevents the change announced by this event from happening. |
| | 58 | |
| | 59 | It is in general a good idea to notify the user about the reasons for vetoing |
| | 60 | the change because otherwise the applications behaviour (which just refuses to |
| | 61 | do what the user wants) might be quite surprising. |
| | 62 | |
projects / wxWidgets.git / blame_incremental