/usr/share/qt5/doc/qtpositioning/qgeoshape.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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qgeoshape.cpp -->
<title>QGeoShape Class | 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-module.html">C++ Classes</a></li>
<li>QGeoShape</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-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<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">QGeoShape Class</h1>
<!-- $$$QGeoShape-brief -->
<p>The <a href="qgeoshape.html">QGeoShape</a> class defines a geographic area. <a href="#details">More...</a></p>
<!-- @@@QGeoShape -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QGeoShape></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += positioning</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qgeocircle.html">QGeoCircle</a> and <a href="qgeorectangle.html">QGeoRectangle</a></p>
</td></tr></table></div><ul>
<li><a href="qgeoshape-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#ShapeType-enum">ShapeType</a></b> { UnknownType, RectangleType, CircleType }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qgeoshape.html#isEmpty-prop">isEmpty</a></b> : const bool</li>
<li class="fn"><b><a href="qgeoshape.html#isValid-prop">isValid</a></b> : const bool</li>
<li class="fn"><b><a href="qgeoshape.html#type-prop">type</a></b> : const ShapeType</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="qgeoshape.html#QGeoShape">QGeoShape</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#QGeoShape-2">QGeoShape</a></b>(const QGeoShape &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#dtor.QGeoShape">~QGeoShape</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoCoordinate </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#center">center</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#contains">contains</a></b>(const QGeoCoordinate &<i> coordinate</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#extendShape">extendShape</a></b>(const QGeoCoordinate &<i> coordinate</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#isEmpty-prop">isEmpty</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#isValid-prop">isValid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#toString">toString</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ShapeType </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#type-prop">type</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#operator-not-eq">operator!=</a></b>(const QGeoShape &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoShape & </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#operator-eq">operator=</a></b>(const QGeoShape &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#operator-eq-eq">operator==</a></b>(const QGeoShape &<i> other</i>) const</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QGeoShape-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qgeoshape.html">QGeoShape</a> class defines a geographic area.</p>
<p>This class is the base class for classes which specify a geographic area.</p>
<p>For the sake of consistency, subclasses should describe the specific details of the associated areas in terms of <a href="qgeocoordinate.html">QGeoCoordinate</a> instances and distances in meters.</p>
<p>This class is a <a href="../qtcore/qobject.html#Q_GADGET">Q_GADGET</a> since Qt 5.5. It can be <a href="positioning-cpp-qml.html#cpp-value-integration-positioning">directly used from C++ and QML</a>.</p>
</div>
<!-- @@@QGeoShape -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$ShapeType$$$UnknownType$$$RectangleType$$$CircleType -->
<h3 class="fn" id="ShapeType-enum"><a name="ShapeType-enum"></a>enum QGeoShape::<span class="name">ShapeType</span></h3>
<p>Describes the type of the shape.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QGeoShape::UnknownType</code></td><td class="topAlign"><code>0</code></td><td class="topAlign">A shape of unknown type.</td></tr>
<tr><td class="topAlign"><code>QGeoShape::RectangleType</code></td><td class="topAlign"><code>1</code></td><td class="topAlign">A rectangular shape.</td></tr>
<tr><td class="topAlign"><code>QGeoShape::CircleType</code></td><td class="topAlign"><code>2</code></td><td class="topAlign">A circular shape.</td></tr>
</table></div>
<!-- @@@ShapeType -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$isEmpty-prop$$$isEmpty -->
<h3 class="fn" id="isEmpty-prop"><a name="isEmpty-prop"></a><span class="name">isEmpty</span> : const <span class="type">bool</span></h3>
<p>This property holds this property defines whether this geo shape is empty.</p>
<p>An empty geo shape is a region which has a geometrical area of 0.</p>
<p>While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.</p>
<p>This property was introduced in Qt 5.5.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isEmpty</b></span>() const</td></tr>
</table></div>
<!-- @@@isEmpty -->
<!-- $$$isValid-prop$$$isValid -->
<h3 class="fn" id="isValid-prop"><a name="isValid-prop"></a><span class="name">isValid</span> : const <span class="type">bool</span></h3>
<p>This property holds this property holds the validity of the geo shape.</p>
<p>A geo shape is considered to be invalid if some of the data that is required to unambiguously describe the geo shape has not been set or has been set to an unsuitable value depending on the subclass of this object. The default constructed objects of this type are invalid.</p>
<p>While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.</p>
<p>This property was introduced in Qt 5.5.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isValid</b></span>() const</td></tr>
</table></div>
<!-- @@@isValid -->
<!-- $$$type-prop$$$type -->
<h3 class="fn" id="type-prop"><a name="type-prop"></a><span class="name">type</span> : const <span class="type"><a href="qgeoshape.html#ShapeType-enum">ShapeType</a></span></h3>
<p>This property holds this property holds the type of this geo shape.</p>
<p>While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.</p>
<p>This property was introduced in Qt 5.5.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> ShapeType </td><td class="memItemRight bottomAlign"><span class="name"><b>type</b></span>() const</td></tr>
</table></div>
<!-- @@@type -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoShape[overload1]$$$QGeoShape -->
<h3 class="fn" id="QGeoShape"><a name="QGeoShape"></a>QGeoShape::<span class="name">QGeoShape</span>()</h3>
<p>Constructs a new invalid geo shape of <a href="qgeoshape.html#ShapeType-enum">UnknownType</a>.</p>
<!-- @@@QGeoShape -->
<!-- $$$QGeoShape$$$QGeoShapeconstQGeoShape& -->
<h3 class="fn" id="QGeoShape-2"><a name="QGeoShape-2"></a>QGeoShape::<span class="name">QGeoShape</span>(const <span class="type"><a href="qgeoshape.html#QGeoShape">QGeoShape</a></span> &<i> other</i>)</h3>
<p>Constructs a new geo shape which is a copy of <i>other</i>.</p>
<!-- @@@QGeoShape -->
<!-- $$$~QGeoShape[overload1]$$$~QGeoShape -->
<h3 class="fn" id="dtor.QGeoShape"><a name="dtor.QGeoShape"></a>QGeoShape::<span class="name">~QGeoShape</span>()</h3>
<p>Destroys this geo shape.</p>
<!-- @@@~QGeoShape -->
<!-- $$$center[overload1]$$$center -->
<h3 class="fn" id="center"><a name="center"></a><span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> QGeoShape::<span class="name">center</span>() const</h3>
<p>Returns the coordinate located at the geometric center of the geo shape.</p>
<p>This function was introduced in Qt 5.5.</p>
<!-- @@@center -->
<!-- $$$contains[overload1]$$$containsconstQGeoCoordinate& -->
<h3 class="fn" id="contains"><a name="contains"></a><span class="type">bool</span> QGeoShape::<span class="name">contains</span>(const <span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> &<i> coordinate</i>) const</h3>
<p>Returns whether the coordinate <i>coordinate</i> is contained within this geo shape.</p>
<!-- @@@contains -->
<!-- $$$extendShape[overload1]$$$extendShapeconstQGeoCoordinate& -->
<h3 class="fn" id="extendShape"><a name="extendShape"></a><span class="type">void</span> QGeoShape::<span class="name">extendShape</span>(const <span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> &<i> coordinate</i>)</h3>
<p>Extends the geo shape to also cover the coordinate <i>coordinate</i></p>
<!-- @@@extendShape -->
<!-- $$$toString[overload1]$$$toString -->
<h3 class="fn" id="toString"><a name="toString"></a><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QGeoShape::<span class="name">toString</span>() const</h3>
<p>Returns a string representation of this geo shape.</p>
<p>This function was introduced in Qt 5.5.</p>
<!-- @@@toString -->
<!-- $$$operator!=[overload1]$$$operator!=constQGeoShape& -->
<h3 class="fn" id="operator-not-eq"><a name="operator-not-eq"></a><span class="type">bool</span> QGeoShape::<span class="name">operator!=</span>(const <span class="type"><a href="qgeoshape.html#QGeoShape">QGeoShape</a></span> &<i> other</i>) const</h3>
<p>Returns true if the <i>other</i> geo shape is not equivalent to this geo shape, otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQGeoShape& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qgeoshape.html#QGeoShape">QGeoShape</a></span> & QGeoShape::<span class="name">operator=</span>(const <span class="type"><a href="qgeoshape.html#QGeoShape">QGeoShape</a></span> &<i> other</i>)</h3>
<p>Assigns <i>other</i> to this geo shape and returns a reference to this geo shape.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQGeoShape& -->
<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> QGeoShape::<span class="name">operator==</span>(const <span class="type"><a href="qgeoshape.html#QGeoShape">QGeoShape</a></span> &<i> other</i>) const</h3>
<p>Returns true if the <i>other</i> geo shape is equivalent to this geo shape, 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>
|