Sophie

Sophie

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

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" />
<!-- qcontactfilter.cpp -->
  <title>Qt Mobility 1.2: QContactFilter 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>QContactFilter</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-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#related-non-members">Related Non-Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QContactFilter Class Reference</h1>
<!-- $$$QContactFilter-brief -->
<p>The QContactFilter class is used to select contacts made available through a <a href="qcontactmanager.html">QContactManager</a>. <a href="#details">More...</a></p>
<!-- @@@QContactFilter -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QContactFilter&gt;</span></pre><p><b>Inherited by: </b><a href="qcontactactionfilter.html">QContactActionFilter</a>, <a href="qcontactchangelogfilter.html">QContactChangeLogFilter</a>, <a href="qcontactdetailfilter.html">QContactDetailFilter</a>, <a href="qcontactdetailrangefilter.html">QContactDetailRangeFilter</a>, <a href="qcontactintersectionfilter.html">QContactIntersectionFilter</a>, <a href="qcontactinvalidfilter.html">QContactInvalidFilter</a>, <a href="qcontactlocalidfilter.html">QContactLocalIdFilter</a>, <a href="qcontactrelationshipfilter.html">QContactRelationshipFilter</a>, and <a href="qcontactunionfilter.html">QContactUnionFilter</a>.</p>
<p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qcontactfilter-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcontactfilter.html#FilterType-enum">FilterType</a></b> { InvalidFilter, ContactDetailFilter, ContactDetailRangeFilter, ChangeLogFilter, ..., DefaultFilter }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcontactfilter.html#MatchFlag-enum">MatchFlag</a></b> { MatchExactly, MatchContains, MatchStartsWith, MatchEndsWith, ..., MatchKeypadCollation }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qcontactfilter.html#MatchFlag-enum">MatchFlags</a></b></td></tr>
</table>
<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="qcontactfilter.html#QContactFilter">QContactFilter</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactfilter.html#QContactFilter-2">QContactFilter</a></b> ( const QContactFilter &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactfilter.html#dtor.QContactFilter">~QContactFilter</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> FilterType </td><td class="memItemRight bottomAlign"><b><a href="qcontactfilter.html#type">type</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactfilter.html#operator-not-eq">operator!=</a></b> ( const QContactFilter &amp; <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactFilter &amp; </td><td class="memItemRight bottomAlign"><b><a href="qcontactfilter.html#operator-eq">operator=</a></b> ( const QContactFilter &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactfilter.html#operator-eq-eq">operator==</a></b> ( const QContactFilter &amp; <i>other</i> ) const</td></tr>
</table>
<a name="related-non-members"></a>
<h2>Related Non-Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QContactFilter </td><td class="memItemRight bottomAlign"><b><a href="qcontactfilter.html#operator-and-2">operator&amp;</a></b> ( const QContactFilter &amp; <i>left</i>, const QContactFilter &amp; <i>right</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QContactFilter </td><td class="memItemRight bottomAlign"><b><a href="qcontactfilter.html#operator-7c-2">operator|</a></b> ( const QContactFilter &amp; <i>left</i>, const QContactFilter &amp; <i>right</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QContactFilter-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QContactFilter class is used to select contacts made available through a <a href="qcontactmanager.html">QContactManager</a>.</p>
<p>This class is used as a parameter to various functions offered by <a href="qcontactmanager.html">QContactManager</a>, to allow selection of contacts which have certain details or properties.</p>
</div>
<!-- @@@QContactFilter -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$FilterType$$$InvalidFilter$$$ContactDetailFilter$$$ContactDetailRangeFilter$$$ChangeLogFilter$$$ActionFilter$$$RelationshipFilter$$$IntersectionFilter$$$UnionFilter$$$LocalIdFilter$$$DefaultFilter -->
<h3 class="fn"><a name="FilterType-enum"></a>enum QContactFilter::<span class="name">FilterType</span></h3>
<p>Describes the type of the filter</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QContactFilter::InvalidFilter</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">An invalid filter which matches nothing</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::ContactDetailFilter</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">A filter which matches contacts containing one or more details of a particular definition with a particular value</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::ContactDetailRangeFilter</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">A filter which matches contacts containing one or more details of a particular definition whose values are within a particular range</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::ChangeLogFilter</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">A filter which matches contacts whose timestamps have been updated since some particular date and time</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::ActionFilter</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">A filter which matches contacts for which a particular action is available, or which contain a detail with a particular value for which a particular action is available</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::RelationshipFilter</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">A filter which matches contacts which participate in a particular type of relationship, or relationship with a specified contact</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::IntersectionFilter</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign">A filter which matches all contacts that are matched by all filters it includes</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::UnionFilter</tt></td><td class="topAlign"><tt>7</tt></td><td class="topAlign">A filter which matches any contact that is matched by any of the filters it includes</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::LocalIdFilter</tt></td><td class="topAlign"><tt>8</tt></td><td class="topAlign">A filter which matches any contact whose local id is contained in a particular list of contact local ids</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::DefaultFilter</tt></td><td class="topAlign"><tt>9</tt></td><td class="topAlign">A filter which matches everything</td></tr>
</table>
<!-- @@@FilterType -->
<!-- $$$MatchFlag$$$MatchExactly$$$MatchContains$$$MatchStartsWith$$$MatchEndsWith$$$MatchFixedString$$$MatchCaseSensitive$$$MatchPhoneNumber$$$MatchKeypadCollation -->
<h3 class="flags"><a name="MatchFlag-enum"></a>enum QContactFilter::<span class="name">MatchFlag</span><br/>flags QContactFilter::<span class="name">MatchFlags</span></h3>
<p>Describes the semantics of matching followed by the filter</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QContactFilter::MatchExactly</tt></td><td class="topAlign"><tt>Qt::MatchExactly</tt></td><td class="topAlign">Performs <a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a>-based matching</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::MatchContains</tt></td><td class="topAlign"><tt>Qt::MatchContains</tt></td><td class="topAlign">The search term is contained in the item</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::MatchStartsWith</tt></td><td class="topAlign"><tt>Qt::MatchStartsWith</tt></td><td class="topAlign">The search term matches the start of the item</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::MatchEndsWith</tt></td><td class="topAlign"><tt>Qt::MatchEndsWith</tt></td><td class="topAlign">The search term matches the end of the item</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::MatchFixedString</tt></td><td class="topAlign"><tt>Qt::MatchFixedString</tt></td><td class="topAlign">Performs string-based matching. String-based comparisons are case-insensitive unless the <tt>MatchCaseSensitive</tt> flag is also specified</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::MatchCaseSensitive</tt></td><td class="topAlign"><tt>Qt::MatchCaseSensitive</tt></td><td class="topAlign">The search is case sensitive</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::MatchPhoneNumber</tt></td><td class="topAlign"><tt>1024</tt></td><td class="topAlign">The search term is considered to be in the form of a phone number, and special processing (removing dialing prefixes, non significant characters like '-'. ')' etc). may be performed when matching the item.</td></tr>
<tr><td class="topAlign"><tt>QContactFilter::MatchKeypadCollation</tt></td><td class="topAlign"><tt>2048</tt></td><td class="topAlign">The search term is in the form of text entered by a numeric phone keypad (such as ITU-T E.161 compliant keypads). Each digit in the search term can represent a number of alphanumeric symbols. For example, the search string &quot;43556&quot; would match items &quot;HELLO&quot;, &quot;GEKKO&quot;, &quot;HELL6&quot; and &quot;43556&quot; among others. Accented characters and other punctuation characters may additionally be matched by the <a href="qcontactmanager.html">QContactManager</a> in a way consistent with the platform.</td></tr>
</table>
<p>The MatchFlags type is a typedef for <a href="qflags.html">QFlags</a>&lt;MatchFlag&gt;. It stores an OR combination of MatchFlag values.</p>
<!-- @@@MatchFlag -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QContactFilter[overload1]$$$QContactFilter -->
<h3 class="fn"><a name="QContactFilter"></a>QContactFilter::<span class="name">QContactFilter</span> ()</h3>
<p>Constructs an empty filter</p>
<!-- @@@QContactFilter -->
<!-- $$$QContactFilter$$$QContactFilterconstQContactFilter& -->
<h3 class="fn"><a name="QContactFilter-2"></a>QContactFilter::<span class="name">QContactFilter</span> ( const <span class="type">QContactFilter</span> &amp; <i>other</i> )</h3>
<p>Constructs a new copy of <i>other</i></p>
<!-- @@@QContactFilter -->
<!-- $$$~QContactFilter[overload1]$$$~QContactFilter -->
<h3 class="fn"><a name="dtor.QContactFilter"></a>QContactFilter::<span class="name">~QContactFilter</span> ()</h3>
<p>Cleans up the memory used by this filter</p>
<!-- @@@~QContactFilter -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn"><a name="type"></a><span class="type"><a href="qcontactfilter.html#FilterType-enum">FilterType</a></span> QContactFilter::<span class="name">type</span> () const</h3>
<p>Returns the type of the filter</p>
<!-- @@@type -->
<!-- $$$operator!=[overload1]$$$operator!=constQContactFilter& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QContactFilter::<span class="name">operator!=</span> ( const <span class="type">QContactFilter</span> &amp; <i>other</i> ) const</h3>
<p>Returns true if this filter is not identical to the <i>other</i> filter.</p>
<p><b>See also </b><a href="qcontactfilter.html#operator-eq-eq">operator==</a>().</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQContactFilter& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QContactFilter</span> &amp; QContactFilter::<span class="name">operator=</span> ( const <span class="type">QContactFilter</span> &amp; <i>other</i> )</h3>
<p>Assigns this filter to be <i>other</i></p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQContactFilter& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QContactFilter::<span class="name">operator==</span> ( const <span class="type">QContactFilter</span> &amp; <i>other</i> ) const</h3>
<p>Returns true if the filter has the same type and criteria as <i>other</i></p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@operator== -->
</div>
<div class="relnonmem">
<h2>Related Non-Members</h2>
<!-- $$$operator&$$$operator&constQContactFilter&constQContactFilter& -->
<h3 class="fn"><a name="operator-and-2"></a>const <span class="type">QContactFilter</span> <span class="name">operator&amp;</span> ( const <span class="type">QContactFilter</span> &amp; <i>left</i>, const <span class="type">QContactFilter</span> &amp; <i>right</i> )</h3>
<p>Returns a filter which is the intersection of the <i>left</i> and <i>right</i> filters</p>
<p><b>See also </b><a href="qcontactintersectionfilter.html">QContactIntersectionFilter</a>.</p>
<!-- @@@operator& -->
<!-- $$$operator|$$$operator|constQContactFilter&constQContactFilter& -->
<h3 class="fn"><a name="operator-7c-2"></a>const <span class="type">QContactFilter</span> <span class="name">operator|</span> ( const <span class="type">QContactFilter</span> &amp; <i>left</i>, const <span class="type">QContactFilter</span> &amp; <i>right</i> )</h3>
<p>Returns a filter which is the union of the <i>left</i> and <i>right</i> filters</p>
<p><b>See also </b><a href="qcontactunionfilter.html">QContactUnionFilter</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>