• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

kabc

  • kabc
  • plugins
  • file
resourcefile.h
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
19*/
20
21#ifndef KABC_RESOURCEFILE_H
22#define KABC_RESOURCEFILE_H
23
24#include "kabc_file_core_export.h"
25
26#include "kabc/resource.h"
27
28#include <kconfig.h>
29#include <kdirwatch.h>
30
31#include <sys/types.h>
32
33class QFile;
34class KTemporaryFile;
35
36class KJob;
37
38namespace KABC {
39
40class Format;
41class Lock;
42
46class KABC_FILE_CORE_EXPORT ResourceFile : public Resource
47{
48 Q_OBJECT
49
50 public:
54 ResourceFile();
60 explicit ResourceFile( const KConfigGroup &group );
61
68 explicit ResourceFile( const QString &fileName,
69 const QString &formatName = QLatin1String( "vcard" ) );
70
74 ~ResourceFile();
75
79 virtual void writeConfig( KConfigGroup &group );
80
85 virtual bool doOpen();
86
90 virtual void doClose();
91
95 virtual Ticket *requestSaveTicket();
96
97 virtual void releaseSaveTicket( Ticket *ticket );
98
103 virtual bool load();
104
105 virtual bool asyncLoad();
106
113 virtual bool save( Ticket *ticket );
114
115 virtual bool asyncSave( Ticket *ticket );
116
120 void setFileName( const QString & );
121
125 QString fileName() const;
126
130 void setFormat( const QString &name );
131
135 QString format() const;
136
145 virtual void removeAddressee( const Addressee &addr );
146
147 private Q_SLOTS:
148 void emitLoadingFinished();
149 void emitSavingFinished();
150
151 protected Q_SLOTS:
152 void fileChanged( const QString &path );
153
154 protected:
155 void init( const QString &fileName, const QString &format );
156
157 bool lock( const QString &fileName );
158 void unlock( const QString &fileName );
159
160 private:
161 bool clearAndLoad( QFile *file );
162 void saveToFile( QFile *file );
163 bool createLocalTempFile();
164 void deleteLocalTempFile();
165 void deleteStaleTempFile();
166 bool hasTempFile() const { return mTempFile != 0; }
167 bool loadDistributionLists();
168 void saveDistributionLists();
169
170 QString mFileName;
171 QString mFormatName;
172
173 Format *mFormat;
174
175 Lock *mLock;
176
177 KDirWatch mDirWatch;
178
179 KTemporaryFile *mTempFile;
180
181 bool mAsynchronous;
182
183 class ResourceFilePrivate;
184 ResourceFilePrivate *d;
185};
186
187}
188
189#endif
KABC::Addressee
address book entry
Definition addressee.h:79
KABC::Format
Base class for address book formats.
Definition format.h:43
KABC::Lock
This class provides locking functionality for a file, directory or an arbitrary string-represented re...
Definition lock.h:35
KABC::ResourceFile::doClose
virtual void doClose()
Closes the file again.
Definition resourcefile.cpp:199
KABC::ResourceFile::fileName
QString fileName() const
Return name of file used for loading and saving the address book.
Definition resourcefile.cpp:412
KABC::ResourceFile::doOpen
virtual bool doOpen()
Tries to open the file and checks for the proper format.
Definition resourcefile.cpp:164
KABC::ResourceFile::writeConfig
virtual void writeConfig(KConfigGroup &group)
Writes the config back.
Definition resourcefile.cpp:118
KABC::ResourceFile::removeAddressee
virtual void removeAddressee(const Addressee &addr)
Remove a addressee from its source.
Definition resourcefile.cpp:466
KABC::ResourceFile::asyncSave
virtual bool asyncSave(Ticket *ticket)
Saves all addressees asynchronously.
Definition resourcefile.cpp:273
KABC::ResourceFile::setFileName
void setFileName(const QString &)
Set name of file to be used for saving.
Definition resourcefile.cpp:399
KABC::ResourceFile::asyncLoad
virtual bool asyncLoad()
Loads all addressees asyncronously.
Definition resourcefile.cpp:234
KABC::ResourceFile::save
virtual bool save(Ticket *ticket)
Saves all addresses from address book to file.
Definition resourcefile.cpp:245
KABC::ResourceFile::setFormat
void setFormat(const QString &name)
Sets a new format by name.
Definition resourcefile.cpp:417
KABC::ResourceFile::ResourceFile
ResourceFile()
Default constructor.
Definition resourcefile.cpp:55
KABC::ResourceFile::format
QString format() const
Returns the format name.
Definition resourcefile.cpp:426
KABC::ResourceFile::requestSaveTicket
virtual Ticket * requestSaveTicket()
Requests a save ticket, that is used by save()
Definition resourcefile.cpp:131
KABC::ResourceFile::releaseSaveTicket
virtual void releaseSaveTicket(Ticket *ticket)
Releases the ticket previousely requested with requestSaveTicket().
Definition resourcefile.cpp:154
KABC::ResourceFile::load
virtual bool load()
Loads all addressees from file to the address book.
Definition resourcefile.cpp:203
KABC::Resource::Resource
Resource()
Default constructor.
Definition resource.cpp:218
KABC::Ticket
Helper class for handling coordinated save of address books.
Definition resource.h:38
KABC
Class that holds a Calendar Url (FBURL/CALADRURI/CALURI)
Definition address.h:29
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kabc

Skip menu "kabc"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal