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