libkdepim Library API Documentation

KPIM::ResourceABC Class Reference

This class is the implementation of subfolder resources for KABC. More...

#include <resourceabc.h>

List of all members.

Public Slots

virtual void setSubresourceActive (const QString &, bool active)=0
virtual void setSubresourceCompletionWeight (const QString &, int weight)=0

Signals

void signalSubresourceAdded (KPIM::ResourceABC *, const QString &type, const QString &subResource)
void signalSubresourceRemoved (KPIM::ResourceABC *, const QString &type, const QString &subResource)

Public Member Functions

 ResourceABC (const KConfig *)
virtual QMap< QString, QStringuidToResourceMap () const =0
virtual QStringList subresources () const
virtual bool subresourceActive (const QString &) const
virtual int subresourceCompletionWeight (const QString &) const =0
virtual QString subresourceLabel (const QString &) const =0
virtual bool removeSubresource (const QString &)=0
virtual bool addSubresource (const QString &label, const QString &parent)=0
virtual bool canHaveSubresources () const


Detailed Description

This class is the implementation of subfolder resources for KABC.

More methods will be added to give KAddressBook the possibility to handle subresources.

Definition at line 42 of file resourceabc.h.


Member Function Documentation

virtual QMap<QString, QString> KPIM::ResourceABC::uidToResourceMap  )  const [pure virtual]
 

Get the UID to subresource map.

This is necessary to implement the search order. The returned map has the UID as key and the resource it's in as the data.

virtual QStringList KPIM::ResourceABC::subresources  )  const [inline, virtual]
 

If this resource has subresources, return a QStringList of them.

In most cases, resources do not have subresources, so this is by default just empty.

Definition at line 63 of file resourceabc.h.

virtual bool KPIM::ResourceABC::subresourceActive const QString  )  const [inline, virtual]
 

Is this subresource active or not?

Definition at line 68 of file resourceabc.h.

virtual int KPIM::ResourceABC::subresourceCompletionWeight const QString  )  const [pure virtual]
 

Completion weight for a given subresource.

virtual QString KPIM::ResourceABC::subresourceLabel const QString  )  const [pure virtual]
 

Label for a given subresource.

virtual bool KPIM::ResourceABC::removeSubresource const QString  )  [pure virtual]
 

Remove a given subresource.

virtual bool KPIM::ResourceABC::addSubresource const QString label,
const QString parent
[pure virtual]
 

Create a new subresource with label.

Parameters:
label under the parent folder
parent or at toplevel, if no parent is given.

virtual bool KPIM::ResourceABC::canHaveSubresources  )  const [inline, virtual]
 

Can the resource have subresources?

Definition at line 88 of file resourceabc.h.

virtual void KPIM::ResourceABC::setSubresourceActive const QString ,
bool  active
[pure virtual, slot]
 

(De-)activate a subresource.

virtual void KPIM::ResourceABC::setSubresourceCompletionWeight const QString ,
int  weight
[pure virtual, slot]
 

Set completion weight for a given subresource.

void KPIM::ResourceABC::signalSubresourceAdded KPIM::ResourceABC ,
const QString type,
const QString subResource
[signal]
 

This signal is emitted when a subresource is added.

void KPIM::ResourceABC::signalSubresourceRemoved KPIM::ResourceABC ,
const QString type,
const QString subResource
[signal]
 

This signal is emitted when a subresource is removed.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkdepim Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Jul 25 11:18:43 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003