added wxListBox::HitTest() from Ryan (patch 1446207)

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

diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex
index f747df581b16a6e2d5d26b51983906aa43245580..817d5983a8c648c8b6889000e171e718dbd3f138 100644 (file)
--- a/docs/latex/wx/event.tex
+++ b/docs/latex/wx/event.tex
@@ -4,6 +4,11 @@ An event is a structure holding information about an event passed to a
 callback or member function. {\bf wxEvent} used to be a multipurpose
 event object, and is an abstract base class for other event classes (see below).
 
 callback or member function. {\bf wxEvent} used to be a multipurpose
 event object, and is an abstract base class for other event classes (see below).
 

+For more information about events, see the \helpref{Event handling overview}{eventhandlingoverview}.
+
+\perlnote{In wxPerl custom event classes should be derived from
+\texttt{Wx::PlEvent} and \texttt{Wx::PlCommandEvent}.}
+

 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}


@@ -19,120 +24,152 @@ event object, and is an abstract base class for other event classes (see below).
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxEvent::wxEvent}
+\membersection{wxEvent::wxEvent}\label{wxeventctor}

 
 

-\func{}{wxEvent}{\param{int }{id = 0}}
+\func{}{wxEvent}{\param{int }{id = 0}, \param{wxEventType }{eventType = {\tt wxEVT\_NULL}}}

 
 Constructor. Should not need to be used directly by an application.
 
 
 Constructor. Should not need to be used directly by an application.
 

-\membersection{wxEvent::m\_eventHandle}
-
-\member{char*}{m\_eventHandle}
-
-Handle of an underlying windowing system event handle, such as
-XEvent. Not guaranteed to be instantiated.
-
-\membersection{wxEvent::m\_eventObject}
-
-\member{wxObject*}{m\_eventObject}
-
-The object (usually a window) that the event was generated from,
-or should be sent to.
+\membersection{wxEvent::m\_propagationLevel}\label{wxeventmpropagationlevel}

 
 

-\membersection{wxEvent::m\_eventType}
+\member{int}{m\_propagationLevel}

 
 

-\member{WXTYPE}{m\_eventType}
+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 type of the event, such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
+The initial value is set to either {\tt wxEVENT\_PROPAGATE\_NONE} (by
+default) meaning that the event shouldn't be propagated at all or to 
+{\tt wxEVENT\_PROPAGATE\_MAX} (for command events) meaning that it should be
+propagated as much as necessary.

 
 

-\membersection{wxEvent::m\_id}
+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.

 
 

-\member{int}{m\_id}
+\membersection{wxEvent::Clone}\label{wxeventclone}

 
 

-Identifier for the window.
+\constfunc{virtual wxEvent*}{Clone}{\void}

 
 

-\membersection{wxEvent::m\_skipped}
+Returns a copy of the event.

 
 

-\member{bool}{m\_skipped}
+Any event that is posted to the wxWidgets event system for later action (via
+\helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent} or
+\helpref{wxPostEvent}{wxpostevent}) must implement this method. All wxWidgets
+events fully implement this method, but any derived events implemented by the
+user should also implement this method just in case they (or some event
+derived from them) are ever posted.

 
 

-Set to TRUE by {\bf Skip} if this event should be skipped.
+All wxWidgets events implement a copy constructor, so the easiest way of
+implementing the Clone function is to implement a copy constructor for
+a new event (call it MyEvent) and then define the Clone function like this:

 
 

-\membersection{wxEvent::m\_timeStamp}
+\begin{verbatim}
+    wxEvent *Clone(void) const { return new MyEvent(*this); }
+\end{verbatim}

 
 

-\member{long}{m\_timeStamp}
-
-Timestamp for this event.
-
-\membersection{wxEvent::GetEventObject}
+\membersection{wxEvent::GetEventObject}\label{wxeventgeteventobject}

 
 \func{wxObject*}{GetEventObject}{\void}
 
 
 \func{wxObject*}{GetEventObject}{\void}
 

