/usr/share/qt5/doc/qtcontacts/qcontactrelationship.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 193 194 195 196 197 198 199 200 201 202 203 204 205 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcontactrelationship.cpp -->
<title>QContactRelationship Class | 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><td >QContactRelationship</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="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</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">QContactRelationship Class</h1>
<!-- $$$QContactRelationship-brief -->
<p>The <a href="qcontactrelationship.html">QContactRelationship</a> class describes a one-to-one relationship between a locally-stored contact and another (possibly remote) contact. <a href="#details">More...</a></p>
<!-- @@@QContactRelationship -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QContactRelationship></span>
</td></tr></table></div><ul>
<li><a href="qcontactrelationship-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#Role-enum">Role</a></b> { First, Second, Either }</td></tr>
</table></div>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#QContactRelationship">QContactRelationship</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#QContactRelationship-1">QContactRelationship</a></b>(const QContactRelationship &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#dtor.QContactRelationship">~QContactRelationship</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContact </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#first">first</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#relationshipType">relationshipType</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContact </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#second">second</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#setFirst">setFirst</a></b>(const QContact &<i>firstContact</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#setRelationshipType">setRelationshipType</a></b>(const QString &<i>relationshipType</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#setSecond">setSecond</a></b>(const QContact &<i>secondContact</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#operator-not-eq">operator!=</a></b>(const QContactRelationship &<i>other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactRelationship &</td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#operator-eq">operator=</a></b>(const QContactRelationship &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#operator-eq-eq">operator==</a></b>(const QContactRelationship &<i>other</i>) const</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#Aggregates">Aggregates</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#HasAssistant">HasAssistant</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#HasManager">HasManager</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#HasMember">HasMember</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#HasSpouse">HasSpouse</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#IsSameAs">IsSameAs</a></b>()</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QContactRelationship-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qcontactrelationship.html">QContactRelationship</a> class describes a one-to-one relationship between a locally-stored contact and another (possibly remote) contact.</p>
<p>Each relationship is uniquely identified by the combination of the first contact, second contact, and the relationship type.</p>
<p>A relationship should not contain a second contact which is the same as the first contact. Any local contacts which are referenced in the relationship (that is, any source contact, or any second contact whose manager URI is left empty or whose manager URI references the manager that stores the source contact, and in which the relationship will be saved) should exist.</p>
<p>If any of these requirements are not met, validation of the relationship may fail when attempting to save the relationship in a <a href="qcontactmanager.html">QContactManager</a>.</p>
</div>
<p><b>See also </b><a href="qcontactrelationshipfilter.html">QContactRelationshipFilter</a>.</p>
<!-- @@@QContactRelationship -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Role$$$First$$$Second$$$Either -->
<h3 class="fn" id="Role-enum"><a name="Role-enum"></a>enum QContactRelationship::<span class="name">Role</span></h3>
<p>Describes the roles that a contact may take in a relationship.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QContactRelationship::First</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The contact is the first contact in the relationship</td></tr>
<tr><td class="topAlign"><code>QContactRelationship::Second</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The contact is the second contact in the relationship</td></tr>
<tr><td class="topAlign"><code>QContactRelationship::Either</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The contact is either the first or second contact in the relationship</td></tr>
</table></div>
<!-- @@@Role -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QContactRelationship[overload1]$$$QContactRelationship -->
<h3 class="fn" id="QContactRelationship"><a name="QContactRelationship"></a>QContactRelationship::<span class="name">QContactRelationship</span>()</h3>
<p>Constructs a new relationship</p>
<!-- @@@QContactRelationship -->
<!-- $$$QContactRelationship$$$QContactRelationshipconstQContactRelationship& -->
<h3 class="fn" id="QContactRelationship-1"><a name="QContactRelationship-1"></a>QContactRelationship::<span class="name">QContactRelationship</span>(const <span class="type"><a href="qcontactrelationship.html#QContactRelationship">QContactRelationship</a></span> &<i>other</i>)</h3>
<p>Creates a copy of the <i>other</i> relationship</p>
<!-- @@@QContactRelationship -->
<!-- $$$~QContactRelationship[overload1]$$$~QContactRelationship -->
<h3 class="fn" id="dtor.QContactRelationship"><a name="dtor.QContactRelationship"></a>QContactRelationship::<span class="name">~QContactRelationship</span>()</h3>
<p>Frees the memory in use by the relationship</p>
<!-- @@@~QContactRelationship -->
<!-- $$$Aggregates[overload1]$$$Aggregates -->
<h3 class="fn" id="Aggregates"><a name="Aggregates"></a><code>[static] </code>const <span class="type">QString</span> QContactRelationship::<span class="name">Aggregates</span>()</h3>
<p>The relationship type which identifies the first contact as aggregating the second contact into a metacontact</p>
<!-- @@@Aggregates -->
<!-- $$$HasAssistant[overload1]$$$HasAssistant -->
<h3 class="fn" id="HasAssistant"><a name="HasAssistant"></a><code>[static] </code>const <span class="type">QString</span> QContactRelationship::<span class="name">HasAssistant</span>()</h3>
<p>The relationship type which identifies the second contact as being the assistant of the first contact</p>
<!-- @@@HasAssistant -->
<!-- $$$HasManager[overload1]$$$HasManager -->
<h3 class="fn" id="HasManager"><a name="HasManager"></a><code>[static] </code>const <span class="type">QString</span> QContactRelationship::<span class="name">HasManager</span>()</h3>
<p>The relationship type which identifies the second contact as being the manager of the first contact</p>
<!-- @@@HasManager -->
<!-- $$$HasMember[overload1]$$$HasMember -->
<h3 class="fn" id="HasMember"><a name="HasMember"></a><code>[static] </code>const <span class="type">QString</span> QContactRelationship::<span class="name">HasMember</span>()</h3>
<p>The relationship type which identifies the first contact as being a group which includes the second contact</p>
<!-- @@@HasMember -->
<!-- $$$HasSpouse[overload1]$$$HasSpouse -->
<h3 class="fn" id="HasSpouse"><a name="HasSpouse"></a><code>[static] </code>const <span class="type">QString</span> QContactRelationship::<span class="name">HasSpouse</span>()</h3>
<p>The relationship type which identifies the second contact as being the spouse of the first contact</p>
<!-- @@@HasSpouse -->
<!-- $$$IsSameAs[overload1]$$$IsSameAs -->
<h3 class="fn" id="IsSameAs"><a name="IsSameAs"></a><code>[static] </code>const <span class="type">QString</span> QContactRelationship::<span class="name">IsSameAs</span>()</h3>
<p>The relationship type which identifies the first contact as being the same contact as the second contact</p>
<!-- @@@IsSameAs -->
<!-- $$$first[overload1]$$$first -->
<h3 class="fn" id="first"><a name="first"></a><span class="type"><a href="qcontact.html">QContact</a></span> QContactRelationship::<span class="name">first</span>() const</h3>
<p>Returns the locally-stored contact which has a relationship of the given type with the second contact</p>
<p><b>See also </b><a href="qcontactrelationship.html#relationshipType">relationshipType</a>(), <a href="qcontactrelationship.html#second">second</a>(), and <a href="qcontactrelationship.html#setFirst">setFirst</a>().</p>
<!-- @@@first -->
<!-- $$$relationshipType[overload1]$$$relationshipType -->
<h3 class="fn" id="relationshipType"><a name="relationshipType"></a><span class="type">QString</span> QContactRelationship::<span class="name">relationshipType</span>() const</h3>
<p>Returns the type of relationship which the source contact has with the destination contacts</p>
<p><b>See also </b><a href="qcontactrelationship.html#setRelationshipType">setRelationshipType</a>().</p>
<!-- @@@relationshipType -->
<!-- $$$second[overload1]$$$second -->
<h3 class="fn" id="second"><a name="second"></a><span class="type"><a href="qcontact.html">QContact</a></span> QContactRelationship::<span class="name">second</span>() const</h3>
<p>Returns the contact with which the first contact has a relationship of the given type</p>
<p><b>See also </b><a href="qcontactrelationship.html#setSecond">setSecond</a>(), <a href="qcontactrelationship.html#relationshipType">relationshipType</a>(), and <a href="qcontactrelationship.html#first">first</a>().</p>
<!-- @@@second -->
<!-- $$$setFirst[overload1]$$$setFirstconstQContact& -->
<h3 class="fn" id="setFirst"><a name="setFirst"></a><span class="type">void</span> QContactRelationship::<span class="name">setFirst</span>(const <span class="type"><a href="qcontact.html">QContact</a></span> &<i>firstContact</i>)</h3>
<p>Sets the first contact in the relationship to <i>firstContact</i>. This contact must be stored in the manager in which the relationship is stored, and has a relationship of the specified type with the second contact.</p>
<p><b>See also </b><a href="qcontactrelationship.html#first">first</a>().</p>
<!-- @@@setFirst -->
<!-- $$$setRelationshipType[overload1]$$$setRelationshipTypeconstQString& -->
<h3 class="fn" id="setRelationshipType"><a name="setRelationshipType"></a><span class="type">void</span> QContactRelationship::<span class="name">setRelationshipType</span>(const <span class="type">QString</span> &<i>relationshipType</i>)</h3>
<p>Sets the type of relationship that the source contact has with the destination contacts to <i>relationshipType</i>.</p>
<p><b>See also </b><a href="qcontactrelationship.html#relationshipType">relationshipType</a>().</p>
<!-- @@@setRelationshipType -->
<!-- $$$setSecond[overload1]$$$setSecondconstQContact& -->
<h3 class="fn" id="setSecond"><a name="setSecond"></a><span class="type">void</span> QContactRelationship::<span class="name">setSecond</span>(const <span class="type"><a href="qcontact.html">QContact</a></span> &<i>secondContact</i>)</h3>
<p>Sets the second contact in the relationship to <i>secondContact</i>. The first contact has a relationship of the specified type with this contact.</p>
<p><b>See also </b><a href="qcontactrelationship.html#second">second</a>().</p>
<!-- @@@setSecond -->
<!-- $$$operator!=[overload1]$$$operator!=constQContactRelationship& -->
<h3 class="fn" id="operator-not-eq"><a name="operator-not-eq"></a><span class="type">bool</span> QContactRelationship::<span class="name">operator!=</span>(const <span class="type"><a href="qcontactrelationship.html#QContactRelationship">QContactRelationship</a></span> &<i>other</i>) const</h3>
<p>Returns true if this relationship is not equal to <i>other</i>, otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQContactRelationship& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qcontactrelationship.html#QContactRelationship">QContactRelationship</a></span> &QContactRelationship::<span class="name">operator=</span>(const <span class="type"><a href="qcontactrelationship.html#QContactRelationship">QContactRelationship</a></span> &<i>other</i>)</h3>
<p>Assigns this relationship to be equal to <i>other</i></p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQContactRelationship& -->
<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> QContactRelationship::<span class="name">operator==</span>(const <span class="type"><a href="qcontactrelationship.html#QContactRelationship">QContactRelationship</a></span> &<i>other</i>) const</h3>
<p>Returns true if this relationship is equal to the <i>other</i> relationship, otherwise returns false.</p>
<!-- @@@operator== -->
</div>
</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>
|