projects / wxWidgets.git / blame
| 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 | ||
| a7af285d VZ |
21 | \wxheading{Library} |
| 22 | ||
| 23 | \helpref{wxCore}{librarieslist} | |
| 24 | ||
| 4d0f3cd6 VZ |
25 | \wxheading{Event table macros} |
| 26 | ||
| 27 | None | |
| 28 | ||
| 29 | \wxheading{See also} | |
| 30 | ||
| 31 | \helpref{wxNotebookEvent}{wxnotebookevent} | |
| 32 | ||
| 33 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 34 | ||
| 35 | \membersection{wxNotifyEvent::wxNotifyEvent}\label{wxnotifyeventconstr} | |
| 36 | ||
| 37 | \func{}{wxNotifyEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL}, \param{int}{ id = 0}} | |
| 38 | ||
| fc2171bd | 39 | Constructor (used internally by wxWidgets only). |
| 4d0f3cd6 | 40 | |
| 01459e68 VZ |
41 | \membersection{wxNotifyEvent::Allow}\label{wxnotifyeventallow} |
| 42 | ||
| 43 | \func{void}{Allow}{\void} | |
| 44 | ||
| 45 | This is the opposite of \helpref{Veto()}{wxnotifyeventveto}: it explicitly | |
| 46 | allows the event to be processed. For most events it is not necessary to call | |
| 47 | this method as the events are allowed anyhow but some are forbidden by default | |
| 48 | (this will be mentioned in the corresponding event description). | |
| 49 | ||
| 4d0f3cd6 VZ |
50 | \membersection{wxNotifyEvent::IsAllowed}\label{wxnotifyeventisallowed} |
| 51 | ||
| 52 | \constfunc{bool}{IsAllowed}{\void} | |
| 53 | ||
| cc81d32f VS |
54 | Returns true if the change is allowed (\helpref{Veto()}{wxnotifyeventveto} |
| 55 | hasn't been called) or false otherwise (if it was). | |
| 4d0f3cd6 VZ |
56 | |
| 57 | \membersection{wxNotifyEvent::Veto}\label{wxnotifyeventveto} | |
| 58 | ||
| 59 | \func{void}{Veto}{\void} | |
| 60 | ||
| 61 | Prevents the change announced by this event from happening. | |
| 62 | ||
| 63 | It is in general a good idea to notify the user about the reasons for vetoing | |
| 64 | the change because otherwise the applications behaviour (which just refuses to | |
| 65 | do what the user wants) might be quite surprising. | |
| 22d6efa8 | 66 |