• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kabc
 

kabc

  • KABC
  • ResourceFile
Public Member Functions | Protected Slots | Protected Member Functions | List of all members
KABC::ResourceFile Class Reference

#include <resourcefile.h>

Inherits KABC::Resource.

Public Member Functions

 ResourceFile (const KConfig *cfg)
 ResourceFile (const TQString &fileName, const TQString &formatName="vcard")
 ~ResourceFile ()
virtual void writeConfig (KConfig *cfg)
virtual bool doOpen ()
virtual void doClose ()
virtual Ticket * requestSaveTicket ()
virtual void releaseSaveTicket (Ticket *)
virtual bool load ()
virtual bool asyncLoad ()
virtual bool save (Ticket *ticket)
virtual bool asyncSave (Ticket *ticket)
void setFileName (const TQString &)
TQString fileName () const
void setFormat (const TQString &name)
TQString format () const
virtual void removeAddressee (const Addressee &addr)
- Public Member Functions inherited from KABC::Resource
 Resource (const KConfig *config)
virtual ~Resource ()
virtual ConstIterator begin () const
virtual Iterator begin ()
virtual ConstIterator end () const
virtual Iterator end ()
AddressBook * addressBook ()
virtual void writeConfig (KConfig *config)
virtual Ticket * requestSaveTicket ()=0
virtual void releaseSaveTicket (Ticket *)=0
virtual bool load ()=0
virtual bool asyncLoad ()
virtual void insertAddressee (const Addressee &)
virtual void removeAddressee (const Addressee &addr)
virtual bool save (Ticket *ticket)=0
virtual bool asyncSave (Ticket *ticket)
virtual Addressee findByUid (const TQString &uid)
virtual Addressee::List findByName (const TQString &name)
virtual Addressee::List findByEmail (const TQString &email)
virtual Addressee::List findByCategory (const TQString &category)
virtual void clear ()
void setAddressBook (AddressBook *)

Protected Slots

void fileChanged ()

Protected Member Functions

void init (const TQString &fileName, const TQString &format)
bool lock (const TQString &fileName)
void unlock (const TQString &fileName)
- Protected Member Functions inherited from KABC::Resource
Ticket * createTicket (Resource *)

Additional Inherited Members

- Signals inherited from KABC::Resource
void loadingFinished (Resource *resource)
void loadingError (Resource *resource, const TQString &msg)
void savingFinished (Resource *resource)
void savingError (Resource *resource, const TQString &msg)
- Protected Attributes inherited from KABC::Resource
Addressee::Map mAddrMap

Detailed Description

This resource allows access to a local file.

Definition at line 40 of file resourcefile.h.

Constructor & Destructor Documentation

ResourceFile::ResourceFile ( const KConfig *  cfg)

Constructor.

Parameters
cfgThe config object where custom resource settings are stored.

Definition at line 49 of file resourcefile.cpp.

ResourceFile::ResourceFile ( const TQString &  fileName,
const TQString &  formatName = "vcard" 
)

Construct file resource on file.

  • fileName using format
  • formatName.

Definition at line 66 of file resourcefile.cpp.

ResourceFile::~ResourceFile ( )

Destructor.

Definition at line 95 of file resourcefile.cpp.

Member Function Documentation

void ResourceFile::doClose ( )
virtual

Closes the file again.

Definition at line 218 of file resourcefile.cpp.

bool ResourceFile::doOpen ( )
virtual

Tries to open the file and checks for the proper format.

This method should be called before load().

Definition at line 144 of file resourcefile.cpp.

TQString ResourceFile::fileName ( ) const

Return name of file used for loading and saving the address book.

Definition at line 355 of file resourcefile.cpp.

TQString ResourceFile::format ( ) const

Returns the format name.

Definition at line 369 of file resourcefile.cpp.

bool ResourceFile::load ( )
virtual

Loads all addressees from file to the address book.

Returns true if all addressees could be loaded otherwise false.

Definition at line 222 of file resourcefile.cpp.

void ResourceFile::removeAddressee ( const Addressee &  addr)
virtual

Remove a addressee from its source.

This method is mainly called by KABC::AddressBook.

Definition at line 390 of file resourcefile.cpp.

Ticket * ResourceFile::requestSaveTicket ( )
virtual

Requests a save ticket, that is used by save()

Definition at line 113 of file resourcefile.cpp.

bool ResourceFile::save ( Ticket *  ticket)
virtual

Saves all addresses from address book to file.

Returns true if all addressees could be saved otherwise false.

Parameters
ticketThe ticket returned by requestSaveTicket()

Definition at line 255 of file resourcefile.cpp.

void ResourceFile::setFileName ( const TQString &  fileName)

Set name of file to be used for saving.

Definition at line 343 of file resourcefile.cpp.

void ResourceFile::setFormat ( const TQString &  name)

Sets a new format by name.

Definition at line 360 of file resourcefile.cpp.

void ResourceFile::writeConfig ( KConfig *  cfg)
virtual

Writes the config back.

Definition at line 101 of file resourcefile.cpp.


The documentation for this class was generated from the following files:
  • resourcefile.h
  • resourcefile.cpp

kabc

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

kabc

Skip menu "kabc"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kabc by doxygen 1.8.1.2
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |