---

KABC::AddresseeList Class Reference

a QValueList of Addressee, with sorting functionality More...

#include <addresseelist.h>

Inheritance diagram for KABC::AddresseeList:

List of all members.

Public Methods
void	dump () const
void	setReverseSorting (bool r=true)
bool	reverseSorting () const
void	sortBy (SortingCriterion c)
void	sort ()
template<class Trait> void	sortByTrait ()
SortingCriterion	sortingCriterion () const

---

Detailed Description

a QValueList of Addressee, with sorting functionality

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.

An AddresseeList 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 or {@link #sortBy to create a defined order again.

Iterator usage is inherited by QValueList and extensively documented there. Please remember that the state of an iterator is undefined after any sorting operation.

For the enumeration Type SortingCriterion, which specifies the field by the collection will be sorted, the following values exist: Uid, Name, FormattedName, FamilyName, GivenName.

Author:

Jost Schenck jost@schenck.de

Definition at line 108 of file addresseelist.h.

---

Member Function Documentation

void KABC::AddresseeList::dump (    )

Debug output.

bool KABC::AddresseeList::reverseSorting (    )  const [inline]

Returns the direction of sorting. Returns: true if sorting is done reverse, false otherwise Definition at line 132 of file addresseelist.h.

void KABC::AddresseeList::setReverseSorting (  bool    r = true )  [inline]

Determines the direction of sorting. On change, the list will not automatically be resorted. Parameters: r  true if sorting should be done reverse, false otherwise Definition at line 126 of file addresseelist.h.

void KABC::AddresseeList::sort (    )

Sorts this list by its active sorting criterion. This normally is the criterion of the last sortBy operation or FormattedName if up to now there has been no sortBy operation. Please note that the sorting trait of the last

void KABC::AddresseeList::sortBy (  SortingCriterion    c )

Sorts this list by a specific criterion. Parameters: c  the criterion by which should be sorted

template<class Trait> void KABC::AddresseeList::sortByTrait (    )

Templated sort function. You normally will not want to use this but and {@link #sort instead as the existing sorting criteria completely suffice for most cases. 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: class MySortingTrait { public: // eq returns true if a1 and a2 are equal static bool eq(KABC::Addressee a1, KABC::Addressee a2); // lt returns true is a1 is "less than" a2 static bool lt(KABC::Addressee a1, KABC::Addressee a2); }; You can then pass this class to the sortByTrait method like this: myAddresseelist.sortByTrait<MySortingTrait>(); Please note that the

SortingCriterion KABC::AddresseeList::sortingCriterion (    )  const [inline]

Returns the active sorting criterion, ie the sorting criterion that will be used by a Definition at line 186 of file addresseelist.h.

---

The documentation for this class was generated from the following file:

• addresseelist.h

---