KABC::NameSortMode Class Reference

Implements comparison by name. More...

#include <sortmode.h>

Inheritance diagram for KABC::NameSortMode:

List of all members.

Public Types

enum  NameType { FormattedName, FamilyName, GivenName }

Public Member Functions

 NameSortMode (NameType type, bool ascending=true)
 NameSortMode ()
virtual bool lesser (const KABC::Addressee &first, const KABC::Addressee &second) const

Detailed Description

Implements comparison by name.

This class implements a comparison of two Addressee objects by name.

Definition at line 54 of file sortmode.h.


Member Enumeration Documentation

Specifies which parts of the name are used for comparison.

Enumerator:
FormattedName 

use the formatted name, e.g.

"John Doe"

FamilyName 

use the last name, e.g.

"Doe"

GivenName 

use the first name, e.g.

"John"

Definition at line 60 of file sortmode.h.


Constructor & Destructor Documentation

NameSortMode::NameSortMode (  ) 

Constructor.

Creates a NameSortMethod with FormattedName as name type set.

Definition at line 37 of file sortmode.cpp.

NameSortMode::NameSortMode ( NameType  type,
bool  ascending = true 
) [explicit]

Constructor.

Creates a NameSortMethod with the specified name type.

Parameters:
type The name type.
ascending if true, Addressee object are sorted in ascending order; if false, objects are sorted in descending order

Definition at line 44 of file sortmode.cpp.


Member Function Documentation

bool NameSortMode::lesser ( const KABC::Addressee &  first,
const KABC::Addressee &  second 
) const [virtual]

Returns whether the first contact is 'smaller' then the second.

Implements KABC::SortMode.

Definition at line 56 of file sortmode.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys