Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 864

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.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" />
<!-- qgeoboundingcircle.cpp -->
  <title>Qt Mobility 1.2: QGeoBoundingCircle Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtlocation.html">QtLocation</a></li>
<li>QGeoBoundingCircle</li>
    </ul>
  </div>
</div>
<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="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QGeoBoundingCircle Class Reference</h1>
<!-- $$$QGeoBoundingCircle-brief -->
<p>The QGeoBoundingCircle class defines a circular geographic area. <a href="#details">More...</a></p>
<!-- @@@QGeoBoundingCircle -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QGeoBoundingCircle&gt;</span></pre><p><b>Inherits: </b><a href="qgeoboundingarea.html">QGeoBoundingArea</a>.</p>
<p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qgeoboundingcircle-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="qgeoboundingcircle.html#QGeoBoundingCircle">QGeoBoundingCircle</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#QGeoBoundingCircle-2">QGeoBoundingCircle</a></b> ( const QGeoCoordinate &amp; <i>center</i>, qreal <i>radius</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#QGeoBoundingCircle-3">QGeoBoundingCircle</a></b> ( const QGeoBoundingCircle &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#dtor.QGeoBoundingCircle">~QGeoBoundingCircle</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoCoordinate </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#center">center</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#radius">radius</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#setCenter">setCenter</a></b> ( const QGeoCoordinate &amp; <i>center</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#setRadius">setRadius</a></b> ( qreal <i>radius</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#translate">translate</a></b> ( double <i>degreesLatitude</i>, double <i>degreesLongitude</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoBoundingCircle </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#translated">translated</a></b> ( double <i>degreesLatitude</i>, double <i>degreesLongitude</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#operator-not-eq">operator!=</a></b> ( const QGeoBoundingCircle &amp; <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoBoundingCircle &amp; </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#operator-eq">operator=</a></b> ( const QGeoBoundingCircle &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#operator-eq-eq">operator==</a></b> ( const QGeoBoundingCircle &amp; <i>other</i> ) const</td></tr>
</table>
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#contains">contains</a></b> ( const QGeoCoordinate &amp; <i>coordinate</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#isEmpty">isEmpty</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QGeoBoundingArea::AreaType </td><td class="memItemRight bottomAlign"><b><a href="qgeoboundingcircle.html#type">type</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">4 public functions inherited from <a href="qgeoboundingarea.html#public-functions">QGeoBoundingArea</a></li>
</ul>
<a name="details"></a>
<!-- $$$QGeoBoundingCircle-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoBoundingCircle class defines a circular geographic area.</p>
<p>The circle is defined in terms of a <a href="qgeocoordinate.html">QGeoCoordinate</a> which specifies the center of the circle and a qreal which specifies the radius of the circle in metres.</p>
<p>The circle is considered invalid if the center coordinate is invalid or if the radius is less than zero.</p>
</div>
<!-- @@@QGeoBoundingCircle -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoBoundingCircle[overload1]$$$QGeoBoundingCircle -->
<h3 class="fn"><a name="QGeoBoundingCircle"></a>QGeoBoundingCircle::<span class="name">QGeoBoundingCircle</span> ()</h3>
<p>Constructs a new, invalid bounding circle.</p>
<!-- @@@QGeoBoundingCircle -->
<!-- $$$QGeoBoundingCircle$$$QGeoBoundingCircleconstQGeoCoordinate&qreal -->
<h3 class="fn"><a name="QGeoBoundingCircle-2"></a>QGeoBoundingCircle::<span class="name">QGeoBoundingCircle</span> ( const <span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> &amp; <i>center</i>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qreal-typedef">qreal</a></span> <i>radius</i> )</h3>
<p>Constructs a new bounding circle centered at <i>center</i> and with a radius of <i>radius</i> metres.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@QGeoBoundingCircle -->
<!-- $$$QGeoBoundingCircle$$$QGeoBoundingCircleconstQGeoBoundingCircle& -->
<h3 class="fn"><a name="QGeoBoundingCircle-3"></a>QGeoBoundingCircle::<span class="name">QGeoBoundingCircle</span> ( const <span class="type">QGeoBoundingCircle</span> &amp; <i>other</i> )</h3>
<p>Constructs a new bounding circle from the contents of <i>other</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@QGeoBoundingCircle -->
<!-- $$$~QGeoBoundingCircle[overload1]$$$~QGeoBoundingCircle -->
<h3 class="fn"><a name="dtor.QGeoBoundingCircle"></a>QGeoBoundingCircle::<span class="name">~QGeoBoundingCircle</span> ()</h3>
<p>Destroys this bounding circle.</p>
<!-- @@@~QGeoBoundingCircle -->
<!-- $$$center[overload1]$$$center -->
<h3 class="fn"><a name="center"></a><span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> QGeoBoundingCircle::<span class="name">center</span> () const</h3>
<p>Returns the center coordinate of this bounding circle.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoboundingcircle.html#setCenter">setCenter</a>().</p>
<!-- @@@center -->
<!-- $$$contains[overload1]$$$containsconstQGeoCoordinate& -->
<h3 class="fn"><a name="contains"></a><span class="type">bool</span> QGeoBoundingCircle::<span class="name">contains</span> ( const <span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> &amp; <i>coordinate</i> ) const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qgeoboundingarea.html#contains">QGeoBoundingArea::contains</a>().</p>
<p>Returns whether the coordinate <i>coordinate</i> is contained within this bounding circle.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@contains -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> QGeoBoundingCircle::<span class="name">isEmpty</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qgeoboundingarea.html#isEmpty">QGeoBoundingArea::isEmpty</a>().</p>
<p>Returns whether this bounding circle has a geometrical area of zero.</p>
<p>Returns true if this bounding circle is invalid.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@isEmpty -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QGeoBoundingCircle::<span class="name">isValid</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qgeoboundingarea.html#isValid">QGeoBoundingArea::isValid</a>().</p>
<p>Returns whether this bounding circle is valid.</p>
<p>A valid bounding circle has a valid center coordinate and a radius greater than or equal to zero.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@isValid -->
<!-- $$$radius[overload1]$$$radius -->
<h3 class="fn"><a name="radius"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qreal-typedef">qreal</a></span> QGeoBoundingCircle::<span class="name">radius</span> () const</h3>
<p>Returns the radius in meters of this bounding circle.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoboundingcircle.html#setRadius">setRadius</a>().</p>
<!-- @@@radius -->
<!-- $$$setCenter[overload1]$$$setCenterconstQGeoCoordinate& -->
<h3 class="fn"><a name="setCenter"></a><span class="type">void</span> QGeoBoundingCircle::<span class="name">setCenter</span> ( const <span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> &amp; <i>center</i> )</h3>
<p>Sets the center coordinate of this bounding circle to <i>center</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoboundingcircle.html#center">center</a>().</p>
<!-- @@@setCenter -->
<!-- $$$setRadius[overload1]$$$setRadiusqreal -->
<h3 class="fn"><a name="setRadius"></a><span class="type">void</span> QGeoBoundingCircle::<span class="name">setRadius</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qreal-typedef">qreal</a></span> <i>radius</i> )</h3>
<p>Sets the radius in meters of this bounding circle to <i>radius</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoboundingcircle.html#radius">radius</a>().</p>
<!-- @@@setRadius -->
<!-- $$$translate[overload1]$$$translatedoubledouble -->
<h3 class="fn"><a name="translate"></a><span class="type">void</span> QGeoBoundingCircle::<span class="name">translate</span> ( <span class="type">double</span> <i>degreesLatitude</i>, <span class="type">double</span> <i>degreesLongitude</i> )</h3>
<p>Translates this bounding circle by <i>degreesLatitude</i> northwards and <i>degreesLongitude</i> eastwards.</p>
<p>Negative values of <i>degreesLatitude</i> and <i>degreesLongitude</i> correspond to southward and westward translation respectively.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@translate -->
<!-- $$$translated[overload1]$$$translateddoubledouble -->
<h3 class="fn"><a name="translated"></a><span class="type">QGeoBoundingCircle</span> QGeoBoundingCircle::<span class="name">translated</span> ( <span class="type">double</span> <i>degreesLatitude</i>, <span class="type">double</span> <i>degreesLongitude</i> ) const</h3>
<p>Returns a copy of this bounding circle translated by <i>degreesLatitude</i> northwards and <i>degreesLongitude</i> eastwards.</p>
<p>Negative values of <i>degreesLatitude</i> and <i>degreesLongitude</i> correspond to southward and westward translation respectively.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoboundingcircle.html#translate">translate</a>().</p>
<!-- @@@translated -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn"><a name="type"></a><span class="type"><a href="qgeoboundingarea.html#AreaType-enum">QGeoBoundingArea::AreaType</a></span> QGeoBoundingCircle::<span class="name">type</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qgeoboundingarea.html#type">QGeoBoundingArea::type</a>().</p>
<p>Returns <a href="qgeoboundingarea.html#AreaType-enum">QGeoBoundingArea::CircleType</a> to identify this as a <a href="qgeoboundingcircle.html">QGeoBoundingCircle</a> instance.</p>
<p>This function is provided to help find the specific type of aQGeoBoundingArea instance.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@type -->
<!-- $$$operator!=[overload1]$$$operator!=constQGeoBoundingCircle& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QGeoBoundingCircle::<span class="name">operator!=</span> ( const <span class="type">QGeoBoundingCircle</span> &amp; <i>other</i> ) const</h3>
<p>Returns whether this bounding circle is not equal to <i>other</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQGeoBoundingCircle& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QGeoBoundingCircle</span> &amp; QGeoBoundingCircle::<span class="name">operator=</span> ( const <span class="type">QGeoBoundingCircle</span> &amp; <i>other</i> )</h3>
<p>Assigns <i>other</i> to this bounding circle and returns a reference to this bounding circle.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQGeoBoundingCircle& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QGeoBoundingCircle::<span class="name">operator==</span> ( const <span class="type">QGeoBoundingCircle</span> &amp; <i>other</i> ) const</h3>
<p>Returns whether this bounding circle is equal to <i>other</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator== -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</acronym> 2008-2011 Nokia Corporation and/or its
     subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
     in Finland and/or other countries worldwide.</p>
  <p>
     All other trademarks are property of their respective owners. <a title="Privacy Policy"
     href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
  <br />
  <p>
    Licensees holding valid Qt Commercial licenses may use this document in accordance with the    Qt Commercial License Agreement provided with the Software or, alternatively, in accordance    with the terms contained in a written agreement between you and Nokia.</p>
  <p>
    Alternatively, this document may be used 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.</p>
</div>
</body>
</html>