removed empty and unused CalculateScrollbar() method

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

diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex
index d6099d0c7b9f6f0d1af2b3795785e5c2bff4fd8a..db4c23d0fc935b2aee12d18f87deda58d06ab896 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,42 +24,34 @@ 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}
-
-\member{int}{m\_id}

 
 

-Identifier for the window.
+\membersection{wxEvent::m\_propagationLevel}\label{wxeventmpropagationlevel}

 
 

-\membersection{wxEvent::m\_skipped}

 
 

-\member{bool}{m\_skipped}
+\member{int}{m\_propagationLevel}

 
 

-Set to TRUE by {\bf Skip} if this event should be skipped.
+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}.

 
 

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

 
 

-\member{long}{m\_timeStamp}
+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.

 
 

-Timestamp for this event.

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


@@ -62,83 +59,139 @@ 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}

 
 

-\func{int}{GetId}{\void}
+\membersection{wxEvent::GetId}\label{wxeventgetid}
+
+\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::GetSkipped}

 
 

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

 
 

-\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}
+
+\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}}
+
+This method can be used inside an event handler to control whether further
+event handlers bound to this event will be called after the current one
+returns. Without Skip() (or equivalently if Skip(false) is used),
+the event will not be processed any more. If Skip(true) is called, the event
+processing system continues searching for a further handler function for this
+event, even though it has been processed already in the current handler.
+
+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.
+
+
+\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.