libkdepim

KPIM::ResourceABC Class Reference

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

#include <resourceabc.h>

Inherits KABC::Resource.

List of all members.

Public Slots

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

Signals

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

Public Member Functions

 ResourceABC (const KConfig *)
virtual TQMap< TQString, TQString > uidToResourceMap () const =0
virtual TQStringList subresources () const
virtual bool subresourceActive (const TQString &) const
virtual bool subresourceWritable (const TQString &) const =0
virtual int subresourceCompletionWeight (const TQString &) const =0
virtual TQString subresourceLabel (const TQString &) const =0

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 44 of file resourceabc.h.


Member Function Documentation

virtual void KPIM::ResourceABC::setSubresourceActive ( const TQString &  ,
bool  active 
) [pure virtual, slot]

(De-)activate a subresource.

virtual void KPIM::ResourceABC::setSubresourceCompletionWeight ( const TQString &  ,
int  weight 
) [pure virtual, slot]

Set completion weight for a given subresource.

void KPIM::ResourceABC::signalSubresourceAdded ( KPIM::ResourceABC ,
const TQString &  type,
const TQString &  subResource 
) [signal]

This signal is emitted when a subresource is added.

void KPIM::ResourceABC::signalSubresourceRemoved ( KPIM::ResourceABC ,
const TQString &  type,
const TQString &  subResource 
) [signal]

This signal is emitted when a subresource is removed.

virtual bool KPIM::ResourceABC::subresourceActive ( const TQString &   )  const [inline, virtual]

Is this subresource active or not?

Definition at line 71 of file resourceabc.h.

virtual int KPIM::ResourceABC::subresourceCompletionWeight ( const TQString &   )  const [pure virtual]

Completion weight for a given subresource.

virtual TQString KPIM::ResourceABC::subresourceLabel ( const TQString &   )  const [pure virtual]

Label for a given subresource.

virtual TQStringList KPIM::ResourceABC::subresources (  )  const [inline, virtual]

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

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

Definition at line 66 of file resourceabc.h.

virtual bool KPIM::ResourceABC::subresourceWritable ( const TQString &   )  const [pure virtual]

Is the given subresource writable?

virtual TQMap<TQString, TQString> 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.


The documentation for this class was generated from the following files: