Diffstat (limited to 'kabc/plugins/opie/resourceopie.h') (more/less context) (show whitespace changes)
-rw-r--r-- | kabc/plugins/opie/resourceopie.h | 149 |
1 files changed, 149 insertions, 0 deletions
diff --git a/kabc/plugins/opie/resourceopie.h b/kabc/plugins/opie/resourceopie.h new file mode 100644 index 0000000..d21272a --- a/dev/null +++ b/kabc/plugins/opie/resourceopie.h | |||
@@ -0,0 +1,149 @@ | |||
1 | /* | ||
2 | This file is part of libkabc. | ||
3 | Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org> | ||
4 | |||
5 | This library is free software; you can redistribute it and/or | ||
6 | modify it under the terms of the GNU Library General Public | ||
7 | License as published by the Free Software Foundation; either | ||
8 | version 2 of the License, or (at your option) any later version. | ||
9 | |||
10 | This library is distributed in the hope that it will be useful, | ||
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
13 | Library General Public License for more details. | ||
14 | |||
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 | ||
17 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | ||
18 | Boston, MA 02111-1307, USA. | ||
19 | */ | ||
20 | |||
21 | /* | ||
22 | Enhanced Version of the file for platform independent KDE tools. | ||
23 | Copyright (c) 2004 Ulf Schenk | ||
24 | |||
25 | $Id$ | ||
26 | */ | ||
27 | |||
28 | |||
29 | #ifndef KABC_RESOURCEOPIE_H | ||
30 | #define KABC_RESOURCEOPIE_H | ||
31 | |||
32 | #include <kconfig.h> | ||
33 | #include <kdirwatch.h> | ||
34 | |||
35 | #include <sys/types.h> | ||
36 | |||
37 | #include "resource.h" | ||
38 | |||
39 | class QTimer; | ||
40 | class FormatPlugin; | ||
41 | |||
42 | namespace KABC { | ||
43 | |||
44 | //US class FormatPlugin; | ||
45 | class ResourceConfigWidget; | ||
46 | |||
47 | /** | ||
48 | @internal | ||
49 | */ | ||
50 | class ResourceOpie : public Resource | ||
51 | { | ||
52 | Q_OBJECT | ||
53 | |||
54 | public: | ||
55 | |||
56 | /** | ||
57 | Constructor. | ||
58 | |||
59 | @param cfg The config object where custom resource settings are stored. | ||
60 | */ | ||
61 | ResourceOpie( const KConfig *cfg ); | ||
62 | |||
63 | /** | ||
64 | Construct file resource on file @arg fileName using format @arg formatName. | ||
65 | */ | ||
66 | ResourceOpie( const QString &fileName ); | ||
67 | |||
68 | /** | ||
69 | * Destructor. | ||
70 | */ | ||
71 | ~ResourceOpie(); | ||
72 | |||
73 | /** | ||
74 | Writes the config back. | ||
75 | */ | ||
76 | virtual void writeConfig( KConfig *cfg ); | ||
77 | |||
78 | /** | ||
79 | * Tries to open the file and checks for the proper format. | ||
80 | * This method should be called before @ref load(). | ||
81 | */ | ||
82 | virtual bool doOpen(); | ||
83 | |||
84 | /** | ||
85 | * Closes the file again. | ||
86 | */ | ||
87 | virtual void doClose(); | ||
88 | |||
89 | /** | ||
90 | * Requests a save ticket, that is used by @ref save() | ||
91 | */ | ||
92 | virtual Ticket *requestSaveTicket(); | ||
93 | |||
94 | /** | ||
95 | * Loads all addressees from file to the address book. | ||
96 | * Returns true if all addressees could be loaded otherwise false. | ||
97 | */ | ||
98 | virtual bool load(); | ||
99 | |||
100 | /** | ||
101 | * Saves all addresses from address book to file. | ||
102 | * Returns true if all addressees could be saved otherwise false. | ||
103 | * | ||
104 | * @param ticket The ticket returned by @ref requestSaveTicket() | ||
105 | */ | ||
106 | virtual bool save( Ticket *ticket ); | ||
107 | |||
108 | /** | ||
109 | * Set name of file to be used for saving. | ||
110 | */ | ||
111 | void setFileName( const QString & ); | ||
112 | |||
113 | /** | ||
114 | * Return name of file used for loading and saving the address book. | ||
115 | */ | ||
116 | QString fileName() const; | ||
117 | |||
118 | /** | ||
119 | * Remove a addressee from its source. | ||
120 | * This method is mainly called by KABC::AddressBook. | ||
121 | */ | ||
122 | virtual void removeAddressee( const Addressee& addr ); | ||
123 | |||
124 | /** | ||
125 | * This method is called by an error handler if the application | ||
126 | * crashed | ||
127 | */ | ||
128 | virtual void cleanUp(); | ||
129 | |||
130 | protected slots: | ||
131 | void fileChanged(); | ||
132 | |||
133 | protected: | ||
134 | void init( const QString &fileName ); | ||
135 | |||
136 | bool lock( const QString &fileName ); | ||
137 | void unlock( const QString &fileName ); | ||
138 | |||
139 | private: | ||
140 | QString mFileName; | ||
141 | |||
142 | QString mLockUniqueName; | ||
143 | |||
144 | KDirWatch mDirWatch; | ||
145 | }; | ||
146 | |||
147 | } | ||
148 | |||
149 | #endif | ||