X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2531c7e393e87dabaf6ae20301044ad893cb3ece..a9249b2eb2a40d8c71f828669045c4ddaa8dc5ff:/docs/latex/wx/timer.tex?ds=sidebyside diff --git a/docs/latex/wx/timer.tex b/docs/latex/wx/timer.tex index 05e5f0e1c7..97939eb2ba 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}{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}{wxtimerwxtimer} - \func{}{wxTimer}{\param{wxEvtHandler *}{owner}, \param{int }{id = -1}} Creates a timer and associates it with {\it owner}. Please see @@ -61,20 +59,20 @@ Destructor. Stops the timer if it is running. Returns the current interval for the timer (in milliseconds). -\membersection{wxTimer::IsOneShot}{wxtimerisoneshot} +\membersection{wxTimer::IsOneShot}\label{wxtimerisoneshot} \constfunc{bool}{IsOneShot}{\void} Returns TRUE if the timer is one shot, i.e. if it will stop after firing the first notification automatically. -\membersection{wxTimer::IsRunning}{wxtimerisrunning} +\membersection{wxTimer::IsRunning}\label{wxtimerisrunning} \constfunc{bool}{IsRunning}{\void} Returns TRUE if the timer is running, FALSE if it is stopped. -\membersection{wxTimer::Notify}{wxtimernotify} +\membersection{wxTimer::Notify}\label{wxtimernotify} \func{void}{Notify}{\void} @@ -83,7 +81,7 @@ used and \helpref{SetOwner}{wxtimersetowner} wasn't called. Perform whatever action which is to be taken periodically here. -\membersection{wxTimer::SetOwner}{wxtimersetowner} +\membersection{wxTimer::SetOwner}\label{wxtimersetowner} \func{void}{SetOwner}{\param{wxEvtHandler *}{owner}, \param{int }{id = -1}} @@ -91,7 +89,7 @@ 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. -\membersection{wxTimer::Start}{wxtimerstart} +\membersection{wxTimer::Start}\label{wxtimerstart} \func{bool}{Start}{\param{int}{ milliseconds = -1}, \param{bool}{ oneShot=FALSE}} @@ -103,7 +101,10 @@ 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. -\membersection{wxTimer::Stop}{wxtimerstop} +If the timer was already running, it will be stopped by this method before +restarting it. + +\membersection{wxTimer::Stop}\label{wxtimerstop} \func{void}{Stop}{\void} @@ -153,54 +154,9 @@ void MyFrame::OnTimer(wxTimerEvent& event) \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxTimerEvent::GetInterval}{wxtimereventgetinterval} +\membersection{wxTimerEvent::GetInterval}\label{wxtimereventgetinterval} \constfunc{int}{GetInterval}{\void} Returns the interval of the timer which generated this event. -\section{\class{wxStopWatch}}\label{wxstopwatch} - -The wxStopWatch class allow you to measure time intervalls. - -\wxheading{Include files} - - - -\wxheading{See also} - -\helpref{::wxStartTimer}{wxstarttimer}, \helpref{::wxGetElapsedTime}{wxgetelapsedtime}, \helpref{wxTimer}{wxtimer} - -\latexignore{\rtfignore{\wxheading{Members}}} - -\membersection{wxStopWatch::wxStopWatch} - -\func{}{wxStopWatch}{\void} - -Constructor. This starts the stop watch. - -\membersection{wxStopWatch::Pause}\label{wxstopwatchpause} - -\func{void}{Pause}{\void} - -Pauses the stop watch. Call \helpref{wxStopWatch::Resume}{wxstopwatchresume} to resume -time measuring again. - -\membersection{wxStopWatch::Start} - -\func{void}{Start}{\param{long}{ milliseconds = 0}} - -(Re)starts the stop watch with a given initial value. - -\membersection{wxStopWatch::Resume}\label{wxstopwatchresume} - -\func{void}{Resume}{\void} - -Resumes the stop watch after having been paused with \helpref{wxStopWatch::Pause}{wxstopwatchpause}. - -\membersection{wxStopWatch::Time} - -\func{long}{Time}{\void}\label{wxstopwatchtime} - -Returns the time in milliseconds since the start (or restart) or the last call of -\helpref{wxStopWatch::Pause}{wxstopwatchpause}.