Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Some doc corrections; Watcom C++ corrections; VC++ 4 corrections

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@5875 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2000-02-06 19:11:10 +00:00
parent 46132182f0
commit 457e6c54a2
32 changed files with 350 additions and 313 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/latex/wx/timer.tex
View File

@@ -34,7 +34,7 @@ be stopped later with \helpref{Stop}{wxtimerstop}.
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxTimer::wxTimer}{wxtimerctordef}
\membersection{wxTimer::wxTimer}\label{wxtimerctordef}
\func{}{wxTimer}{\void}
@@ -42,7 +42,7 @@ 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}
\membersection{wxTimer::wxTimer}\label{wxtimerwxtimer}
\func{}{wxTimer}{\param{wxEvtHandler *}{owner}, \param{int }{id = -1}}
@@ -61,20 +61,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 +83,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 +91,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 +103,7 @@ 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}
\membersection{wxTimer::Stop}\label{wxtimerstop}
\func{void}{Stop}{\void}
@@ -153,7 +153,7 @@ void MyFrame::OnTimer(wxTimerEvent& event)
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxTimerEvent::GetInterval}{wxtimereventgetinterval}
\membersection{wxTimerEvent::GetInterval}\label{wxtimereventgetinterval}
\constfunc{int}{GetInterval}{\void}
@@ -204,3 +204,4 @@ Resumes the stop watch after having been paused with \helpref{wxStopWatch::Pause
Returns the time in milliseconds since the start (or restart) or the last call of
\helpref{wxStopWatch::Pause}{wxstopwatchpause}.