GetPath() now has wxPATH_GET_COLUME by default

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

diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex
index 404294e1129c16e2a7f32ab911f988e22edd6675..c48dd65ac582cdcea4124a17af7c317be994b3a8 100644 (file)
--- a/docs/latex/wx/event.tex
+++ b/docs/latex/wx/event.tex
@@ -44,11 +44,30 @@ The type of the event, such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
 
 Identifier for the window.
 
 
 Identifier for the window.
 

+\membersection{wxEvent::m\_propagationLevel}
+
+\member{int}{m\_propagationLevel}
+
+Indicates how many levels the event can propagate. This member is protected and
+should typically only be set in the constructors of the derived classes. It
+may be temporarily changed by \helpref{StopPropagation}{wxeventstoppropagation} 
+and \helpref{ResumePropagation}{wxeventresumepropagation} and tested with 
+\helpref{ShouldPropagate}{wxeventshouldpropagate}.
+
+The initial value is set to either {\tt wxEVENT\_PROPAGATION\_NONE} (by
+default) meaning that the event shouldn't be propagated at all or to 
+{\tt wxEVENT\_PROPAGATION\_MAX} (for command events) meaning that it should be
+propagated as much as necessary.
+
+Any positive number means that the event should be propagated but no more than
+the given number of times. E.g. the propagation level may be set to $1$ to
+propagate the event to its parent only, but not to its grandparent.
+

 \membersection{wxEvent::m\_skipped}
 
 \member{bool}{m\_skipped}
 
 \membersection{wxEvent::m\_skipped}
 
 \member{bool}{m\_skipped}
 

-Set to TRUE by {\bf Skip} if this event should be skipped.
+Set to true by {\bf Skip} if this event should be skipped.

 
 \membersection{wxEvent::m\_timeStamp}
 
 
 \membersection{wxEvent::m\_timeStamp}
 


@@ -92,22 +111,15 @@ such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
 
 \membersection{wxEvent::GetId}
 
 
 \membersection{wxEvent::GetId}
 

-\func{int}{GetId}{\void}
+\constfunc{int}{GetId}{\void}

 
 Returns the identifier associated with this event, such as a button command id.
 
 
 Returns the identifier associated with this event, such as a button command id.
 

-\membersection{wxEvent::GetObjectType}
-
-\func{WXTYPE}{GetObjectType}{\void}
-
-Returns the type of the object associated with the
-event, such as wxTYPE\_BUTTON.
-

 \membersection{wxEvent::GetSkipped}
 
 \membersection{wxEvent::GetSkipped}
 

-\func{bool}{GetSkipped}{\void}
+\constfunc{bool}{GetSkipped}{\void}

 
 

-Returns TRUE if the event handler should be skipped, FALSE otherwise.
+Returns true if the event handler should be skipped, false otherwise.

 
 \membersection{wxEvent::GetTimestamp}
 
 
 \membersection{wxEvent::GetTimestamp}
 


@@ -115,6 +127,23 @@ Returns TRUE if the event handler should be skipped, FALSE otherwise.
 
 Gets the timestamp for the event.
 
 
 Gets the timestamp for the event.
 

+\membersection{wxEvent::IsCommandEvent}\label{wxeventiscommandevent}
+
+\constfunc{bool}{IsCommandEvent}{\void}
+
+Returns true if the event is or is derived from
+\helpref{wxCommandEvent}{wxcommandevent} else it returns false.
+Note: Exists only for optimization purposes.
+
+
+\membersection{wxEvent::ResumePropagation}\label{wxeventresumepropagation}
+
+\func{void}{ResumePropagation}{\param{int }{propagationLevel}}
+
+Sets the propagation level to the given value (for example returned from an
+earlier call to \helpref{StopPropagation}{wxeventstoppropagation}).
+
+

 \membersection{wxEvent::SetEventObject}
 
 \func{void}{SetEventObject}{\param{wxObject* }{object}}
 \membersection{wxEvent::SetEventObject}
 
 \func{void}{SetEventObject}{\param{wxObject* }{object}}


@@ -141,11 +170,29 @@ Sets the timestamp for the event.
 
 Sets the originating object.
 
 
 Sets the originating object.
 

+\membersection{wxEvent::ShouldPropagate}\label{wxeventshouldpropagate}
+
+\constfunc{bool}{ShouldPropagate}{\void}
+
+Test if this event should be propagated or not, i.e. if the propagation level
+is currently greater than $0$.
+

 \membersection{wxEvent::Skip}\label{wxeventskip}
 
 \membersection{wxEvent::Skip}\label{wxeventskip}
 

-\func{void}{Skip}{\param{bool}{ skip = TRUE}}
+\func{void}{Skip}{\param{bool}{ skip = true}}

 
 Called by an event handler to tell the event system that the
 event handler should be skipped, and the next valid handler used
 instead.
 
 
 Called by an event handler to tell the event system that the
 event handler should be skipped, and the next valid handler used
 instead.
 

+\membersection{wxEvent::StopPropagation}
+
+\func{int}{StopPropagation}{\void}\label{wxeventstoppropagation}
+
+Stop the event from propagating to its parent window.
+
+Returns the old propagation level value which may be later passed to 
+\helpref{ResumePropagation}{wxeventresumepropagation} to allow propagating the
+event again.
+
+