<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qabstractanimation.cpp -->
<title>Qt 4.8: QAbstractAnimation Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtcore.html">QtCore</a></li>
<li>QAbstractAnimation</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QAbstractAnimation Class Reference</h1>
<!-- $$$QAbstractAnimation-brief -->
<p>The QAbstractAnimation class is the base of all animations. <a href="#details">More...</a></p>
<!-- @@@QAbstractAnimation -->
<pre class="cpp"> <span class="preprocessor">#include <QAbstractAnimation></span></pre><p><b>Inherits: </b><a href="qobject.html">QObject</a>.</p>
<p><b>Inherited by: </b><a href="qanimationgroup.html">QAnimationGroup</a>, <a href="qpauseanimation.html">QPauseAnimation</a>, and <a href="qvariantanimation.html">QVariantAnimation</a>.</p>
<p>This class was introduced in Qt 4.6.</p>
<ul>
<li><a href="qabstractanimation-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#DeletionPolicy-enum">DeletionPolicy</a></b> { KeepWhenStopped, DeleteWhenStopped }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#Direction-enum">Direction</a></b> { Forward, Backward }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#State-enum">State</a></b> { Stopped, Paused, Running }</td></tr>
</table>
<a name="properties"></a>
<h2>Properties</h2>
<table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qabstractanimation.html#currentLoop-prop">currentLoop</a></b> : const int</li>
<li class="fn"><b><a href="qabstractanimation.html#currentTime-prop">currentTime</a></b> : int</li>
<li class="fn"><b><a href="qabstractanimation.html#direction-prop">direction</a></b> : Direction</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qabstractanimation.html#duration-prop">duration</a></b> : const int</li>
<li class="fn"><b><a href="qabstractanimation.html#loopCount-prop">loopCount</a></b> : int</li>
<li class="fn"><b><a href="qabstractanimation.html#state-prop">state</a></b> : const State</li>
</ul>
</td></tr>
</table>
<ul>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#QAbstractAnimation">QAbstractAnimation</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#dtor.QAbstractAnimation">~QAbstractAnimation</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#currentLoop-prop">currentLoop</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#currentLoopTime">currentLoopTime</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#currentTime-prop">currentTime</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Direction </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#direction-prop">direction</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#duration-prop">duration</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QAnimationGroup * </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#group">group</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#loopCount-prop">loopCount</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#direction-prop">setDirection</a></b> ( Direction <i>direction</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#loopCount-prop">setLoopCount</a></b> ( int <i>loopCount</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> State </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#state-prop">state</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#totalDuration">totalDuration</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#pause">pause</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#resume">resume</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#currentTime-prop">setCurrentTime</a></b> ( int <i>msecs</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#setPaused">setPaused</a></b> ( bool <i>paused</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#start">start</a></b> ( QAbstractAnimation::DeletionPolicy <i>policy</i> = KeepWhenStopped )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#stop">stop</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#currentLoopChanged">currentLoopChanged</a></b> ( int <i>currentLoop</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#directionChanged">directionChanged</a></b> ( QAbstractAnimation::Direction <i>newDirection</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#finished">finished</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#stateChanged">stateChanged</a></b> ( QAbstractAnimation::State <i>newState</i>, QAbstractAnimation::State <i>oldState</i> )</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#updateCurrentTime">updateCurrentTime</a></b> ( int <i>currentTime</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#updateDirection">updateDirection</a></b> ( QAbstractAnimation::Direction <i>direction</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#updateState">updateState</a></b> ( QAbstractAnimation::State <i>newState</i>, QAbstractAnimation::State <i>oldState</i> )</td></tr>
</table>
<a name="reimplemented-protected-functions"></a>
<h2>Reimplemented Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractanimation.html#event">event</a></b> ( QEvent * <i>event</i> )</td></tr>
</table>
<ul>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAbstractAnimation-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QAbstractAnimation class is the base of all animations.</p>
<p>The class defines the functions for the functionality shared by all animations. By inheriting this class, you can create custom animations that plug into the rest of the animation framework.</p>
<p>The progress of an animation is given by its current time (<a href="qabstractanimation.html#currentLoopTime">currentLoopTime</a>()), which is measured in milliseconds from the start of the animation (0) to its end (<a href="qabstractanimation.html#duration-prop">duration</a>()). The value is updated automatically while the animation is running. It can also be set directly with <a href="qabstractanimation.html#currentTime-prop">setCurrentTime</a>().</p>
<p>At any point an animation is in one of three states: <a href="qabstractanimation.html#State-enum">Running</a>, <a href="qabstractanimation.html#State-enum">Stopped</a>, or <a href="qabstractanimation.html#State-enum">Paused</a>--as defined by the <a href="qabstractanimation.html#State-enum">State</a> enum. The current state can be changed by calling <a href="qabstractanimation.html#start">start</a>(), <a href="qabstractanimation.html#stop">stop</a>(), <a href="qabstractanimation.html#pause">pause</a>(), or <a href="qabstractanimation.html#resume">resume</a>(). An animation will always reset its <a href="qabstractanimation.html#currentTime-prop">current time</a> when it is started. If paused, it will continue with the same current time when resumed. When an animation is stopped, it cannot be resumed, but will keep its current time (until started again). QAbstractAnimation will emit <a href="qabstractanimation.html#stateChanged">stateChanged</a>() whenever its state changes.</p>
<p>An animation can loop any number of times by setting the <a href="qabstractanimation.html#loopCount-prop">loopCount</a> property. When an animation's current time reaches its <a href="qabstractanimation.html#duration-prop">duration</a>(), it will reset the current time and keep running. A loop count of 1 (the default value) means that the animation will run one time. Note that a duration of -1 means that the animation will run until stopped; the current time will increase indefinitely. When the current time equals <a href="qabstractanimation.html#duration-prop">duration</a>() and the animation is in its final loop, the <a href="qabstractanimation.html#State-enum">Stopped</a> state is entered, and the <a href="qabstractanimation.html#finished">finished</a>() signal is emitted.</p>
<p>QAbstractAnimation provides pure virtual functions used by subclasses to track the progress of the animation: <a href="qabstractanimation.html#duration-prop">duration</a>() and <a href="qabstractanimation.html#updateCurrentTime">updateCurrentTime</a>(). The <a href="qabstractanimation.html#duration-prop">duration</a>() function lets you report a duration for the animation (as discussed above). The animation framework calls <a href="qabstractanimation.html#updateCurrentTime">updateCurrentTime</a>() when current time has changed. By reimplementing this function, you can track the animation progress. Note that neither the interval between calls nor the number of calls to this function are defined; though, it will normally be 60 updates per second.</p>
<p>By reimplementing <a href="qabstractanimation.html#updateState">updateState</a>(), you can track the animation's state changes, which is particularly useful for animations that are not driven by time.</p>
</div>
<p><b>See also </b><a href="qvariantanimation.html">QVariantAnimation</a>, <a href="qpropertyanimation.html">QPropertyAnimation</a>, <a href="qanimationgroup.html">QAnimationGroup</a>, and <a href="animation-overview.html">The Animation Framework</a>.</p>
<!-- @@@QAbstractAnimation -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$DeletionPolicy$$$KeepWhenStopped$$$DeleteWhenStopped -->
<h3 class="fn"><a name="DeletionPolicy-enum"></a>enum QAbstractAnimation::<span class="name">DeletionPolicy</span></h3>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QAbstractAnimation::KeepWhenStopped</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The animation will not be deleted when stopped.</td></tr>
<tr><td class="topAlign"><tt>QAbstractAnimation::DeleteWhenStopped</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The animation will be automatically deleted when stopped.</td></tr>
</table>
<!-- @@@DeletionPolicy -->
<!-- $$$Direction$$$Forward$$$Backward -->
<h3 class="fn"><a name="Direction-enum"></a>enum QAbstractAnimation::<span class="name">Direction</span></h3>
<p>This enum describes the direction of the animation when in <a href="qabstractanimation.html#State-enum">Running</a> state.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QAbstractAnimation::Forward</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The current time of the animation increases with time (i.e., moves from 0 and towards the end / duration).</td></tr>
<tr><td class="topAlign"><tt>QAbstractAnimation::Backward</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The current time of the animation decreases with time (i.e., moves from the end / duration and towards 0).</td></tr>
</table>
<p><b>See also </b><a href="qabstractanimation.html#direction-prop">direction</a>.</p>
<!-- @@@Direction -->
<!-- $$$State$$$Stopped$$$Paused$$$Running -->
<h3 class="fn"><a name="State-enum"></a>enum QAbstractAnimation::<span class="name">State</span></h3>
<p>This enum describes the state of the animation.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QAbstractAnimation::Stopped</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The animation is not running. This is the initial state of <a href="qabstractanimation.html">QAbstractAnimation</a>, and the state <a href="qabstractanimation.html">QAbstractAnimation</a> reenters when finished. The current time remain unchanged until either <a href="qabstractanimation.html#currentTime-prop">setCurrentTime</a>() is called, or the animation is started by calling <a href="qabstractanimation.html#start">start</a>().</td></tr>
<tr><td class="topAlign"><tt>QAbstractAnimation::Paused</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The animation is paused (i.e., temporarily suspended). Calling <a href="qabstractanimation.html#resume">resume</a>() will resume animation activity.</td></tr>
<tr><td class="topAlign"><tt>QAbstractAnimation::Running</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The animation is running. While control is in the event loop, <a href="qabstractanimation.html">QAbstractAnimation</a> will update its current time at regular intervals, calling <a href="qabstractanimation.html#updateCurrentTime">updateCurrentTime</a>() when appropriate.</td></tr>
</table>
<p><b>See also </b><a href="qabstractanimation.html#state-prop">state</a>() and <a href="qabstractanimation.html#stateChanged">stateChanged</a>().</p>
<!-- @@@State -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$currentLoop-prop$$$currentLoop$$$currentLoopChangedint -->
<h3 class="fn"><a name="currentLoop-prop"></a><span class="name">currentLoop</span> : const <span class="type">int</span></h3>
<p>This property holds the current loop of the animation.</p>
<p>This property describes the current loop of the animation. By default, the animation's loop count is 1, and so the current loop will always be 0. If the loop count is 2 and the animation runs past its duration, it will automatically rewind and restart at current time 0, and current loop 1, and so on.</p>
<p>When the current loop changes, <a href="qabstractanimation.html">QAbstractAnimation</a> emits the <a href="qabstractanimation.html#currentLoopChanged">currentLoopChanged</a>() signal.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>currentLoop</b></span> () const</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qabstractanimation.html#currentLoopChanged">currentLoopChanged</a></b></span> ( int <i>currentLoop</i> )</td></tr>
</table>
<!-- @@@currentLoop -->
<!-- $$$currentTime-prop$$$currentTime$$$setCurrentTimeint -->
<h3 class="fn"><a name="currentTime-prop"></a><span class="name">currentTime</span> : <span class="type">int</span></h3>
<p>This property holds the current time and progress of the animation.</p>
<p>This property describes the animation's current time. You can change the current time by calling setCurrentTime, or you can call <a href="qabstractanimation.html#start">start</a>() and let the animation run, setting the current time automatically as the animation progresses.</p>
<p>The animation's current time starts at 0, and ends at <a href="qabstractanimation.html#totalDuration">totalDuration</a>().</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>currentTime</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setCurrentTime</b></span> ( int <i>msecs</i> )</td></tr>
</table>
<p><b>See also </b><a href="qabstractanimation.html#loopCount-prop">loopCount</a> and <a href="qabstractanimation.html#currentLoopTime">currentLoopTime</a>().</p>
<!-- @@@currentTime -->
<!-- $$$direction-prop$$$direction$$$setDirectionDirection$$$directionChangedQAbstractAnimation::Direction -->
<h3 class="fn"><a name="direction-prop"></a><span class="name">direction</span> : <span class="type"><a href="qabstractanimation.html#Direction-enum">Direction</a></span></h3>
<p>This property holds the direction of the animation when it is in Running state.</p>
<p>This direction indicates whether the time moves from 0 towards the animation duration, or from the value of the duration and towards 0 after <a href="qabstractanimation.html#start">start</a>() has been called.</p>
<p>By default, this property is set to <a href="qabstractanimation.html#Direction-enum">Forward</a>.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Direction </td><td class="memItemRight bottomAlign"><span class="name"><b>direction</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setDirection</b></span> ( Direction <i>direction</i> )</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qabstractanimation.html#directionChanged">directionChanged</a></b></span> ( QAbstractAnimation::Direction <i>newDirection</i> )</td></tr>
</table>
<!-- @@@direction -->
<!-- $$$duration-prop$$$duration -->
<h3 class="fn"><a name="duration-prop"></a><span class="name">duration</span> : const <span class="type">int</span></h3>
<p>This property holds the duration of the animation.</p>
<p>If the duration is -1, it means that the duration is undefined. In this case, <a href="qabstractanimation.html#loopCount-prop">loopCount</a> is ignored.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> virtual int </td><td class="memItemRight bottomAlign"><span class="name"><b>duration</b></span> () const = 0</td></tr>
</table>
<!-- @@@duration -->
<!-- $$$loopCount-prop$$$loopCount$$$setLoopCountint -->
<h3 class="fn"><a name="loopCount-prop"></a><span class="name">loopCount</span> : <span class="type">int</span></h3>
<p>This property holds the loop count of the animation.</p>
<p>This property describes the loop count of the animation as an integer. By default this value is 1, indicating that the animation should run once only, and then stop. By changing it you can let the animation loop several times. With a value of 0, the animation will not run at all, and with a value of -1, the animation will loop forever until stopped. It is not supported to have loop on an animation that has an undefined duration. It will only run once.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>loopCount</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setLoopCount</b></span> ( int <i>loopCount</i> )</td></tr>
</table>
<!-- @@@loopCount -->
<!-- $$$state-prop$$$state$$$stateChangedQAbstractAnimation::StateQAbstractAnimation::State -->
<h3 class="fn"><a name="state-prop"></a><span class="name">state</span> : const <span class="type"><a href="qabstractanimation.html#State-enum">State</a></span></h3>
<p>This property holds state of the animation.</p>
<p>This property describes the current state of the animation. When the animation state changes, <a href="qabstractanimation.html">QAbstractAnimation</a> emits the <a href="qabstractanimation.html#stateChanged">stateChanged</a>() signal.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> State </td><td class="memItemRight bottomAlign"><span class="name"><b>state</b></span> () const</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qabstractanimation.html#stateChanged">stateChanged</a></b></span> ( QAbstractAnimation::State <i>newState</i>, QAbstractAnimation::State <i>oldState</i> )</td></tr>
</table>
<!-- @@@state -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAbstractAnimation[overload1]$$$QAbstractAnimationQObject* -->
<h3 class="fn"><a name="QAbstractAnimation"></a>QAbstractAnimation::<span class="name">QAbstractAnimation</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs the <a href="qabstractanimation.html">QAbstractAnimation</a> base class, and passes <i>parent</i> to <a href="qobject.html">QObject</a>'s constructor.</p>
<p><b>See also </b><a href="qvariantanimation.html">QVariantAnimation</a> and <a href="qanimationgroup.html">QAnimationGroup</a>.</p>
<!-- @@@QAbstractAnimation -->
<!-- $$$~QAbstractAnimation[overload1]$$$~QAbstractAnimation -->
<h3 class="fn"><a name="dtor.QAbstractAnimation"></a>QAbstractAnimation::<span class="name">~QAbstractAnimation</span> ()<tt> [virtual]</tt></h3>
<p>Stops the animation if it's running, then destroys the <a href="qabstractanimation.html">QAbstractAnimation</a>. If the animation is part of a <a href="qanimationgroup.html">QAnimationGroup</a>, it is automatically removed before it's destroyed.</p>
<!-- @@@~QAbstractAnimation -->
<!-- $$$currentLoopChanged[overload1]$$$currentLoopChangedint -->
<h3 class="fn"><a name="currentLoopChanged"></a><span class="type">void</span> QAbstractAnimation::<span class="name">currentLoopChanged</span> ( <span class="type">int</span> <i>currentLoop</i> )<tt> [signal]</tt></h3>
<p><a href="qabstractanimation.html">QAbstractAnimation</a> emits this signal whenever the current loop changes. <i>currentLoop</i> is the current loop.</p>
<p><b>See also </b><a href="qabstractanimation.html#currentLoop-prop">currentLoop</a>() and <a href="qabstractanimation.html#loopCount-prop">loopCount</a>().</p>
<!-- @@@currentLoopChanged -->
<!-- $$$currentLoopTime[overload1]$$$currentLoopTime -->
<h3 class="fn"><a name="currentLoopTime"></a><span class="type">int</span> QAbstractAnimation::<span class="name">currentLoopTime</span> () const</h3>
<p>Returns the current time inside the current loop. It can go from 0 to <a href="qabstractanimation.html#duration-prop">duration</a>().</p>
<p><b>See also </b><a href="qabstractanimation.html#duration-prop">duration</a>() and <a href="qabstractanimation.html#currentTime-prop">currentTime</a>.</p>
<!-- @@@currentLoopTime -->
<!-- $$$directionChanged[overload1]$$$directionChangedQAbstractAnimation::Direction -->
<h3 class="fn"><a name="directionChanged"></a><span class="type">void</span> QAbstractAnimation::<span class="name">directionChanged</span> ( <span class="type"><a href="qabstractanimation.html#Direction-enum">QAbstractAnimation::Direction</a></span> <i>newDirection</i> )<tt> [signal]</tt></h3>
<p><a href="qabstractanimation.html">QAbstractAnimation</a> emits this signal whenever the direction has been changed. <i>newDirection</i> is the new direction.</p>
<p><b>See also </b><a href="qabstractanimation.html#direction-prop">direction</a>.</p>
<!-- @@@directionChanged -->
<!-- $$$event[overload1]$$$eventQEvent* -->
<h3 class="fn"><a name="event"></a><span class="type">bool</span> QAbstractAnimation::<span class="name">event</span> ( <span class="type"><a href="qevent.html">QEvent</a></span> * <i>event</i> )<tt> [virtual protected]</tt></h3>
<p>Reimplemented from <a href="qobject.html#event">QObject::event</a>().</p>
<!-- @@@event -->
<!-- $$$finished[overload1]$$$finished -->
<h3 class="fn"><a name="finished"></a><span class="type">void</span> QAbstractAnimation::<span class="name">finished</span> ()<tt> [signal]</tt></h3>
<p><a href="qabstractanimation.html">QAbstractAnimation</a> emits this signal after the animation has stopped and has reached the end.</p>
<p>This signal is emitted after <a href="qabstractanimation.html#stateChanged">stateChanged</a>().</p>
<p><b>See also </b><a href="qabstractanimation.html#stateChanged">stateChanged</a>().</p>
<!-- @@@finished -->
<!-- $$$group[overload1]$$$group -->
<h3 class="fn"><a name="group"></a><span class="type"><a href="qanimationgroup.html">QAnimationGroup</a></span> * QAbstractAnimation::<span class="name">group</span> () const</h3>
<p>If this animation is part of a <a href="qanimationgroup.html">QAnimationGroup</a>, this function returns a pointer to the group; otherwise, it returns 0.</p>
<p><b>See also </b><a href="qanimationgroup.html#addAnimation">QAnimationGroup::addAnimation</a>().</p>
<!-- @@@group -->
<!-- $$$pause[overload1]$$$pause -->
<h3 class="fn"><a name="pause"></a><span class="type">void</span> QAbstractAnimation::<span class="name">pause</span> ()<tt> [slot]</tt></h3>
<p>Pauses the animation. When the animation is paused, <a href="qabstractanimation.html#state-prop">state</a>() returns Paused. The value of <a href="qabstractanimation.html#currentTime-prop">currentTime</a> will remain unchanged until <a href="qabstractanimation.html#resume">resume</a>() or <a href="qabstractanimation.html#start">start</a>() is called. If you want to continue from the current time, call <a href="qabstractanimation.html#resume">resume</a>().</p>
<p><b>See also </b><a href="qabstractanimation.html#start">start</a>(), <a href="qabstractanimation.html#state-prop">state</a>(), and <a href="qabstractanimation.html#resume">resume</a>().</p>
<!-- @@@pause -->
<!-- $$$resume[overload1]$$$resume -->
<h3 class="fn"><a name="resume"></a><span class="type">void</span> QAbstractAnimation::<span class="name">resume</span> ()<tt> [slot]</tt></h3>
<p>Resumes the animation after it was paused. When the animation is resumed, it emits the resumed() and <a href="qabstractanimation.html#stateChanged">stateChanged</a>() signals. The currenttime is not changed.</p>
<p><b>See also </b><a href="qabstractanimation.html#start">start</a>(), <a href="qabstractanimation.html#pause">pause</a>(), and <a href="qabstractanimation.html#state-prop">state</a>().</p>
<!-- @@@resume -->
<!-- $$$setPaused[overload1]$$$setPausedbool -->
<h3 class="fn"><a name="setPaused"></a><span class="type">void</span> QAbstractAnimation::<span class="name">setPaused</span> ( <span class="type">bool</span> <i>paused</i> )<tt> [slot]</tt></h3>
<p>If <i>paused</i> is true, the animation is paused. If <i>paused</i> is false, the animation is resumed.</p>
<p><b>See also </b><a href="qabstractanimation.html#state-prop">state</a>(), <a href="qabstractanimation.html#pause">pause</a>(), and <a href="qabstractanimation.html#resume">resume</a>().</p>
<!-- @@@setPaused -->
<!-- $$$start[overload1]$$$startQAbstractAnimation::DeletionPolicy -->
<h3 class="fn"><a name="start"></a><span class="type">void</span> QAbstractAnimation::<span class="name">start</span> ( <span class="type"><a href="qabstractanimation.html#DeletionPolicy-enum">QAbstractAnimation::DeletionPolicy</a></span> <i>policy</i> = KeepWhenStopped )<tt> [slot]</tt></h3>
<p>Starts the animation. The <i>policy</i> argument says whether or not the animation should be deleted when it's done. When the animation starts, the <a href="qabstractanimation.html#stateChanged">stateChanged</a>() signal is emitted, and <a href="qabstractanimation.html#state-prop">state</a>() returns Running. When control reaches the event loop, the animation will run by itself, periodically calling <a href="qabstractanimation.html#updateCurrentTime">updateCurrentTime</a>() as the animation progresses.</p>
<p>If the animation is currently stopped or has already reached the end, calling start() will rewind the animation and start again from the beginning. When the animation reaches the end, the animation will either stop, or if the loop level is more than 1, it will rewind and continue from the beginning.</p>
<p>If the animation is already running, this function does nothing.</p>
<p><b>See also </b><a href="qabstractanimation.html#stop">stop</a>() and <a href="qabstractanimation.html#state-prop">state</a>().</p>
<!-- @@@start -->
<!-- $$$stateChanged[overload1]$$$stateChangedQAbstractAnimation::StateQAbstractAnimation::State -->
<h3 class="fn"><a name="stateChanged"></a><span class="type">void</span> QAbstractAnimation::<span class="name">stateChanged</span> ( <span class="type"><a href="qabstractanimation.html#State-enum">QAbstractAnimation::State</a></span> <i>newState</i>, <span class="type"><a href="qabstractanimation.html#State-enum">QAbstractAnimation::State</a></span> <i>oldState</i> )<tt> [signal]</tt></h3>
<p><a href="qabstractanimation.html">QAbstractAnimation</a> emits this signal whenever the state of the animation has changed from <i>oldState</i> to <i>newState</i>. This signal is emitted after the virtual <a href="qabstractanimation.html#updateState">updateState</a>() function is called.</p>
<p><b>See also </b><a href="qabstractanimation.html#updateState">updateState</a>().</p>
<!-- @@@stateChanged -->
<!-- $$$stop[overload1]$$$stop -->
<h3 class="fn"><a name="stop"></a><span class="type">void</span> QAbstractAnimation::<span class="name">stop</span> ()<tt> [slot]</tt></h3>
<p>Stops the animation. When the animation is stopped, it emits the <a href="qabstractanimation.html#stateChanged">stateChanged</a>() signal, and <a href="qabstractanimation.html#state-prop">state</a>() returns Stopped. The current time is not changed.</p>
<p>If the animation stops by itself after reaching the end (i.e., <a href="qabstractanimation.html#currentLoopTime">currentLoopTime</a>() == <a href="qabstractanimation.html#duration-prop">duration</a>() and <a href="qabstractanimation.html#currentLoop-prop">currentLoop</a>() > <a href="qabstractanimation.html#loopCount-prop">loopCount</a>() - 1), the <a href="qabstractanimation.html#finished">finished</a>() signal is emitted.</p>
<p><b>See also </b><a href="qabstractanimation.html#start">start</a>() and <a href="qabstractanimation.html#state-prop">state</a>().</p>
<!-- @@@stop -->
<!-- $$$totalDuration[overload1]$$$totalDuration -->
<h3 class="fn"><a name="totalDuration"></a><span class="type">int</span> QAbstractAnimation::<span class="name">totalDuration</span> () const</h3>
<p>Returns the total and effective duration of the animation, including the loop count.</p>
<p><b>See also </b><a href="qabstractanimation.html#duration-prop">duration</a>() and <a href="qabstractanimation.html#currentTime-prop">currentTime</a>.</p>
<!-- @@@totalDuration -->
<!-- $$$updateCurrentTime[overload1]$$$updateCurrentTimeint -->
<h3 class="fn"><a name="updateCurrentTime"></a><span class="type">void</span> QAbstractAnimation::<span class="name">updateCurrentTime</span> ( <span class="type">int</span> <i>currentTime</i> )<tt> [pure virtual protected]</tt></h3>
<p>This pure virtual function is called every time the animation's <i>currentTime</i> changes.</p>
<p><b>See also </b><a href="qabstractanimation.html#updateState">updateState</a>().</p>
<!-- @@@updateCurrentTime -->
<!-- $$$updateDirection[overload1]$$$updateDirectionQAbstractAnimation::Direction -->
<h3 class="fn"><a name="updateDirection"></a><span class="type">void</span> QAbstractAnimation::<span class="name">updateDirection</span> ( <span class="type"><a href="qabstractanimation.html#Direction-enum">QAbstractAnimation::Direction</a></span> <i>direction</i> )<tt> [virtual protected]</tt></h3>
<p>This virtual function is called by <a href="qabstractanimation.html">QAbstractAnimation</a> when the direction of the animation is changed. The <i>direction</i> argument is the new direction.</p>
<p><b>See also </b><a href="qabstractanimation.html#direction-prop">setDirection</a>() and <a href="qabstractanimation.html#direction-prop">direction</a>().</p>
<!-- @@@updateDirection -->
<!-- $$$updateState[overload1]$$$updateStateQAbstractAnimation::StateQAbstractAnimation::State -->
<h3 class="fn"><a name="updateState"></a><span class="type">void</span> QAbstractAnimation::<span class="name">updateState</span> ( <span class="type"><a href="qabstractanimation.html#State-enum">QAbstractAnimation::State</a></span> <i>newState</i>, <span class="type"><a href="qabstractanimation.html#State-enum">QAbstractAnimation::State</a></span> <i>oldState</i> )<tt> [virtual protected]</tt></h3>
<p>This virtual function is called by <a href="qabstractanimation.html">QAbstractAnimation</a> when the state of the animation is changed from <i>oldState</i> to <i>newState</i>.</p>
<p><b>See also </b><a href="qabstractanimation.html#start">start</a>(), <a href="qabstractanimation.html#stop">stop</a>(), <a href="qabstractanimation.html#pause">pause</a>(), and <a href="qabstractanimation.html#resume">resume</a>().</p>
<!-- @@@updateState -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Qt and respective logos are trademarks of The Qt Company Ltd
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
