Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 776

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?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" />
<!-- qcontactrelationshipfetchrequest.cpp -->
  <title>Qt Mobility 1.2: QContactRelationshipFetchRequest 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>QContactRelationshipFetchRequest</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-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QContactRelationshipFetchRequest Class Reference</h1>
<!-- $$$QContactRelationshipFetchRequest-brief -->
<p>The QContactRelationshipFetchRequest class allows a client to asynchronously request relationships from a contacts store manager. <a href="#details">More...</a></p>
<!-- @@@QContactRelationshipFetchRequest -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QContactRelationshipFetchRequest&gt;</span></pre><p><b>Inherits: </b><a href="qcontactabstractrequest.html">QContactAbstractRequest</a>.</p>
<p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qcontactrelationshipfetchrequest-members.html">List of all members, including inherited members</a></li>
</ul>
<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="qcontactrelationshipfetchrequest.html#QContactRelationshipFetchRequest">QContactRelationshipFetchRequest</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationshipfetchrequest.html#dtor.QContactRelationshipFetchRequest">~QContactRelationshipFetchRequest</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactId </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationshipfetchrequest.html#first">first</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationshipfetchrequest.html#relationshipType">relationshipType</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList&lt;QContactRelationship&gt; </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationshipfetchrequest.html#relationships">relationships</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactId </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationshipfetchrequest.html#second">second</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationshipfetchrequest.html#setFirst">setFirst</a></b> ( const QContactId &amp; <i>firstId</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationshipfetchrequest.html#setRelationshipType">setRelationshipType</a></b> ( const QString &amp; <i>relationshipType</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactrelationshipfetchrequest.html#setSecond">setSecond</a></b> ( const QContactId &amp; <i>secondId</i> )</td></tr>
</table>
<ul>
<li class="fn">9 public functions inherited from <a href="qcontactabstractrequest.html#public-functions">QContactAbstractRequest</a></li>
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</a></li>
<li class="fn">3 public slots inherited from <a href="qcontactabstractrequest.html#public-slots">QContactAbstractRequest</a></li>
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-slots">QObject</a></li>
<li class="fn">2 signals inherited from <a href="qcontactabstractrequest.html#signals">QContactAbstractRequest</a></li>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-variables">QObject</a></li>
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#static-public-members">QObject</a></li>
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-functions">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QContactRelationshipFetchRequest-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QContactRelationshipFetchRequest class allows a client to asynchronously request relationships from a contacts store manager.</p>
<p>For a QContactRelationshipFetchRequest, the <a href="qcontactabstractrequest.html#resultsAvailable">resultsAvailable</a>() signal will be emitted when the resultant relationships (which may be retrieved by calling <a href="qcontactrelationshipfetchrequest.html#relationships">relationships</a>()), are updated, as well as if the overall operation error (which may be retrieved by calling <a href="qcontactabstractrequest.html#error">error</a>()) is updated.</p>
<p>Please see the class documentation of <a href="qcontactabstractrequest.html">QContactAbstractRequest</a> for more information about the usage of request classes and ownership semantics.</p>
</div>
<!-- @@@QContactRelationshipFetchRequest -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QContactRelationshipFetchRequest[overload1]$$$QContactRelationshipFetchRequestQObject* -->
<h3 class="fn"><a name="QContactRelationshipFetchRequest"></a>QContactRelationshipFetchRequest::<span class="name">QContactRelationshipFetchRequest</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs a new relationship fetch request whose parent is the specified <i>parent</i></p>
<!-- @@@QContactRelationshipFetchRequest -->
<!-- $$$~QContactRelationshipFetchRequest[overload1]$$$~QContactRelationshipFetchRequest -->
<h3 class="fn"><a name="dtor.QContactRelationshipFetchRequest"></a>QContactRelationshipFetchRequest::<span class="name">~QContactRelationshipFetchRequest</span> ()</h3>
<p>Frees any memory used by this request</p>
<!-- @@@~QContactRelationshipFetchRequest -->
<!-- $$$first[overload1]$$$first -->
<h3 class="fn"><a name="first"></a><span class="type"><a href="qcontactid.html">QContactId</a></span> QContactRelationshipFetchRequest::<span class="name">first</span> () const</h3>
<p>Returns the source contact criterion of the fetch request</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactrelationshipfetchrequest.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> QContactRelationshipFetchRequest::<span class="name">relationshipType</span> () const</h3>
<p>Returns the relationship type criterion of the fetch request</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactrelationshipfetchrequest.html#setRelationshipType">setRelationshipType</a>().</p>
<!-- @@@relationshipType -->
<!-- $$$relationships[overload1]$$$relationships -->
<h3 class="fn"><a name="relationships"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span>&lt;<span class="type"><a href="qcontactrelationship.html">QContactRelationship</a></span>&gt; QContactRelationshipFetchRequest::<span class="name">relationships</span> () const</h3>
<p>Returns the list of relationships that was the result of the request</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@relationships -->
<!-- $$$second[overload1]$$$second -->
<h3 class="fn"><a name="second"></a><span class="type"><a href="qcontactid.html">QContactId</a></span> QContactRelationshipFetchRequest::<span class="name">second</span> () const</h3>
<p>Returns the destination contact criterion of the fetch request</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactrelationshipfetchrequest.html#setSecond">setSecond</a>().</p>
<!-- @@@second -->
<!-- $$$setFirst[overload1]$$$setFirstconstQContactId& -->
<h3 class="fn"><a name="setFirst"></a><span class="type">void</span> QContactRelationshipFetchRequest::<span class="name">setFirst</span> ( const <span class="type"><a href="qcontactid.html">QContactId</a></span> &amp; <i>firstId</i> )</h3>
<p>Sets the source contact criterion of the fetch request to <i>firstId</i>. If <i>firstId</i> is the default-constructed id, or the first contact id is not set, the request will fetch relationships involving any first contact.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactrelationshipfetchrequest.html#first">first</a>().</p>
<!-- @@@setFirst -->
<!-- $$$setRelationshipType[overload1]$$$setRelationshipTypeconstQString& -->
<h3 class="fn"><a name="setRelationshipType"></a><span class="type">void</span> QContactRelationshipFetchRequest::<span class="name">setRelationshipType</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>relationshipType</i> )</h3>
<p>Sets the relationship type criterion of the fetch request to <i>relationshipType</i>. If <i>relationshipType</i> is empty, or the relationship type is not set, the request will fetch relationships of any type.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactrelationshipfetchrequest.html#relationshipType">relationshipType</a>().</p>
<!-- @@@setRelationshipType -->
<!-- $$$setSecond[overload1]$$$setSecondconstQContactId& -->
<h3 class="fn"><a name="setSecond"></a><span class="type">void</span> QContactRelationshipFetchRequest::<span class="name">setSecond</span> ( const <span class="type"><a href="qcontactid.html">QContactId</a></span> &amp; <i>secondId</i> )</h3>
<p>Sets the destination contact criterion of the fetch request to <i>secondId</i>. If <i>secondId</i> is the default-constructed id, or the second contact id is not set, the request will fetch relationships involving any second contact.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactrelationshipfetchrequest.html#second">second</a>().</p>
<!-- @@@setSecond -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</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>