Sophie

Sophie

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

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" />
<!-- qcontactdetailrangefilter.cpp -->
  <title>Qt Mobility 1.2: QContactDetailRangeFilter 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>QContactDetailRangeFilter</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="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QContactDetailRangeFilter Class Reference</h1>
<!-- $$$QContactDetailRangeFilter-brief -->
<p>The QContactDetailRangeFilter class provides a filter based around a detail value range criterion. <a href="#details">More...</a></p>
<!-- @@@QContactDetailRangeFilter -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QContactDetailRangeFilter&gt;</span></pre><p><b>Inherits: </b><a href="qcontactfilter.html">QContactFilter</a>.</p>
<p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qcontactdetailrangefilter-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="qcontactdetailrangefilter.html#RangeFlag-enum">RangeFlag</a></b> { IncludeLower, IncludeUpper, ExcludeLower, ExcludeUpper }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qcontactdetailrangefilter.html#RangeFlag-enum">RangeFlags</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="qcontactdetailrangefilter.html#QContactDetailRangeFilter">QContactDetailRangeFilter</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactdetailrangefilter.html#QContactDetailRangeFilter-2">QContactDetailRangeFilter</a></b> ( const QContactFilter &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactdetailrangefilter.html#detailDefinitionName">detailDefinitionName</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactdetailrangefilter.html#detailFieldName">detailFieldName</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactFilter::MatchFlags </td><td class="memItemRight bottomAlign"><b><a href="qcontactdetailrangefilter.html#matchFlags">matchFlags</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qcontactdetailrangefilter.html#maxValue">maxValue</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qcontactdetailrangefilter.html#minValue">minValue</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> RangeFlags </td><td class="memItemRight bottomAlign"><b><a href="qcontactdetailrangefilter.html#rangeFlags">rangeFlags</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactdetailrangefilter.html#setDetailDefinitionName">setDetailDefinitionName</a></b> ( const QString &amp; <i>definitionName</i>, const QString &amp; <i>fieldName</i> = QString() )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactdetailrangefilter.html#setMatchFlags">setMatchFlags</a></b> ( QContactFilter::MatchFlags <i>flags</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactdetailrangefilter.html#setRange">setRange</a></b> ( const QVariant &amp; <i>min</i>, const QVariant &amp; <i>max</i>, RangeFlags <i>flags</i> = 0 )</td></tr>
</table>
<ul>
<li class="fn">4 public functions inherited from <a href="qcontactfilter.html#public-functions">QContactFilter</a></li>
</ul>
<a name="details"></a>
<!-- $$$QContactDetailRangeFilter-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QContactDetailRangeFilter class provides a filter based around a detail value range criterion.</p>
<p>It may be used to select contacts which contain a detail of a particular definition with a particular value that lies in a range (either open or closed).</p>
</div>
<!-- @@@QContactDetailRangeFilter -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$RangeFlag$$$IncludeLower$$$IncludeUpper$$$ExcludeLower$$$ExcludeUpper -->
<h3 class="flags"><a name="RangeFlag-enum"></a>enum QContactDetailRangeFilter::<span class="name">RangeFlag</span><br/>flags QContactDetailRangeFilter::<span class="name">RangeFlags</span></h3>
<p>Enumerates the semantics of the boundary conditions of the detail range 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>QContactDetailRangeFilter::IncludeLower</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The filter will match if the field value is equal to or greater than the minimum value</td></tr>
<tr><td class="topAlign"><tt>QContactDetailRangeFilter::IncludeUpper</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The filter will match if the field value is equal to or less than the maximum value</td></tr>
<tr><td class="topAlign"><tt>QContactDetailRangeFilter::ExcludeLower</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The filter will match if the field value is greater than the minimum value (but not equal)</td></tr>
<tr><td class="topAlign"><tt>QContactDetailRangeFilter::ExcludeUpper</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The filter will match if the field value is less than the maximum value (but not equal)</td></tr>
</table>
<p>The RangeFlags type is a typedef for <a href="qflags.html">QFlags</a>&lt;RangeFlag&gt;. It stores an OR combination of RangeFlag values.</p>
<!-- @@@RangeFlag -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QContactDetailRangeFilter[overload1]$$$QContactDetailRangeFilter -->
<h3 class="fn"><a name="QContactDetailRangeFilter"></a>QContactDetailRangeFilter::<span class="name">QContactDetailRangeFilter</span> ()</h3>
<p>Constructs a new detail range filter</p>
<!-- @@@QContactDetailRangeFilter -->
<!-- $$$QContactDetailRangeFilter$$$QContactDetailRangeFilterconstQContactFilter& -->
<h3 class="fn"><a name="QContactDetailRangeFilter-2"></a>QContactDetailRangeFilter::<span class="name">QContactDetailRangeFilter</span> ( const <span class="type"><a href="qcontactfilter.html">QContactFilter</a></span> &amp; <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i> if possible, otherwise constructs a new detail range filter</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@QContactDetailRangeFilter -->
<!-- $$$detailDefinitionName[overload1]$$$detailDefinitionName -->
<h3 class="fn"><a name="detailDefinitionName"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QContactDetailRangeFilter::<span class="name">detailDefinitionName</span> () const</h3>
<p>Returns the definition name of the details which will be inspected for matching values</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactdetailrangefilter.html#setDetailDefinitionName">setDetailDefinitionName</a>().</p>
<!-- @@@detailDefinitionName -->
<!-- $$$detailFieldName[overload1]$$$detailFieldName -->
<h3 class="fn"><a name="detailFieldName"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QContactDetailRangeFilter::<span class="name">detailFieldName</span> () const</h3>
<p>Returns the name of the field which contains the value which will be matched against the value criterion</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactdetailrangefilter.html#setDetailDefinitionName">setDetailDefinitionName</a>().</p>
<!-- @@@detailFieldName -->
<!-- $$$matchFlags[overload1]$$$matchFlags -->
<h3 class="fn"><a name="matchFlags"></a><span class="type"><a href="qcontactfilter.html#MatchFlag-enum">QContactFilter::MatchFlags</a></span> QContactDetailRangeFilter::<span class="name">matchFlags</span> () const</h3>
<p>Returns the match flags of the criterion, which define semantics such as case sensitivity, and exact matching.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactdetailrangefilter.html#setMatchFlags">setMatchFlags</a>().</p>
<!-- @@@matchFlags -->
<!-- $$$maxValue[overload1]$$$maxValue -->
<h3 class="fn"><a name="maxValue"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> QContactDetailRangeFilter::<span class="name">maxValue</span> () const</h3>
<p>Returns the upper bound of the value range criterion If this value is null, there is no upper bound. If it is valid, the <a href="qcontactdetailrangefilter.html#rangeFlags">rangeFlags</a>() determines whether this value is included in the valid values.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactdetailrangefilter.html#setRange">setRange</a>().</p>
<!-- @@@maxValue -->
<!-- $$$minValue[overload1]$$$minValue -->
<h3 class="fn"><a name="minValue"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> QContactDetailRangeFilter::<span class="name">minValue</span> () const</h3>
<p>Returns the lower bound of the value range criterion. If this value is null, there is no lower bound. If it is valid, the <a href="qcontactdetailrangefilter.html#rangeFlags">rangeFlags</a>() determines whether this value is included in the valid values.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactdetailrangefilter.html#setRange">setRange</a>().</p>
<!-- @@@minValue -->
<!-- $$$rangeFlags[overload1]$$$rangeFlags -->
<h3 class="fn"><a name="rangeFlags"></a><span class="type"><a href="qcontactdetailrangefilter.html#RangeFlag-enum">RangeFlags</a></span> QContactDetailRangeFilter::<span class="name">rangeFlags</span> () const</h3>
<p>Returns a set of flags which defines the boundary condition semantics of the value range criterion</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactdetailrangefilter.html#setRange">setRange</a>().</p>
<!-- @@@rangeFlags -->
<!-- $$$setDetailDefinitionName[overload1]$$$setDetailDefinitionNameconstQString&constQString& -->
<h3 class="fn"><a name="setDetailDefinitionName"></a><span class="type">void</span> QContactDetailRangeFilter::<span class="name">setDetailDefinitionName</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>definitionName</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>fieldName</i> = QString() )</h3>
<p>Sets the name of the detail definition of which type details will be inspected for matching values to <i>definitionName</i>, and the name of the field which will be inspected in details of that definition to <i>fieldName</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactdetailrangefilter.html#detailDefinitionName">detailDefinitionName</a>() and <a href="qcontactdetailrangefilter.html#detailFieldName">detailFieldName</a>().</p>
<!-- @@@setDetailDefinitionName -->
<!-- $$$setMatchFlags[overload1]$$$setMatchFlagsQContactFilter::MatchFlags -->
<h3 class="fn"><a name="setMatchFlags"></a><span class="type">void</span> QContactDetailRangeFilter::<span class="name">setMatchFlags</span> ( <span class="type"><a href="qcontactfilter.html#MatchFlag-enum">QContactFilter::MatchFlags</a></span> <i>flags</i> )</h3>
<p>Sets the match flags of the filter criterion to <i>flags</i></p>
<p>Not all flags are supported by a range filter. The supported flags include:</p>
<ul>
<li><a href="qcontactfilter.html#MatchFlag-enum">QContactFilter::MatchExactly</a></li>
<li><a href="qcontactfilter.html#MatchFlag-enum">QContactFilter::MatchFixedString</a></li>
<li><a href="qcontactfilter.html#MatchFlag-enum">QContactFilter::MatchCaseSensitive</a></li>
</ul>
<p>Unsupported flags will be ignored.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactdetailrangefilter.html#matchFlags">matchFlags</a>().</p>
<!-- @@@setMatchFlags -->
<!-- $$$setRange[overload1]$$$setRangeconstQVariant&constQVariant&RangeFlags -->
<h3 class="fn"><a name="setRange"></a><span class="type">void</span> QContactDetailRangeFilter::<span class="name">setRange</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> &amp; <i>min</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> &amp; <i>max</i>, <span class="type"><a href="qcontactdetailrangefilter.html#RangeFlag-enum">RangeFlags</a></span> <i>flags</i> = 0 )</h3>
<p>Sets the value range criterion of the filter to within <i>min</i> and <i>max</i>, with boundary conditions specified in the given <i>flags</i>. If <i>min</i> or <i>max</i> is a null variant, that condition will not be checked. For example, to check for fields with a value greater than 7, you would specify:</p>
<pre class="cpp"> filter<span class="operator">.</span>setRange(<span class="number">7</span><span class="operator">,</span> <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span>()<span class="operator">,</span> <span class="type"><a href="qcontactdetailrangefilter.html">QContactDetailRangeFilter</a></span><span class="operator">::</span>ExcludeLower);</pre>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactdetailrangefilter.html#minValue">minValue</a>() and <a href="qcontactdetailrangefilter.html#maxValue">maxValue</a>().</p>
<!-- @@@setRange -->
</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>