Sophie

Sophie

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

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" />
<!-- qlandmarkcategory.cpp -->
  <title>Qt Mobility 1.2: QLandmarkCategory 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>QLandmarkCategory</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">QLandmarkCategory Class Reference</h1>
<!-- $$$QLandmarkCategory-brief -->
<p>The QLandmarkCategory class designates a grouping of landmarks of similar type. <a href="#details">More...</a></p>
<!-- @@@QLandmarkCategory -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QLandmarkCategory&gt;</span></pre><p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qlandmarkcategory-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="qlandmarkcategory.html#QLandmarkCategory">QLandmarkCategory</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategory.html#QLandmarkCategory-2">QLandmarkCategory</a></b> ( const QLandmarkCategory &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategory.html#dtor.QLandmarkCategory">~QLandmarkCategory</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLandmarkCategoryId </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategory.html#categoryId">categoryId</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategory.html#clear">clear</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QUrl </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategory.html#iconUrl">iconUrl</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategory.html#name">name</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategory.html#setCategoryId">setCategoryId</a></b> ( const QLandmarkCategoryId &amp; <i>id</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategory.html#setIconUrl">setIconUrl</a></b> ( const QUrl &amp; <i>url</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategory.html#setName">setName</a></b> ( const QString &amp; <i>name</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategory.html#operator-not-eq">operator!=</a></b> ( const QLandmarkCategory &amp; <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLandmarkCategory &amp; </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategory.html#operator-eq">operator=</a></b> ( const QLandmarkCategory &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlandmarkcategory.html#operator-eq-eq">operator==</a></b> ( const QLandmarkCategory &amp; <i>other</i> ) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QLandmarkCategory-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QLandmarkCategory class designates a grouping of landmarks of similar type.</p>
<p>Landmarks of similar type may be grouped together into categories, e.g&#x2e; restaurants, accommodation etc, a QLandmarkCategory object represents one of these.</p>
<p>More than one category can be assigned to a landmark. Assignment of a category to a landmark is achieved by using the <a href="qlandmark.html#setCategoryIds">QLandmark::setCategoryIds</a>() or <a href="qlandmark.html#addCategoryId">QLandmark::addCategoryId</a>() functions.</p>
<p>Some categories may be considered read-only by a manager and cannot be saved. To see if a category is read only, the id of the cateory must be passed into the <a href="qlandmarkmanager.html#isReadOnly">QLandmarkManager::isReadOnly</a>() function. Localization is only possible for categories that are read-only.</p>
<p>A QLandmarkCategory instance is an in memory representation and may not reflect the state of the category found in persistent storage, until the appropriate synchronization method is called on the <a href="qlandmarkmanager.html">QLandmarkManager</a>(e.g&#x2e;<a href="qlandmarkmanager.html#saveCategory">saveCategory()</a>, <a href="qlandmarkmanager.html#removeCategory">removeCategory()</a>).</p>
</div>
<!-- @@@QLandmarkCategory -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QLandmarkCategory[overload1]$$$QLandmarkCategory -->
<h3 class="fn"><a name="QLandmarkCategory"></a>QLandmarkCategory::<span class="name">QLandmarkCategory</span> ()</h3>
<p>Constructs an empty category.</p>
<p>A new category will be assigned an invalid <a href="qlandmarkcategoryid.html">QLandmarkCategoryId</a>.</p>
<!-- @@@QLandmarkCategory -->
<!-- $$$QLandmarkCategory$$$QLandmarkCategoryconstQLandmarkCategory& -->
<h3 class="fn"><a name="QLandmarkCategory-2"></a>QLandmarkCategory::<span class="name">QLandmarkCategory</span> ( const <span class="type">QLandmarkCategory</span> &amp; <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@QLandmarkCategory -->
<!-- $$$~QLandmarkCategory[overload1]$$$~QLandmarkCategory -->
<h3 class="fn"><a name="dtor.QLandmarkCategory"></a>QLandmarkCategory::<span class="name">~QLandmarkCategory</span> ()</h3>
<p>Destroys the category.</p>
<!-- @@@~QLandmarkCategory -->
<!-- $$$categoryId[overload1]$$$categoryId -->
<h3 class="fn"><a name="categoryId"></a><span class="type"><a href="qlandmarkcategoryid.html">QLandmarkCategoryId</a></span> QLandmarkCategory::<span class="name">categoryId</span> () const</h3>
<p>Returns the identifier of the category.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategory.html#setCategoryId">setCategoryId</a>().</p>
<!-- @@@categoryId -->
<!-- $$$clear[overload1]$$$clear -->
<h3 class="fn"><a name="clear"></a><span class="type">void</span> QLandmarkCategory::<span class="name">clear</span> ()</h3>
<p>Clears all the data fields of the category.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@clear -->
<!-- $$$iconUrl[overload1]$$$iconUrl -->
<h3 class="fn"><a name="iconUrl"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qurl.html">QUrl</a></span> QLandmarkCategory::<span class="name">iconUrl</span> () const</h3>
<p>Returns the url of the category's icon.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategory.html#setIconUrl">setIconUrl</a>().</p>
<!-- @@@iconUrl -->
<!-- $$$name[overload1]$$$name -->
<h3 class="fn"><a name="name"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QLandmarkCategory::<span class="name">name</span> () const</h3>
<p>Returns the name of the category.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategory.html#setName">setName</a>().</p>
<!-- @@@name -->
<!-- $$$setCategoryId[overload1]$$$setCategoryIdconstQLandmarkCategoryId& -->
<h3 class="fn"><a name="setCategoryId"></a><span class="type">void</span> QLandmarkCategory::<span class="name">setCategoryId</span> ( const <span class="type"><a href="qlandmarkcategoryid.html">QLandmarkCategoryId</a></span> &amp; <i>id</i> )</h3>
<p>Sets the <i>id</i> of the category.</p>
<p>Note that saving a new category using a <a href="qlandmarkmanager.html">QLandmarkManager</a> will automatically assign the category a valid identifier.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategory.html#categoryId">categoryId</a>().</p>
<!-- @@@setCategoryId -->
<!-- $$$setIconUrl[overload1]$$$setIconUrlconstQUrl& -->
<h3 class="fn"><a name="setIconUrl"></a><span class="type">void</span> QLandmarkCategory::<span class="name">setIconUrl</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qurl.html">QUrl</a></span> &amp; <i>url</i> )</h3>
<p>Sets the <i>url</i> of the category's icon</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategory.html#iconUrl">iconUrl</a>().</p>
<!-- @@@setIconUrl -->
<!-- $$$setName[overload1]$$$setNameconstQString& -->
<h3 class="fn"><a name="setName"></a><span class="type">void</span> QLandmarkCategory::<span class="name">setName</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>name</i> )</h3>
<p>Sets the <i>name</i> of the category.</p>
<p>Using the default manager on the Symbian platform, the catgory name is retricted to a length of 124 characters.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategory.html#name">name</a>().</p>
<!-- @@@setName -->
<!-- $$$operator!=[overload1]$$$operator!=constQLandmarkCategory& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QLandmarkCategory::<span class="name">operator!=</span> ( const <span class="type">QLandmarkCategory</span> &amp; <i>other</i> ) const</h3>
<p>Returns true if this category is not equal to <i>other</i>, otherwise returns false.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategory.html#operator-eq-eq">operator==</a>().</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQLandmarkCategory& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QLandmarkCategory</span> &amp; QLandmarkCategory::<span class="name">operator=</span> ( const <span class="type">QLandmarkCategory</span> &amp; <i>other</i> )</h3>
<p>Assigns <i>other</i> to this category and returns a reference to this category.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQLandmarkCategory& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QLandmarkCategory::<span class="name">operator==</span> ( const <span class="type">QLandmarkCategory</span> &amp; <i>other</i> ) const</h3>
<p>Returns true if this category is equal to <i>other</i>, otherwise returns false.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qlandmarkcategory.html#operator-not-eq">operator!=</a>().</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>