Sophie

Sophie

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

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" />
<!-- qcontactdetails.cpp -->
  <title>Qt Mobility 1.2: QContactFavorite 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="qtcontacts.html">QtContacts</a></li>
<li>QContactFavorite</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="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QContactFavorite Class Reference</h1>
<!-- $$$QContactFavorite-brief -->
<p>The QContactFavorite class indicates if a contact is a favorite contact as well as the position it should appear in an ordered list of favorites. <a href="#details">More...</a></p>
<!-- @@@QContactFavorite -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QContactFavorite&gt;</span></pre><p><b>Inherits: </b><a href="qcontactdetail.html">QContactDetail</a>.</p>
<p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qcontactfavorite-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"> int </td><td class="memItemRight bottomAlign"><b><a href="qcontactfavorite.html#index">index</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactfavorite.html#isFavorite">isFavorite</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactfavorite.html#setFavorite">setFavorite</a></b> ( bool <i>isFavorite</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactfavorite.html#setIndex">setIndex</a></b> ( int <i>index</i> )</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="qcontactdetail.html#public-functions">QContactDetail</a></li>
</ul>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactfavorite.html#DefinitionName-var">DefinitionName</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactfavorite.html#FieldFavorite-var">FieldFavorite</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactfavorite.html#FieldIndex-var">FieldIndex</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactFilter </td><td class="memItemRight bottomAlign"><b><a href="qcontactfavorite.html#match">match</a></b> ()</td></tr>
</table>
<a name="details"></a>
<!-- $$$QContactFavorite-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QContactFavorite class indicates if a contact is a favorite contact as well as the position it should appear in an ordered list of favorites.</p>
<p>This leaf-class has been part of the default schema since version 1.1 of the Qt Mobility project.</p>
</div>
<!-- @@@QContactFavorite -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$index[overload1]$$$index -->
<h3 class="fn"><a name="index"></a><span class="type">int</span> QContactFavorite::<span class="name">index</span> () const</h3>
<p>Returns the index of the favorite contact.</p>
<p><b>See also </b><a href="qcontactfavorite.html#setIndex">setIndex</a>().</p>
<!-- @@@index -->
<!-- $$$isFavorite[overload1]$$$isFavorite -->
<h3 class="fn"><a name="isFavorite"></a><span class="type">bool</span> QContactFavorite::<span class="name">isFavorite</span> () const</h3>
<p>Returns true if the contact is a favorite, false otherwise.</p>
<!-- @@@isFavorite -->
<!-- $$$match[overload1]$$$match -->
<h3 class="fn"><a name="match"></a><span class="type"><a href="qcontactfilter.html">QContactFilter</a></span> QContactFavorite::<span class="name">match</span> ()<tt> [static]</tt></h3>
<p>Returns a filter suitable for finding contacts which are marked as favorite contacts.</p>
<!-- @@@match -->
<!-- $$$setFavorite[overload1]$$$setFavoritebool -->
<h3 class="fn"><a name="setFavorite"></a><span class="type">void</span> QContactFavorite::<span class="name">setFavorite</span> ( <span class="type">bool</span> <i>isFavorite</i> )</h3>
<p>If <i>isFavorite</i> is true, marks the contact as a favorite. Otherwise, marks the contact as not a favorite.</p>
<p><b>See also </b><a href="qcontactfavorite.html#isFavorite">isFavorite</a>().</p>
<!-- @@@setFavorite -->
<!-- $$$setIndex[overload1]$$$setIndexint -->
<h3 class="fn"><a name="setIndex"></a><span class="type">void</span> QContactFavorite::<span class="name">setIndex</span> ( <span class="type">int</span> <i>index</i> )</h3>
<p>Sets the index of the favorite contact to <i>index</i>.</p>
<p><b>See also </b><a href="qcontactfavorite.html#index">index</a>().</p>
<!-- @@@setIndex -->
</div>
<div class="vars">
<h2>Member Variable Documentation</h2>
<!-- $$$DefinitionName -->
<h3 class="fn"><a name="DefinitionName-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactFavorite::<span class="name">DefinitionName</span></h3>
<p>The string constant for the definition name of <a href="qcontactfavorite.html">QContactFavorite</a> details.</p>
<!-- @@@DefinitionName -->
<!-- $$$FieldFavorite -->
<h3 class="fn"><a name="FieldFavorite-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactFavorite::<span class="name">FieldFavorite</span></h3>
<p>The field key constant for the value that indicates whether a contact is a favorite.</p>
<p><b>See also </b><a href="qcontactfavorite.html#index">index</a>() and <a href="qcontactfavorite.html#setIndex">setIndex</a>().</p>
<!-- @@@FieldFavorite -->
<!-- $$$FieldIndex -->
<h3 class="fn"><a name="FieldIndex-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactFavorite::<span class="name">FieldIndex</span></h3>
<p>The field key constant for the value containing the index of the favorite contact (which determines the order they appear)</p>
<p><b>See also </b><a href="qcontactfavorite.html#index">index</a>() and <a href="qcontactfavorite.html#setIndex">setIndex</a>().</p>
<!-- @@@FieldIndex -->
</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>