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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/*
This file is part of libkabc.
Copyright (c) 2001 Cornelius Schumacher <[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_STDADDRESSBOOK_H
#define KABC_STDADDRESSBOOK_H
#include "addressbook.h"
namespace KABC {
/**
Standard KDE address book
This class provides access to the standard KDE address book shared by all
applications.
It's implemented as a singleton. Use self() to get the address book
object. On the first self() call the address book also gets loaded.
Example:
\code
KABC::AddressBook *ab = KABC::StdAddressBook::self();
AddressBook::Ticket *ticket = ab->requestSaveTicket();
if ( ticket ) {
KABC::AddressBook::Iterator it;
for ( it = ab->begin(); it != ab->end(); ++it ) {
kdDebug() << "UID=" << (*it).uid() << endl;
// do some other stuff
}
KABC::StdAddressBook::save( ticket );
}
\endcode
*/
class KABC_EXPORT StdAddressBook : public AddressBook
{
public:
/**
Destructor.
*/
~StdAddressBook();
/**
Returns the standard addressbook object. It also loads all resources of
the users standard address book synchronously.
*/
static StdAddressBook *self();
/**
This is the same as above, but with specified behaviour of resource loading.
@param asynchronous When true, the resources are loaded asynchronous, that
means you have the data foremost the addressBookChanged()
signal has been emitted. So connect to this signal when
using this method!
*/
static StdAddressBook *self( bool asynchronous );
/**
Saves the standard address book to disk.
@deprecated Use AddressBook::save( Ticket* ) instead
*/
static bool save() KDE_DEPRECATED;
/**
@deprecated There is no need to call this function anymore.
*/
static void handleCrash() KDE_DEPRECATED;
/**
Returns the default file name for vcard-based addressbook
*/
static QString fileName();
/**
Returns the default directory name for vcard-based addressbook
*/
static QString directoryName();
/**
Sets the automatic save property of the address book.
@param state If true, the address book is saved automatically
at destruction time, otherwise you have to call
AddressBook::save( Ticket* ).
*/
static void setAutomaticSave( bool state );
/**
Closes the address book. Depending on automaticSave() it will
save the address book first.
*/
static void close();
/**
Returns whether the address book is saved at destruction time.
See also setAutomaticSave().
*/
static bool automaticSave();
/**
Returns the contact, that is associated with the owner of the
address book. This contact should be used by other programs
to access user specific data.
*/
Addressee whoAmI();
/**
Sets the users contact. See whoAmI() for more information.
@param addr The users contact.
*/
void setWhoAmI( const Addressee &addr );
protected:
StdAddressBook();
StdAddressBook( bool asynchronous );
void init( bool asynchronous );
bool saveAll();
private:
static StdAddressBook *mSelf;
static bool mAutomaticSave;
};
}
#endif
|
