You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
163 lines
3.7 KiB
163 lines
3.7 KiB
/*
|
|
This file is part of libkabc.
|
|
Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org>
|
|
|
|
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_RESOURCEFILE_H
|
|
#define KABC_RESOURCEFILE_H
|
|
|
|
#include <tdeconfig.h>
|
|
#include <kdirwatch.h>
|
|
|
|
#include <sys/types.h>
|
|
|
|
#include <tdeabc/resource.h>
|
|
|
|
namespace TDEABC {
|
|
|
|
class FormatPlugin;
|
|
class ResourceConfigWidget;
|
|
class Lock;
|
|
|
|
/**
|
|
This resource allows access to a local file.
|
|
*/
|
|
class KABC_EXPORT ResourceFile : public Resource
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
/**
|
|
Constructor.
|
|
|
|
@param cfg The config object where custom resource settings are stored.
|
|
*/
|
|
ResourceFile( const TDEConfig *cfg );
|
|
|
|
/**
|
|
Construct file resource on file @arg fileName using format @arg formatName.
|
|
*/
|
|
ResourceFile( const TQString &fileName, const TQString &formatName = "vcard" );
|
|
|
|
/**
|
|
Destructor.
|
|
*/
|
|
~ResourceFile();
|
|
|
|
/**
|
|
Writes the config back.
|
|
*/
|
|
virtual void writeConfig( TDEConfig *cfg );
|
|
|
|
/**
|
|
Tries to open the file and checks for the proper format.
|
|
This method should be called before load().
|
|
*/
|
|
virtual bool doOpen();
|
|
|
|
/**
|
|
Closes the file again.
|
|
*/
|
|
virtual void doClose();
|
|
|
|
/**
|
|
Requests a save ticket, that is used by save()
|
|
*/
|
|
virtual Ticket *requestSaveTicket();
|
|
|
|
virtual void releaseSaveTicket( Ticket* );
|
|
|
|
/**
|
|
Loads all addressees from file to the address book.
|
|
Returns true if all addressees could be loaded otherwise false.
|
|
*/
|
|
virtual bool load();
|
|
|
|
virtual bool asyncLoad();
|
|
|
|
/**
|
|
Saves all addresses from address book to file.
|
|
Returns true if all addressees could be saved otherwise false.
|
|
|
|
@param ticket The ticket returned by requestSaveTicket()
|
|
*/
|
|
virtual bool save( Ticket *ticket );
|
|
|
|
virtual bool asyncSave( Ticket *ticket );
|
|
|
|
/**
|
|
Set name of file to be used for saving.
|
|
*/
|
|
void setFileName( const TQString & );
|
|
|
|
/**
|
|
Return name of file used for loading and saving the address book.
|
|
*/
|
|
TQString fileName() const;
|
|
|
|
/**
|
|
Sets a new format by name.
|
|
*/
|
|
void setFormat( const TQString &name );
|
|
|
|
/**
|
|
Returns the format name.
|
|
*/
|
|
TQString format() const;
|
|
|
|
/**
|
|
Remove a addressee from its source.
|
|
This method is mainly called by TDEABC::AddressBook.
|
|
*/
|
|
virtual void removeAddressee( const Addressee& addr );
|
|
|
|
private slots:
|
|
void emitLoadingFinished();
|
|
void emitLoadingError();
|
|
void emitSavingFinished();
|
|
void emitSavingError();
|
|
|
|
protected slots:
|
|
void fileChanged();
|
|
|
|
protected:
|
|
void init( const TQString &fileName, const TQString &format );
|
|
|
|
bool lock( const TQString &fileName );
|
|
void unlock( const TQString &fileName );
|
|
|
|
private:
|
|
TQString mFileName;
|
|
TQString mFormatName;
|
|
|
|
FormatPlugin *mFormat;
|
|
|
|
Lock *mLock;
|
|
|
|
KDirWatch mDirWatch;
|
|
|
|
bool mAsynchronous;
|
|
|
|
class ResourceFilePrivate;
|
|
ResourceFilePrivate *d;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|