<?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>PropertyAction 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 >PropertyAction 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">PropertyAction QML Type</h1>
<span class="subtitle"></span>
<!-- $$$PropertyAction-brief -->
<p>Specifies immediate property changes during animation <a href="#details">More...</a></p>
<!-- @@@PropertyAction -->
<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-propertyaction-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-propertyaction.html#exclude-prop">exclude</a></b></b> : list<Object></li>
<li class="fn"><b><b><a href="qml-qtquick-propertyaction.html#properties-prop">properties</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-propertyaction.html#property-prop">property</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-propertyaction.html#target-prop">target</a></b></b> : Object</li>
<li class="fn"><b><b><a href="qml-qtquick-propertyaction.html#targets-prop">targets</a></b></b> : list<Object></li>
<li class="fn"><b><b><a href="qml-qtquick-propertyaction.html#value-prop">value</a></b></b> : any</li>
</ul>
<!-- $$$PropertyAction-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qml-qtquick-propertyaction.html">PropertyAction</a> is used to specify an immediate property change during an animation. The property change is not animated.</p>
<p>It is useful for setting non-animated property values during an animation.</p>
<p>For example, here is a <a href="qml-qtquick-sequentialanimation.html">SequentialAnimation</a> that sets the image's <a href="qml-qtquick-item.html#opacity-prop">opacity</a> property to <code>.5</code>, animates the width of the image, then sets <a href="qml-qtquick-item.html#opacity-prop">opacity</a> back to <code>1</code>:</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-sequentialanimation.html">SequentialAnimation</a></span> {
<span class="type"><a href="qml-qtquick-propertyaction.html">PropertyAction</a></span> { <span class="name">target</span>: <span class="name">img</span>; <span class="name">property</span>: <span class="string">"opacity"</span>; <span class="name">value</span>: <span class="number">.5</span> }
<span class="type"><a href="qml-qtquick-numberanimation.html">NumberAnimation</a></span> { <span class="name">target</span>: <span class="name">img</span>; <span class="name">property</span>: <span class="string">"width"</span>; <span class="name">to</span>: <span class="number">300</span>; <span class="name">duration</span>: <span class="number">1000</span> }
<span class="type"><a href="qml-qtquick-propertyaction.html">PropertyAction</a></span> { <span class="name">target</span>: <span class="name">img</span>; <span class="name">property</span>: <span class="string">"opacity"</span>; <span class="name">value</span>: <span class="number">1</span> }
}
</pre>
<p><a href="qml-qtquick-propertyaction.html">PropertyAction</a> is also useful for setting the exact point at which a property change should occur during a <a href="qmlexampletoggleswitch.html#transition">Transition</a>. For example, if <a href="qml-qtquick-propertychanges.html">PropertyChanges</a> was used in a <a href="qml-qtquick-state.html">State</a> to rotate an item around a particular <a href="qml-qtquick-item.html#transformOrigin-prop">transformOrigin</a>, it might be implemented like this:</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-item.html">Item</a></span> {
<span class="name">width</span>: <span class="number">400</span>; <span class="name">height</span>: <span class="number">400</span>
<span class="type"><a href="qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">id</span>: <span class="name">rect</span>
<span class="name">width</span>: <span class="number">200</span>; <span class="name">height</span>: <span class="number">100</span>
<span class="name">color</span>: <span class="string">"red"</span>
<span class="name">states</span>: <span class="name">State</span> {
<span class="name">name</span>: <span class="string">"rotated"</span>
<span class="type"><a href="qml-qtquick-propertychanges.html">PropertyChanges</a></span> { <span class="name">target</span>: <span class="name">rect</span>; <span class="name">rotation</span>: <span class="number">180</span>; <span class="name">transformOrigin</span>: <span class="name">Item</span>.<span class="name">BottomRight</span> }
}
<span class="name">transitions</span>: <span class="name">Transition</span> {
<span class="type"><a href="qml-qtquick-rotationanimation.html">RotationAnimation</a></span> { <span class="name">duration</span>: <span class="number">1000</span>; <span class="name">direction</span>: <span class="name">RotationAnimation</span>.<span class="name">Counterclockwise</span> }
}
<span class="type"><a href="qml-qtquick-mousearea.html">MouseArea</a></span> {
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="name">onClicked</span>: <span class="name">rect</span>.<span class="name">state</span> <span class="operator">=</span> <span class="string">"rotated"</span>
}
}
}
</pre>
<p>However, with this code, the <code>transformOrigin</code> is not set until <i>after</i> the animation, as a <a href="qml-qtquick-state.html">State</a> is taken to define the values at the <i>end</i> of a transition. The animation would rotate at the default <code>transformOrigin</code>, then jump to <code>Item.BottomRight</code>. To fix this, insert a <a href="qml-qtquick-propertyaction.html">PropertyAction</a> before the <a href="qml-qtquick-rotationanimation.html">RotationAnimation</a> begins:</p>
<pre class="qml">
<span class="name">transitions</span>: <span class="name">Transition</span> {
<span class="type"><a href="qml-qtquick-sequentialanimation.html">SequentialAnimation</a></span> {
<span class="type"><a href="qml-qtquick-propertyaction.html">PropertyAction</a></span> { <span class="name">target</span>: <span class="name">rect</span>; <span class="name">property</span>: <span class="string">"transformOrigin"</span> }
<span class="type"><a href="qml-qtquick-rotationanimation.html">RotationAnimation</a></span> { <span class="name">duration</span>: <span class="number">1000</span>; <span class="name">direction</span>: <span class="name">RotationAnimation</span>.<span class="name">Counterclockwise</span> }
}
}
</pre>
<p>This immediately sets the <code>transformOrigin</code> property to the value defined in the end state of the <a href="qmlexampletoggleswitch.html#transition">Transition</a> (i.e. the value defined in the <a href="qml-qtquick-propertyaction.html">PropertyAction</a> object) so that the rotation animation begins with the correct transform origin.</p>
<p><b>See also </b><a href="qtquick-statesanimations-animations.html">Animation and Transitions in Qt Quick</a> and Qt QML.</p>
<!-- @@@PropertyAction -->
<h2>Property Documentation</h2>
<!-- $$$exclude -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="exclude-prop">
<td class="tblQmlPropNode"><p>
<a name="exclude-prop"></a><span class="name">exclude</span> : <span class="type">list</span><<span class="type">Object</span>></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the objects that should not be affected by this action.</p>
<p><b>See also </b><a href="qml-qtquick-propertyaction.html#targets-prop">targets</a>.</p>
</div></div><!-- @@@exclude -->
<br/>
<!-- $$$properties -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="properties-prop">
<td class="tblQmlPropNode"><p>
<a name="properties-prop"></a><span class="name">properties</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>These properties determine the items and their properties that are affected by this action.</p>
<p>The details of how these properties are interpreted in different situations is covered in the <a href="qml-qtquick-propertyanimation.html#properties-prop">corresponding</a> <a href="qtquick-animation-example.html#propertyanimation">PropertyAnimation</a> documentation.</p>
<p><b>See also </b><a href="qml-qtquick-propertyaction.html#exclude-prop">exclude</a>.</p>
</div></div><!-- @@@properties -->
<br/>
<!-- $$$property -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="property-prop">
<td class="tblQmlPropNode"><p>
<a name="property-prop"></a><span class="name">property</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>These properties determine the items and their properties that are affected by this action.</p>
<p>The details of how these properties are interpreted in different situations is covered in the <a href="qml-qtquick-propertyanimation.html#properties-prop">corresponding</a> <a href="qtquick-animation-example.html#propertyanimation">PropertyAnimation</a> documentation.</p>
<p><b>See also </b><a href="qml-qtquick-propertyaction.html#exclude-prop">exclude</a>.</p>
</div></div><!-- @@@property -->
<br/>
<!-- $$$target -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="target-prop">
<td class="tblQmlPropNode"><p>
<a name="target-prop"></a><span class="name">target</span> : <span class="type">Object</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>These properties determine the items and their properties that are affected by this action.</p>
<p>The details of how these properties are interpreted in different situations is covered in the <a href="qml-qtquick-propertyanimation.html#properties-prop">corresponding</a> <a href="qtquick-animation-example.html#propertyanimation">PropertyAnimation</a> documentation.</p>
<p><b>See also </b><a href="qml-qtquick-propertyaction.html#exclude-prop">exclude</a>.</p>
</div></div><!-- @@@target -->
<br/>
<!-- $$$targets -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="targets-prop">
<td class="tblQmlPropNode"><p>
<a name="targets-prop"></a><span class="name">targets</span> : <span class="type">list</span><<span class="type">Object</span>></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>These properties determine the items and their properties that are affected by this action.</p>
<p>The details of how these properties are interpreted in different situations is covered in the <a href="qml-qtquick-propertyanimation.html#properties-prop">corresponding</a> <a href="qtquick-animation-example.html#propertyanimation">PropertyAnimation</a> documentation.</p>
<p><b>See also </b><a href="qml-qtquick-propertyaction.html#exclude-prop">exclude</a>.</p>
</div></div><!-- @@@targets -->
<br/>
<!-- $$$value -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="value-prop">
<td class="tblQmlPropNode"><p>
<a name="value-prop"></a><span class="name">value</span> : <span class="type">any</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the value to be set on the property.</p>
<p>If the <a href="qml-qtquick-propertyaction.html">PropertyAction</a> is defined within a <a href="qmlexampletoggleswitch.html#transition">Transition</a> or <a href="qml-qtquick-behavior.html">Behavior</a>, this value defaults to the value defined in the end state of the <a href="qmlexampletoggleswitch.html#transition">Transition</a>, or the value of the property change that triggered the <a href="qml-qtquick-behavior.html">Behavior</a>.</p>
</div></div><!-- @@@value -->
<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>
