kaddressbook

KAB::XXPort Class Reference

Inheritance diagram for KAB::XXPort:

BookmarkXXPort CSVXXPort EudoraXXPort GNOKIIXXPort KDE2XXPort LDIFXXPort OperaXXPort PABXXPort VCardXXPort List of all members.

Detailed Description

Definition at line 68 of file xxport.h.


Public Slots

virtual bool exportContacts (const KABC::AddresseeList &list, const QString &identifier)
virtual KABC::AddresseeList importContacts (const QString &identifier) const

Signals

void exportActivated (const QString &, const QString &)
void importActivated (const QString &, const QString &)

Public Member Functions

 XXPort (KABC::AddressBook *ab, QWidget *parent, const char *name=0)
virtual QString identifier () const =0
virtual bool requiresSorting () const
void setKApplication (KApplication *app)
void processEvents () const

Protected Member Functions

void createImportAction (const QString &label, const QString &identifier=QString::null)
void createExportAction (const QString &label, const QString &identifier=QString::null)
KABC::AddressBook * addressBook () const
QWidget * parentWidget () const

Member Function Documentation

KABC::AddressBook* KAB::XXPort::addressBook  )  const [protected]
 

Returns a pointer to the address book object.

void KAB::XXPort::createExportAction const QString &  label,
const QString &  identifier = QString::null
[protected]
 

Create the export action.

The identifier is passed in the export slot.

void KAB::XXPort::createImportAction const QString &  label,
const QString &  identifier = QString::null
[protected]
 

Create the import action.

The identifier is passed in the import slot.

void KAB::XXPort::exportActivated const QString &  ,
const QString & 
[signal]
 

Emitted whenever the export action is activated.

The parameter contains the identifier() for unique identification.

virtual bool KAB::XXPort::exportContacts const KABC::AddresseeList &  list,
const QString &  identifier
[virtual, slot]
 

Reimplement this method for exporting the contacts.

Reimplemented in BookmarkXXPort, CSVXXPort, GNOKIIXXPort, LDIFXXPort, and VCardXXPort.

virtual QString KAB::XXPort::identifier  )  const [pure virtual]
 

Returns the unique identifier of this xxport modul, it should be the lowercase name of the import/export format e.g.

'vcard'

Implemented in BookmarkXXPort, CSVXXPort, EudoraXXPort, GNOKIIXXPort, KDE2XXPort, LDIFXXPort, OperaXXPort, PABXXPort, and VCardXXPort.

void KAB::XXPort::importActivated const QString &  ,
const QString & 
[signal]
 

Emitted whenever the import action is activated.

The parameter contains the identifier() for unique identification.

virtual KABC::AddresseeList KAB::XXPort::importContacts const QString &  identifier  )  const [virtual, slot]
 

Reimplement this method for importing the contacts.

Reimplemented in CSVXXPort, EudoraXXPort, GNOKIIXXPort, KDE2XXPort, LDIFXXPort, OperaXXPort, PABXXPort, and VCardXXPort.

QWidget* KAB::XXPort::parentWidget  )  const [protected]
 

Returns a pointer to the parent widget.

It can be used as parent for message boxes.

void KAB::XXPort::processEvents  )  const
 

Processes outstanding KApplication events.

It should be called occasionally when the import/export filter is busy performing a long operation (e.g. reading from slow external devices).

See also:
: QApplication::processEvents()

virtual bool KAB::XXPort::requiresSorting  )  const [inline, virtual]
 

Reimplement this method if the XXPortManager shall pass a sorted list to exportContacts().

Definition at line 86 of file xxport.h.

void KAB::XXPort::setKApplication KApplication *  app  ) 
 

set the KApplication pointer.

See also:
: processEvents()

The documentation for this class was generated from the following file:
KDE Home | KDE Accessibility Home | Description of Access Keys