Sophie

Sophie

distrib > Mageia > 6 > x86_64 > media > core-updates > by-pkgid > ed56237261fa5ad3d1f8082a5fac7e2e > files > 374

qtlocation5-doc-5.9.4-1.mga6.noarch.rpm

<?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.9</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.9</td><td ><a href="qtpositioning-index.html">Qt Positioning</a></td><td ><a href="qtpositioning-module.html">C++ Classes</a></td><td >QGeoShape</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
        </tr></table>
      </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 &lt;QGeoShape&gt;</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>, <a href="qgeopath.html">QGeoPath</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>
<li><a href="qgeoshape-obsolete.html">Obsolete 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, PathType }</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-1">QGeoShape</a></b>(const QGeoShape &amp;<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"> QGeoRectangle </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#boundingGeoRectangle">boundingGeoRectangle</a></b>() const</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 &amp;<i>coordinate</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#isEmpty">isEmpty</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#isValid">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">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 &amp;<i>other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoShape &amp;</td><td class="memItemRight bottomAlign"><b><a href="qgeoshape.html#operator-eq">operator=</a></b>(const QGeoShape &amp;<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 &amp;<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 Q_GADGET since Qt 5.5&#x2e; 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$$$PathType -->
<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 tblval"><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 tblval"><code>1</code></td><td class="topAlign">A rectangular shape.</td></tr>
<tr><td class="topAlign"><code>QGeoShape::CircleType</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">A circular shape.</td></tr>
<tr><td class="topAlign"><code>QGeoShape::PathType</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">A path type.</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 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><a href="qgeoshape.html#isEmpty">isEmpty</a></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 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><a href="qgeoshape.html#isValid">isValid</a></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 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><a href="qgeoshape.html#type">type</a></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-1"><a name="QGeoShape-1"></a>QGeoShape::<span class="name">QGeoShape</span>(const <span class="type"><a href="qgeoshape.html#QGeoShape">QGeoShape</a></span> &amp;<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 -->
<!-- $$$boundingGeoRectangle[overload1]$$$boundingGeoRectangle -->
<h3 class="fn" id="boundingGeoRectangle"><a name="boundingGeoRectangle"></a><span class="type"><a href="qgeorectangle.html">QGeoRectangle</a></span> QGeoShape::<span class="name">boundingGeoRectangle</span>() const</h3>
<p>Returns a <a href="qgeorectangle.html">QGeoRectangle</a> representing the geographical bounding rectangle of the geo shape, that defines the latitudinal/longitudinal bounds of the geo shape.</p>
<p>This function was introduced in  Qt 5.9.</p>
<!-- @@@boundingGeoRectangle -->
<!-- $$$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> &amp;<i>coordinate</i>) const</h3>
<p>Returns whether the coordinate <i>coordinate</i> is contained within this geo shape.</p>
<!-- @@@contains -->
<!-- $$$isEmpty -->
<h3 class="fn" id="isEmpty"><a name="isEmpty"></a><span class="type">bool</span> QGeoShape::<span class="name">isEmpty</span>() const</h3>
<p>Returns whether this geo shape is empty.</p>
<p>An empty geo shape is a region which has a geometrical area of 0.</p>
<p><b>Note:</b> Getter function for property <a href="qgeoshape.html#isEmpty-prop">isEmpty</a>. </p><!-- @@@isEmpty -->
<!-- $$$isValid -->
<h3 class="fn" id="isValid"><a name="isValid"></a><span class="type">bool</span> QGeoShape::<span class="name">isValid</span>() const</h3>
<p>Returns whether this geo shape is valid.</p>
<p><b>Note:</b> Getter function for property <a href="qgeoshape.html#isValid-prop">isValid</a>. </p><!-- @@@isValid -->
<!-- $$$toString[overload1]$$$toString -->
<h3 class="fn" id="toString"><a name="toString"></a><span class="type">QString</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 -->
<!-- $$$type -->
<h3 class="fn" id="type"><a name="type"></a><span class="type"><a href="qgeoshape.html#ShapeType-enum">ShapeType</a></span> QGeoShape::<span class="name">type</span>() const</h3>
<p>Returns the type of this geo shape.</p>
<p><b>Note:</b> Getter function for property <a href="qgeoshape.html#type-prop">type</a>. </p><!-- @@@type -->
<!-- $$$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> &amp;<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> &amp;QGeoShape::<span class="name">operator=</span>(const <span class="type"><a href="qgeoshape.html#QGeoShape">QGeoShape</a></span> &amp;<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> &amp;<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">&copy;</acronym> 2017 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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional