/usr/share/qt5/doc/qtpositioning/qgeoaddress.html is in qtpositioning5-doc-html 5.3.2-2.
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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 | <?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" />
<!-- qgeoaddress.cpp -->
<title>QGeoAddress Class | QtPositioning 5.3</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.3</li>
<li><a href="qtpositioning-index.html">Qt Positioning</a></li>
<li><a href="qtpositioning-module.html">C++ Classes</a></li>
<li>QGeoAddress</li>
<li id="buildversion">
Qt 5.3.2 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="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QGeoAddress Class</h1>
<!-- $$$QGeoAddress-brief -->
<p>The QGeoAddress class represents an address of a <a href="qgeolocation.html">QGeoLocation</a>. <a href="#details">More...</a></p>
<!-- @@@QGeoAddress -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QGeoAddress></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += positioning</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.2</td></tr></table><ul>
<li><a href="qgeoaddress-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="qgeoaddress.html#QGeoAddress">QGeoAddress</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#QGeoAddress-2">QGeoAddress</a></b>(const QGeoAddress &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#dtor.QGeoAddress">~QGeoAddress</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#city">city</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#clear">clear</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#country">country</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#countryCode">countryCode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#county">county</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#district">district</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#isEmpty">isEmpty</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#isTextGenerated">isTextGenerated</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#postalCode">postalCode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#setCity">setCity</a></b>(const QString &<i> city</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#setCountry">setCountry</a></b>(const QString &<i> country</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#setCountryCode">setCountryCode</a></b>(const QString &<i> countryCode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#setCounty">setCounty</a></b>(const QString &<i> county</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#setDistrict">setDistrict</a></b>(const QString &<i> district</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#setPostalCode">setPostalCode</a></b>(const QString &<i> postalCode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#setState">setState</a></b>(const QString &<i> state</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#setStreet">setStreet</a></b>(const QString &<i> street</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#setText">setText</a></b>(const QString &<i> text</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#state">state</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#street">street</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#text">text</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#operator-not-eq">operator!=</a></b>(const QGeoAddress &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoAddress & </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#operator-eq">operator=</a></b>(const QGeoAddress &<i> address</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoaddress.html#operator-eq-eq">operator==</a></b>(const QGeoAddress &<i> other</i>) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QGeoAddress-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoAddress class represents an address of a <a href="qgeolocation.html">QGeoLocation</a>.</p>
<p>The address' attributes are normalized to US feature names and can be mapped to the local feature levels (for example State matches "Bundesland" in Germany).</p>
<p>The address contains a <a href="qgeoaddress.html#text">text</a>() for displaying purposes and additional properties to access the components of an address:</p>
<ul>
<li><a href="qgeoaddress.html#country">QGeoAddress::country</a>()</li>
<li><a href="qgeoaddress.html#countryCode">QGeoAddress::countryCode</a>()</li>
<li><a href="qgeoaddress.html#state">QGeoAddress::state</a>()</li>
<li><a href="qgeoaddress.html#city">QGeoAddress::city</a>()</li>
<li><a href="qgeoaddress.html#district">QGeoAddress::district</a>()</li>
<li><a href="qgeoaddress.html#street">QGeoAddress::street</a>()</li>
<li><a href="qgeoaddress.html#postalCode">QGeoAddress::postalCode</a>()</li>
</ul>
</div>
<!-- @@@QGeoAddress -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoAddress[overload1]$$$QGeoAddress -->
<h3 class="fn"><a name="QGeoAddress"></a>QGeoAddress::<span class="name">QGeoAddress</span>()</h3>
<p>Default constructor.</p>
<!-- @@@QGeoAddress -->
<!-- $$$QGeoAddress$$$QGeoAddressconstQGeoAddress& -->
<h3 class="fn"><a name="QGeoAddress-2"></a>QGeoAddress::<span class="name">QGeoAddress</span>(const <span class="type">QGeoAddress</span> &<i> other</i>)</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@QGeoAddress -->
<!-- $$$~QGeoAddress[overload1]$$$~QGeoAddress -->
<h3 class="fn"><a name="dtor.QGeoAddress"></a>QGeoAddress::<span class="name">~QGeoAddress</span>()</h3>
<p>Destroys this address.</p>
<!-- @@@~QGeoAddress -->
<!-- $$$city[overload1]$$$city -->
<h3 class="fn"><a name="city"></a><span class="type">QString</span> QGeoAddress::<span class="name">city</span>() const</h3>
<p>Returns the city.</p>
<p><b>See also </b><a href="qgeoaddress.html#setCity">setCity</a>().</p>
<!-- @@@city -->
<!-- $$$clear[overload1]$$$clear -->
<h3 class="fn"><a name="clear"></a><span class="type">void</span> QGeoAddress::<span class="name">clear</span>()</h3>
<p>Clears all of the address' data fields.</p>
<!-- @@@clear -->
<!-- $$$country[overload1]$$$country -->
<h3 class="fn"><a name="country"></a><span class="type">QString</span> QGeoAddress::<span class="name">country</span>() const</h3>
<p>Returns the country name.</p>
<p><b>See also </b><a href="qgeoaddress.html#setCountry">setCountry</a>().</p>
<!-- @@@country -->
<!-- $$$countryCode[overload1]$$$countryCode -->
<h3 class="fn"><a name="countryCode"></a><span class="type">QString</span> QGeoAddress::<span class="name">countryCode</span>() const</h3>
<p>Returns the country code according to ISO 3166-1 alpha-3</p>
<p><b>See also </b><a href="qgeoaddress.html#setCountryCode">setCountryCode</a>().</p>
<!-- @@@countryCode -->
<!-- $$$county[overload1]$$$county -->
<h3 class="fn"><a name="county"></a><span class="type">QString</span> QGeoAddress::<span class="name">county</span>() const</h3>
<p>Returns the county. The county is considered the second subdivision below country.</p>
<p><b>See also </b><a href="qgeoaddress.html#setCounty">setCounty</a>().</p>
<!-- @@@county -->
<!-- $$$district[overload1]$$$district -->
<h3 class="fn"><a name="district"></a><span class="type">QString</span> QGeoAddress::<span class="name">district</span>() const</h3>
<p>Returns the district. The district is considered the subdivison below city.</p>
<p><b>See also </b><a href="qgeoaddress.html#setDistrict">setDistrict</a>().</p>
<!-- @@@district -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> QGeoAddress::<span class="name">isEmpty</span>() const</h3>
<p>Returns whether this address is empty. An address is considered empty if <i>all</i> of its fields are empty.</p>
<!-- @@@isEmpty -->
<!-- $$$isTextGenerated[overload1]$$$isTextGenerated -->
<h3 class="fn"><a name="isTextGenerated"></a><span class="type">bool</span> QGeoAddress::<span class="name">isTextGenerated</span>() const</h3>
<p>Returns true if <a href="qgeoaddress.html#text">QGeoAddress::text</a>() is automatically generated from address elements, otherwise returns false if <a href="qgeoaddress.html#text">text</a>() has been explicitly assigned.</p>
<p><b>See also </b><a href="qgeoaddress.html#text">text</a>() and <a href="qgeoaddress.html#setText">setText</a>().</p>
<!-- @@@isTextGenerated -->
<!-- $$$postalCode[overload1]$$$postalCode -->
<h3 class="fn"><a name="postalCode"></a><span class="type">QString</span> QGeoAddress::<span class="name">postalCode</span>() const</h3>
<p>Returns the postal code.</p>
<p><b>See also </b><a href="qgeoaddress.html#setPostalCode">setPostalCode</a>().</p>
<!-- @@@postalCode -->
<!-- $$$setCity[overload1]$$$setCityconstQString& -->
<h3 class="fn"><a name="setCity"></a><span class="type">void</span> QGeoAddress::<span class="name">setCity</span>(const <span class="type">QString</span> &<i> city</i>)</h3>
<p>Sets the <i>city</i>.</p>
<p><b>See also </b><a href="qgeoaddress.html#city">city</a>().</p>
<!-- @@@setCity -->
<!-- $$$setCountry[overload1]$$$setCountryconstQString& -->
<h3 class="fn"><a name="setCountry"></a><span class="type">void</span> QGeoAddress::<span class="name">setCountry</span>(const <span class="type">QString</span> &<i> country</i>)</h3>
<p>Sets the <i>country</i> name.</p>
<p><b>See also </b><a href="qgeoaddress.html#country">country</a>().</p>
<!-- @@@setCountry -->
<!-- $$$setCountryCode[overload1]$$$setCountryCodeconstQString& -->
<h3 class="fn"><a name="setCountryCode"></a><span class="type">void</span> QGeoAddress::<span class="name">setCountryCode</span>(const <span class="type">QString</span> &<i> countryCode</i>)</h3>
<p>Sets the <i>countryCode</i> according to ISO 3166-1 alpha-3</p>
<p><b>See also </b><a href="qgeoaddress.html#countryCode">countryCode</a>().</p>
<!-- @@@setCountryCode -->
<!-- $$$setCounty[overload1]$$$setCountyconstQString& -->
<h3 class="fn"><a name="setCounty"></a><span class="type">void</span> QGeoAddress::<span class="name">setCounty</span>(const <span class="type">QString</span> &<i> county</i>)</h3>
<p>Sets the <i>county</i>.</p>
<p><b>See also </b><a href="qgeoaddress.html#county">county</a>().</p>
<!-- @@@setCounty -->
<!-- $$$setDistrict[overload1]$$$setDistrictconstQString& -->
<h3 class="fn"><a name="setDistrict"></a><span class="type">void</span> QGeoAddress::<span class="name">setDistrict</span>(const <span class="type">QString</span> &<i> district</i>)</h3>
<p>Sets the <i>district</i>.</p>
<p><b>See also </b><a href="qgeoaddress.html#district">district</a>().</p>
<!-- @@@setDistrict -->
<!-- $$$setPostalCode[overload1]$$$setPostalCodeconstQString& -->
<h3 class="fn"><a name="setPostalCode"></a><span class="type">void</span> QGeoAddress::<span class="name">setPostalCode</span>(const <span class="type">QString</span> &<i> postalCode</i>)</h3>
<p>Sets the <i>postalCode</i>.</p>
<p><b>See also </b><a href="qgeoaddress.html#postalCode">postalCode</a>().</p>
<!-- @@@setPostalCode -->
<!-- $$$setState[overload1]$$$setStateconstQString& -->
<h3 class="fn"><a name="setState"></a><span class="type">void</span> QGeoAddress::<span class="name">setState</span>(const <span class="type">QString</span> &<i> state</i>)</h3>
<p>Sets the <i>state</i>.</p>
<p><b>See also </b><a href="qgeoaddress.html#state">state</a>().</p>
<!-- @@@setState -->
<!-- $$$setStreet[overload1]$$$setStreetconstQString& -->
<h3 class="fn"><a name="setStreet"></a><span class="type">void</span> QGeoAddress::<span class="name">setStreet</span>(const <span class="type">QString</span> &<i> street</i>)</h3>
<p>Sets the street-level component of the address to <i>street</i>.</p>
<p>This typically includes a street number and street name but may also contain things like a unit number, a building name, or anything else that might be used to distinguish one address from another.</p>
<p><b>See also </b><a href="qgeoaddress.html#street">street</a>().</p>
<!-- @@@setStreet -->
<!-- $$$setText[overload1]$$$setTextconstQString& -->
<h3 class="fn"><a name="setText"></a><span class="type">void</span> QGeoAddress::<span class="name">setText</span>(const <span class="type">QString</span> &<i> text</i>)</h3>
<p>If <i>text</i> is not empty, explicitly assigns <i>text</i> as the string to be returned by <a href="qgeoaddress.html#text">text</a>(). <a href="qgeoaddress.html#isTextGenerated">isTextGenerated</a>() will return false.</p>
<p>If <i>text</i> is empty, indicates that <a href="qgeoaddress.html#text">text</a>() should be automatically generated from the address elements. <a href="qgeoaddress.html#isTextGenerated">isTextGenerated</a>() will return true.</p>
<p><b>See also </b><a href="qgeoaddress.html#text">text</a>().</p>
<!-- @@@setText -->
<!-- $$$state[overload1]$$$state -->
<h3 class="fn"><a name="state"></a><span class="type">QString</span> QGeoAddress::<span class="name">state</span>() const</h3>
<p>Returns the state. The state is considered the first subdivision below country.</p>
<p><b>See also </b><a href="qgeoaddress.html#setState">setState</a>().</p>
<!-- @@@state -->
<!-- $$$street[overload1]$$$street -->
<h3 class="fn"><a name="street"></a><span class="type">QString</span> QGeoAddress::<span class="name">street</span>() const</h3>
<p>Returns the street-level component of the address.</p>
<p>This typically includes a street number and street name but may also contain things like a unit number, a building name, or anything else that might be used to distinguish one address from another.</p>
<p><b>See also </b><a href="qgeoaddress.html#setStreet">setStreet</a>().</p>
<!-- @@@street -->
<!-- $$$text[overload1]$$$text -->
<h3 class="fn"><a name="text"></a><span class="type">QString</span> QGeoAddress::<span class="name">text</span>() const</h3>
<p>Returns the address as a single formatted string. It is the recommended string to use to display the address to the user. It typically takes the format of an address as found on an envelope, but this is not always necessarily the case.</p>
<p>The address text is either automatically generated or explicitly assigned. This can be determined by checking <a href="qgeoaddress.html#isTextGenerated">isTextGenerated</a>.</p>
<p>If an empty string is provided to <a href="qgeoaddress.html#setText">setText</a>(), then <a href="qgeoaddress.html#isTextGenerated">isTextGenerated</a>() will be set to true and text() will return a string which is locally formatted according to <a href="qgeoaddress.html#countryCode">countryCode</a>() and based on the elements of the address such as street, city and so on. Because the text string is generated from the address elements, a sequence of calls such as text(), <a href="qgeoaddress.html#setStreet">setStreet</a>(), text() may return different strings for each invocation of text().</p>
<p>If a non-empty string is provided to <a href="qgeoaddress.html#setText">setText</a>(), then <a href="qgeoaddress.html#isTextGenerated">isTextGenerated</a>() will be set to false and text() will always return the explicitly assigned string. Calls to modify other elements such as <a href="qgeoaddress.html#setStreet">setStreet</a>(), <a href="qgeoaddress.html#setCity">setCity</a>() and so on will not affect the resultant string from text().</p>
<p><b>See also </b><a href="qgeoaddress.html#setText">setText</a>().</p>
<!-- @@@text -->
<!-- $$$operator!=[overload1]$$$operator!=constQGeoAddress& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QGeoAddress::<span class="name">operator!=</span>(const <span class="type">QGeoAddress</span> &<i> other</i>) const</h3>
<p>Returns true if this address is not equal to <i>other</i>, otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQGeoAddress& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QGeoAddress</span> & QGeoAddress::<span class="name">operator=</span>(const <span class="type">QGeoAddress</span> &<i> address</i>)</h3>
<p>Assigns the given <i>address</i> to this address and returns a reference to this address.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQGeoAddress& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QGeoAddress::<span class="name">operator==</span>(const <span class="type">QGeoAddress</span> &<i> other</i>) const</h3>
<p>Returns true if this address is equal to <i>other</i>, otherwise returns false.</p>
<!-- @@@operator== -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2014 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>
|