<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qquickanimation.cpp --> <title>ScriptAction QML Type | Qt Quick 5.9</title> <link rel="stylesheet" type="text/css" href="style/offline-simple.css" /> <script type="text/javascript"> document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css"); // loading style sheet breaks anchors that were jumped to before // so force jumping to anchor again setTimeout(function() { var anchor = location.hash; // need to jump to different anchor first (e.g. none) location.hash = "#"; setTimeout(function() { location.hash = anchor; }, 0); }, 0); </script> </head> <body> <div class="header" id="qtdocheader"> <div class="main"> <div class="main-rounded"> <div class="navigationbar"> <table><tr> <td >Qt 5.9</td><td ><a href="qtquick-index.html">Qt Quick</a></td><td ><a href="qtquick-qmlmodule.html">QML Types</a></td><td >ScriptAction QML Type</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td> </tr></table> </div> </div> <div class="content"> <div class="line"> <div class="content mainContent"> <div class="sidebar"> <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="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">ScriptAction QML Type</h1> <span class="subtitle"></span> <!-- $$$ScriptAction-brief --> <p>Defines scripts to be run during an animation <a href="#details">More...</a></p> <!-- @@@ScriptAction --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick 2.7</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtquick-animation.html">Animation</a></p> </td></tr></table></div><ul> <li><a href="qml-qtquick-scriptaction-members.html">List of all members, including inherited members</a></li> </ul> <a name="properties"></a> <h2 id="properties">Properties</h2> <ul> <li class="fn"><b><b><a href="qml-qtquick-scriptaction.html#script-prop">script</a></b></b> : script</li> <li class="fn"><b><b><a href="qml-qtquick-scriptaction.html#scriptName-prop">scriptName</a></b></b> : string</li> </ul> <!-- $$$ScriptAction-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p><a href="qml-qtquick-scriptaction.html">ScriptAction</a> can be used to run a script at a specific point in an animation.</p> <pre class="qml"> <span class="type"><a href="qml-qtquick-sequentialanimation.html">SequentialAnimation</a></span> { <span class="type"><a href="qml-qtquick-numberanimation.html">NumberAnimation</a></span> { <span class="comment">// ...</span> } <span class="type"><a href="qml-qtquick-scriptaction.html">ScriptAction</a></span> { <span class="name">script</span>: <span class="name">doSomething</span>(); } <span class="type"><a href="qml-qtquick-numberanimation.html">NumberAnimation</a></span> { <span class="comment">// ...</span> } } </pre> <p>When used as part of a Transition, you can also target a specific <a href="qml-qtquick-statechangescript.html">StateChangeScript</a> to run using the <code>scriptName</code> property.</p> <pre class="qml"> <span class="type"><a href="qml-qtquick-state.html">State</a></span> { <span class="name">name</span>: <span class="string">"state1"</span> <span class="type"><a href="qml-qtquick-statechangescript.html">StateChangeScript</a></span> { <span class="name">name</span>: <span class="string">"myScript"</span> <span class="name">script</span>: <span class="name">doStateStuff</span>(); } <span class="comment">// ...</span> } <span class="comment">// ...</span> <span class="type"><a href="qml-qtquick-transition.html">Transition</a></span> { <span class="name">to</span>: <span class="string">"state1"</span> <span class="type"><a href="qml-qtquick-sequentialanimation.html">SequentialAnimation</a></span> { <span class="type"><a href="qml-qtquick-numberanimation.html">NumberAnimation</a></span> { <span class="comment">/* ... */</span> } <span class="type"><a href="qml-qtquick-scriptaction.html">ScriptAction</a></span> { <span class="name">scriptName</span>: <span class="string">"myScript"</span> } <span class="type"><a href="qml-qtquick-numberanimation.html">NumberAnimation</a></span> { <span class="comment">/* ... */</span> } } } </pre> <p><b>See also </b><a href="qml-qtquick-statechangescript.html">StateChangeScript</a>.</p> <!-- @@@ScriptAction --> <h2>Property Documentation</h2> <!-- $$$script --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="script-prop"> <td class="tblQmlPropNode"><p> <a name="script-prop"></a><span class="name">script</span> : <span class="type"><a href="qml-qtquick-scriptaction.html#script-prop">script</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the script to run.</p> </div></div><!-- @@@script --> <br/> <!-- $$$scriptName --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="scriptName-prop"> <td class="tblQmlPropNode"><p> <a name="scriptName-prop"></a><span class="name">scriptName</span> : <span class="type">string</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the name of the <a href="qml-qtquick-statechangescript.html">StateChangeScript</a> to run.</p> <p>This property is only valid when <a href="qml-qtquick-scriptaction.html">ScriptAction</a> is used as part of a transition. If both script and scriptName are set, scriptName will be used.</p> <p><b>Note: </b>When using scriptName in a reversible transition, the script will only be run when the transition is being run forwards.</p></div></div><!-- @@@scriptName --> <br/> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.<br> 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.<br> 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. </p> </div> </body> </html>