-Returns the object associated with the
+Returns the object (usually a window) associated with the

 event, if any.
 
 event, if any.
 

-\membersection{wxEvent::GetEventType}
+\membersection{wxEvent::GetEventType}\label{wxeventgeteventtype}

 
 \func{WXTYPE}{GetEventType}{\void}
 
 Returns the identifier of the given event type,
 such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
 
 
 \func{WXTYPE}{GetEventType}{\void}
 
 Returns the identifier of the given event type,
 such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
 

-\membersection{wxEvent::GetId}
+\membersection{wxEvent::GetId}\label{wxeventgetid}

 
 

-\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}
+\membersection{wxEvent::GetSkipped}\label{wxeventgetskipped}

 
 

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

 
 

-Returns the type of the object associated with the
-event, such as wxTYPE\_BUTTON.
+Returns true if the event handler should be skipped, false otherwise.

 
 

-\membersection{wxEvent::GetSkipped}
+\membersection{wxEvent::GetTimestamp}\label{wxeventgettimestamp}

 
 

-\func{bool}{GetSkipped}{\void}
+\func{long}{GetTimestamp}{\void}

 
 

-Returns TRUE if the event handler should be skipped, FALSE otherwise.
+Gets the timestamp for the event.

 
 

-\membersection{wxEvent::GetTimestamp}
+\membersection{wxEvent::IsCommandEvent}\label{wxeventiscommandevent}

 
 

-\func{long}{GetTimestamp}{\void}
+\constfunc{bool}{IsCommandEvent}{\void}

 
 

-Gets the timestamp for the event.
+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::SetEventObject}
+
+\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}\label{wxeventseteventobject}

 
 \func{void}{SetEventObject}{\param{wxObject* }{object}}
 
 Sets the originating object.
 
 
 \func{void}{SetEventObject}{\param{wxObject* }{object}}
 
 Sets the originating object.
 

-\membersection{wxEvent::SetEventType}
+\membersection{wxEvent::SetEventType}\label{wxeventseteventtype}

 
 \func{void}{SetEventType}{\param{WXTYPE }{typ}}
 
 Sets the event type.
 
 
 \func{void}{SetEventType}{\param{WXTYPE }{typ}}
 
 Sets the event type.
 

-\membersection{wxEvent::SetId}
+\membersection{wxEvent::SetId}\label{wxeventsetid}

 
 \func{void}{SetId}{\param{int}{ id}}
 
 Sets the identifier associated with this event, such as a button command id.
 
 
 \func{void}{SetId}{\param{int}{ id}}
 
 Sets the identifier associated with this event, such as a button command id.
 

-\membersection{wxEvent::SetTimestamp}
+\membersection{wxEvent::SetTimestamp}\label{wxeventsettimestamp}

 
 \func{void}{SetTimestamp}{\param{long }{timeStamp}}
 
 Sets the timestamp for the event.
 
 
 \func{void}{SetTimestamp}{\param{long }{timeStamp}}
 
 Sets the timestamp for the event.
 

-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, it controls whether additional event
+handlers bound to this event will be called after the current event
+handler returns.  Skip(false) (the default behavior) will prevent
+additional event handlers from being called and control will be
+returned to the sender of the event immediately after the current
+handler has finished.  Skip(true) will cause the event processing
+system to continue searching for a handler function for this event.
+
+
+\membersection{wxEvent::StopPropagation}\label{wxeventstoppropagation}
+
+\func{int}{StopPropagation}{\void}
+
+Stop the event from propagating to its parent window.

 
 

-Called by an event handler to tell the event system that the
-event handler should be skipped, and the next valid handler used
-instead.
+Returns the old propagation level value which may be later passed to 
+\helpref{ResumePropagation}{wxeventresumepropagation} to allow propagating the
+event again.