/usr/share/qt5/doc/qtquick/qml-qtquick-particles-itemparticle.html is in qtdeclarative5-doc-html 5.5.1-2ubuntu6.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickitemparticle.cpp -->
<title>ItemParticle QML Type | Qt Quick 5.5</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.5</li>
<li><a href="qtquick-index.html">Qt Quick</a></li>
<li><a href="qtquick-qmlmodule.html">QML Types</a></li>
<li>ItemParticle QML Type</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
</ul>
</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="#methods">Methods</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">ItemParticle QML Type</h1>
<span class="subtitle"></span>
<!-- $$$ItemParticle-brief -->
<p>For specifying a delegate to paint particles <a href="#details">More...</a></p>
<!-- @@@ItemParticle -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick.Particles 2.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtquick-particles-particlepainter.html">ParticlePainter</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtquick-particles-itemparticle-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-particles-itemparticle.html#delegate-prop">delegate</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-particles-itemparticle.html#fade-prop">fade</a></b></b> : bool</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtquick-particles-itemparticle.html#freeze-method">freeze</a></b></b>(Item <i> item</i>)</li>
<li class="fn">void <b><b><a href="qml-qtquick-particles-itemparticle.html#give-method">give</a></b></b>(Item <i> item</i>)</li>
<li class="fn">void <b><b><a href="qml-qtquick-particles-itemparticle.html#take-method">take</a></b></b>(Item <i> item</i>, bool <i> prioritize</i>)</li>
<li class="fn">void <b><b><a href="qml-qtquick-particles-itemparticle.html#unfreeze-method">unfreeze</a></b></b>(Item <i> item</i>)</li>
</ul>
<!-- $$$ItemParticle-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<!-- @@@ItemParticle -->
<h2>Property Documentation</h2>
<!-- $$$delegate -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="delegate-prop"><td class="tblQmlPropNode"><p><a name="delegate-prop"></a><span class="name">delegate</span> : <span class="type">Component</span></p></td></tr></table></div></div><div class="qmldoc"><p>An instance of the delegate will be created for every logical particle, and moved along with it. As an alternative to using delegate, you can create Item instances yourself and hand them to the <a href="qml-qtquick-particles-itemparticle.html">ItemParticle</a> to move using the <a href="qml-qtquick-particles-itemparticle.html#take-method">take</a> method.</p>
<p>Any delegate instances created by <a href="qml-qtquick-particles-itemparticle.html">ItemParticle</a> will be destroyed when the logical particle expires.</p>
</div></div><!-- @@@delegate -->
<br/>
<!-- $$$fade -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="fade-prop"><td class="tblQmlPropNode"><p><a name="fade-prop"></a><span class="name">fade</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>If true, the item will automatically be faded in and out at the ends of its lifetime. If false, you will have to implement any entry effect yourself.</p>
<p>Default is true.</p>
</div></div><!-- @@@fade -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$freeze -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="freeze-method"><td class="tblQmlFuncNode"><p><a name="freeze-method"></a><span class="type">void</span> <span class="name">freeze</span>(<span class="type"><a href="qml-qtquick-item.html">Item</a></span><i> item</i>)</p></td></tr></table></div></div><div class="qmldoc"><p>Suspends the flow of time for the logical particle which item represents, allowing you to control its movement.</p>
</div></div><!-- @@@freeze -->
<br/>
<!-- $$$give -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="give-method"><td class="tblQmlFuncNode"><p><a name="give-method"></a><span class="type">void</span> <span class="name">give</span>(<span class="type"><a href="qml-qtquick-item.html">Item</a></span><i> item</i>)</p></td></tr></table></div></div><div class="qmldoc"><p>Orders the <a href="qml-qtquick-particles-itemparticle.html">ItemParticle</a> to give you control of the item. It will cease controlling it and the item will lose its association to the logical particle.</p>
</div></div><!-- @@@give -->
<br/>
<!-- $$$take -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="take-method"><td class="tblQmlFuncNode"><p><a name="take-method"></a><span class="type">void</span> <span class="name">take</span>(<span class="type"><a href="qml-qtquick-item.html">Item</a></span><i> item</i>, <span class="type">bool</span><i> prioritize</i>)</p></td></tr></table></div></div><div class="qmldoc"><p>Asks the <a href="qml-qtquick-particles-itemparticle.html">ItemParticle</a> to take over control of item positioning temporarily. It will follow the movement of a logical particle when one is available.</p>
<p>By default items form a queue when waiting for a logical particle, but if prioritize is true then it will go immediately to the head of the queue.</p>
<p><a href="qml-qtquick-particles-itemparticle.html">ItemParticle</a> does not take ownership of the item, and will relinquish control when the logical particle expires. Commonly at this point you will want to put it back in the queue, you can do this with the below line in the delegate definition:</p>
<pre class="cpp">ItemParticle<span class="operator">.</span>onDetached: itemParticleInstance<span class="operator">.</span>take(delegateRootItem);</pre>
<p>or delete it, such as with the below line in the delegate definition:</p>
<pre class="cpp">ItemParticle<span class="operator">.</span>onDetached: delegateRootItem<span class="operator">.</span>destroy();</pre>
</div></div><!-- @@@take -->
<br/>
<!-- $$$unfreeze -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="unfreeze-method"><td class="tblQmlFuncNode"><p><a name="unfreeze-method"></a><span class="type">void</span> <span class="name">unfreeze</span>(<span class="type"><a href="qml-qtquick-item.html">Item</a></span><i> item</i>)</p></td></tr></table></div></div><div class="qmldoc"><p>Restarts the flow of time for the logical particle which item represents, allowing it to be moved by the particle system again.</p>
</div></div><!-- @@@unfreeze -->
<br/>
</div>
</div>
</div>
</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.<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>
|