KNArticleCollection Class Reference

#include <knarticlecollection.h>

Inheritance diagram for KNArticleCollection:

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

Public Member Functions
	KNArticleCollection (KNCollection::Ptr p=KNCollection::Ptr())
	~KNArticleCollection ()
void	append (KNArticle::Ptr a)
void	articleLocked ()
void	articleUnlocked ()
KNArticle::Ptr	at (int i)
KNArticle::Ptr	byId (int id)
KNArticle::Ptr	byMessageId (const QByteArray &mid)
void	clear ()
void	compact ()
bool	isEmpty ()
bool	isLoaded ()
bool	isNotUnloadable ()
int	length ()
unsigned int	lockedArticles ()
void	remove (const KNArticle::Ptr &art)
void	setLastID ()
void	setNotUnloadable (bool b=true)
void	syncSearchIndex ()
Public Member Functions inherited from KNCollection
	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

Additional Inherited Members
Protected Member Functions inherited from KNCollection
virtual KNCollection::Ptr	selfPtr ()=0
Protected Attributes inherited from KNCollection
int	c_ount
KNCollectionViewItem *	l_istItem
QString	n_ame
KNCollection::Ptr	p_arent

Detailed Description

Abstract base class for article collections, ie.

news groups and folders.

Definition at line 76 of file knarticlecollection.h.

Member Typedef Documentation

typedef QList<KNArticleCollection::Ptr> KNArticleCollection::List

List of KNArticleCollection.

Definition at line 86 of file knarticlecollection.h.

typedef boost::shared_ptr<KNArticleCollection> KNArticleCollection::Ptr

Shared pointer to a KNArticle.

To be used instead of raw KNArticleCollection*.

Definition at line 82 of file knarticlecollection.h.

Constructor & Destructor Documentation

KNArticleCollection::KNArticleCollection ( KNCollection::Ptr  p = KNCollection::Ptr() )

explicit

Definition at line 174 of file knarticlecollection.cpp.

KNArticleCollection::~KNArticleCollection

(

)

Definition at line 182 of file knarticlecollection.cpp.

Member Function Documentation

void KNArticleCollection::append

(

KNArticle::Ptr

a

)

Appends an article to this collection.

Definition at line 186 of file knarticlecollection.cpp.

void KNArticleCollection::articleLocked ( )

inline

Definition at line 103 of file knarticlecollection.h.

void KNArticleCollection::articleUnlocked ( )

inline

Definition at line 104 of file knarticlecollection.h.

KNArticle::Ptr KNArticleCollection::at ( int  i )

inline

Returns the article at index i in this collection, or an empty KNArticle::Ptr if it is not found.

Definition at line 123 of file knarticlecollection.h.

KNArticle::Ptr KNArticleCollection::byId

(

int

id

)

Returns the article whose id is id, or an empty KNArticle::Ptr if it is not found.

Definition at line 214 of file knarticlecollection.cpp.

KNArticle::Ptr KNArticleCollection::byMessageId

(

const QByteArray &

mid

)

Returns the article whose message-id is mid, or an empty KNArticle::Ptr if it is not found.

Definition at line 220 of file knarticlecollection.cpp.

void KNArticleCollection::clear

(

)

Definition at line 200 of file knarticlecollection.cpp.

void KNArticleCollection::compact

(

)

Definition at line 208 of file knarticlecollection.cpp.

bool KNArticleCollection::isEmpty ( )

inline

Returns true if this collection doesn't contain any article.

Definition at line 93 of file knarticlecollection.h.

bool KNArticleCollection::isLoaded ( )

inline

Definition at line 94 of file knarticlecollection.h.

bool KNArticleCollection::isNotUnloadable ( )

inline

Definition at line 98 of file knarticlecollection.h.

int KNArticleCollection::length ( )

inline

Definition at line 95 of file knarticlecollection.h.

unsigned int KNArticleCollection::lockedArticles ( )

inline

Definition at line 102 of file knarticlecollection.h.

void KNArticleCollection::remove

(

const KNArticle::Ptr &

art

)

Remove the article art from this collection.

Definition at line 194 of file knarticlecollection.cpp.

void KNArticleCollection::setLastID

(

)

Definition at line 230 of file knarticlecollection.cpp.

void KNArticleCollection::setNotUnloadable ( bool  b = true )

inline

Definition at line 99 of file knarticlecollection.h.

void KNArticleCollection::syncSearchIndex

(

)

Definition at line 240 of file knarticlecollection.cpp.

---

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

• knarticlecollection.h
• knarticlecollection.cpp