1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*
This file is part of libkabc.
Copyright (c) 2004 Tobias Koenig <[email protected]>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KABC_SORTMODE_H
#define KABC_SORTMODE_H
#include <kdelibs_export.h>
#include <kabc/addressee.h>
namespace KABC {
/**
@short Sort method for sorting an addressee list.
This interface should be reimplemented by classes which shall act as
SortModes for KABC::AddresseeList.
*/
class KABC_EXPORT SortMode
{
public:
/**
Reimplement this method and return whether the first contact is 'smaller'
than the second.
*/
virtual bool lesser( const KABC::Addressee &first, const KABC::Addressee &second ) const = 0;
};
class KABC_EXPORT NameSortMode : public SortMode
{
public:
enum NameType
{
FormattedName,
FamilyName,
GivenName
};
/**
Constructor.
Creates a NameSortMethod with FormattedName as name type set.
*/
NameSortMode();
/**
Constructor.
Creates a NameSortMethod with the specified name type.
@param type The name type.
@param ascending true for ascending sort, false for descending.
*/
NameSortMode( NameType type, bool ascending = true );
/**
Returns whether the first contact is 'smaller' then the second.
*/
virtual bool lesser( const KABC::Addressee&, const KABC::Addressee& ) const;
private:
NameType mNameType;
bool mAscendingOrder;
class NameSortModePrivate;
NameSortModePrivate *d;
};
class KABC_EXPORT FieldSortMode : public SortMode
{
public:
/**
Constructor.
Creates a FieldSortMethod with the specified field.
@param field The field.
@param ascending true for ascending sort, false for descending.
*/
FieldSortMode( KABC::Field *field, bool ascending = true );
/**
Returns whether the first contact is 'smaller' then the second.
*/
virtual bool lesser( const KABC::Addressee&, const KABC::Addressee& ) const;
private:
KABC::Field *mField;
bool mAscendingOrder;
class FieldSortModePrivate;
FieldSortModePrivate *d;
};
}
#endif
|