/usr/share/qt5/doc/qtqml/qml-qtqml-binding.html is in qtdeclarative5-doc-html 5.9.5-0ubuntu1.
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 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qqmlbind.cpp -->
<title>Binding QML Type | Qt QML 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="qtqml-index.html">Qt QML</a></td><td ><a href="qtqml-qmlmodule.html">QML Types</a></td><td >Binding QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 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>
<li class="level2"><a href="#binding-to-an-inaccessible-property">Binding to an Inaccessible Property</a></li>
<li class="level2"><a href="#conditional-bindings">Conditional Bindings</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Binding QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Binding-brief -->
<p>Enables the arbitrary creation of property bindings. <a href="#details">More...</a></p>
<!-- @@@Binding -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQml 2.2</td></tr></table></div><ul>
<li><a href="qml-qtqml-binding-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-qtqml-binding.html#delayed-prop">delayed</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtqml-binding.html#property-prop">property</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtqml-binding.html#target-prop">target</a></b></b> : Object</li>
<li class="fn"><b><b><a href="qml-qtqml-binding.html#value-prop">value</a></b></b> : any</li>
<li class="fn"><b><b><a href="qml-qtqml-binding.html#when-prop">when</a></b></b> : bool</li>
</ul>
<!-- $$$Binding-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>In QML, property bindings result in a dependency between the properties of different objects.</p>
<a name="binding-to-an-inaccessible-property"></a>
<h2 id="binding-to-an-inaccessible-property">Binding to an Inaccessible Property</h2>
<p>Sometimes it is necessary to bind an object's property to that of another object that isn't directly instantiated by QML, such as a property of a class exported to QML by C++. You can use the Binding type to establish this dependency; binding any value to any object's property.</p>
<p>For example, in a C++ application that maps an "app.enteredText" property into QML, you can use Binding to update the enteredText property.</p>
<pre class="cpp">
TextEdit { id: myTextField; text: <span class="string">"Please type here..."</span> }
Binding { target: app; property: <span class="string">"enteredText"</span>; value: myTextField<span class="operator">.</span>text }
</pre>
<p>When <code>text</code> changes, the C++ property <code>enteredText</code> will update automatically.</p>
<a name="conditional-bindings"></a>
<h2 id="conditional-bindings">Conditional Bindings</h2>
<p>In some cases you may want to modify the value of a property when a certain condition is met but leave it unmodified otherwise. Often, it's not possible to do this with direct bindings, as you have to supply values for all possible branches.</p>
<p>For example, the code snippet below results in a warning whenever you release the mouse. This is because the value of the binding is undefined when the mouse isn't pressed.</p>
<pre class="qml">
// produces warning: "Unable to assign [undefined] to double value"
value: if (mouse.pressed) mouse.mouseX
</pre>
<p>The Binding type can prevent this warning.</p>
<pre class="qml">
Binding on value {
when: mouse.pressed
value: mouse.mouseX
}
</pre>
<p>The Binding type restores any previously set direct bindings on the property.</p>
<p><b>See also </b><a href="qtqml-index.html">Qt QML</a>.</p>
<!-- @@@Binding -->
<h2>Property Documentation</h2>
<!-- $$$delayed -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="delayed-prop">
<td class="tblQmlPropNode"><p>
<a name="delayed-prop"></a><span class="name">delayed</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the binding should be delayed.</p>
<p>A delayed binding will not immediately update the target, but rather wait until the event queue has been cleared. This can be used as an optimization, or to prevent intermediary values from being assigned.</p>
<pre class="cpp">
Binding {
target: contactName; property: <span class="char">'text'</span>
value: givenName <span class="operator">+</span> <span class="string">" "</span> <span class="operator">+</span> familyName; when: list<span class="operator">.</span>ListView<span class="operator">.</span>isCurrentItem
delayed: <span class="keyword">true</span>
}
</pre>
<p>This QML property was introduced in Qt 5.8.</p>
</div></div><!-- @@@delayed -->
<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>The property to be updated.</p>
<p>This can be a group property if the expression results in accessing a property of a <a href="qtqml-typesystem-basictypes.html">value type</a>. For example:</p>
<pre class="qml">
Item {
id: item
property rect rectangle: Qt.rect(0, 0, 200, 200)
}
Binding {
target: item
property: "rectangle.x"
value: 100
}
</pre>
</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>The object to be updated.</p>
</div></div><!-- @@@target -->
<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>The value to be set on the target object and property. This can be a constant (which isn't very useful), or a bound expression.</p>
</div></div><!-- @@@value -->
<br/>
<!-- $$$when -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="when-prop">
<td class="tblQmlPropNode"><p>
<a name="when-prop"></a><span class="name">when</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds when the binding is active. This should be set to an expression that evaluates to true when you want the binding to be active.</p>
<pre class="cpp">
Binding {
target: contactName; property: <span class="char">'text'</span>
value: name; when: list<span class="operator">.</span>ListView<span class="operator">.</span>isCurrentItem
}
</pre>
<p>When the binding becomes inactive again, any direct bindings that were previously set on the property will be restored.</p>
</div></div><!-- @@@when -->
<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>
|