<?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" />
<!-- qcontactsortorder.cpp -->
<title>Qt Mobility 1.2: QContactSortOrder 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>QContactSortOrder</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">QContactSortOrder Class Reference</h1>
<!-- $$$QContactSortOrder-brief -->
<p>The QContactSortOrder class defines how a list of contacts should be ordered according to some criteria <a href="#details">More...</a></p>
<!-- @@@QContactSortOrder -->
<pre class="cpp"> <span class="preprocessor">#include <QContactSortOrder></span></pre><p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qcontactsortorder-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="qcontactsortorder.html#BlankPolicy-enum">BlankPolicy</a></b> { BlanksFirst, BlanksLast }</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="qcontactsortorder.html#QContactSortOrder">QContactSortOrder</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#QContactSortOrder-2">QContactSortOrder</a></b> ( const QContactSortOrder & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#dtor.QContactSortOrder">~QContactSortOrder</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> BlankPolicy </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#blankPolicy">blankPolicy</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::CaseSensitivity </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#caseSensitivity">caseSensitivity</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#detailDefinitionName">detailDefinitionName</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#detailFieldName">detailFieldName</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::SortOrder </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#direction">direction</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#setBlankPolicy">setBlankPolicy</a></b> ( BlankPolicy <i>blankPolicy</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#setCaseSensitivity">setCaseSensitivity</a></b> ( Qt::CaseSensitivity <i>sensitivity</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#setDetailDefinitionName">setDetailDefinitionName</a></b> ( const QString & <i>definitionName</i>, const QString & <i>fieldName</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#setDirection">setDirection</a></b> ( Qt::SortOrder <i>direction</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#operator-QList-ltQContactSortOrder-gt">operator QList<QContactSortOrder></a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#operator-not-eq">operator!=</a></b> ( const QContactSortOrder & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactSortOrder & </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#operator-eq">operator=</a></b> ( const QContactSortOrder & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactsortorder.html#operator-eq-eq">operator==</a></b> ( const QContactSortOrder & <i>other</i> ) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QContactSortOrder-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QContactSortOrder class defines how a list of contacts should be ordered according to some criteria</p>
</div>
<!-- @@@QContactSortOrder -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$BlankPolicy$$$BlanksFirst$$$BlanksLast -->
<h3 class="fn"><a name="BlankPolicy-enum"></a>enum QContactSortOrder::<span class="name">BlankPolicy</span></h3>
<p>Enumerates the ways in which the sort order interprets blanks when sorting contacts</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>QContactSortOrder::BlanksFirst</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">Considers blank values to evaluate to less than all other values in comparisons</td></tr>
<tr><td class="topAlign"><tt>QContactSortOrder::BlanksLast</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">Considers blank values to evaluate to greater than all other values in comparisons</td></tr>
</table>
<!-- @@@BlankPolicy -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QContactSortOrder[overload1]$$$QContactSortOrder -->
<h3 class="fn"><a name="QContactSortOrder"></a>QContactSortOrder::<span class="name">QContactSortOrder</span> ()</h3>
<p>Constructs a new sort order</p>
<!-- @@@QContactSortOrder -->
<!-- $$$QContactSortOrder$$$QContactSortOrderconstQContactSortOrder& -->
<h3 class="fn"><a name="QContactSortOrder-2"></a>QContactSortOrder::<span class="name">QContactSortOrder</span> ( const <span class="type">QContactSortOrder</span> & <i>other</i> )</h3>
<p>Constructs a copy of the <i>other</i> sort order</p>
<!-- @@@QContactSortOrder -->
<!-- $$$~QContactSortOrder[overload1]$$$~QContactSortOrder -->
<h3 class="fn"><a name="dtor.QContactSortOrder"></a>QContactSortOrder::<span class="name">~QContactSortOrder</span> ()</h3>
<p>Frees any memory in use by this sort order</p>
<!-- @@@~QContactSortOrder -->
<!-- $$$blankPolicy[overload1]$$$blankPolicy -->
<h3 class="fn"><a name="blankPolicy"></a><span class="type"><a href="qcontactsortorder.html#BlankPolicy-enum">BlankPolicy</a></span> QContactSortOrder::<span class="name">blankPolicy</span> () const</h3>
<p>Returns the blank policy of the sort order</p>
<p><b>See also </b><a href="qcontactsortorder.html#setBlankPolicy">setBlankPolicy</a>().</p>
<!-- @@@blankPolicy -->
<!-- $$$caseSensitivity[overload1]$$$caseSensitivity -->
<h3 class="fn"><a name="caseSensitivity"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qt.html#CaseSensitivity-enum">Qt::CaseSensitivity</a></span> QContactSortOrder::<span class="name">caseSensitivity</span> () const</h3>
<p>Returns the case sensitivity of the sort order</p>
<p><b>See also </b><a href="qcontactsortorder.html#setCaseSensitivity">setCaseSensitivity</a>().</p>
<!-- @@@caseSensitivity -->
<!-- $$$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> QContactSortOrder::<span class="name">detailDefinitionName</span> () const</h3>
<p>Returns the definition name of the details which will be inspected to perform sorting. Note that if a contact has multiple details of the definition, the result of the sorting is undefined.</p>
<p><b>See also </b><a href="qcontactsortorder.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> QContactSortOrder::<span class="name">detailFieldName</span> () const</h3>
<p>Returns the name of the field in the definition which will be inspected to perform sorting</p>
<p><b>See also </b><a href="qcontactsortorder.html#setDetailDefinitionName">setDetailDefinitionName</a>().</p>
<!-- @@@detailFieldName -->
<!-- $$$direction[overload1]$$$direction -->
<h3 class="fn"><a name="direction"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qt.html#SortOrder-enum">Qt::SortOrder</a></span> QContactSortOrder::<span class="name">direction</span> () const</h3>
<p>Returns the direction of the sort order</p>
<p><b>See also </b><a href="qcontactsortorder.html#setDirection">setDirection</a>().</p>
<!-- @@@direction -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QContactSortOrder::<span class="name">isValid</span> () const</h3>
<p>Returns true if the sort order is able to be used to sort a list of contacts; otherwise, returns false</p>
<!-- @@@isValid -->
<!-- $$$setBlankPolicy[overload1]$$$setBlankPolicyBlankPolicy -->
<h3 class="fn"><a name="setBlankPolicy"></a><span class="type">void</span> QContactSortOrder::<span class="name">setBlankPolicy</span> ( <span class="type"><a href="qcontactsortorder.html#BlankPolicy-enum">BlankPolicy</a></span> <i>blankPolicy</i> )</h3>
<p>Sets the sort order's policy on blank values with respect to sorting to <i>blankPolicy</i></p>
<p><b>See also </b><a href="qcontactsortorder.html#blankPolicy">blankPolicy</a>().</p>
<!-- @@@setBlankPolicy -->
<!-- $$$setCaseSensitivity[overload1]$$$setCaseSensitivityQt::CaseSensitivity -->
<h3 class="fn"><a name="setCaseSensitivity"></a><span class="type">void</span> QContactSortOrder::<span class="name">setCaseSensitivity</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qt.html#CaseSensitivity-enum">Qt::CaseSensitivity</a></span> <i>sensitivity</i> )</h3>
<p>Sets the case sensitivity of the sort order to <i>sensitivity</i></p>
<p><b>See also </b><a href="qcontactsortorder.html#caseSensitivity">caseSensitivity</a>().</p>
<!-- @@@setCaseSensitivity -->
<!-- $$$setDetailDefinitionName[overload1]$$$setDetailDefinitionNameconstQString&constQString& -->
<h3 class="fn"><a name="setDetailDefinitionName"></a><span class="type">void</span> QContactSortOrder::<span class="name">setDetailDefinitionName</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>definitionName</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>fieldName</i> )</h3>
<p>Sets the definition name of the details which will be inspected to perform sorting to <i>definitionName</i>, and the name of those details' fields which contains the value which contacts will be sorted by to <i>fieldName</i></p>
<p><b>See also </b><a href="qcontactsortorder.html#detailDefinitionName">detailDefinitionName</a>() and <a href="qcontactsortorder.html#detailFieldName">detailFieldName</a>().</p>
<!-- @@@setDetailDefinitionName -->
<!-- $$$setDirection[overload1]$$$setDirectionQt::SortOrder -->
<h3 class="fn"><a name="setDirection"></a><span class="type">void</span> QContactSortOrder::<span class="name">setDirection</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qt.html#SortOrder-enum">Qt::SortOrder</a></span> <i>direction</i> )</h3>
<p>Sets the sort order direction to <i>direction</i></p>
<p><b>See also </b><a href="qcontactsortorder.html#direction">direction</a>().</p>
<!-- @@@setDirection -->
<!-- $$$operator QList<QContactSortOrder>[overload1]$$$operator QList<QContactSortOrder> -->
<h3 class="fn"><a name="operator-QList-ltQContactSortOrder-gt"></a>QContactSortOrder::<span class="name">operator QList<QContactSortOrder></span> () const</h3>
<p>Constructs a new list of sort orders containing only the current sort order</p>
<!-- @@@operator QList<QContactSortOrder> -->
<!-- $$$operator!=[overload1]$$$operator!=constQContactSortOrder& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QContactSortOrder::<span class="name">operator!=</span> ( const <span class="type">QContactSortOrder</span> & <i>other</i> ) const</h3>
<p>Returns true if this sort order is not identical to the <i>other</i> sort order</p>
<p><b>See also </b><a href="qcontactsortorder.html#operator-eq-eq">operator==</a>().</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQContactSortOrder& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QContactSortOrder</span> & QContactSortOrder::<span class="name">operator=</span> ( const <span class="type">QContactSortOrder</span> & <i>other</i> )</h3>
<p>Assigns this sort order to be equal to <i>other</i></p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQContactSortOrder& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QContactSortOrder::<span class="name">operator==</span> ( const <span class="type">QContactSortOrder</span> & <i>other</i> ) const</h3>
<p>Returns true if this sort order is identical to the <i>other</i> sort order</p>
<p><b>See also </b><a href="qcontactsortorder.html#operator-not-eq">operator!=</a>().</p>
<!-- @@@operator== -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
50facae208d4a6f280e44a513b104320
>
files
>
790
