Sophie

Sophie

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

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" />
<!-- qlandmarkcategoryfetchrequest.cpp -->
  <title>Qt Mobility 1.2: QLandmarkCategoryFetchRequest 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>QLandmarkCategoryFetchRequest</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">QLandmarkCategoryFetchRequest Class Reference</h1>
<!-- $$$QLandmarkCategoryFetchRequest-brief -->
<p>The QLandmarkCategoryFetchRequest class allows a client to asynchronously request a list of categories from a landmark manager. <a href="#details">More...</a></p>
<!-- @@@QLandmarkCategoryFetchRequest -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QLandmarkCategoryFetchRequest&gt;</span></pre><p><b>Inherits: </b><a href="qlandmarkabstractrequest.html">QLandmarkAbstractRequest</a>.</p>
<p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qlandmarkcategoryfetchrequest-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="qlandmarkcategoryfetchrequest.html#QLandmarkCategoryFetchRequest">QLandmarkCategoryFetchRequest</a></b> ( QLandmarkManager * <i>manager</i>, QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategoryfetchrequest.html#dtor.QLandmarkCategoryFetchRequest">~QLandmarkCategoryFetchRequest</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList&lt;QLandmarkCategory&gt; </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategoryfetchrequest.html#categories">categories</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategoryfetchrequest.html#limit">limit</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategoryfetchrequest.html#offset">offset</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategoryfetchrequest.html#setLimit">setLimit</a></b> ( int <i>limit</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategoryfetchrequest.html#setOffset">setOffset</a></b> ( int <i>offset</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategoryfetchrequest.html#setSorting">setSorting</a></b> ( const QLandmarkNameSort &amp; <i>nameSort</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLandmarkNameSort </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategoryfetchrequest.html#sorting">sorting</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">9 public functions inherited from <a href="qlandmarkabstractrequest.html#public-functions">QLandmarkAbstractRequest</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">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</a></li>
<li class="fn">3 public slots inherited from <a href="qlandmarkabstractrequest.html#public-slots">QLandmarkAbstractRequest</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">2 signals inherited from <a href="qlandmarkabstractrequest.html#signals">QLandmarkAbstractRequest</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">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>
<!-- $$$QLandmarkCategoryFetchRequest-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QLandmarkCategoryFetchRequest class allows a client to asynchronously request a list of categories from a landmark manager.</p>
<p>For a QLandmarkCategoryFetchRequest, the <a href="qlandmarkabstractrequest.html#resultsAvailable">resultsAvailable</a>() signal will be emitted as resultant categories are found (these are retrievable by calling <a href="qlandmarkcategoryfetchrequest.html#categories">categories</a>()), as well as if an overall operation error occurred(which may be retrieved by calling <a href="qlandmarkabstractrequest.html#error">QLandmarkAbstractRequest::error</a>()).</p>
<p>Please see the class documentation for <a href="qlandmarkabstractrequest.html">QLandmarkAbstractRequest</a> for more information about the usage of request classes and ownership semantics.</p>
</div>
<!-- @@@QLandmarkCategoryFetchRequest -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QLandmarkCategoryFetchRequest[overload1]$$$QLandmarkCategoryFetchRequestQLandmarkManager*QObject* -->
<h3 class="fn"><a name="QLandmarkCategoryFetchRequest"></a>QLandmarkCategoryFetchRequest::<span class="name">QLandmarkCategoryFetchRequest</span> ( <span class="type"><a href="qlandmarkmanager.html">QLandmarkManager</a></span> * <i>manager</i>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Creates a new category fetch request object with the given <i>manager</i> and <i>parent</i>.</p>
<!-- @@@QLandmarkCategoryFetchRequest -->
<!-- $$$~QLandmarkCategoryFetchRequest[overload1]$$$~QLandmarkCategoryFetchRequest -->
<h3 class="fn"><a name="dtor.QLandmarkCategoryFetchRequest"></a>QLandmarkCategoryFetchRequest::<span class="name">~QLandmarkCategoryFetchRequest</span> ()</h3>
<p>Destroys the request object.</p>
<!-- @@@~QLandmarkCategoryFetchRequest -->
<!-- $$$categories[overload1]$$$categories -->
<h3 class="fn"><a name="categories"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span>&lt;<span class="type"><a href="qlandmarkcategory.html">QLandmarkCategory</a></span>&gt; QLandmarkCategoryFetchRequest::<span class="name">categories</span> () const</h3>
<p>Returns the list of categories that have been found during the request.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@categories -->
<!-- $$$limit[overload1]$$$limit -->
<h3 class="fn"><a name="limit"></a><span class="type">int</span> QLandmarkCategoryFetchRequest::<span class="name">limit</span> () const</h3>
<p>Returns the maximum number of categories to be returned. By default the limit is -1 indicating that all categories should be retrieved.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategoryfetchrequest.html#setLimit">setLimit</a>().</p>
<!-- @@@limit -->
<!-- $$$offset[overload1]$$$offset -->
<h3 class="fn"><a name="offset"></a><span class="type">int</span> QLandmarkCategoryFetchRequest::<span class="name">offset</span> () const</h3>
<p>Returns the index offset for the request. By default the offset is 0. The offset determines the first index which is retrieved, it is generally used in conjunction with <a href="qlandmarkcategoryfetchrequest.html#limit">limit</a>() to facilitate paging.</p>
<p>For example, if there are 10 categories in the landmark store, setting the offset to 2 and limit to 5 will retrieve the 3rd to 7th categories inclusively. (The order of categories is specified by the sorting field).</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategoryfetchrequest.html#setOffset">setOffset</a>().</p>
<!-- @@@offset -->
<!-- $$$setLimit[overload1]$$$setLimitint -->
<h3 class="fn"><a name="setLimit"></a><span class="type">void</span> QLandmarkCategoryFetchRequest::<span class="name">setLimit</span> ( <span class="type">int</span> <i>limit</i> )</h3>
<p>Sets the maximum number of categories to be returned to <i>limit</i>. A limit of -1 will retrieve all categories.</p>
<p>(A limit of 0 will retrieve no categories.)</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategoryfetchrequest.html#limit">limit</a>().</p>
<!-- @@@setLimit -->
<!-- $$$setOffset[overload1]$$$setOffsetint -->
<h3 class="fn"><a name="setOffset"></a><span class="type">void</span> QLandmarkCategoryFetchRequest::<span class="name">setOffset</span> ( <span class="type">int</span> <i>offset</i> )</h3>
<p>Sets the index <i>offset</i> for the request.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategoryfetchrequest.html#offset">offset</a>().</p>
<!-- @@@setOffset -->
<!-- $$$setSorting[overload1]$$$setSortingconstQLandmarkNameSort& -->
<h3 class="fn"><a name="setSorting"></a><span class="type">void</span> QLandmarkCategoryFetchRequest::<span class="name">setSorting</span> ( const <span class="type"><a href="qlandmarknamesort.html">QLandmarkNameSort</a></span> &amp; <i>nameSort</i> )</h3>
<p>Sets <i>nameSort</i> to specify the sorting of the returned categories.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategoryfetchrequest.html#sorting">sorting</a>().</p>
<!-- @@@setSorting -->
<!-- $$$sorting[overload1]$$$sorting -->
<h3 class="fn"><a name="sorting"></a><span class="type"><a href="qlandmarknamesort.html">QLandmarkNameSort</a></span> QLandmarkCategoryFetchRequest::<span class="name">sorting</span> () const</h3>
<p>Returns the sorting of the categories. By default the sorting is case insensitive and in ascending order according to the category name.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategoryfetchrequest.html#setSorting">setSorting</a>().</p>
<!-- @@@sorting -->
</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>