/usr/share/qt5/doc/qtcontacts/qml-qtcontacts-relationshipmodel.html is in qtpim5-doc-html 5.0~git20140515~29475884-0ubuntu24~7.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativecontactrelationshipmodel.cpp -->
<title>RelationshipModel QML Type | Qt 5.0</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.0</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.0.0 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="#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">RelationshipModel QML Type</h1>
<span class="subtitle"></span>
<!-- $$$RelationshipModel-brief -->
<p>The <a href="qml-qtcontacts-relationshipmodel.html">RelationshipModel</a> provides a model of contact relationships from the contacts store. <a href="#details">More...</a></p>
<!-- @@@RelationshipModel -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtContacts 5.0</td></tr></table></div><ul>
<li><a href="qml-qtcontacts-relationshipmodel-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-qtcontacts-relationshipmodel.html#autoUpdate-prop">autoUpdate</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtcontacts-relationshipmodel.html#error-prop">error</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtcontacts-relationshipmodel.html#manager-prop">manager</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtcontacts-relationshipmodel.html#participantId-prop">participantId</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtcontacts-relationshipmodel.html#relationshipType-prop">relationshipType</a></b></b> : variant</li>
<li class="fn"><b><b><a href="qml-qtcontacts-relationshipmodel.html#relationships-prop">relationships</a></b></b> : list<Relationship></li>
<li class="fn"><b><b><a href="qml-qtcontacts-relationshipmodel.html#role-prop">role</a></b></b> : enumeration</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtcontacts-relationshipmodel.html#addRelationship-method">addRelationship</a></b></b>(<i>relationship</i>)</li>
<li class="fn"><b><b><a href="qml-qtcontacts-relationshipmodel.html#removeRelationship-method">removeRelationship</a></b></b>(<i>relationship</i>)</li>
</ul>
<!-- $$$RelationshipModel-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>This element is part of the <b><a href="qtcontacts-qmlmodule.html">QtContacts</a></b> module.</p>
<p>The contents of the model can be specified with <a href="qml-qtcontacts-relationshipmodel.html#participantId-prop">participantId</a>, <a href="qml-qtcontacts-relationshipmodel.html#role-prop">role</a> and <a href="qml-qtcontacts-relationshipmodel.html#relationshipType-prop">relationshipType</a> properties. Whether the model is automatically updated when the store or filter changes, can be controlled with <a href="qml-qtcontacts-relationshipmodel.html#autoUpdate-prop">RelationshipModel::autoUpdate</a> property.</p>
<p>There are two ways of accessing the relationship data: through model by using views and delegates, or alternatively via <a href="qtcontacts-overview.html#relationships">relationships</a> list property.</p>
<p>At the moment only data role provided by the model is <code>relationship</code> (<a href="qml-qtcontacts-relationship.html">Relationship</a>). Through that one can access any data provided by the Relationship element.</p>
<p><b>See also </b><a href="qml-qtcontacts-relationship.html">Relationship</a> and <a href="qcontactrelationship.html">QContactRelationship</a>.</p>
<!-- @@@RelationshipModel -->
<h2>Property Documentation</h2>
<!-- $$$autoUpdate -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="autoUpdate-prop">
<td class="tblQmlPropNode"><p>
<a name="autoUpdate-prop"></a><span class="name">autoUpdate</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property indicates whether or not the relationship model should be updated automatically, default value is true.</p>
</div></div><!-- @@@autoUpdate -->
<br/>
<!-- $$$error -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="error-prop">
<td class="tblQmlPropNode"><p>
<a name="error-prop"></a><span class="name">error</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the latest error code returned by the contact manager.</p>
<p>This property is read only.</p>
</div></div><!-- @@@error -->
<br/>
<!-- $$$manager -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="manager-prop">
<td class="tblQmlPropNode"><p>
<a name="manager-prop"></a><span class="name">manager</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the manager uri of the contact backend engine.</p>
</div></div><!-- @@@manager -->
<br/>
<!-- $$$participantId -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="participantId-prop">
<td class="tblQmlPropNode"><p>
<a name="participantId-prop"></a><span class="name">participantId</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the participant which the list of relationships returned by <a href="qml-qtcontacts-relationshipmodel.html">RelationshipModel</a> should contain.</p>
<p><b>See also </b><a href="qml-qtcontacts-relationshipfilter.html#relatedContactId-prop">RelationshipFilter::relatedContactId</a> and <a href="qml-qtcontacts-relationshipmodel.html#role-prop">RelationshipModel::role</a>.</p>
</div></div><!-- @@@participantId -->
<br/>
<!-- $$$relationshipType -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="relationshipType-prop">
<td class="tblQmlPropNode"><p>
<a name="relationshipType-prop"></a><span class="name">relationshipType</span> : <span class="type">variant</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the relationship type which the list of relationships returned by <a href="qml-qtcontacts-relationshipmodel.html">RelationshipModel</a> should contain.</p>
<p><b>See also </b><a href="qml-qtcontacts-relationship.html#type-prop">Relationship::type</a>.</p>
</div></div><!-- @@@relationshipType -->
<br/>
<!-- $$$relationships -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="relationships-prop">
<td class="tblQmlPropNode"><p>
<a name="relationships-prop"></a><span class="name">relationships</span> : <span class="type">list</span><<span class="type"><a href="qml-qtcontacts-relationship.html">Relationship</a></span>></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds a list of relationships.</p>
<p><b>See also </b><a href="qml-qtcontacts-relationship.html">Relationship</a>.</p>
</div></div><!-- @@@relationships -->
<br/>
<!-- $$$role -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="role-prop">
<td class="tblQmlPropNode"><p>
<a name="role-prop"></a><span class="name">role</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the relationship role which the list of relationships returned by <a href="qml-qtcontacts-relationshipmodel.html">RelationshipModel</a> should contain.</p>
<p><b>See also </b><a href="qml-qtcontacts-relationshipfilter.html#relatedContactRole-prop">RelationshipFilter::relatedContactRole</a>.</p>
</div></div><!-- @@@role -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$addRelationship -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="addRelationship-method">
<td class="tblQmlFuncNode"><p>
<a name="addRelationship-method"></a><span class="name">addRelationship</span>(<i>relationship</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Addes the given <i>relationship</i> to the backend store.</p>
</div></div><!-- @@@addRelationship -->
<br/>
<!-- $$$removeRelationship -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="removeRelationship-method">
<td class="tblQmlFuncNode"><p>
<a name="removeRelationship-method"></a><span class="name">removeRelationship</span>(<i>relationship</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Removes the given <i>relationship</i> from the backend store.</p>
</div></div><!-- @@@removeRelationship -->
<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>
|