X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2b5f62a0b2db198609b45dec622a018dae37008e..56b88f1276ea4049a21f6174842b56ca9f280a3f:/docs/latex/wx/timer.tex diff --git a/docs/latex/wx/timer.tex b/docs/latex/wx/timer.tex index 262e8332fc..88ecf4940b 100644 --- a/docs/latex/wx/timer.tex +++ b/docs/latex/wx/timer.tex @@ -11,9 +11,13 @@ There are two different ways to use this class: \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 -constructor or \helpref{SetOwner}{wxtimersetowner}. Then use {\tt EVT\_TIMER} +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. +\item Or you may use a derived class and the {\tt EVT\_TIMER} +macro to connect it to an event handler defined in the derived class. +If the default constructor is used, the timer object will be its +own owner object, since it is derived from wxEvtHandler. \end{enumerate} In any case, you must start the timer with \helpref{Start}{wxtimerstart} @@ -24,7 +28,7 @@ be stopped later with \helpref{Stop}{wxtimerstop}. \wxheading{Derived from} -\helpref{wxObject}{wxobject} +\helpref{wxEvtHandler}{wxevthandler} \wxheading{Include files} @@ -55,7 +59,7 @@ Creates a timer and associates it with {\it owner}. Please see Destructor. Stops the timer if it is running. -\membersection{wxTimer::GetInterval}{wxtimergetinterval} +\membersection{wxTimer::GetInterval}\label{wxtimergetinterval} \constfunc{int}{GetInterval}{\void} @@ -65,14 +69,14 @@ Returns the current interval for the timer (in milliseconds). \constfunc{bool}{IsOneShot}{\void} -Returns {\tt TRUE} if the timer is one shot, i.e.\ if it will stop after firing the +Returns {\tt true} if the timer is one shot, i.e.\ if it will stop after firing the first notification automatically. \membersection{wxTimer::IsRunning}\label{wxtimerisrunning} \constfunc{bool}{IsRunning}{\void} -Returns {\tt TRUE} if the timer is running, {\tt FALSE} if it is stopped. +Returns {\tt true} if the timer is running, {\tt false} if it is stopped. \membersection{wxTimer::Notify}\label{wxtimernotify} @@ -93,14 +97,14 @@ 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, -{\tt TRUE} otherwise (in MS Windows timers are a limited resource). +the previous value is used. Returns {\tt false} if the timer could not be started, +{\tt true} otherwise (in MS Windows timers are a limited resource). -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}, +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}%