-rw-r--r-- | kabc/resource.h | 16 |
1 files changed, 1 insertions, 15 deletions
diff --git a/kabc/resource.h b/kabc/resource.h index 2024d2d..e5f0d5d 100644 --- a/kabc/resource.h +++ b/kabc/resource.h | |||
@@ -1,171 +1,157 @@ | |||
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 | /* |
22 | Enhanced Version of the file for platform independent KDE tools. | 22 | Enhanced Version of the file for platform independent KDE tools. |
23 | Copyright (c) 2004 Ulf Schenk | 23 | Copyright (c) 2004 Ulf Schenk |
24 | 24 | ||
25 | $Id$ | 25 | $Id$ |
26 | */ | 26 | */ |
27 | 27 | ||
28 | #ifndef KABC_RESOURCE_H | 28 | #ifndef KABC_RESOURCE_H |
29 | #define KABC_RESOURCE_H | 29 | #define KABC_RESOURCE_H |
30 | 30 | ||
31 | #include <kresources/resource.h> | 31 | #include <kresources/resource.h> |
32 | 32 | ||
33 | 33 | ||
34 | #include "addressbook.h" | 34 | #include "addressbook.h" |
35 | 35 | ||
36 | class KSyncProfile; | ||
37 | |||
38 | namespace KABC { | 36 | namespace KABC { |
39 | 37 | ||
40 | /** | 38 | /** |
41 | * @short Helper class for handling coordinated save of address books. | 39 | * @short Helper class for handling coordinated save of address books. |
42 | * | 40 | * |
43 | * This class is used as helper class for saving address book. | 41 | * This class is used as helper class for saving address book. |
44 | * @see requestSaveTicket(), save(). | 42 | * @see requestSaveTicket(), save(). |
45 | */ | 43 | */ |
46 | class Ticket | 44 | class Ticket |
47 | { | 45 | { |
48 | friend class Resource; | 46 | friend class Resource; |
49 | public: | 47 | public: |
50 | Resource *resource() { return mResource; } | 48 | Resource *resource() { return mResource; } |
51 | 49 | ||
52 | private: | 50 | private: |
53 | Ticket( Resource *resource ) : mResource( resource ) {} | 51 | Ticket( Resource *resource ) : mResource( resource ) {} |
54 | 52 | ||
55 | Resource *mResource; | 53 | Resource *mResource; |
56 | }; | 54 | }; |
57 | 55 | ||
58 | /** | 56 | /** |
59 | * @internal | 57 | * @internal |
60 | */ | 58 | */ |
61 | class Resource : public KRES::Resource | 59 | class Resource : public KRES::Resource |
62 | { | 60 | { |
63 | private: | ||
64 | /** | ||
65 | * make this constructor private to force everybody to use the other one | ||
66 | */ | ||
67 | Resource( const KConfig *config); | ||
68 | |||
69 | public: | 61 | public: |
70 | /** | 62 | /** |
71 | * Constructor | 63 | * Constructor |
72 | */ | 64 | */ |
73 | Resource( const KConfig *config, bool syncable ); | 65 | Resource( const KConfig *config ); |
74 | 66 | ||
75 | /** | 67 | /** |
76 | * Destructor. | 68 | * Destructor. |
77 | */ | 69 | */ |
78 | virtual ~Resource(); | 70 | virtual ~Resource(); |
79 | 71 | ||
80 | /** | 72 | /** |
81 | * Sets the address book of the resource. | 73 | * Sets the address book of the resource. |
82 | */ | 74 | */ |
83 | void setAddressBook( AddressBook* ); | 75 | void setAddressBook( AddressBook* ); |
84 | 76 | ||
85 | /** | 77 | /** |
86 | * Returns a pointer to the addressbook. | 78 | * Returns a pointer to the addressbook. |
87 | */ | 79 | */ |
88 | AddressBook *addressBook(); | 80 | AddressBook *addressBook(); |
89 | 81 | ||
90 | /** | 82 | /** |
91 | * Writes the resource specific config to file. | 83 | * Writes the resource specific config to file. |
92 | */ | 84 | */ |
93 | virtual void writeConfig( KConfig *config ); | 85 | virtual void writeConfig( KConfig *config ); |
94 | 86 | ||
95 | /** | 87 | /** |
96 | * Open the resource and returns if it was successfully | 88 | * Open the resource and returns if it was successfully |
97 | */ | 89 | */ |
98 | virtual bool doOpen(); | 90 | virtual bool doOpen(); |
99 | 91 | ||
100 | 92 | ||
101 | /** | 93 | /** |
102 | * Request a ticket, you have to pass through @ref save() to | 94 | * Request a ticket, you have to pass through @ref save() to |
103 | * allow locking. | 95 | * allow locking. |
104 | */ | 96 | */ |
105 | virtual Ticket *requestSaveTicket(); | 97 | virtual Ticket *requestSaveTicket(); |
106 | 98 | ||
107 | /** | 99 | /** |
108 | * Load all addressees to the addressbook | 100 | * Load all addressees to the addressbook |
109 | */ | 101 | */ |
110 | virtual bool load(); | 102 | virtual bool load(); |
111 | 103 | ||
112 | /** | 104 | /** |
113 | * Save all addressees to the addressbook. | 105 | * Save all addressees to the addressbook. |
114 | * | 106 | * |
115 | * @param ticket The ticket you get by @ref requestSaveTicket() | 107 | * @param ticket The ticket you get by @ref requestSaveTicket() |
116 | */ | 108 | */ |
117 | virtual bool save( Ticket *ticket ); | 109 | virtual bool save( Ticket *ticket ); |
118 | 110 | ||
119 | /** | 111 | /** |
120 | * Removes a addressee from resource. This method is mainly | 112 | * Removes a addressee from resource. This method is mainly |
121 | * used by record-based resources like LDAP or SQL. | 113 | * used by record-based resources like LDAP or SQL. |
122 | */ | 114 | */ |
123 | virtual void removeAddressee( const Addressee& addr ); | 115 | virtual void removeAddressee( const Addressee& addr ); |
124 | 116 | ||
125 | 117 | ||
126 | /** | 118 | /** |
127 | * This method is called by an error handler if the application | 119 | * This method is called by an error handler if the application |
128 | * crashed | 120 | * crashed |
129 | */ | 121 | */ |
130 | virtual void cleanUp(); | 122 | virtual void cleanUp(); |
131 | 123 | ||
132 | /** | 124 | /** |
133 | * Set name of file to be used for saving. | 125 | * Set name of file to be used for saving. |
134 | */ | 126 | */ |
135 | virtual void setFileName( const QString & ); | 127 | virtual void setFileName( const QString & ); |
136 | 128 | ||
137 | /** | 129 | /** |
138 | * Return name of file used for loading and saving the address book. | 130 | * Return name of file used for loading and saving the address book. |
139 | */ | 131 | */ |
140 | virtual QString fileName() const; | 132 | virtual QString fileName() const; |
141 | 133 | ||
142 | |||
143 | virtual bool isSyncable() const; | ||
144 | |||
145 | virtual KSyncProfile* getSyncProfile(); | ||
146 | |||
147 | /** | 134 | /** |
148 | * Set the name of resource.You can override this method, | 135 | * Set the name of resource.You can override this method, |
149 | * but also remember to call Resource::setResourceName(). | 136 | * but also remember to call Resource::setResourceName(). |
150 | */ | 137 | */ |
151 | virtual void setResourceName( const QString &name ); | 138 | virtual void setResourceName( const QString &name ); |
152 | 139 | ||
153 | 140 | ||
154 | 141 | ||
155 | protected: | 142 | protected: |
156 | Ticket *createTicket( Resource * ); | 143 | Ticket *createTicket( Resource * ); |
157 | virtual void doClose(); | 144 | virtual void doClose(); |
158 | 145 | ||
159 | private: | 146 | private: |
160 | AddressBook *mAddressBook; | 147 | AddressBook *mAddressBook; |
161 | KSyncProfile *mSyncProfile; | ||
162 | QString mFileName; | 148 | QString mFileName; |
163 | 149 | ||
164 | }; | 150 | }; |
165 | 151 | ||
166 | 152 | ||
167 | } | 153 | } |
168 | 154 | ||
169 | 155 | ||
170 | 156 | ||
171 | #endif | 157 | #endif |