X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/01ebf7520366a4cf80975d820794fea394c96d7b..dba7934c9d1b520ff7b48cd0d80cc52f8be6a052:/docs/latex/wx/timer.tex?ds=sidebyside diff --git a/docs/latex/wx/timer.tex b/docs/latex/wx/timer.tex index 88ecf4940b..b1577120f4 100644 --- a/docs/latex/wx/timer.tex +++ b/docs/latex/wx/timer.tex @@ -4,13 +4,13 @@ The wxTimer class allows you to execute code at specified intervals. Its precision is platform-dependent, but in general will not be better than 1ms nor worse than 1s. -There are two different ways to use this class: +There are three different ways to use this class: \begin{enumerate} \item You may derive a new class from wxTimer and override the \helpref{Notify}{wxtimernotify} member to perform the required action. \item Or you may redirect the notifications to any -\helpref{wxEvtHandler}{wxevthandler} derived object by using the non default +\helpref{wxEvtHandler}{wxevthandler} derived object by using the non-default constructor or \helpref{SetOwner}{wxtimersetowner}. Then use the {\tt EVT\_TIMER} macro to connect it to the event handler which will receive \helpref{wxTimerEvent}{wxtimerevent} notifications. @@ -24,11 +24,12 @@ In any case, you must start the timer with \helpref{Start}{wxtimerstart} after constructing it before it actually starts sending notifications. It can be stopped later with \helpref{Stop}{wxtimerstop}. -{\bf NB:} note that timer can only be used from the main thread currently. +{\bf Note:} A timer can only be used from the main thread. \wxheading{Derived from} \helpref{wxEvtHandler}{wxevthandler} +\helpref{wxObject}{wxobject} \wxheading{Include files} @@ -53,7 +54,7 @@ Default constructor. If you use it to construct the object and don't call Creates a timer and associates it with {\it owner}. Please see \helpref{SetOwner}{wxtimersetowner} for the description of parameters. -\membersection{wxTimer::\destruct{wxTimer}} +\membersection{wxTimer::\destruct{wxTimer}}\label{wxtimerdtor} \func{}{\destruct{wxTimer}}{\void} @@ -97,7 +98,7 @@ id equal to {\it id}\/ specified here. \membersection{wxTimer::Start}\label{wxtimerstart} -\func{bool}{Start}{\param{int}{milliseconds = -1}, \param{bool }{oneShot = {\tt false}}} +\func{bool}{Start}{\param{int }{milliseconds = -1}, \param{bool }{oneShot = {\tt false}}} (Re)starts the timer. If {\it milliseconds}\/ parameter is -1 (value by default), the previous value is used. Returns {\tt false} if the timer could not be started, @@ -106,14 +107,14 @@ the previous value is used. Returns {\tt false} if the timer could not be starte If {\it oneShot}\/ is {\tt false} (the default), the \helpref{Notify}{wxtimernotify} function will be called repeatedly until the timer is stopped. If {\tt true}, it will be called only once and the timer will stop automatically. To make your -code more readable you may also use the following symbolic constants -\twocolwidtha{5cm}% +code more readable you may also use the following symbolic constants: + +\twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt \twocolitem{wxTIMER\_CONTINUOUS}{Start a normal, continuously running, timer} \twocolitem{wxTIMER\_ONE\_SHOT}{Start a one shot timer} \end{twocollist} - If the timer was already running, it will be stopped by this method before restarting it. @@ -157,6 +158,10 @@ void MyFrame::OnTimer(wxTimerEvent& event) \end{verbatim} +\wxheading{Derived from} + +\helpref{wxEvent}{wxevent} + \wxheading{Include files}