<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.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" />
<!-- qcontactrelationship.cpp -->
<title>Qt Mobility 1.2: QContactRelationship Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtcontacts.html">QtContacts</a></li>
<li>QContactRelationship</li>
</ul>
</div>
</div>
<div class="content mainContent">
<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>
<h1 class="title">QContactRelationship Class Reference</h1>
<!-- $$$QContactRelationship-brief -->
<p>The QContactRelationship class describes a one-to-one relationship between a locally-stored contact and another (possibly remote) contact. <a href="#details">More...</a></p>
<!-- @@@QContactRelationship -->
<pre class="cpp"> <span class="preprocessor">#include <QContactRelationship></span></pre><p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qcontactrelationship-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<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>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<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-2">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"> QContactId </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"> QContactId </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 QContactId & <i>firstId</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 QContactId & <i>secondId</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>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#Aggregates-var">Aggregates</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#HasAssistant-var">HasAssistant</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#HasManager-var">HasManager</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#HasMember-var">HasMember</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#HasSpouse-var">HasSpouse</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationship.html#IsSameAs-var">IsSameAs</a></b></td></tr>
</table>
<a name="details"></a>
<!-- $$$QContactRelationship-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QContactRelationship 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 id, second contact id, 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"><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>
<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"><tt>QContactRelationship::First</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The contact is the first contact in the relationship</td></tr>
<tr><td class="topAlign"><tt>QContactRelationship::Second</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The contact is the second contact in the relationship</td></tr>
<tr><td class="topAlign"><tt>QContactRelationship::Either</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The contact is either the first or second contact in the relationship</td></tr>
</table>
<!-- @@@Role -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QContactRelationship[overload1]$$$QContactRelationship -->
<h3 class="fn"><a name="QContactRelationship"></a>QContactRelationship::<span class="name">QContactRelationship</span> ()</h3>
<p>Constructs a new relationship</p>
<!-- @@@QContactRelationship -->
<!-- $$$QContactRelationship$$$QContactRelationshipconstQContactRelationship& -->
<h3 class="fn"><a name="QContactRelationship-2"></a>QContactRelationship::<span class="name">QContactRelationship</span> ( const <span class="type">QContactRelationship</span> & <i>other</i> )</h3>
<p>Creates a copy of the <i>other</i> relationship</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@QContactRelationship -->
<!-- $$$~QContactRelationship[overload1]$$$~QContactRelationship -->
<h3 class="fn"><a name="dtor.QContactRelationship"></a>QContactRelationship::<span class="name">~QContactRelationship</span> ()</h3>
<p>Frees the memory in use by the relationship</p>
<!-- @@@~QContactRelationship -->
<!-- $$$first[overload1]$$$first -->
<h3 class="fn"><a name="first"></a><span class="type"><a href="qcontactid.html">QContactId</a></span> QContactRelationship::<span class="name">first</span> () const</h3>
<p>Returns the id of the locally-stored contact which has a relationship of the given type with the second contact</p>
<p>This function was introduced in Qt Mobility 1.0.</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"><a name="relationshipType"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></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>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactrelationship.html#setRelationshipType">setRelationshipType</a>().</p>
<!-- @@@relationshipType -->
<!-- $$$second[overload1]$$$second -->
<h3 class="fn"><a name="second"></a><span class="type"><a href="qcontactid.html">QContactId</a></span> QContactRelationship::<span class="name">second</span> () const</h3>
<p>Returns the id of the contact with which the first contact has a relationship of the given type</p>
<p>This function was introduced in Qt Mobility 1.0.</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]$$$setFirstconstQContactId& -->
<h3 class="fn"><a name="setFirst"></a><span class="type">void</span> QContactRelationship::<span class="name">setFirst</span> ( const <span class="type"><a href="qcontactid.html">QContactId</a></span> & <i>firstId</i> )</h3>
<p>Sets the id of the first contact in the relationship to <i>firstId</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>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactrelationship.html#first">first</a>().</p>
<!-- @@@setFirst -->
<!-- $$$setRelationshipType[overload1]$$$setRelationshipTypeconstQString& -->
<h3 class="fn"><a name="setRelationshipType"></a><span class="type">void</span> QContactRelationship::<span class="name">setRelationshipType</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></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>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactrelationship.html#relationshipType">relationshipType</a>().</p>
<!-- @@@setRelationshipType -->
<!-- $$$setSecond[overload1]$$$setSecondconstQContactId& -->
<h3 class="fn"><a name="setSecond"></a><span class="type">void</span> QContactRelationship::<span class="name">setSecond</span> ( const <span class="type"><a href="qcontactid.html">QContactId</a></span> & <i>secondId</i> )</h3>
<p>Sets the second contact in the relationship to <i>secondId</i>. The first contact has a relationship of the specified type with this contact.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactrelationship.html#second">second</a>().</p>
<!-- @@@setSecond -->
<!-- $$$operator!=[overload1]$$$operator!=constQContactRelationship& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QContactRelationship::<span class="name">operator!=</span> ( const <span class="type">QContactRelationship</span> & <i>other</i> ) const</h3>
<p>Returns true if this relationship is not equal to <i>other</i>, otherwise returns false.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQContactRelationship& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QContactRelationship</span> & QContactRelationship::<span class="name">operator=</span> ( const <span class="type">QContactRelationship</span> & <i>other</i> )</h3>
<p>Assigns this relationship to be equal to <i>other</i></p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQContactRelationship& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QContactRelationship::<span class="name">operator==</span> ( const <span class="type">QContactRelationship</span> & <i>other</i> ) const</h3>
<p>Returns true if this relationship is equal to the <i>other</i> relationship, otherwise returns false.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator== -->
</div>
<div class="vars">
<h2>Member Variable Documentation</h2>
<!-- $$$Aggregates -->
<h3 class="fn"><a name="Aggregates-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></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 -->
<h3 class="fn"><a name="HasAssistant-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></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 -->
<h3 class="fn"><a name="HasManager-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></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 -->
<h3 class="fn"><a name="HasMember-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></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 -->
<h3 class="fn"><a name="HasSpouse-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></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 -->
<h3 class="fn"><a name="IsSameAs-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></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 -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2008-2011 Nokia Corporation and/or its
subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide.</p>
<p>
All other trademarks are property of their respective owners. <a title="Privacy Policy"
href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
<br />
<p>
Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.</p>
<p>
Alternatively, this document may be used 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.</p>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
50facae208d4a6f280e44a513b104320
>
files
>
774
