remove C++ comment

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

diff --git a/docs/latex/wx/timer.tex b/docs/latex/wx/timer.tex
index d5554cd07c825cbedd63610b473912a6fcc82547..f5d7b52f5fee5b914826f6aff496582543e195a8 100644 (file)
--- 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.
 
 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
+\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.
 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,19 +24,24 @@ 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}.
 
 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}
 
 \wxheading{Derived from}
 
 \helpref{wxEvtHandler}{wxevthandler}

+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 <wx/timer.h>
 
 
 \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}}}
 


@@ -65,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}


@@ -123,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.


@@ -157,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}


@@ -173,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.
+