/usr/share/qt5/doc/qtpositioning/qml-qtpositioning-address.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativegeoaddress.cpp -->
<title>Address QML Type | Qt Positioning 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="qtpositioning-index.html">Qt Positioning</a></li>
<li><a href="qtpositioning-qmlmodule.html">QML Types</a></li>
<li>Address QML Type</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="#properties">Properties</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#example-usage">Example Usage</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Address QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Address-brief -->
<p>The Address QML type represents a specific location as a street address. <a href="#details">More...</a></p>
<!-- @@@Address -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtPositioning 5.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.2</td></tr></table></div><ul>
<li><a href="qml-qtpositioning-address-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtpositioning-address.html#address-prop">address</a></b></b> : QGeoAddress</li>
<li class="fn"><b><b><a href="qml-qtpositioning-address.html#city-prop">city</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtpositioning-address.html#country-prop">country</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtpositioning-address.html#countryCode-prop">countryCode</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtpositioning-address.html#county-prop">county</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtpositioning-address.html#district-prop">district</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtpositioning-address.html#isTextGenerated-prop">isTextGenerated</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtpositioning-address.html#postalCode-prop">postalCode</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtpositioning-address.html#state-prop">state</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtpositioning-address.html#street-prop">street</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtpositioning-address.html#text-prop">text</a></b></b> : string</li>
</ul>
<!-- $$$Address-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>An Address is used as a unit of data for queries such as (Reverse) Geocoding or Places searches -- many of these operations either accept an Address or return one.</p>
<p>Not all properties of an Address are necessarily available or relevant in all parts of the world and all locales. The <a href="qml-qtpositioning-address.html#district-prop">district</a>, <a href="qml-qtpositioning-address.html#state-prop">state</a> and <a href="qml-qtpositioning-address.html#county-prop">county</a> properties are particularly area-specific for many data sources, and often only one or two of these are available or useful.</p>
<p>The Address has a <a href="qml-qtpositioning-address.html#text-prop">text</a> property which holds a formatted string. It is the recommended way to display an address to the user and typically takes the format of an address as found on an envelope, but this is not always the case. The <a href="qml-qtpositioning-address.html#text-prop">text</a> may be automatically generated from constituent address properties such as <a href="qml-qtpositioning-address.html#street-prop">street</a>, <a href="qml-qtpositioning-address.html#city-prop">city</a> and and so on, but can also be explicitly assigned. See <a href="qml-qtpositioning-address.html#text-prop">text</a> for details.</p>
<a name="example-usage"></a>
<h3 >Example Usage</h3>
<p>The following code snippet shows the declaration of an Address object.</p>
<pre class="cpp">Address {
id: address
street: <span class="string">"53 Brandl St"</span>
city: <span class="string">"Eight Mile Plains"</span>
country: <span class="string">"Australia"</span>
countryCode: <span class="string">"AUS"</span>
}</pre>
<p>This could then be used, for example, as the value of a geocoding query, to get an exact longitude and latitude for the address.</p>
<p><b>See also </b><a href="qgeoaddress.html">QGeoAddress</a>.</p>
<!-- @@@Address -->
<h2>Property Documentation</h2>
<!-- $$$address -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="address-prop"><td class="tblQmlPropNode"><p><a name="address-prop"></a><span class="name">address</span> : <span class="type"><a href="qgeoaddress.html">QGeoAddress</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>For details on how to use this property to interface between C++ and QML see "<a href="positioning-cpp-qml.html#address-qgeoaddress">Interfaces between C++ and QML Code</a>".</p>
</div></div><!-- @@@address -->
<br/>
<!-- $$$city -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="city-prop"><td class="tblQmlPropNode"><p><a name="city-prop"></a><span class="name">city</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the city of the address as a single formatted string.</p>
</div></div><!-- @@@city -->
<br/>
<!-- $$$country -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="country-prop"><td class="tblQmlPropNode"><p><a name="country-prop"></a><span class="name">country</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the country of the address as a single formatted string.</p>
</div></div><!-- @@@country -->
<br/>
<!-- $$$countryCode -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="countryCode-prop"><td class="tblQmlPropNode"><p><a name="countryCode-prop"></a><span class="name">countryCode</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the country code of the address as a single formatted string.</p>
</div></div><!-- @@@countryCode -->
<br/>
<!-- $$$county -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="county-prop"><td class="tblQmlPropNode"><p><a name="county-prop"></a><span class="name">county</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the county of the address as a single formatted string.</p>
</div></div><!-- @@@county -->
<br/>
<!-- $$$district -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="district-prop"><td class="tblQmlPropNode"><p><a name="district-prop"></a><span class="name">district</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the district of the address as a single formatted string.</p>
</div></div><!-- @@@district -->
<br/>
<!-- $$$isTextGenerated -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="isTextGenerated-prop"><td class="tblQmlPropNode"><p><a name="isTextGenerated-prop"></a><span class="name">isTextGenerated</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds a boolean that if true, indicates that <a href="qml-qtpositioning-address.html#text-prop">text</a> is automatically generated from address properties. If false, it indicates that the <a href="qml-qtpositioning-address.html#text-prop">text</a> has been explicitly assigned.</p>
</div></div><!-- @@@isTextGenerated -->
<br/>
<!-- $$$postalCode -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="postalCode-prop"><td class="tblQmlPropNode"><p><a name="postalCode-prop"></a><span class="name">postalCode</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the postal code of the address as a single formatted string.</p>
</div></div><!-- @@@postalCode -->
<br/>
<!-- $$$state -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="state-prop"><td class="tblQmlPropNode"><p><a name="state-prop"></a><span class="name">state</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the state of the address as a single formatted string.</p>
</div></div><!-- @@@state -->
<br/>
<!-- $$$street -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="street-prop"><td class="tblQmlPropNode"><p><a name="street-prop"></a><span class="name">street</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the street of the address 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>
</div></div><!-- @@@street -->
<br/>
<!-- $$$text -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="text-prop"><td class="tblQmlPropNode"><p><a name="text-prop"></a><span class="name">text</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds 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 <code>text</code> is either automatically generated or explicitly assigned, this can be determined by checking <a href="qml-qtpositioning-address.html#isTextGenerated-prop">isTextGenerated</a>.</p>
<p>If an empty string is assigned to <code>text</code>, then <a href="qml-qtpositioning-address.html#isTextGenerated-prop">isTextGenerated</a> will be set to true and <code>text</code> will return a string which is locally formatted according to <a href="qml-qtpositioning-address.html#countryCode-prop">countryCode</a> and based on the properties of the address. Modifying the address properties such as <a href="qml-qtpositioning-address.html#street-prop">street</a>, <a href="qml-qtpositioning-address.html#city-prop">city</a> and so on may cause the contents of <code>text</code> to change.</p>
<p>If a non-empty string is assigned to <code>text</code>, then <a href="qml-qtpositioning-address.html#isTextGenerated-prop">isTextGenerated</a> will be set to false and <code>text</code> will always return the explicitly assigned string. Modifying address properties will not affect the <code>text</code> property.</p>
</div></div><!-- @@@text -->
<br/>
</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>
|