/usr/share/qt5/doc/qtlocation/qplaceattribute.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 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | <?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" />
<!-- qplaceattribute.cpp -->
<title>QPlaceAttribute 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>QPlaceAttribute</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>
<li class="level2"><a href="#attribute-types">Attribute Types</a></li>
<li class="level3"><a href="#user-readable-and-non-user-readable-attributes">User Readable and Non-User Readable Attributes</a></li>
</ul>
</div>
<h1 class="title">QPlaceAttribute Class</h1>
<!-- $$$QPlaceAttribute-brief -->
<p>The QPlaceAttribute class represents generic attribute information about a place. <a href="#details">More...</a></p>
<!-- @@@QPlaceAttribute -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QPlaceAttribute></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="qplaceattribute-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="qplaceattribute.html#QPlaceAttribute">QPlaceAttribute</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplaceattribute.html#QPlaceAttribute-2">QPlaceAttribute</a></b>(const QPlaceAttribute &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qplaceattribute.html#dtor.QPlaceAttribute">~QPlaceAttribute</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplaceattribute.html#isEmpty">isEmpty</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplaceattribute.html#label">label</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplaceattribute.html#setLabel">setLabel</a></b>(const QString &<i> label</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplaceattribute.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="qplaceattribute.html#text">text</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplaceattribute.html#operator-not-eq">operator!=</a></b>(const QPlaceAttribute &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceAttribute & </td><td class="memItemRight bottomAlign"><b><a href="qplaceattribute.html#operator-eq">operator=</a></b>(const QPlaceAttribute &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplaceattribute.html#operator-eq-eq">operator==</a></b>(const QPlaceAttribute &<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="qplaceattribute.html#OpeningHours-var">OpeningHours</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qplaceattribute.html#Payment-var">Payment</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qplaceattribute.html#Provider-var">Provider</a></b></td></tr>
</table>
<a name="details"></a>
<!-- $$$QPlaceAttribute-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QPlaceAttribute class represents generic attribute information about a place.</p>
<p>A QPlaceAttribute instance stores an additional piece of information about a place that is not otherwise exposed through the <a href="qplace.html">QPlace</a> class. A QPlaceAttribute encapsulates a localized label which describes the attribute and rich text string representing the attribute's value. Generally, both are intended to be displayed to the end-user as is.</p>
<p>Some plugins may not support attributes at all, others may only support a certain set, others still may support a dynamically changing set of attributes over time or even allow attributes to be arbitrarily defined by the client application. The attributes could also vary on a place by place basis, for example one place may have opening hours while another does not. Consult the <a href="qtlocation-index.html#plugin-references-and-parameters">plugin references</a> for details.</p>
<a name="attribute-types"></a>
<h4>Attribute Types</h4>
<p>The QPlaceAttribute class defines some constant strings which characterize standard <i>attribute types</i>.</p>
<ul>
<li><a href="qplaceattribute.html#OpeningHours-var">QPlaceAttribute::OpeningHours</a></li>
<li><a href="qplaceattribute.html#Payment-var">QPlaceAttribute::Payment</a></li>
<li><a href="qplaceattribute.html#Provider-var">QPlaceAttribute::Provider</a></li>
</ul>
<p>There is a class of attribute types of the format x_id_<provider> for example x_id_nokia. This class of attributes is a set of alternative identifiers of the place, from the specified provider's perspective.</p>
<p>The above types are used to access and modify attributes in <a href="qplace.html">QPlace</a> via:</p>
<ul>
<li><a href="qplace.html#extendedAttribute">QPlace::extendedAttribute</a>()</li>
<li><a href="qplace.html#setExtendedAttribute">QPlace::setExtendedAttribute</a>()</li>
<li><a href="qplace.html#removeExtendedAttribute">QPlace::removeExtendedAttribute</a>()</li>
<li><a href="qplace.html#removeExtendedAttribute">QPlace::removeExtendedAttribute</a>()</li>
</ul>
<p>The <i>attribute type</i> is a string type so that providers are able to introduce new attributes as necessary. Custom attribute types should always be prefixed by a qualifier in order to avoid conflicts.</p>
<a name="user-readable-and-non-user-readable-attributes"></a>
<h5>User Readable and Non-User Readable Attributes</h5>
<p>Some attributes may not be intended to be readable by end users, the label field of such attributes are empty to indicate this fact.</p>
</div>
<!-- @@@QPlaceAttribute -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPlaceAttribute[overload1]$$$QPlaceAttribute -->
<h3 class="fn"><a name="QPlaceAttribute"></a>QPlaceAttribute::<span class="name">QPlaceAttribute</span>()</h3>
<p>Constructs an attribute.</p>
<!-- @@@QPlaceAttribute -->
<!-- $$$QPlaceAttribute$$$QPlaceAttributeconstQPlaceAttribute& -->
<h3 class="fn"><a name="QPlaceAttribute-2"></a>QPlaceAttribute::<span class="name">QPlaceAttribute</span>(const <span class="type">QPlaceAttribute</span> &<i> other</i>)</h3>
<p>Creates a copy of <i>other</i>.</p>
<!-- @@@QPlaceAttribute -->
<!-- $$$~QPlaceAttribute[overload1]$$$~QPlaceAttribute -->
<h3 class="fn"><a name="dtor.QPlaceAttribute"></a>QPlaceAttribute::<span class="name">~QPlaceAttribute</span>()<tt> [virtual]</tt></h3>
<p>Destroys the attribute.</p>
<!-- @@@~QPlaceAttribute -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> QPlaceAttribute::<span class="name">isEmpty</span>() const</h3>
<p>Returns a boolean indicating whether the all the fields of the place attribute are empty or not.</p>
<!-- @@@isEmpty -->
<!-- $$$label[overload1]$$$label -->
<h3 class="fn"><a name="label"></a><span class="type">QString</span> QPlaceAttribute::<span class="name">label</span>() const</h3>
<p>Returns a localized label describing the attribute.</p>
<p><b>See also </b><a href="qplaceattribute.html#setLabel">setLabel</a>().</p>
<!-- @@@label -->
<!-- $$$setLabel[overload1]$$$setLabelconstQString& -->
<h3 class="fn"><a name="setLabel"></a><span class="type">void</span> QPlaceAttribute::<span class="name">setLabel</span>(const <span class="type">QString</span> &<i> label</i>)</h3>
<p>Sets the <i>label</i> of the attribute.</p>
<p><b>See also </b><a href="qplaceattribute.html#label">label</a>().</p>
<!-- @@@setLabel -->
<!-- $$$setText[overload1]$$$setTextconstQString& -->
<h3 class="fn"><a name="setText"></a><span class="type">void</span> QPlaceAttribute::<span class="name">setText</span>(const <span class="type">QString</span> &<i> text</i>)</h3>
<p>Sets the <i>text</i> of the attribute.</p>
<p><b>See also </b><a href="qplaceattribute.html#text">text</a>().</p>
<!-- @@@setText -->
<!-- $$$text[overload1]$$$text -->
<h3 class="fn"><a name="text"></a><span class="type">QString</span> QPlaceAttribute::<span class="name">text</span>() const</h3>
<p>Returns a piece of rich text representing the attribute value.</p>
<p><b>See also </b><a href="qplaceattribute.html#setText">setText</a>().</p>
<!-- @@@text -->
<!-- $$$operator!=[overload1]$$$operator!=constQPlaceAttribute& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QPlaceAttribute::<span class="name">operator!=</span>(const <span class="type">QPlaceAttribute</span> &<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is not equal to this attribute, otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQPlaceAttribute& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QPlaceAttribute</span> & QPlaceAttribute::<span class="name">operator=</span>(const <span class="type">QPlaceAttribute</span> &<i> other</i>)</h3>
<p>Assigns <i>other</i> to this attribute and returns a reference to this attribute.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQPlaceAttribute& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QPlaceAttribute::<span class="name">operator==</span>(const <span class="type">QPlaceAttribute</span> &<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is equal to this attribute, otherwise returns false.</p>
<!-- @@@operator== -->
</div>
<div class="vars">
<h2>Member Variable Documentation</h2>
<!-- $$$OpeningHours -->
<h3 class="fn"><a name="OpeningHours-var"></a>const <span class="type">QString</span> QPlaceAttribute::<span class="name">OpeningHours</span></h3>
<p>Specifies the opening hours.</p>
<!-- @@@OpeningHours -->
<!-- $$$Payment -->
<h3 class="fn"><a name="Payment-var"></a>const <span class="type">QString</span> QPlaceAttribute::<span class="name">Payment</span></h3>
<p>The constant to specify an attribute that defines the methods of payment.</p>
<!-- @@@Payment -->
<!-- $$$Provider -->
<h3 class="fn"><a name="Provider-var"></a>const <span class="type">QString</span> QPlaceAttribute::<span class="name">Provider</span></h3>
<p>The constant to specify an attribute that defines which provider the place came from.</p>
<!-- @@@Provider -->
</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>
|