summaryrefslogtreecommitdiffabout
path: root/kabc/phonenumber.h
Unidiff
Diffstat (limited to 'kabc/phonenumber.h') (more/less context) (ignore whitespace changes)
-rw-r--r--kabc/phonenumber.h1
1 files changed, 1 insertions, 0 deletions
diff --git a/kabc/phonenumber.h b/kabc/phonenumber.h
index 410a52f..2d4d3e0 100644
--- a/kabc/phonenumber.h
+++ b/kabc/phonenumber.h
@@ -1,168 +1,169 @@
1/* 1/*
2 This file is part of libkabc. 2 This file is part of libkabc.
3 Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org> 3 Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org>
4 4
5 This library is free software; you can redistribute it and/or 5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public 6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either 7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version. 8 version 2 of the License, or (at your option) any later version.
9 9
10 This library is distributed in the hope that it will be useful, 10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of 11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details. 13 Library General Public License for more details.
14 14
15 You should have received a copy of the GNU Library General Public License 15 You should have received a copy of the GNU Library General Public License
16 along with this library; see the file COPYING.LIB. If not, write to 16 along with this library; see the file COPYING.LIB. If not, write to
17 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 17 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA. 18 Boston, MA 02111-1307, USA.
19*/ 19*/
20 20
21/* 21/*
22Enhanced Version of the file for platform independent KDE tools. 22Enhanced Version of the file for platform independent KDE tools.
23Copyright (c) 2004 Ulf Schenk 23Copyright (c) 2004 Ulf Schenk
24 24
25$Id$ 25$Id$
26*/ 26*/
27 27
28#ifndef KABC_PHONENUMBER_H 28#ifndef KABC_PHONENUMBER_H
29#define KABC_PHONENUMBER_H 29#define KABC_PHONENUMBER_H
30 30
31#include <qvaluelist.h> 31#include <qvaluelist.h>
32#include <qstring.h> 32#include <qstring.h>
33 33
34namespace KABC { 34namespace KABC {
35 35
36/** 36/**
37 @short Phonenumber information. 37 @short Phonenumber information.
38 38
39 This class provides phone number information. A phone number is classified by 39 This class provides phone number information. A phone number is classified by
40 a type. The following types are available, it's possible to use multiple types 40 a type. The following types are available, it's possible to use multiple types
41 @ref Types for a number by combining them through a logical or. 41 @ref Types for a number by combining them through a logical or.
42*/ 42*/
43class PhoneNumber 43class PhoneNumber
44{ 44{
45 friend QDataStream &operator<<( QDataStream &, const PhoneNumber & ); 45 friend QDataStream &operator<<( QDataStream &, const PhoneNumber & );
46 friend QDataStream &operator>>( QDataStream &, PhoneNumber & ); 46 friend QDataStream &operator>>( QDataStream &, PhoneNumber & );
47 47
48 public: 48 public:
49 typedef QValueList<PhoneNumber> List; 49 typedef QValueList<PhoneNumber> List;
50 typedef QValueList<int> TypeList; 50 typedef QValueList<int> TypeList;
51 51
52 /** 52 /**
53 @li @p Home - Home number 53 @li @p Home - Home number
54 @li @p Work - Office number 54 @li @p Work - Office number
55 @li @p Msg - Messaging 55 @li @p Msg - Messaging
56 @li @p Pref - Preferred number 56 @li @p Pref - Preferred number
57 @li @p Voice - Voice 57 @li @p Voice - Voice
58 @li @p Fax - Fax machine 58 @li @p Fax - Fax machine
59 @li @p Cell - Cell phone 59 @li @p Cell - Cell phone
60 @li @p Video - Video phone 60 @li @p Video - Video phone
61 @li @p Bbs - Mailbox 61 @li @p Bbs - Mailbox
62 @li @p Modem - Modem 62 @li @p Modem - Modem
63 @li @p Car - Car phone 63 @li @p Car - Car phone
64 @li @p Isdn - ISDN connection 64 @li @p Isdn - ISDN connection
65 @li @p Pcs - Personal Communication Service 65 @li @p Pcs - Personal Communication Service
66 @li @p Pager - Pager 66 @li @p Pager - Pager
67 @li @p SIP - VoIP 67 @li @p SIP - VoIP
68 */ 68 */
69 enum Types { Home = 1, Work = 2, Msg = 4, Pref = 8, Voice = 16, Fax = 32, 69 enum Types { Home = 1, Work = 2, Msg = 4, Pref = 8, Voice = 16, Fax = 32,
70 Cell = 64, Video = 128, Bbs = 256, Modem = 512, Car = 1024, 70 Cell = 64, Video = 128, Bbs = 256, Modem = 512, Car = 1024,
71 Isdn = 2048, Pcs = 4096, Pager = 8192, Sip = 16384 }; 71 Isdn = 2048, Pcs = 4096, Pager = 8192, Sip = 16384 };
72 72
73 /** 73 /**
74 Create an empty phone number object. 74 Create an empty phone number object.
75 */ 75 */
76 PhoneNumber(); 76 PhoneNumber();
77 77
78 /** 78 /**
79 Create a phonenumber object. 79 Create a phonenumber object.
80 80
81 @param number Number 81 @param number Number
82 @param type Type as defined in enum. Multiple types can be 82 @param type Type as defined in enum. Multiple types can be
83 specified by combining them by a logical or. 83 specified by combining them by a logical or.
84 */ 84 */
85 PhoneNumber( const QString &number, int type = Home ); 85 PhoneNumber( const QString &number, int type = Home );
86 86
87 /** 87 /**
88 Destructor. 88 Destructor.
89 */ 89 */
90 ~PhoneNumber(); 90 ~PhoneNumber();
91 91
92 bool operator==( const PhoneNumber & ) const; 92 bool operator==( const PhoneNumber & ) const;
93 bool operator!=( const PhoneNumber & ) const; 93 bool operator!=( const PhoneNumber & ) const;
94 94
95 bool contains( const PhoneNumber &p );
95 /** 96 /**
96 Sets the unique identifier. 97 Sets the unique identifier.
97 */ 98 */
98 void setId( const QString &id ); 99 void setId( const QString &id );
99 100
100 /** 101 /**
101 Returns the unique identifier. 102 Returns the unique identifier.
102 */ 103 */
103 QString id() const; 104 QString id() const;
104 105
105 /** 106 /**
106 Sets the number. 107 Sets the number.
107 */ 108 */
108 void setNumber( const QString & ); 109 void setNumber( const QString & );
109 110
110 /** 111 /**
111 Returns the number. 112 Returns the number.
112 */ 113 */
113 QString number() const; 114 QString number() const;
114 115
115 /** 116 /**
116 Sets the type. Multiple types can be specified by combining them by 117 Sets the type. Multiple types can be specified by combining them by
117 a logical or. 118 a logical or.
118 */ 119 */
119 void setType( int ); 120 void setType( int );
120 121
121 /** 122 /**
122 Returns the type. Can be a multiple types combined by a logical or. 123 Returns the type. Can be a multiple types combined by a logical or.
123 */ 124 */
124 int type() const; 125 int type() const;
125 126
126 /** 127 /**
127 Returns a translated string of all types the address has. 128 Returns a translated string of all types the address has.
128 */ 129 */
129 QString typeLabel() const; 130 QString typeLabel() const;
130 131
131 /** 132 /**
132 Returns the translated label for phone number depending on its type. 133 Returns the translated label for phone number depending on its type.
133 */ 134 */
134 QString label() const; 135 QString label() const;
135 136
136 /** 137 /**
137 Returns a list of all available types 138 Returns a list of all available types
138 */ 139 */
139 static TypeList typeList(); 140 static TypeList typeList();
140 141
141 /** 142 /**
142 Returns the translated label for phone number type. 143 Returns the translated label for phone number type.
143 */ 144 */
144 static QString typeLabel( int type ); 145 static QString typeLabel( int type );
145 146
146 /** 147 /**
147 Returns the translated label for phone number type. 148 Returns the translated label for phone number type.
148 @obsolete 149 @obsolete
149 */ 150 */
150 static QString label( int type ); 151 static QString label( int type );
151 bool simplifyNumber(); 152 bool simplifyNumber();
152 void simplifyType(); 153 void simplifyType();
153 154
154 private: 155 private:
155 void init(); 156 void init();
156 157
157 QString mId; 158 QString mId;
158 159
159 int mType; 160 int mType;
160 QString mNumber; 161 QString mNumber;
161}; 162};
162 163
163QDataStream &operator<<( QDataStream &, const PhoneNumber & ); 164QDataStream &operator<<( QDataStream &, const PhoneNumber & );
164QDataStream &operator>>( QDataStream &, PhoneNumber & ); 165QDataStream &operator>>( QDataStream &, PhoneNumber & );
165 166
166} 167}
167 168
168#endif 169#endif