Sophie

Sophie

distrib > Fedora > 18 > i386 > by-pkgid > 110492f5122731329f0db69a1df590c3 > files > 1931

kdepimlibs-apidocs-4.10.5-1.fc18.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
  <title>KABC::AddresseeList Class Reference</title>
<style type="text/css">
  .cp-doNotDisplay { display: none; }
  @media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }}
  .cp-edit { text-align: right; }
  @media print, embossed { .cp-edit { display: none; }}
</style>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta http-equiv="Content-Style-Type" content="text/css" />
  <link rel="meta" href="http://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" />
  <meta name="trademark" content="KDE e.V." />
  <meta name="description" content="K Desktop Environment Homepage, KDE.org" />
  <meta name="MSSmartTagsPreventParsing" content="true" />
  <meta name="robots" content="all" />
  <meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" />
  <script type="text/javascript" src="jquery.js"></script>
  <script type="text/javascript" src="dynsections.js"></script>
  <link rel="shortcut icon" href="../../favicon.ico" /><link rel="icon" href="../../favicon.ico" />
  <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../../kde.css" />
  <link rel="stylesheet" media="print, embossed" type="text/css" href="../../print.css" />
  <link rel="stylesheet" media="screen, aural, handheld, tty, braille" type="text/css" title="Flat" href="../../flat.css" />
  <link rel="stylesheet" type="text/css" href="../../doxygen.css" />
  <link rel="stylesheet" type="text/css" href="../../tabs.css" />
</head>
<body>
<ul class="cp-doNotDisplay">
  <li><a href="#cp-content" accesskey="2">Skip to content</a></li>
  <li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li>
</ul>
<div id="container">
<div id="header">
  <div id="header_top"><div><div>
    <img alt ="" src="../../top-kde.jpg"/>
    </div></div></div>
  <div id="header_bottom">
    <div id="location">
      <ul>
        <li><a href="http://api.kde.org">KDE API Reference</a></li>
        <li><a href="../../index.html">kdepimlibs-4.10.5 API Reference</a></li>
      </ul>
    </div>
    <div id="menu">
<ul>
<li><a href="http://www.kde.org/">KDE Home</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<!-- End page header -->
    <div id="body_wrapper">
      <div id="body">
        <!-- begin main content -->
        <div id="right">
          <div class="content">
          <div id="main">
            <div class="clearer">&nbsp;</div>
<h2><a name="content"></a>kabc</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>KABC</b></li><li class="navelem"><a class="el" href="classKABC_1_1AddresseeList.html">AddresseeList</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classKABC_1_1AddresseeList-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">KABC::AddresseeList Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="addresseelist_8h_source.html">addresseelist.h</a>&gt;</code></p>

