kword
KWMailMergeKABC Class Reference
Inheritance diagram for KWMailMergeKABC:
Detailed Description
Definition at line 33 of file KWMailMergeKABC.h.
Public Member Functions | |
| KWMailMergeKABC (KInstance *inst, QObject *parent) | |
| ~KWMailMergeKABC () | |
| virtual void | save (QDomDocument &, QDomElement &) |
| virtual void | load (QDomElement &) |
| virtual class QString | getValue (const class QString &name, int record=-1) const |
| virtual int | getNumRecords () const |
| virtual void | refresh (bool force) |
| virtual bool | showConfigDialog (QWidget *, int action) |
Protected Member Functions | |
| void | addEntry (const QString &uid) |
| void | addList (const QString &id) |
| void | clear () |
| virtual QStringList | lists () const |
| virtual QStringList | singleRecords () const |
Friends | |
| class | KWMailMergeKABCConfig |
Member Function Documentation
| void KWMailMergeKABC::save | ( | QDomDocument & | , | |
| QDomElement & | ||||
| ) | [virtual] |
Saves the mail merge list to the kword document.
Implements KWMailMergeDataSource.
Definition at line 483 of file KWMailMergeKABC.cpp.
| void KWMailMergeKABC::load | ( | QDomElement & | ) | [virtual] |
Loads the mail merge list stored in the kword document.
Implements KWMailMergeDataSource.
Definition at line 399 of file KWMailMergeKABC.cpp.
| virtual class QString KWMailMergeKABC::getValue | ( | const class QString & | name, | |
| int | record = -1 | |||
| ) | const [virtual] |
- Parameters:
-
name The name of the value e.g.
"Family name".
- Parameters:
-
record The position of the the entry in mail merge list.
- Returns:
- The value of the mail merge variable.
record equals -1, name is returned.
Implements KWMailMergeDataSource.
| int KWMailMergeKABC::getNumRecords | ( | ) | const [virtual] |
- Returns:
- The number of available contacts in mail merge list.
Implements KWMailMergeDataSource.
Definition at line 127 of file KWMailMergeKABC.cpp.
| void KWMailMergeKABC::refresh | ( | bool | force | ) | [virtual] |
Only for compatability reasons.
- Parameters:
-
force Hasn't any effect.
Implements KWMailMergeDataSource.
Definition at line 474 of file KWMailMergeKABC.cpp.
| bool KWMailMergeKABC::showConfigDialog | ( | QWidget * | , | |
| int | action | |||
| ) | [virtual] |
Shows a KWMailMergeKABCConfig dialog for selecting entries from KAddressbook.
Implements KWMailMergeDataSource.
Definition at line 509 of file KWMailMergeKABC.cpp.
| void KWMailMergeKABC::addEntry | ( | const QString & | uid | ) | [protected] |
Adds an entry from KABC::StdAddressBook::self() to the mail merge list.
To be called by KWMailMergeKABC::load() and KWMailMergeKABCConfig::acceptSelection() only.
- Parameters:
-
uid The entry's KABC::Addressee::uid().
Definition at line 103 of file KWMailMergeKABC.cpp.
| void KWMailMergeKABC::addList | ( | const QString & | id | ) | [protected] |
Adds a distribution list to the mail merge list.
To be called by KWMailMergeKABC::load() and KWMailMergeKABCConfig::acceptSelection() only.
- Parameters:
-
id The DistributionList::name().
Definition at line 110 of file KWMailMergeKABC.cpp.
| void KWMailMergeKABC::clear | ( | ) | [protected] |
Removes all entries and distribution lists from the mail merge list.
Definition at line 118 of file KWMailMergeKABC.cpp.
| QStringList KWMailMergeKABC::lists | ( | ) | const [protected, virtual] |
- Returns:
- All selected DistributionList::name().
To be called by KWMailMergeKABCConfig::initSelectedLists()
Definition at line 393 of file KWMailMergeKABC.cpp.
| QStringList KWMailMergeKABC::singleRecords | ( | ) | const [protected, virtual] |
- Returns:
- The KABC::Addressee::uid() of all individually selected entries in mail merge list.
To be called by KWMailMergeKABCConfig::initSelectedAddressees()
Definition at line 531 of file KWMailMergeKABC.cpp.
The documentation for this class was generated from the following files:
