/usr/share/qt5/doc/qtcontacts/qcontactfetchhint.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcontactfetchhint.cpp -->
<title>QContactFetchHint 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 >QContactFetchHint</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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QContactFetchHint Class</h1>
<!-- $$$QContactFetchHint-brief -->
<p>The <a href="qcontactfetchhint.html">QContactFetchHint</a> class provides hints to the manager about which contact information needs to be retrieved in an asynchronous fetch request or a synchronous function call. <a href="#details">More...</a></p>
<!-- @@@QContactFetchHint -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QContactFetchHint></span>
</td></tr></table></div><ul>
<li><a href="qcontactfetchhint-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="qcontactfetchhint.html#OptimizationHint-enum">OptimizationHint</a></b> { AllRequired, NoRelationships, NoActionPreferences, NoBinaryBlobs }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#OptimizationHint-enum">OptimizationHints</a></b></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="qcontactfetchhint.html#QContactFetchHint">QContactFetchHint</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#QContactFetchHint-1">QContactFetchHint</a></b>(const QContactFetchHint &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#dtor.QContactFetchHint">~QContactFetchHint</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContactDetail::DetailType> </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#detailTypesHint">detailTypesHint</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#maxCountHint">maxCountHint</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> OptimizationHints </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#optimizationHints">optimizationHints</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSize </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#preferredImageSize">preferredImageSize</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#relationshipTypesHint">relationshipTypesHint</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#setDetailTypesHint">setDetailTypesHint</a></b>(const QList<QContactDetail::DetailType> &<i>types</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#setMaxCountHint">setMaxCountHint</a></b>(int <i>count</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#setOptimizationHints">setOptimizationHints</a></b>(OptimizationHints <i>hints</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#setPreferredImageSize">setPreferredImageSize</a></b>(const QSize &<i>size</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#setRelationshipTypesHint">setRelationshipTypesHint</a></b>(const QStringList &<i>relationshipTypes</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactFetchHint &</td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchhint.html#operator-eq">operator=</a></b>(const QContactFetchHint &<i>other</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QContactFetchHint-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qcontactfetchhint.html">QContactFetchHint</a> class provides hints to the manager about which contact information needs to be retrieved in an asynchronous fetch request or a synchronous function call.</p>
<p>All of the hints may be ignored at the discretion of the manager, however if a manager is able to optimize retrieval of contacts due to hints, it may do so. If a manager ignores a hint, it must retrieve the full set of data that the hint refers to.</p>
<p>The fetch hint contains:</p>
<ul>
<li>a list of detail types which the client is interested in (empty if interested in all detail types)</li>
<li>a list of relationship types which the client is interested in (empty if interested in all relationships)</li>
<li>some optimization flags which allow the client to tell the backend if they are not interested in any relationships, any action preferences, or any binary blobs (images etc).</li>
<li>a preferred size for any images, if the backend supports multiple sizes or scaling</li>
</ul>
<p>Important note: 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 can 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>
</div>
<!-- @@@QContactFetchHint -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$OptimizationHint$$$AllRequired$$$NoRelationships$$$NoActionPreferences$$$NoBinaryBlobs -->
<h3 class="flags" id="OptimizationHint-enum"><a name="OptimizationHint-enum"></a>enum QContactFetchHint::<span class="name">OptimizationHint</span><br/>flags QContactFetchHint::<span class="name">OptimizationHints</span></h3>
<p>This enum defines flags which may be set to inform the backend that the client does not require certain information. The backend may safely ignore the hint, but then must return the full set of information relating to the optimization hint.</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>QContactFetchHint::AllRequired</code></td><td class="topAlign tblval"><code>0x0</code></td><td class="topAlign">Tells the backend that all information is required</td></tr>
<tr><td class="topAlign"><code>QContactFetchHint::NoRelationships</code></td><td class="topAlign tblval"><code>0x1</code></td><td class="topAlign">Tells the backend that the client does not require retrieved contacts to include a cache of relationships</td></tr>
<tr><td class="topAlign"><code>QContactFetchHint::NoActionPreferences</code></td><td class="topAlign tblval"><code>0x2</code></td><td class="topAlign">Tells the backend that the client does not require retrieved contacts to include a cache of action preferences</td></tr>
<tr><td class="topAlign"><code>QContactFetchHint::NoBinaryBlobs</code></td><td class="topAlign tblval"><code>0x4</code></td><td class="topAlign">Tells the backend that the client does not require retrieved contacts to include binary blobs</td></tr>
</table></div>
<p>The OptimizationHints type is a typedef for <a href="">QFlags</a><OptimizationHint>. It stores an OR combination of OptimizationHint values.</p>
<!-- @@@OptimizationHint -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QContactFetchHint[overload1]$$$QContactFetchHint -->
<h3 class="fn" id="QContactFetchHint"><a name="QContactFetchHint"></a>QContactFetchHint::<span class="name">QContactFetchHint</span>()</h3>
<p>Constructs a new contact fetch hint which requests that the backend fetch all information</p>
<!-- @@@QContactFetchHint -->
<!-- $$$QContactFetchHint$$$QContactFetchHintconstQContactFetchHint& -->
<h3 class="fn" id="QContactFetchHint-1"><a name="QContactFetchHint-1"></a>QContactFetchHint::<span class="name">QContactFetchHint</span>(const <span class="type"><a href="qcontactfetchhint.html#QContactFetchHint">QContactFetchHint</a></span> &<i>other</i>)</h3>
<p>Constructs a new contact fetch hint as a copy of <i>other</i></p>
<!-- @@@QContactFetchHint -->
<!-- $$$~QContactFetchHint[overload1]$$$~QContactFetchHint -->
<h3 class="fn" id="dtor.QContactFetchHint"><a name="dtor.QContactFetchHint"></a>QContactFetchHint::<span class="name">~QContactFetchHint</span>()</h3>
<p>Frees any memory in use by the fetch hint</p>
<!-- @@@~QContactFetchHint -->
<!-- $$$detailTypesHint[overload1]$$$detailTypesHint -->
<h3 class="fn" id="detailTypesHint"><a name="detailTypesHint"></a><span class="type">QList</span><<span class="type"><a href="qcontactdetail.html#DetailType-enum">QContactDetail::DetailType</a></span>> QContactFetchHint::<span class="name">detailTypesHint</span>() const</h3>
<p>Returns the list of detail types that identify which detail type the manager should (at a minimum) retrieve when fetching contacts. This hint may be ignored by the backend, in which case it will return the full set of details for each contact retrieved.</p>
<p><b>See also </b><a href="qcontactfetchhint.html#setDetailTypesHint">setDetailTypesHint</a>().</p>
<!-- @@@detailTypesHint -->
<!-- $$$maxCountHint[overload1]$$$maxCountHint -->
<h3 class="fn" id="maxCountHint"><a name="maxCountHint"></a><span class="type">int</span> QContactFetchHint::<span class="name">maxCountHint</span>() const</h3>
<p>Returns the number of results which the client considers to be the maximum number of useful results. The client is only interested in this number of results, so returning any more results would be superfluous to the client's requirements. Note that this fetch hint only affects operations where the backend would return a list of contacts; this hint specifies the maximum number of contacts in the list which would be useful to the client. The backend may ignore this hint, in which case it must return all contacts which would otherwise have been returned as a result of the operation.</p>
<p>A negative value for count denotes that the client wishes to retrieve all results. The default value is -1.</p>
<p><b>See also </b><a href="qcontactfetchhint.html#setMaxCountHint">setMaxCountHint</a>().</p>
<!-- @@@maxCountHint -->
<!-- $$$optimizationHints[overload1]$$$optimizationHints -->
<h3 class="fn" id="optimizationHints"><a name="optimizationHints"></a><span class="type"><a href="qcontactfetchhint.html#OptimizationHint-enum">OptimizationHints</a></span> QContactFetchHint::<span class="name">optimizationHints</span>() const</h3>
<p>Returns the optimization hint flags specified by the client. These hints may be ignored by the backend, in which case it will return the full set of information accessible in a contact, including relationships, action preferences, and binary blobs.</p>
<p><b>See also </b><a href="qcontactfetchhint.html#setOptimizationHints">setOptimizationHints</a>().</p>
<!-- @@@optimizationHints -->
<!-- $$$preferredImageSize[overload1]$$$preferredImageSize -->
<h3 class="fn" id="preferredImageSize"><a name="preferredImageSize"></a><span class="type">QSize</span> QContactFetchHint::<span class="name">preferredImageSize</span>() const</h3>
<p>Returns the preferred pixel dimensions for any images returned by the manager for a given request. This hint may be ignored by the manager.</p>
<p>This is useful when the backend supports multiple sizes of an image (or the image is natively scaleable) in order to get an image that will look good at the indicated dimensions.</p>
<p>The caller should be prepared for images of any dimensions, in any case.</p>
<p><b>See also </b><a href="qcontactfetchhint.html#setPreferredImageSize">setPreferredImageSize</a>().</p>
<!-- @@@preferredImageSize -->
<!-- $$$relationshipTypesHint[overload1]$$$relationshipTypesHint -->
<h3 class="fn" id="relationshipTypesHint"><a name="relationshipTypesHint"></a><span class="type">QStringList</span> QContactFetchHint::<span class="name">relationshipTypesHint</span>() const</h3>
<p>Returns the list of relationship types that the manager should (at a minimum) retrieve when fetching contacts. This hint may be ignored by the backend, in which case it will return the full set of relationships for each contact retrieved.</p>
<p><b>See also </b><a href="qcontactfetchhint.html#setRelationshipTypesHint">setRelationshipTypesHint</a>() and <a href="qcontact.html#relationships">QContact::relationships</a>().</p>
<!-- @@@relationshipTypesHint -->
<!-- $$$setDetailTypesHint[overload1]$$$setDetailTypesHintconstQList<QContactDetail::DetailType>& -->
<h3 class="fn" id="setDetailTypesHint"><a name="setDetailTypesHint"></a><span class="type">void</span> QContactFetchHint::<span class="name">setDetailTypesHint</span>(const <span class="type">QList</span><<span class="type"><a href="qcontactdetail.html#DetailType-enum">QContactDetail::DetailType</a></span>> &<i>types</i>)</h3>
<p>Sets the list of detail types that identify which detail type the manager should (at a minimum) retrieve when fetching contacts to <i>types</i>. This hint may be ignored by the backend, in which case it will return the full set of details for each contact retrieved.</p>
<p><b>See also </b><a href="qcontactfetchhint.html#detailTypesHint">detailTypesHint</a>().</p>
<!-- @@@setDetailTypesHint -->
<!-- $$$setMaxCountHint[overload1]$$$setMaxCountHintint -->
<h3 class="fn" id="setMaxCountHint"><a name="setMaxCountHint"></a><span class="type">void</span> QContactFetchHint::<span class="name">setMaxCountHint</span>(<span class="type">int</span> <i>count</i>)</h3>
<p>Sets the maximum number of results which the client is interested in to <i>count</i>. The client is only interested in this number of results, so returning any more results would be superfluous to the client's requirements. Note that this fetch hint only affects operations where the backend would return a list of contacts; this hint specifies the maximum number of contacts in the list which would be useful to the client. The backend may ignore this hint, in which case it must return all contacts which would otherwise have been returned as a result of the operation.</p>
<p>A negative value for count denotes that the client wishes to retrieve all results. The default value is -1.</p>
<p><b>See also </b><a href="qcontactfetchhint.html#maxCountHint">maxCountHint</a>().</p>
<!-- @@@setMaxCountHint -->
<!-- $$$setOptimizationHints[overload1]$$$setOptimizationHintsOptimizationHints -->
<h3 class="fn" id="setOptimizationHints"><a name="setOptimizationHints"></a><span class="type">void</span> QContactFetchHint::<span class="name">setOptimizationHints</span>(<span class="type"><a href="qcontactfetchhint.html#OptimizationHint-enum">OptimizationHints</a></span> <i>hints</i>)</h3>
<p>Sets the optimization hint flags specified by the client to <i>hints</i>. These hints may be ignored by the backend, in which case it will return the full set of information accessible in a contact, including relationships, action preferences, and binary blobs.</p>
<p><b>See also </b><a href="qcontactfetchhint.html#optimizationHints">optimizationHints</a>().</p>
<!-- @@@setOptimizationHints -->
<!-- $$$setPreferredImageSize[overload1]$$$setPreferredImageSizeconstQSize& -->
<h3 class="fn" id="setPreferredImageSize"><a name="setPreferredImageSize"></a><span class="type">void</span> QContactFetchHint::<span class="name">setPreferredImageSize</span>(const <span class="type">QSize</span> &<i>size</i>)</h3>
<p>Sets the preferred pixel dimensions for any images returned by the manager for the given request to <i>size</i>. This hint may be ignored by the manager.</p>
<p>This is useful when the backend supports multiple sizes of an image (or the image is natively scaleable) in order to get an image that will look good at the indicated dimensions.</p>
<p>The caller should be prepared for images of any dimensions, in any case.</p>
<p><b>See also </b><a href="qcontactfetchhint.html#preferredImageSize">preferredImageSize</a>().</p>
<!-- @@@setPreferredImageSize -->
<!-- $$$setRelationshipTypesHint[overload1]$$$setRelationshipTypesHintconstQStringList& -->
<h3 class="fn" id="setRelationshipTypesHint"><a name="setRelationshipTypesHint"></a><span class="type">void</span> QContactFetchHint::<span class="name">setRelationshipTypesHint</span>(const <span class="type">QStringList</span> &<i>relationshipTypes</i>)</h3>
<p>Sets the list of relationship types that the manager should (at a minimum) retrieve when fetching contacts to <i>relationshipTypes</i>. This hint may be ignored by the backend, in which case it will return the full set of relationships for each contact retrieved.</p>
<p><b>See also </b><a href="qcontactfetchhint.html#relationshipTypesHint">relationshipTypesHint</a>() and <a href="qcontact.html#relationships">QContact::relationships</a>().</p>
<!-- @@@setRelationshipTypesHint -->
<!-- $$$operator=[overload1]$$$operator=constQContactFetchHint& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qcontactfetchhint.html#QContactFetchHint">QContactFetchHint</a></span> &QContactFetchHint::<span class="name">operator=</span>(const <span class="type"><a href="qcontactfetchhint.html#QContactFetchHint">QContactFetchHint</a></span> &<i>other</i>)</h3>
<p>Assigns this fetch hint to be equal to the <i>other</i> fetch hint</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>
|