X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9c824f2977a2e8a502b0570c5301caa2a547833a..3e60899273993070615df55ff895cc39346754b9:/docs/latex/wx/timer.tex

diff --git a/docs/latex/wx/timer.tex b/docs/latex/wx/timer.tex
index 00eba9a6ca..7830183b5d 100644
--- a/docs/latex/wx/timer.tex
+++ b/docs/latex/wx/timer.tex
@@ -34,7 +34,7 @@ be stopped later with \helpref{Stop}{wxtimerstop}.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxTimer::wxTimer}\label{wxtimerctordef}
+\membersection{wxTimer::wxTimer}\label{wxtimerwxtimer}
 
 \func{}{wxTimer}{\void}
 
@@ -42,8 +42,6 @@ Default constructor. If you use it to construct the object and don't call
 \helpref{SetOwner}{wxtimersetowner} later, you must override 
 \helpref{Notify}{wxtimernotify} method to process the notifications.
 
-\membersection{wxTimer::wxTimer}\label{wxtimerwxtimer}
-
 \func{}{wxTimer}{\param{wxEvtHandler *}{owner}, \param{int }{id = -1}}
 
 Creates a timer and associates it with {\it owner}. Please see 
@@ -65,14 +63,14 @@ Returns the current interval for the timer (in milliseconds).
 
 \constfunc{bool}{IsOneShot}{\void}
 
-Returns 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 TRUE if the timer is running, FALSE if it is stopped.
+Returns {\tt TRUE} if the timer is running, {\tt FALSE} if it is stopped.
 
 \membersection{wxTimer::Notify}\label{wxtimernotify}
 
@@ -87,21 +85,31 @@ Perform whatever action which is to be taken periodically here.
 
 \func{void}{SetOwner}{\param{wxEvtHandler *}{owner}, \param{int }{id = -1}}
 
-Associates the timer with the given {\it owner} object. When the timer is
+Associates the timer with the given {\it owner}\/ object. When the timer is
 running, the owner will receive \helpref{timer events}{wxtimerevent} with
-id equal to {\it id} specified here.
+id equal to {\it id}\/ specified here.
 
 \membersection{wxTimer::Start}\label{wxtimerstart}
 
-\func{bool}{Start}{\param{int}{ milliseconds = -1}, \param{bool}{ oneShot=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).
+
+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}%
+\begin{twocollist}\itemsep=0pt
+\twocolitem{wxTIMER\_CONTINUOUS}{Start a normal, continuously running, timer}
+\twocolitem{wxTIMER\_ONE\_SHOT}{Start a one shot timer}
+\end{twocollist}
 
-(Re)starts the timer. If {\it milliseconds} parameter is -1 (value by default),
-the previous value is used. Returns FALSE if the timer could not be started,
-TRUE otherwise (in MS Windows timers are a limited resource).
 
-If {\it oneShot} is FALSE (the default), the \helpref{Notify}{wxtimernotify} 
-function will be called repeatedly until the timer is stopped. If TRUE,
-it will be called only once and the timer will stop automatically.
+If the timer was already running, it will be stopped by this method before
+restarting it.
 
 \membersection{wxTimer::Stop}\label{wxtimerstop}