/usr/share/qt5/doc/qtlocation/qplacecontentrequest.html is in qtlocation5-doc-html 5.5.1-3ubuntu1.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qplacecontentrequest.cpp -->
<title>QPlaceContentRequest Class | Qt Location 5.5</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.5</li>
<li><a href="qtlocation-index.html">Qt Location</a></li>
<li><a href="qtlocation-module.html">C++ Classes</a></li>
<li>QPlaceContentRequest</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
</ul>
</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">QPlaceContentRequest Class</h1>
<!-- $$$QPlaceContentRequest-brief -->
<p>The <a href="qplacecontentrequest.html">QPlaceContentRequest</a> class represents the parameters of a content request. <a href="#details">More...</a></p>
<!-- @@@QPlaceContentRequest -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QPlaceContentRequest></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += location</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.5</td></tr></table></div><ul>
<li><a href="qplacecontentrequest-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="qplacecontentrequest.html#QPlaceContentRequest">QPlaceContentRequest</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#QPlaceContentRequest-2">QPlaceContentRequest</a></b>(const QPlaceContentRequest &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#dtor.QPlaceContentRequest">~QPlaceContentRequest</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#clear">clear</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#contentContext">contentContext</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceContent::Type </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#contentType">contentType</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#limit">limit</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#placeId">placeId</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#setContentContext">setContentContext</a></b>(const QVariant &<i> context</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#setContentType">setContentType</a></b>(QPlaceContent::Type<i> type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#setLimit">setLimit</a></b>(int<i> limit</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#setPlaceId">setPlaceId</a></b>(const QString &<i> identifier</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#operator-not-eq">operator!=</a></b>(const QPlaceContentRequest &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceContentRequest & </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#operator-eq">operator=</a></b>(const QPlaceContentRequest &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplacecontentrequest.html#operator-eq-eq">operator==</a></b>(const QPlaceContentRequest &<i> other</i>) const</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QPlaceContentRequest-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qplacecontentrequest.html">QPlaceContentRequest</a> class represents the parameters of a content request.</p>
<p>The <a href="qplacecontentrequest.html">QPlaceContentRequest</a> class is used in conjunction with a <a href="qplacemanager.html">QPlaceManager</a> to retrieve rich content like images and reviews in a paginated fashion. The following code would request a set of 5 images from the 10th index:</p>
<pre class="cpp"><span class="type"><a href="qplacecontentrequest.html#QPlaceContentRequest">QPlaceContentRequest</a></span> request;
request<span class="operator">.</span>setContentType(<span class="type"><a href="qplacecontent.html">QPlaceContent</a></span><span class="operator">::</span>ImageType);
request<span class="operator">.</span>setPlaceId(place<span class="operator">.</span>placeId());
request<span class="operator">.</span>setLimit(<span class="number">5</span>);
<span class="type"><a href="qplacecontentreply.html">QPlaceContentReply</a></span> <span class="operator">*</span>contentReply <span class="operator">=</span> manager<span class="operator">-</span><span class="operator">></span>getPlaceContent(request);
<span class="comment">//..connect signals..//</span>
...
...
<span class="type">void</span> contentHandler() {
<span class="keyword">if</span> (contentReply<span class="operator">-</span><span class="operator">></span>error() <span class="operator">=</span><span class="operator">=</span> <span class="type"><a href="qplacereply.html">QPlaceReply</a></span><span class="operator">::</span>NoError) {
place<span class="operator">.</span>insertContent(contentReply<span class="operator">-</span><span class="operator">></span>request()<span class="operator">.</span>contentType()<span class="operator">,</span>
contentReply<span class="operator">-</span><span class="operator">></span>content());
}
}</pre>
</div>
<p><b>See also </b><a href="qplacecontentreply.html">QPlaceContentReply</a>.</p>
<!-- @@@QPlaceContentRequest -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPlaceContentRequest[overload1]$$$QPlaceContentRequest -->
<h3 class="fn" id="QPlaceContentRequest"><a name="QPlaceContentRequest"></a>QPlaceContentRequest::<span class="name">QPlaceContentRequest</span>()</h3>
<p>Constructs a new request object.</p>
<!-- @@@QPlaceContentRequest -->
<!-- $$$QPlaceContentRequest$$$QPlaceContentRequestconstQPlaceContentRequest& -->
<h3 class="fn" id="QPlaceContentRequest-2"><a name="QPlaceContentRequest-2"></a>QPlaceContentRequest::<span class="name">QPlaceContentRequest</span>(const <span class="type"><a href="qplacecontentrequest.html#QPlaceContentRequest">QPlaceContentRequest</a></span> &<i> other</i>)</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@QPlaceContentRequest -->
<!-- $$$~QPlaceContentRequest[overload1]$$$~QPlaceContentRequest -->
<h3 class="fn" id="dtor.QPlaceContentRequest"><a name="dtor.QPlaceContentRequest"></a>QPlaceContentRequest::<span class="name">~QPlaceContentRequest</span>()</h3>
<p>Destroys the request object</p>
<!-- @@@~QPlaceContentRequest -->
<!-- $$$clear[overload1]$$$clear -->
<h3 class="fn" id="clear"><a name="clear"></a><span class="type">void</span> QPlaceContentRequest::<span class="name">clear</span>()</h3>
<p>Clears the content request.</p>
<!-- @@@clear -->
<!-- $$$contentContext[overload1]$$$contentContext -->
<h3 class="fn" id="contentContext"><a name="contentContext"></a><span class="type"><a href="../qtcore/qvariant.html">QVariant</a></span> QPlaceContentRequest::<span class="name">contentContext</span>() const</h3>
<p>Returns backend specific additional content context associated with this place content request.</p>
<p><b>See also </b><a href="qplacecontentrequest.html#setContentContext">setContentContext</a>().</p>
<!-- @@@contentContext -->
<!-- $$$contentType[overload1]$$$contentType -->
<h3 class="fn" id="contentType"><a name="contentType"></a><span class="type"><a href="qplacecontent.html#Type-enum">QPlaceContent::Type</a></span> QPlaceContentRequest::<span class="name">contentType</span>() const</h3>
<p>Returns the type of content to be requested, for example reviews or images</p>
<p><b>See also </b><a href="qplacecontentrequest.html#setContentType">setContentType</a>().</p>
<!-- @@@contentType -->
<!-- $$$limit[overload1]$$$limit -->
<h3 class="fn" id="limit"><a name="limit"></a><span class="type">int</span> QPlaceContentRequest::<span class="name">limit</span>() const</h3>
<p>Returns the maximum number of content items to retrieve.</p>
<p>A negative value for limit means that it is undefined. It is left up to the backend provider to choose an appropriate number of items to return.</p>
<p>The default limit is -1.</p>
<p><b>See also </b><a href="qplacecontentrequest.html#setLimit">setLimit</a>().</p>
<!-- @@@limit -->
<!-- $$$placeId[overload1]$$$placeId -->
<h3 class="fn" id="placeId"><a name="placeId"></a><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QPlaceContentRequest::<span class="name">placeId</span>() const</h3>
<p>Returns the identifier of the place content is to be fetched for.</p>
<p><b>See also </b><a href="qplacecontentrequest.html#setPlaceId">setPlaceId</a>().</p>
<!-- @@@placeId -->
<!-- $$$setContentContext[overload1]$$$setContentContextconstQVariant& -->
<h3 class="fn" id="setContentContext"><a name="setContentContext"></a><span class="type">void</span> QPlaceContentRequest::<span class="name">setContentContext</span>(const <span class="type"><a href="../qtcore/qvariant.html">QVariant</a></span> &<i> context</i>)</h3>
<p>Sets the content context to <i>context</i>.</p>
<p><b>Note: </b>This method is intended to be used by geo service plugins when returning place content results.</p><p>The content context is used by backends to store additional content context related to the content request. Other relevant fields should also be filled in. For example, if the content request is for image content the content type should also be set with <a href="qplacecontentrequest.html#setContentType">setContentType</a>(). The content context allows additional context to be kept which is not directly accessible via the Qt Location API.</p>
<p>The content context can be of any type storable in a <a href="../qtcore/qvariant.html">QVariant</a>. The value of the content context is not intended to be used directly by applications.</p>
<p><b>See also </b><a href="qplacecontentrequest.html#contentContext">contentContext</a>().</p>
<!-- @@@setContentContext -->
<!-- $$$setContentType[overload1]$$$setContentTypeQPlaceContent::Type -->
<h3 class="fn" id="setContentType"><a name="setContentType"></a><span class="type">void</span> QPlaceContentRequest::<span class="name">setContentType</span>(<span class="type"><a href="qplacecontent.html#Type-enum">QPlaceContent::Type</a></span><i> type</i>)</h3>
<p>Sets the <i>type</i> of content to be requested.</p>
<p><b>See also </b><a href="qplacecontentrequest.html#contentType">contentType</a>().</p>
<!-- @@@setContentType -->
<!-- $$$setLimit[overload1]$$$setLimitint -->
<h3 class="fn" id="setLimit"><a name="setLimit"></a><span class="type">void</span> QPlaceContentRequest::<span class="name">setLimit</span>(<span class="type">int</span><i> limit</i>)</h3>
<p>Set the maximum number of content items to retrieve to <i>limit</i>.</p>
<p><b>See also </b><a href="qplacecontentrequest.html#limit">limit</a>().</p>
<!-- @@@setLimit -->
<!-- $$$setPlaceId[overload1]$$$setPlaceIdconstQString& -->
<h3 class="fn" id="setPlaceId"><a name="setPlaceId"></a><span class="type">void</span> QPlaceContentRequest::<span class="name">setPlaceId</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i> identifier</i>)</h3>
<p>Sets the identifier of the place to fetch content for to <i>identifier</i>.</p>
<p><b>See also </b><a href="qplacecontentrequest.html#placeId">placeId</a>().</p>
<!-- @@@setPlaceId -->
<!-- $$$operator!=[overload1]$$$operator!=constQPlaceContentRequest& -->
<h3 class="fn" id="operator-not-eq"><a name="operator-not-eq"></a><span class="type">bool</span> QPlaceContentRequest::<span class="name">operator!=</span>(const <span class="type"><a href="qplacecontentrequest.html#QPlaceContentRequest">QPlaceContentRequest</a></span> &<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is not equal to this content request, otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQPlaceContentRequest& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qplacecontentrequest.html#QPlaceContentRequest">QPlaceContentRequest</a></span> & QPlaceContentRequest::<span class="name">operator=</span>(const <span class="type"><a href="qplacecontentrequest.html#QPlaceContentRequest">QPlaceContentRequest</a></span> &<i> other</i>)</h3>
<p>Assigns <i>other</i> to this content request and returns a reference to this content request.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQPlaceContentRequest& -->
<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> QPlaceContentRequest::<span class="name">operator==</span>(const <span class="type"><a href="qplacecontentrequest.html#QPlaceContentRequest">QPlaceContentRequest</a></span> &<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is equal to this content request, otherwise returns false.</p>
<!-- @@@operator== -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 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>
|