KNCollection Class Reference

#include <kncollection.h>

Inheritance diagram for KNCollection:

Public Types
enum	collectionType {   CTnntpAccount, CTgroup, CTfolder, CTcategory,   CTvirtualGroup }
typedef boost::shared_ptr < KNCollection >	Ptr

Public Member Functions
	KNCollection (KNCollection::Ptr p)
virtual	~KNCollection ()
int	count () const
void	decCount (int i)
void	incCount (int i)
KNCollectionViewItem *	listItem () const
virtual const QString &	name ()
KNCollection::Ptr	parent () const
virtual QString	path ()=0
virtual bool	readInfo (const QString &confPath)=0
void	setCount (int i)
void	setListItem (KNCollectionViewItem *i)
void	setName (const QString &s)
virtual void	setParent (KNCollection::Ptr p)
virtual collectionType	type ()=0
virtual void	updateListItem ()
virtual void	writeConfig ()=0

Protected Member Functions
virtual KNCollection::Ptr	selfPtr ()=0

Protected Attributes
int	c_ount
KNCollectionViewItem *	l_istItem
QString	n_ame
KNCollection::Ptr	p_arent

Detailed Description

Abstract base class for everything that is visible in the folder tree.

This includes:

• news groups
• folders
• news server accounts

Definition at line 32 of file kncollection.h.

Member Typedef Documentation

typedef boost::shared_ptr<KNCollection> KNCollection::Ptr

Shared pointer to a KNCollection.

To be used instead of raw KNCollection*.

Definition at line 42 of file kncollection.h.

Member Enumeration Documentation

enum KNCollection::collectionType

Enumerator
CTnntpAccount
CTgroup
CTfolder
CTcategory
CTvirtualGroup

Definition at line 35 of file kncollection.h.

Constructor & Destructor Documentation

KNCollection::KNCollection ( KNCollection::Ptr  p )

explicit

Create a new collection.

Parameters

p	The parent collection.

Definition at line 18 of file kncollection.cpp.

KNCollection::~KNCollection ( )

virtual

Definition at line 27 of file kncollection.cpp.

Member Function Documentation

int KNCollection::count ( ) const

inline

Definition at line 83 of file kncollection.h.

void KNCollection::decCount ( int  i )

inline

Definition at line 86 of file kncollection.h.

void KNCollection::incCount ( int  i )

inline

Definition at line 85 of file kncollection.h.

KNCollectionViewItem* KNCollection::listItem ( ) const

inline

Returns the listview item representing this collection in the folder tree.

Definition at line 57 of file kncollection.h.

virtual const QString& KNCollection::name ( )

inlinevirtual

Returns the collection name.

Reimplemented in KNGroup.

Definition at line 78 of file kncollection.h.

KNCollection::Ptr KNCollection::parent ( ) const

inline

Returns the parent collection.

Definition at line 73 of file kncollection.h.

virtual QString KNCollection::path ( )

pure virtual

Implemented in KNNntpAccount, KNGroup, and KNFolder.

virtual bool KNCollection::readInfo ( const QString &  confPath )

pure virtual

Load the properties/settings of this collection.

Implemented in KNNntpAccount, KNGroup, and KNFolder.

virtual KNCollection::Ptr KNCollection::selfPtr ( )

protectedpure virtual

Returns a shared pointer pointing to this collection.

Implemented in KNGroup, and KNNntpAccount.

void KNCollection::setCount ( int  i )

inline

Definition at line 84 of file kncollection.h.

void KNCollection::setListItem

(

KNCollectionViewItem *

i

)

Sets the listview item which represents this collection in the folder tree.

Definition at line 34 of file kncollection.cpp.

void KNCollection::setName ( const QString &  s )

inline

Sets the collection name.

Definition at line 80 of file kncollection.h.

virtual void KNCollection::setParent ( KNCollection::Ptr  p )

inlinevirtual

Sets the parent collection.

Reimplemented in KNFolder.

Definition at line 75 of file kncollection.h.

virtual collectionType KNCollection::type ( )

pure virtual

Returns the collection type.

Implemented in KNNntpAccount, KNGroup, and KNFolder.

void KNCollection::updateListItem ( )

virtual

Updates the listview item after the collection has changed.

Reimplemented in KNGroup, and KNFolder.

Definition at line 45 of file kncollection.cpp.

virtual void KNCollection::writeConfig ( )

pure virtual

Save the properties/settings of this collection.

Implemented in KNNntpAccount, KNFolder, and KNGroup.

Member Data Documentation

int KNCollection::c_ount

protected

Definition at line 100 of file kncollection.h.

KNCollectionViewItem* KNCollection::l_istItem

protected

The list view item representing this collection in the folder tree.

Definition at line 97 of file kncollection.h.

QString KNCollection::n_ame

protected

The name of this collection.

Definition at line 99 of file kncollection.h.

KNCollection::Ptr KNCollection::p_arent

protected

A pointer to the parent collection.

Definition at line 95 of file kncollection.h.

---

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

• kncollection.h
• kncollection.cpp