X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/641d44aef554d7e62d8bd0f35c98bd2b9b15b5b0..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/timer.tex?ds=sidebyside diff --git a/docs/latex/wx/timer.tex b/docs/latex/wx/timer.tex index b1577120f4..f5d7b52f5f 100644 --- a/docs/latex/wx/timer.tex +++ b/docs/latex/wx/timer.tex @@ -35,9 +35,13 @@ be stopped later with \helpref{Stop}{wxtimerstop}. +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} -\helpref{::wxStartTimer}{wxstarttimer}, \helpref{::wxGetElapsedTime}{wxgetelapsedtime}, \helpref{wxStopWatch}{wxstopwatch} +\helpref{wxStopWatch}{wxstopwatch} \latexignore{\rtfignore{\wxheading{Members}}} @@ -66,6 +70,20 @@ Destructor. Stops the timer if it is running. 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} @@ -124,6 +142,13 @@ restarting it. Stops the timer. + + + + +%% wxTimerEvent + + \section{\class{wxTimerEvent}}\label{wxtimerevent} wxTimerEvent object is passed to the event handler of timer events. @@ -160,12 +185,17 @@ void MyFrame::OnTimer(wxTimerEvent& event) \wxheading{Derived from} -\helpref{wxEvent}{wxevent} +\helpref{wxEvent}{wxevent}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxTimer}{wxtimer} @@ -178,3 +208,10 @@ void MyFrame::OnTimer(wxTimerEvent& 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. +