cheng/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

mention that timestamp is in ms

Browse Source 
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
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/latex/wx/event.tex
View File

@ -24,14 +24,17 @@ For more information about events, see the \helpref{Event handling overview}{eve
\latexignore{\rtfignore{\wxheading{Members}}}
\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.
\membersection{wxEvent::m\_propagationLevel}\label{wxeventmpropagationlevel}
\member{int}{m\_propagationLevel}
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
propagate the event to its parent only, but not to its grandparent.
\membersection{wxEvent::Clone}\label{wxeventclone}
\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); }
\end{verbatim}
\membersection{wxEvent::GetEventObject}\label{wxeventgeteventobject}
\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
event, if any.
\membersection{wxEvent::GetEventType}\label{wxeventgeteventtype}
\func{WXTYPE}{GetEventType}{\void}
@ -84,23 +90,30 @@ event, if any.
Returns the identifier of the given event type,
such as \texttt{wxEVT\_COMMAND\_BUTTON\_CLICKED}.
\membersection{wxEvent::GetId}\label{wxeventgetid}
\constfunc{int}{GetId}{\void}
Returns the identifier associated with this event, such as a button command id.
\membersection{wxEvent::GetSkipped}\label{wxeventgetskipped}
\constfunc{bool}{GetSkipped}{\void}
Returns true if the event handler should be skipped, false otherwise.
\membersection{wxEvent::GetTimestamp}\label{wxeventgettimestamp}
\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}
@ -125,24 +138,28 @@ earlier call to \helpref{StopPropagation}{wxeventstoppropagation}).
Sets the originating object.
\membersection{wxEvent::SetEventType}\label{wxeventseteventtype}
\func{void}{SetEventType}{\param{WXTYPE }{typ}}
Sets the event type.
\membersection{wxEvent::SetId}\label{wxeventsetid}
\func{void}{SetId}{\param{int}{ id}}
Sets the identifier associated with this event, such as a button command id.
\membersection{wxEvent::SetTimestamp}\label{wxeventsettimestamp}
\func{void}{SetTimestamp}{\param{long }{timeStamp}}
Sets the timestamp for the event.
\membersection{wxEvent::ShouldPropagate}\label{wxeventshouldpropagate}
\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
is currently greater than $0$.
\membersection{wxEvent::Skip}\label{wxeventskip}
\func{void}{Skip}{\param{bool}{ skip = true}}