-rw-r--r-- | kabc/addressbook.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/kabc/addressbook.h b/kabc/addressbook.h index 532e05d..cc755d1 100644 --- a/kabc/addressbook.h +++ b/kabc/addressbook.h | |||
@@ -49,192 +49,195 @@ class Ticket; | |||
49 | */ | 49 | */ |
50 | class AddressBook : public QObject | 50 | class AddressBook : public QObject |
51 | { | 51 | { |
52 | Q_OBJECT | 52 | Q_OBJECT |
53 | 53 | ||
54 | friend QDataStream &operator<<( QDataStream &, const AddressBook & ); | 54 | friend QDataStream &operator<<( QDataStream &, const AddressBook & ); |
55 | friend QDataStream &operator>>( QDataStream &, AddressBook & ); | 55 | friend QDataStream &operator>>( QDataStream &, AddressBook & ); |
56 | friend class StdAddressBook; | 56 | friend class StdAddressBook; |
57 | 57 | ||
58 | public: | 58 | public: |
59 | /** | 59 | /** |
60 | @short Address Book Iterator | 60 | @short Address Book Iterator |
61 | 61 | ||
62 | This class provides an iterator for address book entries. | 62 | This class provides an iterator for address book entries. |
63 | */ | 63 | */ |
64 | class Iterator | 64 | class Iterator |
65 | { | 65 | { |
66 | public: | 66 | public: |
67 | Iterator(); | 67 | Iterator(); |
68 | Iterator( const Iterator & ); | 68 | Iterator( const Iterator & ); |
69 | ~Iterator(); | 69 | ~Iterator(); |
70 | 70 | ||
71 | Iterator &operator=( const Iterator & ); | 71 | Iterator &operator=( const Iterator & ); |
72 | const Addressee &operator*() const; | 72 | const Addressee &operator*() const; |
73 | Addressee &operator*(); | 73 | Addressee &operator*(); |
74 | Addressee* operator->(); | 74 | Addressee* operator->(); |
75 | Iterator &operator++(); | 75 | Iterator &operator++(); |
76 | Iterator &operator++(int); | 76 | Iterator &operator++(int); |
77 | Iterator &operator--(); | 77 | Iterator &operator--(); |
78 | Iterator &operator--(int); | 78 | Iterator &operator--(int); |
79 | bool operator==( const Iterator &it ); | 79 | bool operator==( const Iterator &it ); |
80 | bool operator!=( const Iterator &it ); | 80 | bool operator!=( const Iterator &it ); |
81 | 81 | ||
82 | struct IteratorData; | 82 | struct IteratorData; |
83 | IteratorData *d; | 83 | IteratorData *d; |
84 | }; | 84 | }; |
85 | 85 | ||
86 | /** | 86 | /** |
87 | @short Address Book Const Iterator | 87 | @short Address Book Const Iterator |
88 | 88 | ||
89 | This class provides a const iterator for address book entries. | 89 | This class provides a const iterator for address book entries. |
90 | */ | 90 | */ |
91 | class ConstIterator | 91 | class ConstIterator |
92 | { | 92 | { |
93 | public: | 93 | public: |
94 | ConstIterator(); | 94 | ConstIterator(); |
95 | ConstIterator( const ConstIterator & ); | 95 | ConstIterator( const ConstIterator & ); |
96 | ~ConstIterator(); | 96 | ~ConstIterator(); |
97 | 97 | ||
98 | ConstIterator &operator=( const ConstIterator & ); | 98 | ConstIterator &operator=( const ConstIterator & ); |
99 | const Addressee &operator*() const; | 99 | const Addressee &operator*() const; |
100 | const Addressee* operator->() const; | 100 | const Addressee* operator->() const; |
101 | ConstIterator &operator++(); | 101 | ConstIterator &operator++(); |
102 | ConstIterator &operator++(int); | 102 | ConstIterator &operator++(int); |
103 | ConstIterator &operator--(); | 103 | ConstIterator &operator--(); |
104 | ConstIterator &operator--(int); | 104 | ConstIterator &operator--(int); |
105 | bool operator==( const ConstIterator &it ); | 105 | bool operator==( const ConstIterator &it ); |
106 | bool operator!=( const ConstIterator &it ); | 106 | bool operator!=( const ConstIterator &it ); |
107 | 107 | ||
108 | struct ConstIteratorData; | 108 | struct ConstIteratorData; |
109 | ConstIteratorData *d; | 109 | ConstIteratorData *d; |
110 | }; | 110 | }; |
111 | 111 | ||
112 | /** | 112 | /** |
113 | Constructs a address book object. | 113 | Constructs a address book object. |
114 | 114 | ||
115 | @param format File format class. | 115 | @param format File format class. |
116 | */ | 116 | */ |
117 | AddressBook(); | 117 | AddressBook(); |
118 | AddressBook( const QString &config ); | 118 | AddressBook( const QString &config ); |
119 | AddressBook( const QString &config, const QString &family ); | 119 | AddressBook( const QString &config, const QString &family ); |
120 | virtual ~AddressBook(); | 120 | virtual ~AddressBook(); |
121 | 121 | ||
122 | /** | 122 | /** |
123 | Requests a ticket for saving the addressbook. Calling this function locks | 123 | Requests a ticket for saving the addressbook. Calling this function locks |
124 | the addressbook for all other processes. If the address book is already | 124 | the addressbook for all other processes. If the address book is already |
125 | locked the function returns 0. You need the returned @ref Ticket object | 125 | locked the function returns 0. You need the returned @ref Ticket object |
126 | for calling the @ref save() function. | 126 | for calling the @ref save() function. |
127 | 127 | ||
128 | @see save() | 128 | @see save() |
129 | */ | 129 | */ |
130 | Ticket *requestSaveTicket( Resource *resource=0 ); | 130 | Ticket *requestSaveTicket( Resource *resource=0 ); |
131 | 131 | ||
132 | /** | 132 | /** |
133 | Load address book from file. | 133 | Load address book from file. |
134 | */ | 134 | */ |
135 | bool load(); | 135 | bool load(); |
136 | 136 | ||
137 | /** | 137 | /** |
138 | Save address book. The address book is saved to the file, the Ticket | 138 | Save address book. The address book is saved to the file, the Ticket |
139 | object has been requested for by @ref requestSaveTicket(). | 139 | object has been requested for by @ref requestSaveTicket(). |
140 | 140 | ||
141 | @param ticket a ticket object returned by @ref requestSaveTicket() | 141 | @param ticket a ticket object returned by @ref requestSaveTicket() |
142 | */ | 142 | */ |
143 | bool save( Ticket *ticket ); | 143 | bool save( Ticket *ticket ); |
144 | bool saveAB( ); | 144 | bool saveAB( ); |
145 | bool saveABphone( QString fileName ); | ||
146 | void smplifyAddressees(); | ||
147 | void preparePhoneSync( QString currentSyncDevice, bool isPreSync ); | ||
145 | void export2File( QString fileName ); | 148 | void export2File( QString fileName ); |
146 | void importFromFile( QString fileName, bool replaceLabel = false, bool removeOld = false ); | 149 | void importFromFile( QString fileName, bool replaceLabel = false, bool removeOld = false ); |
147 | void setUntagged(); | 150 | void setUntagged(); |
148 | void removeUntagged(); | 151 | void removeUntagged(); |
149 | /** | 152 | /** |
150 | Returns a iterator for first entry of address book. | 153 | Returns a iterator for first entry of address book. |
151 | */ | 154 | */ |
152 | Iterator begin(); | 155 | Iterator begin(); |
153 | 156 | ||
154 | /** | 157 | /** |
155 | Returns a const iterator for first entry of address book. | 158 | Returns a const iterator for first entry of address book. |
156 | */ | 159 | */ |
157 | ConstIterator begin() const; | 160 | ConstIterator begin() const; |
158 | 161 | ||
159 | /** | 162 | /** |
160 | Returns a iterator for first entry of address book. | 163 | Returns a iterator for first entry of address book. |
161 | */ | 164 | */ |
162 | Iterator end(); | 165 | Iterator end(); |
163 | 166 | ||
164 | /** | 167 | /** |
165 | Returns a const iterator for first entry of address book. | 168 | Returns a const iterator for first entry of address book. |
166 | */ | 169 | */ |
167 | ConstIterator end() const; | 170 | ConstIterator end() const; |
168 | 171 | ||
169 | /** | 172 | /** |
170 | Removes all entries from address book. | 173 | Removes all entries from address book. |
171 | */ | 174 | */ |
172 | void clear(); | 175 | void clear(); |
173 | 176 | ||
174 | /** | 177 | /** |
175 | Insert an Addressee object into address book. If an object with the same | 178 | Insert an Addressee object into address book. If an object with the same |
176 | unique id already exists in the address book it it replaced by the new | 179 | unique id already exists in the address book it it replaced by the new |
177 | one. If not the new object is appended to the address book. | 180 | one. If not the new object is appended to the address book. |
178 | */ | 181 | */ |
179 | void insertAddressee( const Addressee &, bool setRev = true, bool takeResource = false); | 182 | void insertAddressee( const Addressee &, bool setRev = true, bool takeResource = false); |
180 | 183 | ||
181 | /** | 184 | /** |
182 | Removes entry from the address book. | 185 | Removes entry from the address book. |
183 | */ | 186 | */ |
184 | void removeAddressee( const Addressee & ); | 187 | void removeAddressee( const Addressee & ); |
185 | 188 | ||
186 | /** | 189 | /** |
187 | This is like @ref removeAddressee() just above, with the difference that | 190 | This is like @ref removeAddressee() just above, with the difference that |
188 | the first element is a iterator, returned by @ref begin(). | 191 | the first element is a iterator, returned by @ref begin(). |
189 | */ | 192 | */ |
190 | void removeAddressee( const Iterator & ); | 193 | void removeAddressee( const Iterator & ); |
191 | 194 | ||
192 | /** | 195 | /** |
193 | Find the specified entry in address book. Returns end(), if the entry | 196 | Find the specified entry in address book. Returns end(), if the entry |
194 | couldn't be found. | 197 | couldn't be found. |
195 | */ | 198 | */ |
196 | Iterator find( const Addressee & ); | 199 | Iterator find( const Addressee & ); |
197 | 200 | ||
198 | /** | 201 | /** |
199 | Find the entry specified by an unique id. Returns an empty Addressee | 202 | Find the entry specified by an unique id. Returns an empty Addressee |
200 | object, if the address book does not contain an entry with this id. | 203 | object, if the address book does not contain an entry with this id. |
201 | */ | 204 | */ |
202 | Addressee findByUid( const QString & ); | 205 | Addressee findByUid( const QString & ); |
203 | 206 | ||
204 | 207 | ||
205 | /** | 208 | /** |
206 | Returns a list of all addressees in the address book. This list can | 209 | Returns a list of all addressees in the address book. This list can |
207 | be sorted with @ref KABC::AddresseeList for example. | 210 | be sorted with @ref KABC::AddresseeList for example. |
208 | */ | 211 | */ |
209 | Addressee::List allAddressees(); | 212 | Addressee::List allAddressees(); |
210 | 213 | ||
211 | /** | 214 | /** |
212 | Find all entries with the specified name in the address book. Returns | 215 | Find all entries with the specified name in the address book. Returns |
213 | an empty list, if no entries could be found. | 216 | an empty list, if no entries could be found. |
214 | */ | 217 | */ |
215 | Addressee::List findByName( const QString & ); | 218 | Addressee::List findByName( const QString & ); |
216 | 219 | ||
217 | /** | 220 | /** |
218 | Find all entries with the specified email address in the address book. | 221 | Find all entries with the specified email address in the address book. |
219 | Returns an empty list, if no entries could be found. | 222 | Returns an empty list, if no entries could be found. |
220 | */ | 223 | */ |
221 | Addressee::List findByEmail( const QString & ); | 224 | Addressee::List findByEmail( const QString & ); |
222 | 225 | ||
223 | /** | 226 | /** |
224 | Find all entries wich have the specified category in the address book. | 227 | Find all entries wich have the specified category in the address book. |
225 | Returns an empty list, if no entries could be found. | 228 | Returns an empty list, if no entries could be found. |
226 | */ | 229 | */ |
227 | Addressee::List findByCategory( const QString & ); | 230 | Addressee::List findByCategory( const QString & ); |
228 | 231 | ||
229 | /** | 232 | /** |
230 | Return a string identifying this addressbook. | 233 | Return a string identifying this addressbook. |
231 | */ | 234 | */ |
232 | virtual QString identifier(); | 235 | virtual QString identifier(); |
233 | 236 | ||
234 | /** | 237 | /** |
235 | Used for debug output. | 238 | Used for debug output. |
236 | */ | 239 | */ |
237 | void dump() const; | 240 | void dump() const; |
238 | 241 | ||
239 | void emitAddressBookLocked() { emit addressBookLocked( this ); } | 242 | void emitAddressBookLocked() { emit addressBookLocked( this ); } |
240 | void emitAddressBookUnlocked() { emit addressBookUnlocked( this ); } | 243 | void emitAddressBookUnlocked() { emit addressBookUnlocked( this ); } |