added more properties

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

diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex
index c48dd65ac582cdcea4124a17af7c317be994b3a8..fc016f23f2f64381992bdd98ce709c170a8e1658 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,32 +24,16 @@ 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}, \param{wxEventType }{eventType = {\tt wxEVT\_NULL}}}
 
 Constructor. Should not need to be used directly by an application.
 
 
 \func{}{wxEvent}{\param{int }{id = 0}, \param{wxEventType }{eventType = {\tt wxEVT\_NULL}}}
 
 Constructor. Should not need to be used directly by an application.
 

-\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\_eventType}
-
-\member{WXTYPE}{m\_eventType}
-
-The type of the event, such as wxEVENT\_TYPE\_BUTTON\_COMMAND.

 
 

-\membersection{wxEvent::m\_id}
+\membersection{wxEvent::m\_propagationLevel}\label{wxeventmpropagationlevel}

 
 

-\member{int}{m\_id}
-
-Identifier for the window.
-
-\membersection{wxEvent::m\_propagationLevel}

 
 \member{int}{m\_propagationLevel}
 
 
 \member{int}{m\_propagationLevel}
 


@@ -54,26 +43,15 @@ may be temporarily changed by \helpref{StopPropagation}{wxeventstoppropagation}
 and \helpref{ResumePropagation}{wxeventresumepropagation} and tested with 
 \helpref{ShouldPropagate}{wxeventshouldpropagate}.
 
 and \helpref{ResumePropagation}{wxeventresumepropagation} and tested with 
 \helpref{ShouldPropagate}{wxeventshouldpropagate}.
 

-The initial value is set to either {\tt wxEVENT\_PROPAGATION\_NONE} (by
+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 
 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
+{\tt wxEVENT\_PROPAGATE\_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.
 
 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}
-
-Set to true by {\bf Skip} if this event should be skipped.
-
-\membersection{wxEvent::m\_timeStamp}
-
-\member{long}{m\_timeStamp}
-
-Timestamp for this event.

 
 \membersection{wxEvent::Clone}\label{wxeventclone}
 
 
 \membersection{wxEvent::Clone}\label{wxeventclone}
 


@@ -81,51 +59,61 @@ Timestamp for this event.
 
 Returns a copy of the event.
 
 
 Returns a copy of the event.
 

-Any event that is posted to the wxWindows event system for later action (via
+Any event that is posted to the wxWidgets event system for later action (via

 \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent} or
 \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent} or

-\helpref{wxPostEvent}{wxpostevent}) must implement this method. All wxWindows
+\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.
 
 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.
 

-All wxWindows events implement a copy constructor, so the easiest way of
+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:
 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:

+

 \begin{verbatim}
     wxEvent *Clone(void) const { return new MyEvent(*this); }
 \end{verbatim}
 
 \begin{verbatim}
     wxEvent *Clone(void) const { return new MyEvent(*this); }
 \end{verbatim}
 

-\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}

 
 

-\func{WXTYPE}{GetEventType}{\void}
+\membersection{wxEvent::GetEventType}\label{wxeventgeteventtype}
+
+\func{wxEventType}{GetEventType}{\void}

 
 Returns the identifier of the given event type,
 
 Returns the identifier of the given event type,

-such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
+such as \texttt{wxEVT\_COMMAND\_BUTTON\_CLICKED}.
+

 
 

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

 
 \constfunc{int}{GetId}{\void}
 
 Returns the identifier associated with this event, such as a button command id.
 
 
 \constfunc{int}{GetId}{\void}
 
 Returns the identifier associated with this event, such as a button command id.
 

-\membersection{wxEvent::GetSkipped}
+
+\membersection{wxEvent::GetSkipped}\label{wxeventgetskipped}

 
 \constfunc{bool}{GetSkipped}{\void}
 
 Returns true if the event handler should be skipped, false otherwise.
 
 
 \constfunc{bool}{GetSkipped}{\void}
 
 Returns true if the event handler should be skipped, false otherwise.
 

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

 
 \func{long}{GetTimestamp}{\void}
 
 
 \func{long}{GetTimestamp}{\void}
 

-Gets the timestamp for the event.
+Gets the timestamp for the event. The timestamp is the time in milliseconds
+since some fixed moment (\emph{not} necessarily the standard Unix Epoch, so
+only differences between the timestamps and not their absolute values usually
+make sense).
+

 
 \membersection{wxEvent::IsCommandEvent}\label{wxeventiscommandevent}
 
 
 \membersection{wxEvent::IsCommandEvent}\label{wxeventiscommandevent}
 


@@ -144,31 +132,33 @@ Sets the propagation level to the given value (for example returned from an
 earlier call to \helpref{StopPropagation}{wxeventstoppropagation}).
 
 
 earlier call to \helpref{StopPropagation}{wxeventstoppropagation}).
 
 

-\membersection{wxEvent::SetEventObject}
+\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}

 
 

-\func{void}{SetEventType}{\param{WXTYPE }{typ}}
+\membersection{wxEvent::SetEventType}\label{wxeventseteventtype}
+
+\func{void}{SetEventType}{\param{wxEventType }{type}}

 
 Sets the event type.
 
 
 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}
 
 
 \membersection{wxEvent::ShouldPropagate}\label{wxeventshouldpropagate}
 


@@ -177,17 +167,29 @@ Sets the originating object.
 Test if this event should be propagated or not, i.e. if the propagation level
 is currently greater than $0$.
 
 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}
 
 \func{void}{Skip}{\param{bool}{ skip = true}}
 
 \membersection{wxEvent::Skip}\label{wxeventskip}
 
 \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.
+This method can be called by an event handler and controls whether additional
+event handlers bound to this event will be called after the current event
+handler returns. The default behavior is equivalent to calling Skip(false)
+(which is, hence, usually unnecessary) and 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. If Skip(true) is
+called, the event processing system continues searching for a handler
+function for this event as if the current handler didn't exist.

 
 

-\membersection{wxEvent::StopPropagation}
+In general, it is recommended to skip all non-command events to allow the
+default handling to take place. The command events are, however, normally not
+skipped as usually a single command such as a button click or menu item
+selection must only be processed by one handler.

 
 

-\func{int}{StopPropagation}{\void}\label{wxeventstoppropagation}
+
+\membersection{wxEvent::StopPropagation}\label{wxeventstoppropagation}
+
+\func{int}{StopPropagation}{\void}

 
 Stop the event from propagating to its parent window.
 
 
 Stop the event from propagating to its parent window.
 


@@ -195,4 +197,3 @@ Returns the old propagation level value which may be later passed to
 \helpref{ResumePropagation}{wxeventresumepropagation} to allow propagating the
 event again.
 
 \helpref{ResumePropagation}{wxeventresumepropagation} to allow propagating the
 event again.
 

-