KABC::AddresseeList Class Reference
a QValueList of Addressee, with sorting functionality More...
#include <addresseelist.h>
Inheritance diagram for KABC::AddresseeList:

Public Member Functions | |
AddresseeList (const AddresseeList &) | |
AddresseeList (const QValueList< Addressee > &) | |
void | dump () const |
void | setReverseSorting (bool r=true) |
bool | reverseSorting () const |
void | sortBy (SortingCriterion c) |
void | sortByField (Field *field=0) |
void | sort () |
template<class Trait> void | sortByTrait () |
SortingCriterion | sortingCriterion () const |
Field * | sortingField () const |
Detailed Description
a QValueList of Addressee, with sorting functionalityThis 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 sort or 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 110 of file addresseelist.h.
Member Function Documentation
|
Debug output. Definition at line 131 of file addresseelist.cpp. |
|
Determines the direction of sorting. On change, the list will not automatically be resorted.
|
|
Returns the direction of sorting.
|
|
Sorts this list by a specific criterion.
References endl(), and kdError(). Referenced by sort(). |
|
Sorts this list by a specific field. If no parameter is given, the last used Field object will be used.
References endl(), and kdWarning(). |
|
Sorts this list by its active sorting criterion.
This normally is the criterion of the last sortBy operation or Please note that the sorting trait of the last sortByTrait method call is not remembered and thus the action can not be repeated by this method. Definition at line 178 of file addresseelist.cpp. References sortBy(). |
|
Templated sort function. You normally will not want to use this but sortBy and 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); }; myAddresseelist.sortByTrait<MySortingTrait>(); sortByTrait action.Right now this method uses the bubble sort algorithm. This should be replaced for a better one when I have time. Definition at line 184 of file addresseelist.cpp. |
|
Returns the active sorting criterion, ie the sorting criterion that will be used by a sort call. Definition at line 193 of file addresseelist.h. References KABC::SortingCriterion. |
|
Returns the active sorting field, ie a pointer to the Field object which was used for the last sortByField operation. 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. Definition at line 237 of file addresseelist.cpp. |
The documentation for this class was generated from the following files: