KNArticle Class Reference

#include <knarticle.h>

Inheritance diagram for KNArticle:

Public Types
enum	articleType { ATmimeContent, ATremote, ATlocal }
typedef QList< KNArticle::Ptr >	List
typedef boost::shared_ptr < KNArticle >	Ptr
Public Types inherited from KNJobItem
typedef boost::shared_ptr < KNJobItem >	Ptr

Public Member Functions
	KNArticle (boost::shared_ptr< KNArticleCollection > c)
	~KNArticle ()
virtual void	clear ()
boost::shared_ptr < KNArticleCollection >	collection () const
int	id () const
bool	isLocked ()
bool	isNotUnloadable ()
bool	isOrphant () const
KNHdrViewItem *	listItem () const
void	setCollection (boost::shared_ptr< KNArticleCollection > c)
void	setId (int i)
void	setListItem (KNHdrViewItem *i, KNArticle::Ptr a)
void	setLocked (bool b=true)
void	setNotUnloadable (bool b=true)
virtual articleType	type () const
virtual void	updateListItem ()
Public Member Functions inherited from KNJobItem
	KNJobItem ()
virtual	~KNJobItem ()
virtual QString	prepareForExecution ()

Protected Attributes
boost::shared_ptr < KNArticleCollection >	c_ol
KMime::BoolFlags	f_lags
int	i_d
KNHdrViewItem *	i_tem

Detailed Description

This class encapsulates a generic article.

It provides all the usual headers of a RFC822-message. Further more it contains an unique id and can store a pointer to a QListViewItem. It is used as a base class for all visible articles.

Definition at line 37 of file knarticle.h.

Member Typedef Documentation

typedef QList<KNArticle::Ptr> KNArticle::List

List of articles.

Definition at line 43 of file knarticle.h.

typedef boost::shared_ptr<KNArticle> KNArticle::Ptr

Shared pointer to a KNArticle. To be used instead of raw KNArticle*.

Definition at line 41 of file knarticle.h.

Member Enumeration Documentation

enum KNArticle::articleType

Enumerator
ATmimeContent
ATremote
ATlocal

Definition at line 45 of file knarticle.h.

Constructor & Destructor Documentation

KNArticle::KNArticle ( boost::shared_ptr< KNArticleCollection >  c )

explicit

Definition at line 33 of file knarticle.cpp.

KNArticle::~KNArticle

(

)

Definition at line 39 of file knarticle.cpp.

Member Function Documentation

void KNArticle::clear ( )

virtual

Definition at line 45 of file knarticle.cpp.

boost::shared_ptr<KNArticleCollection> KNArticle::collection ( ) const

inline

Definition at line 84 of file knarticle.h.

int KNArticle::id ( ) const

inline

Returns the article id.

Definition at line 59 of file knarticle.h.

bool KNArticle::isLocked ( )

inlinevirtual

Reimplemented from KNJobItem.

Definition at line 76 of file knarticle.h.

bool KNArticle::isNotUnloadable ( )

inline

Definition at line 80 of file knarticle.h.

bool KNArticle::isOrphant ( ) const

inline

Definition at line 86 of file knarticle.h.

KNHdrViewItem* KNArticle::listItem ( ) const

inline

Definition at line 66 of file knarticle.h.

void KNArticle::setCollection ( boost::shared_ptr< KNArticleCollection >  c )

inline

Definition at line 85 of file knarticle.h.

void KNArticle::setId ( int  i )

inline

Sets the article id.

Parameters

i	The article id.

Definition at line 63 of file knarticle.h.

void KNArticle::setListItem	(	KNHdrViewItem *	i,
		KNArticle::Ptr	a
	)

Sets the headerview item associated to this article.

Parameters

i	The item associated to this item or 0 to break the link to the previous item.
a	The shared pointer of this article.

Definition at line 51 of file knarticle.cpp.

void KNArticle::setLocked ( bool  b = true )

virtual

Reimplemented from KNJobItem.

Definition at line 61 of file knarticle.cpp.

void KNArticle::setNotUnloadable ( bool  b = true )

inline

Definition at line 81 of file knarticle.h.

virtual articleType KNArticle::type ( ) const

inlinevirtual

Reimplemented in KNLocalArticle, and KNRemoteArticle.

Definition at line 56 of file knarticle.h.

virtual void KNArticle::updateListItem ( )

inlinevirtual

Reimplemented in KNLocalArticle, and KNRemoteArticle.

Definition at line 73 of file knarticle.h.

Member Data Documentation

boost::shared_ptr<KNArticleCollection> KNArticle::c_ol

protected

Definition at line 90 of file knarticle.h.

KMime::BoolFlags KNArticle::f_lags

protected

Definition at line 93 of file knarticle.h.

int KNArticle::i_d

protected

Definition at line 89 of file knarticle.h.

KNHdrViewItem* KNArticle::i_tem

protected

Definition at line 91 of file knarticle.h.

---

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

• knarticle.h
• knarticle.cpp