/usr/share/qt5/doc/qtquick/qml-qtquick-animatedimage.html is in qtdeclarative5-doc-html 5.2.1-3ubuntu15.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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" />
<!-- qquickanimatedimage.cpp -->
<title>AnimatedImage | QtQuick 5.2</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtquick-index.html">Qt Quick</a></li>
<li><a href="qtquick-qmltypereference.html">QML Types</a></li>
<li>AnimatedImage</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<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="#details">Detailed Description</a></li>
<li class="level2"><a href="#example-usage">Example Usage</a></li>
</ul>
</div>
<h1 class="title">AnimatedImage</h1>
<span class="subtitle"></span>
<!-- $$$AnimatedImage-brief -->
<p>Plays animations stored as a series of images <a href="#details">More...</a></p>
<!-- @@@AnimatedImage -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> </b><tt>import QtQuick 2.2</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtquick-image.html">Image</a></p>
</td></tr></table><ul>
<li><a href="qml-qtquick-animatedimage-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-qtquick-animatedimage.html#currentFrame-prop">currentFrame</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-animatedimage.html#frameCount-prop">frameCount</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-animatedimage.html#paused-prop">paused</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-animatedimage.html#playing-prop">playing</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-animatedimage.html#source-prop">source</a></b></b> : url</li>
</ul>
<!-- $$$AnimatedImage-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p>The AnimatedImage type extends the features of the <a href="qml-qtquick-image.html">Image</a> type, providing a way to play animations stored as images containing a series of frames, such as those stored in GIF files.</p>
<p>Information about the current frame and total length of the animation can be obtained using the <a href="qml-qtquick-animatedimage.html#currentFrame-prop">currentFrame</a> and <a href="qml-qtquick-animatedimage.html#frameCount-prop">frameCount</a> properties. You can start, pause and stop the animation by changing the values of the <a href="qml-qtquick-animatedimage.html#playing-prop">playing</a> and <a href="qml-qtquick-animatedimage.html#paused-prop">paused</a> properties.</p>
<p>The full list of supported formats can be determined with QMovie::supportedFormats().</p>
<a name="example-usage"></a>
<h2>Example Usage</h2>
<div style="float: left; margin-right: 2em"><p class="centerAlign"><img src="images/animatedimageitem.gif" alt="" /></p></div><p>The following QML shows how to display an animated image and obtain information about its state, such as the current frame and total number of frames. The result is an animated image with a simple progress indicator underneath it.</p>
<p><b>Note</b>: Unlike images, animated images are not cached or shared internally.</p>
<br style="clear: both" /><pre class="qml">import QtQuick 2.0
<span class="type"><a href="qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">width</span>: <span class="name">animation</span>.<span class="name">width</span>; <span class="name">height</span>: <span class="name">animation</span>.<span class="name">height</span> <span class="operator">+</span> <span class="number">8</span>
<span class="type">AnimatedImage</span> { <span class="name">id</span>: <span class="name">animation</span>; <span class="name">source</span>: <span class="string">"animation.gif"</span> }
<span class="type"><a href="qml-qtquick-rectangle.html">Rectangle</a></span> {
property <span class="type">int</span> <span class="name">frames</span>: <span class="name">animation</span>.<span class="name">frameCount</span>
<span class="name">width</span>: <span class="number">4</span>; <span class="name">height</span>: <span class="number">8</span>
<span class="name">x</span>: (<span class="name">animation</span>.<span class="name">width</span> <span class="operator">-</span> <span class="name">width</span>) <span class="operator">*</span> <span class="name">animation</span>.<span class="name">currentFrame</span> <span class="operator">/</span> <span class="name">frames</span>
<span class="name">y</span>: <span class="name">animation</span>.<span class="name">height</span>
<span class="name">color</span>: <span class="string">"red"</span>
}
}</pre>
<p><b>See also </b><a href="qml-qtquick-borderimage.html">BorderImage</a> and <a href="qml-qtquick-image.html">Image</a>.</p>
<!-- @@@AnimatedImage -->
<h2>Property Documentation</h2>
<!-- $$$currentFrame -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="currentFrame-prop"></a><span class="name">currentFrame</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p>currentFrame is the frame that is currently visible. By monitoring this property for changes, you can animate other items at the same time as the image.</p>
<p><a href="qml-qtquick-animatedimage.html#frameCount-prop">frameCount</a> is the number of frames in the animation. For some animation formats, <a href="qml-qtquick-animatedimage.html#frameCount-prop">frameCount</a> is unknown and has a value of zero.</p>
</div></div><!-- @@@currentFrame -->
<br/>
<!-- $$$frameCount -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="frameCount-prop"></a><span class="name">frameCount</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p><a href="qml-qtquick-animatedimage.html#currentFrame-prop">currentFrame</a> is the frame that is currently visible. By monitoring this property for changes, you can animate other items at the same time as the image.</p>
<p>frameCount is the number of frames in the animation. For some animation formats, frameCount is unknown and has a value of zero.</p>
</div></div><!-- @@@frameCount -->
<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">bool</span></p></td></tr></table></div><div class="qmldoc"><p>This property holds whether the animated image is paused.</p>
<p>By default, this property is false. Set it to true when you want to pause the animation.</p>
</div></div><!-- @@@paused -->
<br/>
<!-- $$$playing -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="playing-prop"></a><span class="name">playing</span> : <span class="type">bool</span></p></td></tr></table></div><div class="qmldoc"><p>This property holds whether the animated image is playing.</p>
<p>By default, this property is true, meaning that the animation will start playing immediately.</p>
<p><b>Note</b>: this property is affected by changes to the actual playing state of <a href="qml-qtquick-animatedimage.html">AnimatedImage</a>. If non-animated images are used, <i>playing</i> will need to be manually set to <i>true</i> in order to animate following images.</p>
<pre class="qml"><span class="type"><a href="qml-qtquick-animatedimage.html">AnimatedImage</a></span> {
<span class="name">onStatusChanged</span>: <span class="name">playing</span> <span class="operator">=</span> (<span class="name">status</span> <span class="operator">==</span> <span class="name">AnimatedImage</span>.<span class="name">Ready</span>)
}</pre>
</div></div><!-- @@@playing -->
<br/>
<!-- $$$source -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="source-prop"></a><span class="name">source</span> : <span class="type">url</span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the URL that refers to the source image.</p>
<p><a href="qml-qtquick-animatedimage.html">AnimatedImage</a> can handle any image format supported by Qt, loaded from any URL scheme supported by Qt.</p>
<p><b>See also </b><a href="qquickimageprovider.html">QQuickImageProvider</a>.</p>
</div></div><!-- @@@source -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|