Sophie

Sophie

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

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" />
<!-- qgeosatelliteinfosource.cpp -->
  <title>Qt Mobility 1.2: QGeoSatelliteInfoSource 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>QGeoSatelliteInfoSource</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="#public-slots">Public Slots</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">QGeoSatelliteInfoSource Class Reference</h1>
<!-- $$$QGeoSatelliteInfoSource-brief -->
<p>The QGeoSatelliteInfoSource class is an abstract base class for the distribution of satellite information updates. <a href="#details">More...</a></p>
<!-- @@@QGeoSatelliteInfoSource -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QGeoSatelliteInfoSource&gt;</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="qgeosatelliteinfosource-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="qgeosatelliteinfosource.html#QGeoSatelliteInfoSource">QGeoSatelliteInfoSource</a></b> ( QObject * <i>parent</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="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfosource.html#requestUpdate">requestUpdate</a></b> ( int <i>timeout</i> = 0 ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfosource.html#startUpdates">startUpdates</a></b> () = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfosource.html#stopUpdates">stopUpdates</a></b> () = 0</td></tr>
</table>
<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>
</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="qgeosatelliteinfosource.html#requestTimeout">requestTimeout</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfosource.html#satellitesInUseUpdated">satellitesInUseUpdated</a></b> ( const QList&lt;QGeoSatelliteInfo&gt; &amp; <i>satellites</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfosource.html#satellitesInViewUpdated">satellitesInViewUpdated</a></b> ( const QList&lt;QGeoSatelliteInfo&gt; &amp; <i>satellites</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"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfosource.html#availableSources">availableSources</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoSatelliteInfoSource * </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfosource.html#createDefaultSource">createDefaultSource</a></b> ( QObject * <i>parent</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoSatelliteInfoSource * </td><td class="memItemRight bottomAlign"><b><a href="qgeosatelliteinfosource.html#createSource">createSource</a></b> ( const QString &amp; <i>sourceName</i>, 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 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">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>
<!-- $$$QGeoSatelliteInfoSource-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoSatelliteInfoSource class is an abstract base class for the distribution of satellite information updates.</p>
<p>The static function <a href="qgeosatelliteinfosource.html#createDefaultSource">QGeoSatelliteInfoSource::createDefaultSource</a>() creates a default satellite data source that is appropriate for the platform, if one is available. Otherwise, available <a href="qgeopositioninfosourcefactory.html">QGeoPositionInfoSourceFactory</a> plugins will be checked for one that has a satellite data source available.</p>
<p>Call <a href="qgeosatelliteinfosource.html#startUpdates">startUpdates</a>() and <a href="qgeosatelliteinfosource.html#stopUpdates">stopUpdates</a>() to start and stop regular updates, or <a href="qgeosatelliteinfosource.html#requestUpdate">requestUpdate</a>() to request a single update. When an update is available, <a href="qgeosatelliteinfosource.html#satellitesInViewUpdated">satellitesInViewUpdated</a>() and/or <a href="qgeosatelliteinfosource.html#satellitesInUseUpdated">satellitesInUseUpdated</a>() will be emitted.</p>
<p><b>Warning:</b> On Windows CE it is not possible to detect if a device is GPS enabled. The default satellite source on a Windows CE device without GPS support will never provide any satellite data.</p>
<p><b>Warning:</b> On Symbian it is currently only possible to instantiate and use the satellite sources in the main thread of the application.</p>
</div>
<!-- @@@QGeoSatelliteInfoSource -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoSatelliteInfoSource[overload1]$$$QGeoSatelliteInfoSourceQObject* -->
<h3 class="fn"><a name="QGeoSatelliteInfoSource"></a>QGeoSatelliteInfoSource::<span class="name">QGeoSatelliteInfoSource</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 source with the specified <i>parent</i>.</p>
<!-- @@@QGeoSatelliteInfoSource -->
<!-- $$$availableSources[overload1]$$$availableSources -->
<h3 class="fn"><a name="availableSources"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstringlist.html">QStringList</a></span> QGeoSatelliteInfoSource::<span class="name">availableSources</span> ()<tt> [static]</tt></h3>
<p>Returns a list of available source plugins. Note that this does not include the default system backend, if one is available.</p>
<!-- @@@availableSources -->
<!-- $$$createDefaultSource[overload1]$$$createDefaultSourceQObject* -->
<h3 class="fn"><a name="createDefaultSource"></a><span class="type">QGeoSatelliteInfoSource</span> * QGeoSatelliteInfoSource::<span class="name">createDefaultSource</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 source with the specified <i>parent</i> that reads from the system's default source of satellite update information, or the highest priority available plugin.</p>
<p>Returns 0 if the system has no default source and no valid plugins could be found.</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>
<!-- @@@createDefaultSource -->
<!-- $$$createSource[overload1]$$$createSourceconstQString&QObject* -->
<h3 class="fn"><a name="createSource"></a><span class="type">QGeoSatelliteInfoSource</span> * QGeoSatelliteInfoSource::<span class="name">createSource</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>sourceName</i>, <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 source with the given <i>parent</i>, by loading the plugin named <i>sourceName</i>.</p>
<p>Returns 0 if the plugin cannot be found.</p>
<!-- @@@createSource -->
<!-- $$$requestTimeout[overload1]$$$requestTimeout -->
<h3 class="fn"><a name="requestTimeout"></a><span class="type">void</span> QGeoSatelliteInfoSource::<span class="name">requestTimeout</span> ()<tt> [signal]</tt></h3>
<p>Emitted if <a href="qgeosatelliteinfosource.html#requestUpdate">requestUpdate</a>() was called and the current satellite information could not be retrieved within the specified timeout.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@requestTimeout -->
<!-- $$$requestUpdate[overload1]$$$requestUpdateint -->
<h3 class="fn"><a name="requestUpdate"></a><span class="type">void</span> QGeoSatelliteInfoSource::<span class="name">requestUpdate</span> ( <span class="type">int</span> <i>timeout</i> = 0 )<tt> [pure virtual slot]</tt></h3>
<p>Attempts to get the current satellite information and emit <a href="qgeosatelliteinfosource.html#satellitesInViewUpdated">satellitesInViewUpdated</a>() and <a href="qgeosatelliteinfosource.html#satellitesInUseUpdated">satellitesInUseUpdated</a>() with this information. If the current position cannot be found within the given <i>timeout</i> (in milliseconds), <a href="qgeosatelliteinfosource.html#requestTimeout">requestTimeout</a>() is emitted.</p>
<p>If the timeout is zero, the timeout defaults to a reasonable timeout period as appropriate for the source.</p>
<p>This does nothing if another update request is in progress. However it can be called even if <a href="qgeosatelliteinfosource.html#startUpdates">startUpdates</a>() has already been called and regular updates are in progress.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@requestUpdate -->
<!-- $$$satellitesInUseUpdated[overload1]$$$satellitesInUseUpdatedconstQList<QGeoSatelliteInfo>& -->
<h3 class="fn"><a name="satellitesInUseUpdated"></a><span class="type">void</span> QGeoSatelliteInfoSource::<span class="name">satellitesInUseUpdated</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span>&lt;<span class="type"><a href="qgeosatelliteinfo.html">QGeoSatelliteInfo</a></span>&gt; &amp; <i>satellites</i> )<tt> [signal]</tt></h3>
<p>If <a href="qgeosatelliteinfosource.html#startUpdates">startUpdates</a>() or <a href="qgeosatelliteinfosource.html#requestUpdate">requestUpdate</a>() is called, this signal is emitted when an update is available on the number of satellites that are currently in use.</p>
<p>These are the satellites that are used to get a &quot;fix&quot; - that is, those used to determine the current position.</p>
<p>The <i>satellites</i> parameter holds the satellites currently in use.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@satellitesInUseUpdated -->
<!-- $$$satellitesInViewUpdated[overload1]$$$satellitesInViewUpdatedconstQList<QGeoSatelliteInfo>& -->
<h3 class="fn"><a name="satellitesInViewUpdated"></a><span class="type">void</span> QGeoSatelliteInfoSource::<span class="name">satellitesInViewUpdated</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span>&lt;<span class="type"><a href="qgeosatelliteinfo.html">QGeoSatelliteInfo</a></span>&gt; &amp; <i>satellites</i> )<tt> [signal]</tt></h3>
<p>If <a href="qgeosatelliteinfosource.html#startUpdates">startUpdates</a>() or <a href="qgeosatelliteinfosource.html#requestUpdate">requestUpdate</a>() is called, this signal is emitted when an update is available on the satellites that are currently in view.</p>
<p>The <i>satellites</i> parameter holds the satellites currently in view.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@satellitesInViewUpdated -->
<!-- $$$startUpdates[overload1]$$$startUpdates -->
<h3 class="fn"><a name="startUpdates"></a><span class="type">void</span> QGeoSatelliteInfoSource::<span class="name">startUpdates</span> ()<tt> [pure virtual slot]</tt></h3>
<p>Starts emitting updates at regular intervals. The updates will be provided whenever new satellite information becomes available.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qgeosatelliteinfosource.html#satellitesInViewUpdated">satellitesInViewUpdated</a>() and <a href="qgeosatelliteinfosource.html#satellitesInUseUpdated">satellitesInUseUpdated</a>().</p>
<!-- @@@startUpdates -->
<!-- $$$stopUpdates[overload1]$$$stopUpdates -->
<h3 class="fn"><a name="stopUpdates"></a><span class="type">void</span> QGeoSatelliteInfoSource::<span class="name">stopUpdates</span> ()<tt> [pure virtual slot]</tt></h3>
<p>Stops emitting updates at regular intervals.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@stopUpdates -->
</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>

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