kabc Library API Documentation

KABC::DistributionListManager Class Reference

Manager of distribution lists. More...

#include <distributionlist.h>

List of all members.

Public Member Functions

 DistributionListManager (AddressBook *)
 ~DistributionListManager ()
DistributionListlist (const QString &name)
void insert (DistributionList *)
void remove (DistributionList *)
QStringList listNames ()
bool load ()
bool save ()


Detailed Description

Manager of distribution lists.

This class represents a collection of distribution lists, which are associated with a given address book.

Definition at line 122 of file distributionlist.h.


Constructor & Destructor Documentation

DistributionListManager::DistributionListManager AddressBook  ) 
 

Create manager for given address book.

Definition at line 110 of file distributionlist.cpp.

References QPtrList< DistributionList >::setAutoDelete().

DistributionListManager::~DistributionListManager  ) 
 

Destructor.

Definition at line 116 of file distributionlist.cpp.

References QPtrList< DistributionList >::clear().


Member Function Documentation

DistributionList * DistributionListManager::list const QString name  ) 
 

Return distribution list with given name.

Definition at line 121 of file distributionlist.cpp.

References QPtrList< DistributionList >::first(), KABC::DistributionList::name(), and QPtrList< DistributionList >::next().

void DistributionListManager::insert DistributionList  ) 
 

Insert distribution list.

If a list with this name already exists, nothing happens. The passed object is deleted by the manager.

Definition at line 131 of file distributionlist.cpp.

References QPtrList< DistributionList >::append(), QPtrList< DistributionList >::first(), KABC::DistributionList::name(), QPtrList< DistributionList >::next(), and QPtrList< DistributionList >::remove().

Referenced by KABC::DistributionList::DistributionList().

void DistributionListManager::remove DistributionList  ) 
 

Remove distribution list.

If a list with this name doesn't exist, nothing happens.

Definition at line 146 of file distributionlist.cpp.

References QPtrList< DistributionList >::first(), KABC::DistributionList::name(), QPtrList< DistributionList >::next(), and QPtrList< DistributionList >::remove().

Referenced by KABC::DistributionList::~DistributionList().

QStringList DistributionListManager::listNames  ) 
 

Return names of all distribution lists managed by this manager.

Definition at line 160 of file distributionlist.cpp.

References QPtrList< DistributionList >::first(), KABC::DistributionList::name(), and QPtrList< DistributionList >::next().

bool DistributionListManager::load  ) 
 

Load distribution lists form disk.

Definition at line 172 of file distributionlist.cpp.

References QMap::begin(), QPtrList< DistributionList >::clear(), QMap::end(), KConfig::entryMap(), KABC::AddressBook::findByUid(), KABC::AddressBook::identifier(), KABC::DistributionList::insertEntry(), KABC::Addressee::isEmpty(), QMap::isEmpty(), QStringList::join(), kdDebug(), locateLocal(), KConfigBase::readListEntry(), and KConfigBase::setGroup().

bool DistributionListManager::save  ) 
 

Save distribution lists to disk.

Definition at line 216 of file distributionlist.cpp.

References KConfigBase::deleteGroup(), KABC::DistributionList::entries(), QPtrList< DistributionList >::first(), KABC::AddressBook::identifier(), kdDebug(), locateLocal(), KABC::DistributionList::name(), QPtrList< DistributionList >::next(), KConfigBase::setGroup(), KSimpleConfig::sync(), and KConfigBase::writeEntry().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kabc Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Apr 21 18:44:45 2004 by doxygen 1.3.6-20040222 written by Dimitri van Heesch, © 1997-2003