<?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" /> <!-- qdeclarativeanimation.cpp --> <title>Qt 4.8: QML Animation Element</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="qdeclarativeelements.html">QML Elements</a></li> <li>QML Animation Element</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="#properties">Properties</a></li> <li class="level1"><a href="#methods">Methods</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <h1 class="title">QML Animation Element</h1> <span class="subtitle"></span> <!-- $$$Animation-brief --> <p>The Animation element is the base of all QML animations. <a href="#details">More...</a></p> <!-- @@@Animation --> <p>Inherited by <a href="qml-anchoranimation.html">AnchorAnimation</a>, <a href="qml-parallelanimation.html">ParallelAnimation</a>, <a href="qml-parentanimation.html">ParentAnimation</a>, <a href="qml-pauseanimation.html">PauseAnimation</a>, <a href="qml-propertyaction.html">PropertyAction</a>, <a href="qml-propertyanimation.html">PropertyAnimation</a>, <a href="qml-scriptaction.html">ScriptAction</a>, and <a href="qml-sequentialanimation.html">SequentialAnimation</a>.</p> <p>This element was introduced in Qt 4.7.</p> <ul> <li><a href="qml-animation-members.html">List of all members, including inherited members</a></li> </ul> <a name="properties"></a> <h2>Properties</h2> <ul> <li class="fn"><b><b><a href="qml-animation.html#alwaysRunToEnd-prop">alwaysRunToEnd</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-animation.html#loops-prop">loops</a></b></b> : int</li> <li class="fn"><b><b><a href="qml-animation.html#paused-prop">paused</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-animation.html#running-prop">running</a></b></b> : bool</li> </ul> <a name="methods"></a> <h2>Methods</h2> <ul> <li class="fn"><b><b><a href="qml-animation.html#complete-method">complete</a></b></b></li> <li class="fn"><b><b><a href="qml-animation.html#pause-method">pause</a></b></b></li> <li class="fn"><b><b><a href="qml-animation.html#restart-method">restart</a></b></b></li> <li class="fn"><b><b><a href="qml-animation.html#resume-method">resume</a></b></b></li> <li class="fn"><b><b><a href="qml-animation.html#start-method">start</a></b></b></li> <li class="fn"><b><b><a href="qml-animation.html#stop-method">stop</a></b></b></li> </ul> <!-- $$$Animation-description --> <a name="details"></a> <h2>Detailed Description</h2> <p>The Animation element cannot be used directly in a QML file. It exists to provide a set of common properties and methods, available across all the other animation types that inherit from it. Attempting to use the Animation element directly will result in an error.</p> <!-- @@@Animation --> <h2>Property Documentation</h2> <!-- $$$alwaysRunToEnd --> <div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="alwaysRunToEnd-prop"></a><span class="name">alwaysRunToEnd</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds whether the animation should run to completion when it is stopped.</p> <p>If this true the animation will complete its current iteration when it is stopped - either by setting the <tt>running</tt> property to false, or by calling the <tt>stop()</tt> method. The <tt>complete()</tt> method is not effected by this value.</p> <p>This behavior is most useful when the <tt>repeat</tt> property is set, as the animation will finish playing normally but not restart.</p> <p>By default, the alwaysRunToEnd property is not set.</p> <p><b>Note:</b> alwaysRunToEnd has no effect on animations in a Transition.</p> </div></div><!-- @@@alwaysRunToEnd --> <br/> <!-- $$$loops --> <div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="loops-prop"></a><span class="name">loops</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the number of times the animation should play.</p> <p>By default, <tt>loops</tt> is 1: the animation will play through once and then stop.</p> <p>If set to Animation.Infinite, the animation will continuously repeat until it is explicitly stopped - either by setting the <tt>running</tt> property to false, or by calling the <tt>stop()</tt> method.</p> <p>In the following example, the rectangle will spin indefinitely.</p> <pre class="cpp"> Rectangle { width: <span class="number">100</span>; height: <span class="number">100</span>; color: <span class="string">"green"</span> RotationAnimation on rotation { loops: Animation<span class="operator">.</span>Infinite from: <span class="number">0</span> to: <span class="number">360</span> } }</pre> </div></div><!-- @@@loops --> <br/> <!-- $$$paused --> <div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="paused-prop"></a><span class="name">paused</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds whether the animation is currently paused.</p> <p>The <tt>paused</tt> property can be set to declaratively control whether or not an animation is paused.</p> <p>Animations can also be paused and resumed imperatively from JavaScript using the <tt>pause()</tt> and <tt>resume()</tt> methods.</p> <p>By default, animations are not paused.</p> </div></div><!-- @@@paused --> <br/> <!-- $$$running --> <div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="running-prop"></a><span class="name">running</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds whether the animation is currently running.</p> <p>The <tt>running</tt> property can be set to declaratively control whether or not an animation is running. The following example will animate a rectangle whenever the <a href="qml-mousearea.html">MouseArea</a> is pressed.</p> <pre class="cpp"> Rectangle { width: <span class="number">100</span>; height: <span class="number">100</span> NumberAnimation on x { running: myMouse<span class="operator">.</span>pressed from: <span class="number">0</span>; to: <span class="number">100</span> } MouseArea { id: myMouse } }</pre> <p>Likewise, the <tt>running</tt> property can be read to determine if the animation is running. In the following example the text element will indicate whether or not the animation is running.</p> <pre class="cpp"> NumberAnimation { id: myAnimation } Text { text: myAnimation<span class="operator">.</span>running <span class="operator">?</span> <span class="string">"Animation is running"</span> : <span class="string">"Animation is not running"</span> }</pre> <p>Animations can also be started and stopped imperatively from JavaScript using the <tt>start()</tt> and <tt>stop()</tt> methods.</p> <p>By default, animations are not running. Though, when the animations are assigned to properties, as property value sources using the <i>on</i> syntax, they are set to running by default.</p> </div></div><!-- @@@running --> <br/> <h2>Method Documentation</h2> <!-- $$$complete --> <div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="complete-method"></a>Animation::<span class="name">complete</span> ()</p></td></tr></table></div><div class="qmldoc"><p>Stops the animation, jumping to the final property values.</p> <p>If the animation is not running, calling this method has no effect. The <tt>running</tt> property will be false following a call to <tt>complete()</tt>.</p> <p>Unlike <tt>stop()</tt>, <tt>complete()</tt> immediately fast-forwards the animation to its end. In the following example,</p> <pre class="cpp"> Rectangle { NumberAnimation on x { from: <span class="number">0</span>; to: <span class="number">100</span>; duration: <span class="number">500</span> } }</pre> <p>calling <tt>stop()</tt> at time 250ms will result in the <tt>x</tt> property having a value of 50, while calling <tt>complete()</tt> will set the <tt>x</tt> property to 100, exactly as though the animation had played the whole way through.</p> </div></div><!-- @@@complete --> <br/> <!-- $$$pause --> <div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="pause-method"></a>Animation::<span class="name">pause</span> ()</p></td></tr></table></div><div class="qmldoc"><p>Pauses the animation.</p> <p>If the animation is already paused, calling this method has no effect. The <tt>paused</tt> property will be true following a call to <tt>pause()</tt>.</p> </div></div><!-- @@@pause --> <br/> <!-- $$$restart --> <div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="restart-method"></a>Animation::<span class="name">restart</span> ()</p></td></tr></table></div><div class="qmldoc"><p>Restarts the animation.</p> <p>This is a convenience method, and is equivalent to calling <tt>stop()</tt> and then <tt>start()</tt>.</p> </div></div><!-- @@@restart --> <br/> <!-- $$$resume --> <div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="resume-method"></a>Animation::<span class="name">resume</span> ()</p></td></tr></table></div><div class="qmldoc"><p>Resumes a paused animation.</p> <p>If the animation is not paused, calling this method has no effect. The <tt>paused</tt> property will be false following a call to <tt>resume()</tt>.</p> </div></div><!-- @@@resume --> <br/> <!-- $$$start --> <div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="start-method"></a>Animation::<span class="name">start</span> ()</p></td></tr></table></div><div class="qmldoc"><p>Starts the animation.</p> <p>If the animation is already running, calling this method has no effect. The <tt>running</tt> property will be true following a call to <tt>start()</tt>.</p> </div></div><!-- @@@start --> <br/> <!-- $$$stop --> <div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="stop-method"></a>Animation::<span class="name">stop</span> ()</p></td></tr></table></div><div class="qmldoc"><p>Stops the animation.</p> <p>If the animation is not running, calling this method has no effect. The <tt>running</tt> property will be false following a call to <tt>stop()</tt>.</p> <p>Normally <tt>stop()</tt> stops the animation immediately, and the animation has no further influence on property values. In this example animation</p> <pre class="cpp"> Rectangle { NumberAnimation on x { from: <span class="number">0</span>; to: <span class="number">100</span>; duration: <span class="number">500</span> } }</pre> <p>was stopped at time 250ms, the <tt>x</tt> property will have a value of 50.</p> <p>However, if the <tt>alwaysRunToEnd</tt> property is set, the animation will continue running until it completes and then stop. The <tt>running</tt> property will still become false immediately.</p> </div></div><!-- @@@stop --> <br/> </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>