class ResourceFile

More...

Internal Use Only
Full nameKABC::ResourceFile
Definition#include <resourcefile.h>
InheritsQObject (qt) [public ], KABC::Resource [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods

Protected Slots


Detailed Description

 ResourceFile ( AddressBook *ab, const KConfig *cfg )

ResourceFile

Constructor.

Parameters:
abThe address book where the addressees should be stored.
cfgThe config object where custom resource settings are stored.

 ResourceFile ( AddressBook *ab, const QString &filename, FormatPlugin *format = 0 )

ResourceFile

Constructor.

Parameters:
abThe address book where the addressees should be stored.
filenameThe name of the file, the addressees should be read from.
formatThe pointer to a format handler.

 ~ResourceFile ()

~ResourceFile

Destructor.

bool  open ()

open

Tries to open the file and checks for the proper format. This method should be called before load().

Reimplemented from Resource.

void  close ()

close

Closes the file again.

Reimplemented from Resource.

Ticket * requestSaveTicket ()

requestSaveTicket

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

Reimplemented from Resource.

bool  load ()

load

Loads all addressees from file to the address book. Returns true if all addressees could be loaded otherwise false.

Reimplemented from Resource.

bool  save ( Ticket *ticket )

save

Saves all addresses from address book to file. Returns true if all addressees could be saved otherwise false.

Parameters:
ticketThe ticket returned by requestSaveTicket()

Reimplemented from Resource.

void  setFileName ( const QString & )

setFileName

Set name of file to be used for saving.

QString  fileName ()

fileName

[const]

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

QString  identifier ()

identifier

[const virtual]

Returns the unique identifier.

Reimplemented from Resource.

void  removeAddressee ( const Addressee& addr )

removeAddressee

Remove a addressee from its source. This method is mainly called by KABC::AddressBook.

Reimplemented from Resource.

void  cleanUp ()

cleanUp

[virtual]

This method is called by an error handler if the application crashed

Reimplemented from Resource.

void  fileChanged ()

fileChanged

[protected slots slot]

bool  lock ( const QString &fileName )

lock

[protected]

void  unlock ( const QString &fileName )

unlock

[protected]


Generated by: caleb on tcdevel on Tue Jan 28 12:54:33 2003, using kdoc $.