/usr/share/qt5/doc/qtcontacts/qcontactfetchrequest.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcontactfetchrequest.cpp -->
<title>QContactFetchRequest 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 >QContactFetchRequest</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-functions">Public Functions</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">QContactFetchRequest Class</h1>
<!-- $$$QContactFetchRequest-brief -->
<p>The <a href="qcontactfetchrequest.html">QContactFetchRequest</a> class allows a client to asynchronously request contacts from a contacts store manager. <a href="#details">More...</a></p>
<!-- @@@QContactFetchRequest -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QContactFetchRequest></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qcontactabstractrequest.html">QContactAbstractRequest</a></td></tr></table></div><ul>
<li><a href="qcontactfetchrequest-members.html">List of all members, including inherited members</a></li>
</ul>
<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="qcontactfetchrequest.html#QContactFetchRequest">QContactFetchRequest</a></b>(QObject *<i>parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchrequest.html#dtor.QContactFetchRequest">~QContactFetchRequest</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContact> </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchrequest.html#contacts">contacts</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactFetchHint </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchrequest.html#fetchHint">fetchHint</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactFilter </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchrequest.html#filter">filter</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchrequest.html#setFetchHint">setFetchHint</a></b>(const QContactFetchHint &<i>fetchHint</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchrequest.html#setFilter">setFilter</a></b>(const QContactFilter &<i>filter</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchrequest.html#setSorting">setSorting</a></b>(const QList<QContactSortOrder> &<i>sorting</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchrequest.html#setStorageLocations">setStorageLocations</a></b>(QContactAbstractRequest::StorageLocations <i>storageLocations</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContactSortOrder> </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchrequest.html#sorting">sorting</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactAbstractRequest::StorageLocations </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchrequest.html#storageLocations">storageLocations</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">9 public functions inherited from <a href="qcontactabstractrequest.html#public-functions">QContactAbstractRequest</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">3 public slots inherited from <a href="qcontactabstractrequest.html#public-slots">QContactAbstractRequest</a></li>
<li class="fn">2 signals inherited from <a href="qcontactabstractrequest.html#signals">QContactAbstractRequest</a></li>
</ul>
<a name="details"></a>
<!-- $$$QContactFetchRequest-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qcontactfetchrequest.html">QContactFetchRequest</a> class allows a client to asynchronously request contacts from a contacts store manager.</p>
<p>For a <a href="qcontactfetchrequest.html">QContactFetchRequest</a>, the <a href="qcontactabstractrequest.html#resultsAvailable">resultsAvailable</a>() signal will be emitted when the resultant contacts (which may be retrieved by calling <a href="qcontactfetchrequest.html#contacts">contacts</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>
<!-- @@@QContactFetchRequest -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QContactFetchRequest[overload1]$$$QContactFetchRequestQObject* -->
<h3 class="fn" id="QContactFetchRequest"><a name="QContactFetchRequest"></a>QContactFetchRequest::<span class="name">QContactFetchRequest</span>(<span class="type">QObject</span> *<i>parent</i> = 0)</h3>
<p>Constructs a new contact fetch request whose parent is the specified <i>parent</i></p>
<!-- @@@QContactFetchRequest -->
<!-- $$$~QContactFetchRequest[overload1]$$$~QContactFetchRequest -->
<h3 class="fn" id="dtor.QContactFetchRequest"><a name="dtor.QContactFetchRequest"></a>QContactFetchRequest::<span class="name">~QContactFetchRequest</span>()</h3>
<p>Frees any memory used by this request</p>
<!-- @@@~QContactFetchRequest -->
<!-- $$$contacts[overload1]$$$contacts -->
<h3 class="fn" id="contacts"><a name="contacts"></a><span class="type">QList</span><<span class="type"><a href="qcontact.html">QContact</a></span>> QContactFetchRequest::<span class="name">contacts</span>() const</h3>
<p>Returns the list of contacts retrieved by this request</p>
<!-- @@@contacts -->
<!-- $$$fetchHint[overload1]$$$fetchHint -->
<h3 class="fn" id="fetchHint"><a name="fetchHint"></a><span class="type"><a href="qcontactfetchhint.html">QContactFetchHint</a></span> QContactFetchRequest::<span class="name">fetchHint</span>() const</h3>
<p>Returns the fetch hint which may be used by the backend to optimize contact retrieval. A client should not make changes to a contact which has been retrieved using a fetch hint other than the default fetch hint. Doing so will result in information loss when saving the contact back to the manager (as the "new" restricted contact will replace the previously saved contact in the backend).</p>
<p><b>See also </b><a href="qcontactfetchrequest.html#setFetchHint">setFetchHint</a>() and <a href="qcontactfetchhint.html">QContactFetchHint</a>.</p>
<!-- @@@fetchHint -->
<!-- $$$filter[overload1]$$$filter -->
<h3 class="fn" id="filter"><a name="filter"></a><span class="type"><a href="qcontactfilter.html">QContactFilter</a></span> QContactFetchRequest::<span class="name">filter</span>() const</h3>
<p>Returns the filter that will be used to select contacts to be returned</p>
<p><b>See also </b><a href="qcontactfetchrequest.html#setFilter">setFilter</a>().</p>
<!-- @@@filter -->
<!-- $$$setFetchHint[overload1]$$$setFetchHintconstQContactFetchHint& -->
<h3 class="fn" id="setFetchHint"><a name="setFetchHint"></a><span class="type">void</span> QContactFetchRequest::<span class="name">setFetchHint</span>(const <span class="type"><a href="qcontactfetchhint.html">QContactFetchHint</a></span> &<i>fetchHint</i>)</h3>
<p>Sets the fetch hint which may be used by the backend to optimize contact retrieval to <i>fetchHint</i>. A client should not make changes to a contact which has been retrieved using a fetch hint other than the default fetch hint. Doing so will result in information loss when saving the contact back to the manager (as the "new" restricted contact will replace the previously saved contact in the backend).</p>
<p><b>See also </b><a href="qcontactfetchrequest.html#fetchHint">fetchHint</a>() and <a href="qcontactfetchhint.html">QContactFetchHint</a>.</p>
<!-- @@@setFetchHint -->
<!-- $$$setFilter[overload1]$$$setFilterconstQContactFilter& -->
<h3 class="fn" id="setFilter"><a name="setFilter"></a><span class="type">void</span> QContactFetchRequest::<span class="name">setFilter</span>(const <span class="type"><a href="qcontactfilter.html">QContactFilter</a></span> &<i>filter</i>)</h3>
<p>Sets the contact filter used to determine which contacts will be retrieved to <i>filter</i>.</p>
<p><b>See also </b><a href="qcontactfetchrequest.html#filter">filter</a>().</p>
<!-- @@@setFilter -->
<!-- $$$setSorting[overload1]$$$setSortingconstQList<QContactSortOrder>& -->
<h3 class="fn" id="setSorting"><a name="setSorting"></a><span class="type">void</span> QContactFetchRequest::<span class="name">setSorting</span>(const <span class="type">QList</span><<span class="type"><a href="qcontactsortorder.html">QContactSortOrder</a></span>> &<i>sorting</i>)</h3>
<p>Sets the sort order of the result to <i>sorting</i>. Only has an effect if called prior to calling <code>start()</code></p>
<p><b>See also </b><a href="qcontactfetchrequest.html#sorting">sorting</a>().</p>
<!-- @@@setSorting -->
<!-- $$$setStorageLocations[overload1]$$$setStorageLocationsQContactAbstractRequest::StorageLocations -->
<h3 class="fn" id="setStorageLocations"><a name="setStorageLocations"></a><span class="type">void</span> QContactFetchRequest::<span class="name">setStorageLocations</span>(<span class="type"><a href="qcontactabstractrequest.html#StorageLocation-enum">QContactAbstractRequest::StorageLocations</a></span> <i>storageLocations</i>)</h3>
<p>Sets the storage location from where the contacts will be retrieved.</p>
<p><i>storageLocations</i> is a flag so it is possible to define multiple locations in it. However, some backend implementations may accept only one flag to be set. In case multiple flags are set fetching is done from the default storage location.</p>
<p><b>See also </b><a href="qcontactfetchrequest.html#storageLocations">storageLocations</a>(), <a href="qcontactabstractrequest.html#StorageLocation-enum">QContactAbstractRequest::StorageLocation</a>, and <a href="qcontactabstractrequest.html#StorageLocation-enum">QContactAbstractRequest::StorageLocations</a>.</p>
<!-- @@@setStorageLocations -->
<!-- $$$sorting[overload1]$$$sorting -->
<h3 class="fn" id="sorting"><a name="sorting"></a><span class="type">QList</span><<span class="type"><a href="qcontactsortorder.html">QContactSortOrder</a></span>> QContactFetchRequest::<span class="name">sorting</span>() const</h3>
<p>Returns the sort ordering that will be used sort the results of this request</p>
<p><b>See also </b><a href="qcontactfetchrequest.html#setSorting">setSorting</a>().</p>
<!-- @@@sorting -->
<!-- $$$storageLocations[overload1]$$$storageLocations -->
<h3 class="fn" id="storageLocations"><a name="storageLocations"></a><span class="type"><a href="qcontactabstractrequest.html#StorageLocation-enum">QContactAbstractRequest::StorageLocations</a></span> QContactFetchRequest::<span class="name">storageLocations</span>() const</h3>
<p>Returns the storage locations from where the contacts will be retrieved.</p>
<p><b>See also </b><a href="qcontactfetchrequest.html#setStorageLocations">setStorageLocations</a>(), <a href="qcontactabstractrequest.html#StorageLocation-enum">QContactAbstractRequest::StorageLocation</a>, and <a href="qcontactabstractrequest.html#StorageLocation-enum">QContactAbstractRequest::StorageLocations</a>.</p>
<!-- @@@storageLocations -->
</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>
|