]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/notifevt.tex
Typo correction
[wxWidgets.git] / docs / latex / wx / notifevt.tex
index bdd5ac9e0101fedfa992ac5d5e18b367a5c49f49..1d430fb7b18bf88b6bb503a2c024898fa06b9cac 100644 (file)
@@ -18,6 +18,10 @@ change if it wants to prevent it from happening.
 
 <wx/event.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{Event table macros}
 
 None
@@ -32,14 +36,23 @@ None
 
 \func{}{wxNotifyEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL}, \param{int}{ id = 0}}
 
-Constructor (used internally by wxWindows only).
+Constructor (used internally by wxWidgets only).
+
+\membersection{wxNotifyEvent::Allow}\label{wxnotifyeventallow}
+
+\func{void}{Allow}{\void}
+
+This is the opposite of \helpref{Veto()}{wxnotifyeventveto}: it explicitly
+allows the event to be processed. For most events it is not necessary to call
+this method as the events are allowed anyhow but some are forbidden by default
+(this will be mentioned in the corresponding event description).
 
 \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).
+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}
 
@@ -50,3 +63,4 @@ 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.
+