<?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" />
<!-- qmagnetometer.cpp -->
<title>Qt Mobility 1.2: QMagnetometer 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="qtsensors.html">QtSensors</a></li>
<li>QMagnetometer</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="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QMagnetometer Class Reference</h1>
<!-- $$$QMagnetometer-brief -->
<p>The QMagnetometer class is a convenience wrapper around <a href="qsensor.html">QSensor</a>. <a href="#details">More...</a></p>
<!-- @@@QMagnetometer -->
<pre class="cpp"> <span class="preprocessor">#include <QMagnetometer></span></pre><p><b>Inherits: </b><a href="qsensor.html">QSensor</a>.</p>
<p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qmagnetometer-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="qmagnetometer.html#returnGeoValues-prop">returnGeoValues</a></b> : const bool</li>
</ul>
<ul>
<li class="fn">15 properties inherited from <a href="qsensor.html#properties">QSensor</a></li>
<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="qmagnetometer.html#QMagnetometer">QMagnetometer</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qmagnetometer.html#dtor.QMagnetometer">~QMagnetometer</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMagnetometerReading * </td><td class="memItemRight bottomAlign"><b><a href="qmagnetometer.html#reading">reading</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">20 public functions inherited from <a href="qsensor.html#public-functions">QSensor</a></li>
<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>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">2 public slots inherited from <a href="qsensor.html#public-slots">QSensor</a></li>
<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">5 signals inherited from <a href="qsensor.html#signals">QSensor</a></li>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">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">3 static public members inherited from <a href="qsensor.html#static-public-members">QSensor</a></li>
<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>
<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>
<!-- $$$QMagnetometer-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QMagnetometer class is a convenience wrapper around <a href="qsensor.html">QSensor</a>.</p>
<p>The only behavioural difference is that this class sets the type properly.</p>
<p>This class also features a <a href="qmagnetometer.html#reading">reading</a>() function that returns a <a href="qmagnetometerreading.html">QMagnetometerReading</a> instead of a <a href="qsensorreading.html">QSensorReading</a>.</p>
<p>For details about how the sensor works, see <a href="qmagnetometerreading.html">QMagnetometerReading</a>.</p>
</div>
<p><b>See also </b><a href="qmagnetometerreading.html">QMagnetometerReading</a>.</p>
<!-- @@@QMagnetometer -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$returnGeoValues-prop -->
<h3 class="fn"><a name="returnGeoValues-prop"></a><span class="name">returnGeoValues</span> : const <span class="type">bool</span></h3>
<p>This property holds a value indicating if geomagnetic values should be returned.</p>
<p>Set to true to return geomagnetic flux density. Set to false (the default) to return raw magnetic flux density.</p>
<p>Note that you must access this property via <a href="http://qt.nokia.com/doc/4.7/qobject.html#property">QObject::property</a>() and <a href="http://qt.nokia.com/doc/4.7/qobject.html#setProperty">QObject::setProperty</a>(). The property must be set before calling <a href="qsensor.html#start">start</a>().</p>
<p>This property was introduced in Qt Mobility 1.0.</p>
<!-- @@@returnGeoValues -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QMagnetometer[overload1]$$$QMagnetometerQObject* -->
<h3 class="fn"><a name="QMagnetometer"></a>QMagnetometer::<span class="name">QMagnetometer</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Construct the sensor as a child of <i>parent</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@QMagnetometer -->
<!-- $$$~QMagnetometer[overload1]$$$~QMagnetometer -->
<h3 class="fn"><a name="dtor.QMagnetometer"></a>QMagnetometer::<span class="name">~QMagnetometer</span> ()<tt> [virtual]</tt></h3>
<p>Destroy the sensor. Stops the sensor if it has not already been stopped.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@~QMagnetometer -->
<!-- $$$reading[overload1]$$$reading -->
<h3 class="fn"><a name="reading"></a><span class="type"><a href="qmagnetometerreading.html">QMagnetometerReading</a></span> * QMagnetometer::<span class="name">reading</span> () const</h3>
<p>Returns the reading class for this sensor.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qsensor.html#reading-prop">QSensor::reading</a>().</p>
<!-- @@@reading -->
</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
>
1032
