<?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" />
<!-- qgeoareamonitor.cpp -->
<title>Qt Mobility 1.2: QGeoAreaMonitor 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>QGeoAreaMonitor</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<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="#signals">Signals</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>
</ul>
</div>
<h1 class="title">QGeoAreaMonitor Class Reference</h1>
<!-- $$$QGeoAreaMonitor-brief -->
<p>The QGeoAreaMonitor class enables the detection of proximity changes for a specified set of coordinates. <a href="#details">More...</a></p>
<!-- @@@QGeoAreaMonitor -->
<pre class="cpp"> <span class="preprocessor">#include <QGeoAreaMonitor></span></pre><p><b>Inherits: </b><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a>.</p>
<p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qgeoareamonitor-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><a href="qgeoareamonitor.html#center-prop">center</a></b> : QGeoCoordinate</li>
<li class="fn"><b><a href="qgeoareamonitor.html#radius-prop">radius</a></b> : qreal</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</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="qgeoareamonitor.html#QGeoAreaMonitor">QGeoAreaMonitor</a></b> ( QObject * <i>parent</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qgeoareamonitor.html#dtor.QGeoAreaMonitor">~QGeoAreaMonitor</a></b> () = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoCoordinate </td><td class="memItemRight bottomAlign"><b><a href="qgeoareamonitor.html#center-prop">center</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qgeoareamonitor.html#radius-prop">radius</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qgeoareamonitor.html#center-prop">setCenter</a></b> ( const QGeoCoordinate & <i>coordinate</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qgeoareamonitor.html#radius-prop">setRadius</a></b> ( qreal <i>radius</i> )</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoareamonitor.html#areaEntered">areaEntered</a></b> ( const QGeoPositionInfo & <i>update</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoareamonitor.html#areaExited">areaExited</a></b> ( const QGeoPositionInfo & <i>update</i> )</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">QObject</a></li>
</ul>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QGeoAreaMonitor * </td><td class="memItemRight bottomAlign"><b><a href="qgeoareamonitor.html#createDefaultMonitor">createDefaultMonitor</a></b> ( QObject * <i>parent</i> )</td></tr>
</table>
<ul>
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#static-public-members">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-slots">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-variables">QObject</a></li>
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-functions">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QGeoAreaMonitor-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoAreaMonitor class enables the detection of proximity changes for a specified set of coordinates.</p>
<p>A QGeoAreaMonitor emits signals when the current position is in range, or has moved out of range, of a specified circular area. The area is specified by a coordinate (the center point) and a radius (in meters).</p>
<p>For example:</p>
<pre class="cpp"> <span class="keyword">public</span>:
MyClass<span class="operator">::</span>MyClass()
{
<span class="type">QGeoAreaMonitor</span> <span class="operator">*</span><span class="keyword">monitor</span> <span class="operator">=</span> <span class="type">QGeoAreaMonitor</span><span class="operator">::</span>createDefaultMonitor();
connect(<span class="keyword">monitor</span><span class="operator">,</span> SIGNAL(areaEntered(<span class="type"><a href="qgeopositioninfo.html">QGeoPositionInfo</a></span>))<span class="operator">,</span>
<span class="keyword">this</span><span class="operator">,</span> SLOT(areaEntered(<span class="type"><a href="qgeopositioninfo.html">QGeoPositionInfo</a></span>)));
connect(<span class="keyword">monitor</span><span class="operator">,</span> SIGNAL(areaExited(<span class="type"><a href="qgeopositioninfo.html">QGeoPositionInfo</a></span>))<span class="operator">,</span>
<span class="keyword">this</span><span class="operator">,</span> SLOT(areaExited(<span class="type"><a href="qgeopositioninfo.html">QGeoPositionInfo</a></span>)));
<span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> bigBenLocation(<span class="number">51.50104</span><span class="operator">,</span> <span class="operator">-</span><span class="number">0.124632</span>);
<span class="keyword">monitor</span><span class="operator">-</span><span class="operator">></span>setCenter(bigBenLocation);
<span class="keyword">monitor</span><span class="operator">-</span><span class="operator">></span>setRadius(<span class="number">100</span>);
}
<span class="keyword">public</span> Q_SLOTS:
<span class="type">void</span> <a href="qgeoareamonitor.html#areaEntered">areaEntered</a>(<span class="keyword">const</span> <span class="type"><a href="qgeopositioninfo.html">QGeoPositionInfo</a></span> <span class="operator">&</span>update)
{
<a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qDebug">qDebug</a>() <span class="operator"><</span><span class="operator"><</span> <span class="string">"Now within 100 meters, current position is"</span> <span class="operator"><</span><span class="operator"><</span> update<span class="operator">.</span>coordinate();
}
<span class="type">void</span> <a href="qgeoareamonitor.html#areaExited">areaExited</a>(<span class="keyword">const</span> <span class="type"><a href="qgeopositioninfo.html">QGeoPositionInfo</a></span> <span class="operator">&</span>update)
{
<a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qDebug">qDebug</a>() <span class="operator"><</span><span class="operator"><</span> <span class="string">"No longer within 100 meters, current position is"</span> <span class="operator"><</span><span class="operator"><</span> update<span class="operator">.</span>coordinate();
}</pre>
</div>
<!-- @@@QGeoAreaMonitor -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$center-prop$$$center$$$setCenterconstQGeoCoordinate& -->
<h3 class="fn"><a name="center-prop"></a><span class="name">center</span> : <span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span></h3>
<p>This property holds the center of the area to be monitored.</p>
<p>When the center is set, if the radius has already been set and the current position is within the monitored area, <a href="qgeoareamonitor.html#areaEntered">areaEntered</a>() is emitted immediately.</p>
<p>By default, contains an invalid coordinate.</p>
<p>Note: Subclass implementations must call the base implementation of setCenter() so that center() returns the correct value.</p>
<p>This property was introduced in Qt Mobility 1.0.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QGeoCoordinate </td><td class="memItemRight bottomAlign"><span class="name"><b>center</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setCenter</b></span> ( const QGeoCoordinate & <i>coordinate</i> )</td></tr>
</table>
<!-- @@@center -->
<!-- $$$radius-prop$$$radius$$$setRadiusqreal -->
<h3 class="fn"><a name="radius-prop"></a><span class="name">radius</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#qreal-typedef">qreal</a></span></h3>
<p>This property holds the radius of the area to be monitored, in meters.</p>
<p>If the specified radius is less than the minimum supported radius, the radius is set to the minimum radius.</p>
<p>When this property is set, if the center coordinate has already been set and the current position is within the monitored area, <a href="qgeoareamonitor.html#areaEntered">areaEntered</a>() is emitted immediately.</p>
<p>By default, this property is 0.</p>
<p>Note: Subclass implementations must call the base implementation of setRadius() so that radius() returns the correct value.</p>
<p>This property was introduced in Qt Mobility 1.0.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> qreal </td><td class="memItemRight bottomAlign"><span class="name"><b>radius</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setRadius</b></span> ( qreal <i>radius</i> )</td></tr>
</table>
<!-- @@@radius -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoAreaMonitor[overload1]$$$QGeoAreaMonitorQObject* -->
<h3 class="fn"><a name="QGeoAreaMonitor"></a>QGeoAreaMonitor::<span class="name">QGeoAreaMonitor</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i> )</h3>
<p>Creates a monitor with the given <i>parent</i>.</p>
<!-- @@@QGeoAreaMonitor -->
<!-- $$$~QGeoAreaMonitor[overload1]$$$~QGeoAreaMonitor -->
<h3 class="fn"><a name="dtor.QGeoAreaMonitor"></a>QGeoAreaMonitor::<span class="name">~QGeoAreaMonitor</span> ()<tt> [pure virtual]</tt></h3>
<p>Destroys the monitor.</p>
<!-- @@@~QGeoAreaMonitor -->
<!-- $$$areaEntered[overload1]$$$areaEnteredconstQGeoPositionInfo& -->
<h3 class="fn"><a name="areaEntered"></a><span class="type">void</span> QGeoAreaMonitor::<span class="name">areaEntered</span> ( const <span class="type"><a href="qgeopositioninfo.html">QGeoPositionInfo</a></span> & <i>update</i> )<tt> [signal]</tt></h3>
<p>Emitted when the current position has moved from a position outside the monitored area to a position within the monitored area.</p>
<p>The <i>update</i> holds the new position.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@areaEntered -->
<!-- $$$areaExited[overload1]$$$areaExitedconstQGeoPositionInfo& -->
<h3 class="fn"><a name="areaExited"></a><span class="type">void</span> QGeoAreaMonitor::<span class="name">areaExited</span> ( const <span class="type"><a href="qgeopositioninfo.html">QGeoPositionInfo</a></span> & <i>update</i> )<tt> [signal]</tt></h3>
<p>Emitted when the current position has moved from a position within the monitored area to a position outside the monitored area.</p>
<p>The <i>update</i> holds the new position.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@areaExited -->
<!-- $$$createDefaultMonitor[overload1]$$$createDefaultMonitorQObject* -->
<h3 class="fn"><a name="createDefaultMonitor"></a><span class="type">QGeoAreaMonitor</span> * QGeoAreaMonitor::<span class="name">createDefaultMonitor</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i> )<tt> [static]</tt></h3>
<p>Creates and returns a monitor with the given <i>parent</i> that monitors areas using resources on the underlying system.</p>
<p>Returns 0 if the system has no support for position monitoring.</p>
<p>Note: Symbian applications will need to have the Location capability otherwise this will return 0.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@createDefaultMonitor -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
50facae208d4a6f280e44a513b104320
>
files
>
858
