Sophie

Sophie

distrib > * > 2009.0 > i586 > by-pkgid > a6711891ce757817bba854bf3f25205a > files > 1927

qtjambi-doc-4.3.3-3mdv2008.1.i586.rpm

<class name="QBasicTimer" doc="/**
&lt;p&gt;The &lt;a href=&quot;QBasicTimer.html#QBasicTimer()&quot;&gt;&lt;tt&gt;QBasicTimer&lt;/tt&gt;&lt;/a&gt; class provides timer events for objects.&lt;/p&gt;
&lt;p&gt;This is a fast, lightweight, and low-level class used by Qt internally. We recommend using the higher-level &lt;a href=&quot;QTimer.html&quot;&gt;&lt;tt&gt;QTimer&lt;/tt&gt;&lt;/a&gt; class rather than this class if you want to use timers in your applications.&lt;/p&gt;
&lt;p&gt;To use this class, create a &lt;a href=&quot;QBasicTimer.html#QBasicTimer()&quot;&gt;&lt;tt&gt;QBasicTimer&lt;/tt&gt;&lt;/a&gt;, and call its &lt;a href=&quot;QBasicTimer.html#start(int, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;start&lt;/tt&gt;&lt;/a&gt; function with a timeout interval and with a pointer to a &lt;a href=&quot;QObject.html&quot;&gt;&lt;tt&gt;QObject&lt;/tt&gt;&lt;/a&gt; subclass. When the timer times out it will send a timer event to the &lt;a href=&quot;QObject.html&quot;&gt;&lt;tt&gt;QObject&lt;/tt&gt;&lt;/a&gt; subclass. The timer can be stopped at any time using &lt;a href=&quot;QBasicTimer.html#stop()&quot;&gt;&lt;tt&gt;stop&lt;/tt&gt;&lt;/a&gt;. &lt;a href=&quot;QBasicTimer.html#isActive()&quot;&gt;&lt;tt&gt;isActive&lt;/tt&gt;&lt;/a&gt; returns true for a timer that is running; i.e&amp;#x2e; it has been started, has not reached the timeout time, and has not been stopped. The timer's ID can be retrieved using &lt;a href=&quot;QBasicTimer.html#timerId()&quot;&gt;&lt;tt&gt;timerId&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;The Wiggly&lt;/tt&gt; example uses &lt;a href=&quot;QBasicTimer.html#QBasicTimer()&quot;&gt;&lt;tt&gt;QBasicTimer&lt;/tt&gt;&lt;/a&gt; to repaint a widget at regular intervals.&lt;/p&gt;

@see &lt;a href=&quot;QTimer.html&quot;&gt;&lt;tt&gt;QTimer&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTimerEvent.html&quot;&gt;&lt;tt&gt;QTimerEvent&lt;/tt&gt;&lt;/a&gt;
@see &lt;tt&gt;QObject::timerEvent&lt;/tt&gt;
@see &lt;a href=&quot;%2E%2E/timers.html&quot;&gt;Timers&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;%2E%2E/qtjambi-wiggly.html&quot;&gt;Wiggly Example&lt;/tt&gt;&lt;/a&gt; */">
    <method name="public QBasicTimer()" doc="/**
&lt;p&gt;Contructs a basic timer.&lt;/p&gt;

@see &lt;a href=&quot;QBasicTimer.html#start(int, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;start&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final boolean isActive()" doc="/**
&lt;p&gt;Returns true if the timer is running, has not yet timed out, and has not been stopped; otherwise returns false.&lt;/p&gt;

@see &lt;a href=&quot;QBasicTimer.html#start(int, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;start&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QBasicTimer.html#stop()&quot;&gt;&lt;tt&gt;stop&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void start(int msec, com.trolltech.qt.core.QObject obj)" doc="/**
&lt;p&gt;Starts (or restarts) the timer with a &lt;tt&gt;msec&lt;/tt&gt; milliseconds timeout.&lt;/p&gt;
&lt;p&gt;The given &lt;tt&gt;obj&lt;/tt&gt; will receive timer events.&lt;/p&gt;

@see &lt;a href=&quot;QBasicTimer.html#stop()&quot;&gt;&lt;tt&gt;stop&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QBasicTimer.html#isActive()&quot;&gt;&lt;tt&gt;isActive&lt;/tt&gt;&lt;/a&gt;
@see &lt;tt&gt;QObject::timerEvent&lt;/tt&gt; */"/>
    <method name="public final void stop()" doc="/**
&lt;p&gt;Stops the timer.&lt;/p&gt;

@see &lt;a href=&quot;QBasicTimer.html#start(int, com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;start&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QBasicTimer.html#isActive()&quot;&gt;&lt;tt&gt;isActive&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final int timerId()" doc="/**
&lt;p&gt;Returns the timer's ID.&lt;/p&gt;

@see &lt;tt&gt;QTimerEvent::timerId&lt;/tt&gt; */"/>
</class>