/usr/share/qt5/doc/qtlocation/qplacematchrequest.html is in qtlocation5-doc-html 5.2.1-1ubuntu2.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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" />
<!-- qplacematchrequest.cpp -->
<title>QPlaceMatchRequest Class | QtLocation 5.2</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.2</li>
<li><a href="qtlocation-index.html">Qt Location</a></li>
<li><a href="qtlocation-module.html">C++ Classes</a></li>
<li>QPlaceMatchRequest</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<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="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QPlaceMatchRequest Class</h1>
<!-- $$$QPlaceMatchRequest-brief -->
<p>The QPlaceMatchRequest class is used to find places from one manager that match those from another. It represents a set of request parameters. <a href="#details">More...</a></p>
<!-- @@@QPlaceMatchRequest -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QPlaceMatchRequest></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += location</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt Location 5.0</td></tr></table><ul>
<li><a href="qplacematchrequest-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="qplacematchrequest.html#QPlaceMatchRequest">QPlaceMatchRequest</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#QPlaceMatchRequest-2">QPlaceMatchRequest</a></b>(const QPlaceMatchRequest &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#dtor.QPlaceMatchRequest">~QPlaceMatchRequest</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#clear">clear</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariantMap </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#parameters">parameters</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QPlace> </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#places">places</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#setParameters">setParameters</a></b>(const QVariantMap &<i> parameters</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#setPlaces">setPlaces</a></b>(const QList<QPlace><i> places</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#setResults">setResults</a></b>(const QList<QPlaceSearchResult> &<i> results</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#operator-not-eq">operator!=</a></b>(const QPlaceMatchRequest &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceMatchRequest & </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#operator-eq">operator=</a></b>(const QPlaceMatchRequest &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#operator-eq-eq">operator==</a></b>(const QPlaceMatchRequest &<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 QString </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#AlternativeId-var">AlternativeId</a></b></td></tr>
</table>
<a name="details"></a>
<!-- $$$QPlaceMatchRequest-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QPlaceMatchRequest class is used to find places from one manager that match those from another. It represents a set of request parameters.</p>
<p>Places from another manager that may have corresponding/matching places in the current manager are assigned using <a href="qplacematchrequest.html#setPlaces">setPlaces</a>() or <a href="qplacematchrequest.html#setResults">setResults</a>(). A set of further parameters are specified which determines the criteria for matching.</p>
<p>The typical key for matching is the <a href="qplacematchrequest.html#AlternativeId-var">QPlaceMatchRequest::AlternativeId</a>, the value is an alternative identifier attribute type of the format x_id_<provider name> for example x_id_nokia. The provider name is name supplied to the <a href="qgeoserviceprovider.html">QGeoServiceProvider</a> instance.</p>
<p>See <a href="location-places-cpp.html#matching-places-between-managers">Matching places between managers</a> for an example on how to use a match request.</p>
</div>
<p><b>See also </b><a href="qplacematchreply.html">QPlaceMatchReply</a> and <a href="qplacemanager.html">QPlaceManager</a>.</p>
<!-- @@@QPlaceMatchRequest -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPlaceMatchRequest[overload1]$$$QPlaceMatchRequest -->
<h3 class="fn"><a name="QPlaceMatchRequest"></a>QPlaceMatchRequest::<span class="name">QPlaceMatchRequest</span>()</h3>
<p>Default constructor. Constructs a new request object.</p>
<!-- @@@QPlaceMatchRequest -->
<!-- $$$QPlaceMatchRequest$$$QPlaceMatchRequestconstQPlaceMatchRequest& -->
<h3 class="fn"><a name="QPlaceMatchRequest-2"></a>QPlaceMatchRequest::<span class="name">QPlaceMatchRequest</span>(const <span class="type">QPlaceMatchRequest</span> &<i> other</i>)</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@QPlaceMatchRequest -->
<!-- $$$~QPlaceMatchRequest[overload1]$$$~QPlaceMatchRequest -->
<h3 class="fn"><a name="dtor.QPlaceMatchRequest"></a>QPlaceMatchRequest::<span class="name">~QPlaceMatchRequest</span>()</h3>
<p>Destroys the request object.</p>
<!-- @@@~QPlaceMatchRequest -->
<!-- $$$clear[overload1]$$$clear -->
<h3 class="fn"><a name="clear"></a><span class="type">void</span> QPlaceMatchRequest::<span class="name">clear</span>()</h3>
<p>Clears the match request.</p>
<!-- @@@clear -->
<!-- $$$parameters[overload1]$$$parameters -->
<h3 class="fn"><a name="parameters"></a><span class="type">QVariantMap</span> QPlaceMatchRequest::<span class="name">parameters</span>() const</h3>
<p>Returns the paramaters for matching places.</p>
<p><b>See also </b><a href="qplacematchrequest.html#setParameters">setParameters</a>().</p>
<!-- @@@parameters -->
<!-- $$$places[overload1]$$$places -->
<h3 class="fn"><a name="places"></a><span class="type">QList</span><<span class="type"><a href="qplace.html">QPlace</a></span>> QPlaceMatchRequest::<span class="name">places</span>() const</h3>
<p>Returns a list of places which are to be matched.</p>
<p><b>See also </b><a href="qplacematchrequest.html#setPlaces">setPlaces</a>().</p>
<!-- @@@places -->
<!-- $$$setParameters[overload1]$$$setParametersconstQVariantMap& -->
<h3 class="fn"><a name="setParameters"></a><span class="type">void</span> QPlaceMatchRequest::<span class="name">setParameters</span>(const <span class="type">QVariantMap</span> &<i> parameters</i>)</h3>
<p>Sets the <i>parameters</i> for matching places.</p>
<p><b>See also </b><a href="qplacematchrequest.html#parameters">parameters</a>().</p>
<!-- @@@setParameters -->
<!-- $$$setPlaces[overload1]$$$setPlacesconstQList<QPlace> -->
<h3 class="fn"><a name="setPlaces"></a><span class="type">void</span> QPlaceMatchRequest::<span class="name">setPlaces</span>(const <span class="type">QList</span><<span class="type"><a href="qplace.html">QPlace</a></span>><i> places</i>)</h3>
<p>Sets a list of <i>places</i> which are to be matched.</p>
<p><b>See also </b><a href="qplacematchrequest.html#places">places</a>() and <a href="qplacematchrequest.html#setResults">setResults</a>().</p>
<!-- @@@setPlaces -->
<!-- $$$setResults[overload1]$$$setResultsconstQList<QPlaceSearchResult>& -->
<h3 class="fn"><a name="setResults"></a><span class="type">void</span> QPlaceMatchRequest::<span class="name">setResults</span>(const <span class="type">QList</span><<span class="type"><a href="qplacesearchresult.html">QPlaceSearchResult</a></span>> &<i> results</i>)</h3>
<p>Convenience function which uses a set of search <i>results</i> to set the places which should be matched.</p>
<p><b>See also </b><a href="qplacematchrequest.html#setPlaces">setPlaces</a>().</p>
<!-- @@@setResults -->
<!-- $$$operator!=[overload1]$$$operator!=constQPlaceMatchRequest& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QPlaceMatchRequest::<span class="name">operator!=</span>(const <span class="type">QPlaceMatchRequest</span> &<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is not equal to this match request, otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQPlaceMatchRequest& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QPlaceMatchRequest</span> & QPlaceMatchRequest::<span class="name">operator=</span>(const <span class="type">QPlaceMatchRequest</span> &<i> other</i>)</h3>
<p>Assigns <i>other</i> to this search request and returns a reference to this match request.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQPlaceMatchRequest& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QPlaceMatchRequest::<span class="name">operator==</span>(const <span class="type">QPlaceMatchRequest</span> &<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is equal to this match request, otherwise returns false.</p>
<!-- @@@operator== -->
</div>
<div class="vars">
<h2>Member Variable Documentation</h2>
<!-- $$$AlternativeId -->
<h3 class="fn"><a name="AlternativeId-var"></a>const <span class="type">QString</span> QPlaceMatchRequest::<span class="name">AlternativeId</span></h3>
<p>The key to specify that matching is to be accomplished via an alternative place identifier.</p>
<!-- @@@AlternativeId -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|