/usr/share/qt5/doc/qtpositioning/qml-geoshape.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- positioning.cpp -->
<title>geoshape QML Basic 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>geoshape QML Basic 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="#example-usage">Example Usage</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level2"><a href="#isempty">isEmpty</a></li>
<li class="level2"><a href="#isvalid">isValid</a></li>
<li class="level2"><a href="#type">type</a></li>
<li class="level1"><a href="#methods">Methods</a></li>
<li class="level2"><a href="#contains">contains()</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">geoshape QML Basic Type</h1>
<span class="subtitle"></span>
<!-- $$$geoshape-description -->
<div class="descr"> <a name="details"></a>
<p>A geoshape type represents an abstract geographic area.</p>
<p>This type is a QML representation of <a href="qgeoshape.html">QGeoShape</a> which is an abstract geographic area. It includes attributes and methods common to all geographic areas. To create objects that represent a valid geographic area use <a href="qml-georectangle.html">georectangle</a> or <a href="qml-geocircle.html">geocircle</a>.</p>
<p>The <a href="qml-geoshape.html#isvalid">isValid</a> attribute can be used to test if the geoshape represents a valid geographic area.</p>
<p>The <a href="qml-geoshape.html#isempty">isEmpty</a> attribute can be used to test if the geoshape represents a region with a geometrical area of 0.</p>
<p>The <a href="qml-geoshape.html#contains">contains()</a> method can be used to test if a <a href="location-positioning-qml.html#coordinate">coordinate</a> is within the geoshape.</p>
<a name="example-usage"></a>
<h2 id="example-usage">Example Usage</h2>
<p>Use properties of type variant to store a <code>geoshape</code>. To create a <code>geoshape</code> use one of the methods described below.</p>
<p>To create a <code>geoshape</code> value, specify it as a "shape()" string:</p>
<pre class="qml">import QtPositioning
<span class="type">Item</span> {
property <span class="type">variant</span> <span class="name">region</span>: <span class="string">"shape()"</span>
}</pre>
<p>or with the <a href="qml-qtpositioning-qtpositioning.html#shape-method">QtPositioning.shape()</a> function:</p>
<pre class="qml">import QtPositioning 5.2
<span class="type">Item</span> {
property <span class="type">variant</span> <span class="name">region</span>: <span class="name">QtPositioning</span>.<span class="name">shape</span>()
}</pre>
<p>When integrating with C++, note that any <a href="qgeoshape.html">QGeoShape</a> value passed into QML from C++ is automatically converted into a <code>geoshape</code> value, and vice-versa.</p>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<a name="isempty"></a>
<h3 >isEmpty</h3>
<pre class="cpp">bool isEmpty</pre>
<p>Returns whether this geoshape is empty. An empty geoshape is a region which has a geometrical area of 0.</p>
<a name="isvalid"></a>
<h3 >isValid</h3>
<pre class="cpp">bool isValid</pre>
<p>Returns whether this geoshape is valid.</p>
<p>A geoshape is considered to be invalid if some of the data that is required to unambiguously describe the geoshape has not been set or has been set to an unsuitable value.</p>
<a name="type"></a>
<h3 >type</h3>
<pre class="cpp">ShapeType type</pre>
<p>Returns the current type of the shape.</p>
<ul>
<li>GeoShape.UnknownType - The shape's type is not known.</li>
<li>GeoShape.RectangleType - The shape is a <a href="qml-georectangle.html">georectangle</a>.</li>
<li>GeoShape.CircleType - The shape is a <a href="qml-geocircle.html">geocircle</a>.</li>
</ul>
<p>This QML property was introduced by Qt 5.5.</p>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<a name="contains"></a>
<h3 >contains()</h3>
<pre class="cpp">bool contains(coordinate coord)</pre>
<p>Returns true if the <a href="qml-qtpositioning-qtpositioning.html#coordinate-method">coordinate</a> specified by <i>coord</i> is within this geoshape; Otherwise returns false.</p>
</div>
<!-- @@@geoshape -->
</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>
|