mention that timestamp is in ms

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39053 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2006-05-05 19:37:41 +00:00
parent b14b1312ac
commit 6f7b61759e

View File

@@ -24,14 +24,17 @@ For more information about events, see the \helpref{Event handling overview}{eve
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxEvent::wxEvent}\label{wxeventctor} \membersection{wxEvent::wxEvent}\label{wxeventctor}
\func{}{wxEvent}{\param{int }{id = 0}, \param{wxEventType }{eventType = {\tt wxEVT\_NULL}}} \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\_propagationLevel}\label{wxeventmpropagationlevel} \membersection{wxEvent::m\_propagationLevel}\label{wxeventmpropagationlevel}
\member{int}{m\_propagationLevel} \member{int}{m\_propagationLevel}
Indicates how many levels the event can propagate. This member is protected and Indicates how many levels the event can propagate. This member is protected and
@@ -49,6 +52,7 @@ 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 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. propagate the event to its parent only, but not to its grandparent.
\membersection{wxEvent::Clone}\label{wxeventclone} \membersection{wxEvent::Clone}\label{wxeventclone}
\constfunc{virtual wxEvent*}{Clone}{\void} \constfunc{virtual wxEvent*}{Clone}{\void}
@@ -70,6 +74,7 @@ a new event (call it MyEvent) and then define the Clone function like this:
wxEvent *Clone(void) const { return new MyEvent(*this); } wxEvent *Clone(void) const { return new MyEvent(*this); }
\end{verbatim} \end{verbatim}
\membersection{wxEvent::GetEventObject}\label{wxeventgeteventobject} \membersection{wxEvent::GetEventObject}\label{wxeventgeteventobject}
\func{wxObject*}{GetEventObject}{\void} \func{wxObject*}{GetEventObject}{\void}
@@ -77,6 +82,7 @@ a new event (call it MyEvent) and then define the Clone function like this:
Returns the object (usually a window) associated with the Returns the object (usually a window) associated with the
event, if any. event, if any.
\membersection{wxEvent::GetEventType}\label{wxeventgeteventtype} \membersection{wxEvent::GetEventType}\label{wxeventgeteventtype}
\func{WXTYPE}{GetEventType}{\void} \func{WXTYPE}{GetEventType}{\void}
@@ -84,23 +90,30 @@ event, if any.
Returns the identifier of the given event type, Returns the identifier of the given event type,
such as \texttt{wxEVT\_COMMAND\_BUTTON\_CLICKED}. such as \texttt{wxEVT\_COMMAND\_BUTTON\_CLICKED}.
\membersection{wxEvent::GetId}\label{wxeventgetid} \membersection{wxEvent::GetId}\label{wxeventgetid}
\constfunc{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::GetSkipped}\label{wxeventgetskipped} \membersection{wxEvent::GetSkipped}\label{wxeventgetskipped}
\constfunc{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}\label{wxeventgettimestamp} \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}
@@ -125,24 +138,28 @@ earlier call to \helpref{StopPropagation}{wxeventstoppropagation}).
Sets the originating object. Sets the originating object.
\membersection{wxEvent::SetEventType}\label{wxeventseteventtype} \membersection{wxEvent::SetEventType}\label{wxeventseteventtype}
\func{void}{SetEventType}{\param{WXTYPE }{typ}} \func{void}{SetEventType}{\param{WXTYPE }{typ}}
Sets the event type. Sets the event type.
\membersection{wxEvent::SetId}\label{wxeventsetid} \membersection{wxEvent::SetId}\label{wxeventsetid}
\func{void}{SetId}{\param{int}{ id}} \func{void}{SetId}{\param{int}{ id}}
Sets the identifier associated with this event, such as a button command id. Sets the identifier associated with this event, such as a button command id.
\membersection{wxEvent::SetTimestamp}\label{wxeventsettimestamp} \membersection{wxEvent::SetTimestamp}\label{wxeventsettimestamp}
\func{void}{SetTimestamp}{\param{long }{timeStamp}} \func{void}{SetTimestamp}{\param{long }{timeStamp}}
Sets the timestamp for the event. Sets the timestamp for the event.
\membersection{wxEvent::ShouldPropagate}\label{wxeventshouldpropagate} \membersection{wxEvent::ShouldPropagate}\label{wxeventshouldpropagate}
\constfunc{bool}{ShouldPropagate}{\void} \constfunc{bool}{ShouldPropagate}{\void}
@@ -150,6 +167,7 @@ Sets the timestamp for the event.
Test if this event should be propagated or not, i.e. if the propagation level Test if this event should be propagated or not, i.e. if the propagation level
is currently greater than $0$. 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}}