Added wxDataViewTreeCtrl

[wxWidgets.git] / docs / latex / wx / timer.tex

diff --git a/docs/latex/wx/timer.tex b/docs/latex/wx/timer.tex
index 1648196884231477264597571ccd2e2ce68cd99b..f5d7b52f5fee5b914826f6aff496582543e195a8 100644 (file)
--- a/docs/latex/wx/timer.tex
+++ b/docs/latex/wx/timer.tex
@@ -4,35 +4,44 @@ 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.
 
 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 
 
 \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
-constructor or \helpref{SetOwner}{wxtimersetowner}. Then use {\tt EVT\_TIMER} 
+\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.
 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} 
 after constructing it before it actually starts sending notifications. It can
 be stopped later with \helpref{Stop}{wxtimerstop}.
 
 \end{enumerate}
 
 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}
 
 
 \wxheading{Derived from}
 

+\helpref{wxEvtHandler}{wxevthandler}

 \helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
 <wx/timer.h>
 
 \helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
 <wx/timer.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \wxheading{See also}
 

-\helpref{::wxStartTimer}{wxstarttimer}, \helpref{::wxGetElapsedTime}{wxgetelapsedtime}, \helpref{wxStopWatch}{wxstopwatch}
+\helpref{wxStopWatch}{wxstopwatch}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 


@@ -49,7 +58,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.
 
 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}
 
 
 \func{}{\destruct{wxTimer}}{\void}
 


@@ -61,6 +70,20 @@ Destructor. Stops the timer if it is running.
 
 Returns the current interval for the timer (in milliseconds).
 
 
 Returns the current interval for the timer (in milliseconds).
 

+\membersection{wxTimer::GetOwner}\label{wxtimergetowner}
+
+\constfunc{wxEvtHandler}{GetOwner}{\void}
+
+Returns the current {\it owner} of the timer.
+If non-\NULL this is the event handler which will receive the 
+\helpref{timer events}{wxtimerevent} when the timer is running.
+
+\membersection{wxTimer::GetId}\label{wxtimergetid}
+
+\constfunc{int}{GetId}{\void}
+
+Returns the ID of the events generated by this timer.
+

 \membersection{wxTimer::IsOneShot}\label{wxtimerisoneshot}
 
 \constfunc{bool}{IsOneShot}{\void}
 \membersection{wxTimer::IsOneShot}\label{wxtimerisoneshot}
 
 \constfunc{bool}{IsOneShot}{\void}


@@ -93,7 +116,7 @@ id equal to {\it id}\/ specified here.
 
 \membersection{wxTimer::Start}\label{wxtimerstart}
 
 
 \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,
 
 (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,


@@ -102,14 +125,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
 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}
 
 \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.
 
 If the timer was already running, it will be stopped by this method before
 restarting it.
 


@@ -119,6 +142,13 @@ restarting it.
 
 Stops the timer.
 
 
 Stops the timer.
 

+
+
+
+
+%% wxTimerEvent
+
+

 \section{\class{wxTimerEvent}}\label{wxtimerevent}
 
 wxTimerEvent object is passed to the event handler of timer events.
 \section{\class{wxTimerEvent}}\label{wxtimerevent}
 
 wxTimerEvent object is passed to the event handler of timer events.


@@ -153,10 +183,19 @@ void MyFrame::OnTimer(wxTimerEvent& event)
 
 \end{verbatim}
 
 
 \end{verbatim}
 

+\wxheading{Derived from}
+
+\helpref{wxEvent}{wxevent}\\
+\helpref{wxObject}{wxobject}
+

 \wxheading{Include files}
 
 <wx/timer.h>
 
 \wxheading{Include files}
 
 <wx/timer.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxTimer}{wxtimer}
 \wxheading{See also}
 
 \helpref{wxTimer}{wxtimer}


@@ -169,3 +208,10 @@ void MyFrame::OnTimer(wxTimerEvent& event)
 
 Returns the interval of the timer which generated this event.
 
 
 Returns the interval of the timer which generated this event.
 

+
+\membersection{wxTimerEvent::GetTimer}\label{wxtimereventgettimer}
+
+\constfunc{wxTimer\&}{GetTimer}{\void}
+
+Returns the timer object which generated this event.
+