<p>Inherits QList&lt; T &gt;.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac67e0e020cfcf3ef39a66b50cc9f982f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#ac67e0e020cfcf3ef39a66b50cc9f982f">AddresseeList</a> ()</td></tr>
<tr class="separator:ac67e0e020cfcf3ef39a66b50cc9f982f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11c5383166ad4ee7bb6c12c5d308a2f6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#a11c5383166ad4ee7bb6c12c5d308a2f6">AddresseeList</a> (const <a class="el" href="classKABC_1_1AddresseeList.html">AddresseeList</a> &amp;)</td></tr>
<tr class="separator:a11c5383166ad4ee7bb6c12c5d308a2f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90996d65c9220382767ce661264c4ee0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#a90996d65c9220382767ce661264c4ee0">AddresseeList</a> (const QList&lt; Addressee &gt; &amp;)</td></tr>
<tr class="separator:a90996d65c9220382767ce661264c4ee0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d24355914c8b99b30bd5c5de3b848c9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#a6d24355914c8b99b30bd5c5de3b848c9">~AddresseeList</a> ()</td></tr>
<tr class="separator:a6d24355914c8b99b30bd5c5de3b848c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae06e5f202588683149b3af5eff9e51f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKABC_1_1AddresseeList.html">AddresseeList</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#ae06e5f202588683149b3af5eff9e51f0">operator=</a> (const <a class="el" href="classKABC_1_1AddresseeList.html">AddresseeList</a> &amp;other)</td></tr>
<tr class="separator:ae06e5f202588683149b3af5eff9e51f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2889ddda3aa8621b71254fcb32f76b9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#ab2889ddda3aa8621b71254fcb32f76b9">reverseSorting</a> () const </td></tr>
<tr class="separator:ab2889ddda3aa8621b71254fcb32f76b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ac53a79b35b3354f6570d34fcc15f90"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#a5ac53a79b35b3354f6570d34fcc15f90">setReverseSorting</a> (bool <a class="el" href="classKABC_1_1AddresseeList.html#ab2889ddda3aa8621b71254fcb32f76b9">reverseSorting</a>=true)</td></tr>
<tr class="separator:a5ac53a79b35b3354f6570d34fcc15f90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f96808948654ab93179b250d4e011b9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#a8f96808948654ab93179b250d4e011b9">sort</a> ()</td></tr>
<tr class="separator:a8f96808948654ab93179b250d4e011b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcb081c6fa45236e9a416b9a1690c4c1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#abcb081c6fa45236e9a416b9a1690c4c1">sortBy</a> (SortingCriterion c)</td></tr>
<tr class="separator:abcb081c6fa45236e9a416b9a1690c4c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adff80eab259560b16f3686eb625d1d35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#adff80eab259560b16f3686eb625d1d35">sortByField</a> (<a class="el" href="classKABC_1_1Field.html">Field</a> *field=0)</td></tr>
<tr class="separator:adff80eab259560b16f3686eb625d1d35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a629bfffa116d90ed933449abf1f15676"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#a629bfffa116d90ed933449abf1f15676">sortByMode</a> (<a class="el" href="classKABC_1_1SortMode.html">SortMode</a> *mode=0)</td></tr>
<tr class="separator:a629bfffa116d90ed933449abf1f15676"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bfd01513c4972209f1a2dfae55e40b4"><td class="memTemplParams" colspan="2">template&lt;class Trait &gt; </td></tr>
<tr class="memitem:a9bfd01513c4972209f1a2dfae55e40b4"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#a9bfd01513c4972209f1a2dfae55e40b4">sortByTrait</a> ()</td></tr>
<tr class="separator:a9bfd01513c4972209f1a2dfae55e40b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a072973f7b63c2941efe1f779a83f11fd"><td class="memItemLeft" align="right" valign="top">SortingCriterion&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#a072973f7b63c2941efe1f779a83f11fd">sortingCriterion</a> () const </td></tr>
<tr class="separator:a072973f7b63c2941efe1f779a83f11fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61c8d068aa98dea7d850a352b59cc9b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKABC_1_1Field.html">Field</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#a61c8d068aa98dea7d850a352b59cc9b6">sortingField</a> () const </td></tr>
<tr class="separator:a61c8d068aa98dea7d850a352b59cc9b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a536e76450e191671aae481c0ed17cdeb"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeList.html#a536e76450e191671aae481c0ed17cdeb">toString</a> () const </td></tr>
<tr class="separator:a536e76450e191671aae481c0ed17cdeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>a QValueList of Addressee, with sorting functionality </p>
<p>This class extends the functionality of QValueList with sorting methods specific to the Addressee class. It can be used just like any other QValueList but is no template class.</p>
<p>An <a class="el" href="classKABC_1_1AddresseeList.html" title="a QValueList of Addressee, with sorting functionality">AddresseeList</a> does not automatically keep sorted when addressees are added or removed or the sorting order is changed, as this would slow down larger operations by sorting after every step. So after such operations you have to call <a class="el" href="classKABC_1_1AddresseeList.html#a8f96808948654ab93179b250d4e011b9">sort</a> or <a class="el" href="classKABC_1_1AddresseeList.html#abcb081c6fa45236e9a416b9a1690c4c1">sortBy</a> to create a defined order again.</p>
<p>Iterator usage is inherited from QList and extensively documented there. Please remember that the state of an iterator is undefined after any sorting operation.</p>
<p>For the enumeration Type SortingCriterion, which specifies the field by the collection will be sorted, the following values exist: Uid, Name, FormattedName, FamilyName, GivenName.</p>
<dl class="section author"><dt>Author</dt><dd>Jost Schenck <a href="#" onclick="location.href='mai'+'lto:'+'jos'+'t@'+'sch'+'en'+'ck.'+'de'; return false;">jost@<span style="display: none;">.nosp@m.</span>sche<span style="display: none;">.nosp@m.</span>nck.d<span style="display: none;">.nosp@m.</span>e</a> </dd></dl>

<p>Definition at line <a class="el" href="addresseelist_8h_source.html#l00288">288</a> of file <a class="el" href="addresseelist_8h_source.html">addresseelist.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac67e0e020cfcf3ef39a66b50cc9f982f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">AddresseeList::AddresseeList </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a new addressee list. </p>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00176">176</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a11c5383166ad4ee7bb6c12c5d308a2f6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">AddresseeList::AddresseeList </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classKABC_1_1AddresseeList.html">AddresseeList</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a new addressee list. </p>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00185">185</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a90996d65c9220382767ce661264c4ee0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">AddresseeList::AddresseeList </td>
          <td>(</td>
          <td class="paramtype">const QList&lt; Addressee &gt; &amp;&#160;</td>
          <td class="paramname"><em>l</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a new addressee list. </p>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00190">190</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a6d24355914c8b99b30bd5c5de3b848c9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">AddresseeList::~AddresseeList </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroys the addressee list. </p>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00181">181</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae06e5f202588683149b3af5eff9e51f0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classKABC_1_1AddresseeList.html">AddresseeList</a> &amp; AddresseeList::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classKABC_1_1AddresseeList.html">AddresseeList</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">other</td><td>the list to assign from </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a reference to <code>this</code> </dd></dl>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00195">195</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ab2889ddda3aa8621b71254fcb32f76b9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool AddresseeList::reverseSorting </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the direction of sorting. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if sorting is done reverse, <code>false</code> otherwise </dd></dl>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00246">246</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a5ac53a79b35b3354f6570d34fcc15f90"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void AddresseeList::setReverseSorting </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>reverseSorting</em> = <code>true</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Determines the direction of sorting. </p>
<p>On change, the list will <em>not</em> automatically be resorted. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">reverseSorting</td><td><code>true</code> if sorting should be done reverse, <code>false</code> otherwise </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00241">241</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a8f96808948654ab93179b250d4e011b9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void AddresseeList::sort </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sorts this list by its active sorting criterion. </p>
<p>This normally is the criterion of the last sortBy operation or <code>FormattedName</code> if up to now there has been no sortBy operation.</p>
<p>Please note that the sorting trait of the last <a class="el" href="classKABC_1_1AddresseeList.html#a9bfd01513c4972209f1a2dfae55e40b4">sortByTrait</a> method call is not remembered and thus the action can not be repeated by this method. </p>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00270">270</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="abcb081c6fa45236e9a416b9a1690c4c1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void AddresseeList::sortBy </td>
          <td>(</td>
          <td class="paramtype">SortingCriterion&#160;</td>
          <td class="paramname"><em>c</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sorts this list by a specific criterion. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">c</td><td>the criterion by which should be sorted </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00251">251</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="adff80eab259560b16f3686eb625d1d35"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void AddresseeList::sortByField </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classKABC_1_1Field.html">Field</a> *&#160;</td>
          <td class="paramname"><em>field</em> = <code>0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sorts this list by a specific field. </p>
<p>If no parameter is given, the last used <a class="el" href="classKABC_1_1Field.html" title="Represents a field in the Addressbook.">Field</a> object will be used. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">field</td><td>pointer to the <a class="el" href="classKABC_1_1Field.html" title="Represents a field in the Addressbook.">Field</a> object to be sorted by </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00312">312</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a629bfffa116d90ed933449abf1f15676"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void AddresseeList::sortByMode </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classKABC_1_1SortMode.html">SortMode</a> *&#160;</td>
          <td class="paramname"><em>mode</em> = <code>0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sorts this list by a specific sorting mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">mode</td><td>pointer to the sorting mode object to be sorted by </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00334">334</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a9bfd01513c4972209f1a2dfae55e40b4"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Trait &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void AddresseeList::sortByTrait </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Templated sort function. </p>
<p>You normally will not want to use this but <a class="el" href="classKABC_1_1AddresseeList.html#abcb081c6fa45236e9a416b9a1690c4c1">sortBy</a> and <a class="el" href="classKABC_1_1AddresseeList.html#a8f96808948654ab93179b250d4e011b9">sort</a> instead as the existing sorting criteria completely suffice for most cases.</p>
<p>However, if you do want to use some special sorting criterion, you can write a trait class that will be provided to this templated method. This trait class has to have a class declaration like the following: </p>
<div class="fragment"><div class="line"><span class="keyword">class </span>MySortingTrait {</div>
<div class="line">  <span class="keyword">public</span>:</div>
<div class="line">    <span class="comment">// eq returns true if a1 and a2 are equal</span></div>
<div class="line">    <span class="keyword">static</span> <span class="keywordtype">bool</span> eq(KABC::Addressee a1, KABC::Addressee a2);</div>
<div class="line">    <span class="comment">// lt returns true is a1 is &quot;less than&quot; a2</span></div>
<div class="line">    <span class="keyword">static</span> <span class="keywordtype">bool</span> lt(KABC::Addressee a1, KABC::Addressee a2);</div>
<div class="line">};</div>
</div><!-- fragment --><p> You can then pass this class to the sortByTrait method like this: </p>
<div class="fragment"><div class="line">myAddresseelist.sortByTrait&amp;lt;MySortingTrait&amp;gt;();</div>
</div><!-- fragment --><p> Please note that the <a class="el" href="classKABC_1_1AddresseeList.html#a8f96808948654ab93179b250d4e011b9">sort</a> method can not be used to repeat the sorting of the last <code>sortByTrait</code> action.</p>
<p>Right now this method uses the bubble sort algorithm. This should be replaced for a better one when I have time. </p>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00276">276</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a072973f7b63c2941efe1f779a83f11fd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SortingCriterion AddresseeList::sortingCriterion </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the active sorting criterion, ie the sorting criterion that will be used by a <a class="el" href="classKABC_1_1AddresseeList.html#a8f96808948654ab93179b250d4e011b9">sort</a> call. </p>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00345">345</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a61c8d068aa98dea7d850a352b59cc9b6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classKABC_1_1Field.html">Field</a> * AddresseeList::sortingField </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the active sorting field, ie a pointer to the <a class="el" href="classKABC_1_1Field.html" title="Represents a field in the Addressbook.">Field</a> object which was used for the last <a class="el" href="classKABC_1_1AddresseeList.html#adff80eab259560b16f3686eb625d1d35">sortByField</a> operation. </p>
<p>This function returns the last GLOBAL sorting field, not the class specific one. You're a lot better off by keeping track of this locally. </p>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00350">350</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a536e76450e191671aae481c0ed17cdeb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString AddresseeList::toString </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a string representation of the addressee list. </p>

<p>Definition at line <a class="el" href="addresseelist_8cpp_source.html#l00205">205</a> of file <a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="addresseelist_8h_source.html">addresseelist.h</a></li>
<li><a class="el" href="addresseelist_8cpp_source.html">addresseelist.cpp</a></li>
</ul>
</div><!-- contents -->
<div class="copyrights">
This file is part of the KDE documentation.<br/>
Documentation copyright &copy; 1996-2013 The KDE developers.<br/>
Generated on Fri Jul 12 2013 16:49:41 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.3.1 written
by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, &copy;&nbsp;1997-2006
<p>
KDE's <a href="http://techbase.kde.org/Policies/Library_Documentation_Policy">Doxygen guidelines</a> are available online.
</p>
</div>
            </div>
          </div>
        </div>
        <div id="left">
          <div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kabc</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kabc"</a>
</div></div>
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="functions.html">Class Members</a></li><li><a href="files.html">File List</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
  <option value="classKABC_1_1Address.html">kabc::address</option>,  <option value="classKABC_1_1AddressBook.html">kabc::addressbook</option>,  <option value="classKABC_1_1AddressBook_1_1ConstIterator.html">kabc::addressbook::constiterator</option>,  <option value="classKABC_1_1AddressBook_1_1Iterator.html">kabc::addressbook::iterator</option>,  <option value="classKABC_1_1AddresseeDialog.html">kabc::addresseedialog</option>,  <option value="classKABC_1_1AddresseeHelper.html">kabc::addresseehelper</option>,  <option value="classKABC_1_1AddresseeItem.html">kabc::addresseeitem</option>,  <option value="classKABC_1_1AddresseeList.html">kabc::addresseelist</option>,  <option value="classKABC_1_1AddressLineEdit.html">kabc::addresslineedit</option>,  <option value="classKABC_1_1BinaryFormat.html">kabc::binaryformat</option>,  <option value="classKABC_1_1ConsoleErrorHandler.html">kabc::consoleerrorhandler</option>,  <option value="classKABC_1_1ContactGroup.html">kabc::contactgroup</option>,  <option value="classKABC_1_1ContactGroup_1_1ContactGroupReference.html">kabc::contactgroup::contactgroupreference</option>,  <option value="classKABC_1_1ContactGroup_1_1ContactReference.html">kabc::contactgroup::contactreference</option>,  <option value="classKABC_1_1ContactGroup_1_1Data.html">kabc::contactgroup::data</option>,  <option value="classKABC_1_1DistributionList.html">kabc::distributionlist</option>,  <option value="classKABC_1_1DistributionList_1_1Entry.html">kabc::distributionlist::entry</option>,  <option value="classKABC_1_1DistributionListDialog.html">kabc::distributionlistdialog</option>,  <option value="classKABC_1_1DistributionListEditorWidget.html">kabc::distributionlisteditorwidget</option>,  <option value="classKABC_1_1EmailSelector.html">kabc::emailselector</option>,  <option value="classKABC_1_1ErrorHandler.html">kabc::errorhandler</option>,  <option value="classKABC_1_1Field.html">kabc::field</option>,  <option value="classKABC_1_1FieldSortMode.html">kabc::fieldsortmode</option>,  <option value="classKABC_1_1Format.html">kabc::format</option>,  <option value="classKABC_1_1FormatFactory.html">kabc::formatfactory</option>,  <option value="classKABC_1_1Geo.html">kabc::geo</option>,  <option value="classKABC_1_1GuiErrorHandler.html">kabc::guierrorhandler</option>,  <option value="classKABC_1_1Key.html">kabc::key</option>,  <option value="classKABC_1_1Lock.html">kabc::lock</option>,  <option value="classKABC_1_1LockNull.html">kabc::locknull</option>,  <option value="classKABC_1_1NameSortMode.html">kabc::namesortmode</option>,  <option value="classKABC_1_1PhoneNumber.html">kabc::phonenumber</option>,  <option value="classKABC_1_1Picture.html">kabc::picture</option>,  <option value="classKABC_1_1Plugin.html">kabc::plugin</option>,  <option value="classKABC_1_1Resource.html">kabc::resource</option>,  <option value="classKABC_1_1Resource_1_1ConstIterator.html">kabc::resource::constiterator</option>,  <option value="classKABC_1_1ResourceABC.html">kabc::resourceabc</option>,  <option value="classKABC_1_1ResourceDir.html">kabc::resourcedir</option>,  <option value="classKABC_1_1ResourceFile.html">kabc::resourcefile</option>,  <option value="classKABC_1_1ResourceNet.html">kabc::resourcenet</option>,  <option value="classKABC_1_1SortMode.html">kabc::sortmode</option>,  <option value="classKABC_1_1Sound.html">kabc::sound</option>,  <option value="classKABC_1_1StdAddressBook.html">kabc::stdaddressbook</option>,  <option value="classKABC_1_1Ticket.html">kabc::ticket</option>,  <option value="classKABC_1_1TimeZone.html">kabc::timezone</option>,  <option value="classKABC_1_1VCardConverter.html">kabc::vcardconverter</option>,  <option value="classKABC_1_1VCardFormat.html">kabc::vcardformat</option>,  <option value="classLdif.html">ldif</option>,
</select>
</form>
</div>
-->
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kdepimlibs-4.10.5 API Reference</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kdepimlibs-4.10.5 API Reference"</a>
</div></div>
<div class="nav_list">
<ul>
<li><a href="../../akonadi/html/index.html">akonadi</a></li><li>&nbsp;&nbsp;<a href="../../akonadi/contact/html/index.html">contact</a></li><li>&nbsp;&nbsp;<a href="../../akonadi/kmime/html/index.html">kmime</a></li><li>&nbsp;&nbsp;<a href="../../akonadi/socialutils/html/index.html">socialutils</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kalarmcal/html/index.html">kalarmcal</a></li><li><a href="../../kblog/html/index.html">kblog</a></li><li><a href="../../kcal/html/index.html">kcal</a></li><li><a href="../../kcalcore/html/index.html">kcalcore</a></li><li><a href="../../kcalutils/html/index.html">kcalutils</a></li><li><a href="../../kholidays/html/index.html">kholidays</a></li><li><a href="../../kimap/html/index.html">kimap</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li>&nbsp;&nbsp;<a href="../../kioslave/imap4/html/index.html">imap4</a></li><li>&nbsp;&nbsp;<a href="../../kioslave/mbox/html/index.html">mbox</a></li><li>&nbsp;&nbsp;<a href="../../kioslave/nntp/html/index.html">nntp</a></li><li><a href="../../kldap/html/index.html">kldap</a></li><li><a href="../../kmbox/html/index.html">kmbox</a></li><li><a href="../../kmime/html/index.html">kmime</a></li><li><a href="../../kontactinterface/html/index.html">kontactinterface</a></li><li><a href="../../kpimidentities/html/index.html">kpimidentities</a></li><li><a href="../../kpimtextedit/html/index.html">kpimtextedit</a></li><li><a href="../../kpimutils/html/index.html">kpimutils</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../ktnef/html/index.html">ktnef</a></li><li><a href="../../kxmlrpcclient/html/index.html">kxmlrpcclient</a></li><li><a href="../../mailtransport/html/index.html">mailtransport</a></li><li><a href="../../microblog/html/index.html">microblog</a></li><li><a href="../../qgpgme/html/index.html">qgpgme</a></li><li><a href="../../syndication/html/index.html">syndication</a></li><li>&nbsp;&nbsp;<a href="../../syndication/atom/html/index.html">atom</a></li><li>&nbsp;&nbsp;<a href="../../syndication/rdf/html/index.html">rdf</a></li><li>&nbsp;&nbsp;<a href="../../syndication/rss2/html/index.html">rss2</a></li>
</ul></div></div>
<!-- api_searchbox -->
          </div>
        </div>
        <div class="clearer"></div>
      </div>
      <div class="clearer"></div>
    </div>
    <div id="end_body"></div>
    <div id="footer"><div id="footer_text">
    Report problems with this website to <a href="https://bugs.kde.org/enter_sysadmin_request.cgi?component=api.kde.org">our bug tracking system</a>.<br>
    Contact the specific authors with questions and comments about the page contents.<p>
    KDE<sup>&#174;</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
        <a href="http://www.kde.org/contact/impressum.php">Legal</a></p>
    </div></div>
  </div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a>
WARNING END
-->
</body>
</html>