KNFolder Class Reference

#include <knfolder.h>

Inheritance diagram for KNFolder:

Classes
class	DynData

Public Types
typedef QList< KNFolder::Ptr >	List
typedef boost::shared_ptr < KNFolder >	Ptr
Public Types inherited from KNArticleCollection
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
	KNFolder ()
	KNFolder (int id, const QString &name, KNFolder::Ptr parent=KNFolder::Ptr())
	KNFolder (int id, const QString &name, const QString &prefix, KNFolder::Ptr parent=KNFolder::Ptr())
	~KNFolder ()
KNLocalArticle::Ptr	at (int i)
KNLocalArticle::Ptr	byId (int id)
KNLocalArticle::Ptr	byMessageId (const QByteArray &mId)
void	deleteAll ()
void	deleteFiles ()
int	id () const
bool	isRootFolder ()
bool	isStandardFolder ()
bool	loadArticle (KNLocalArticle::Ptr a)
bool	loadHdrs ()
int	parentId () const
QString	path ()
bool	readInfo (const QString &confPath)
bool	readInfo ()
void	removeArticles (KNLocalArticle::List &l, bool del=true)
bool	saveArticles (KNLocalArticle::List &l)
void	setId (int i)
void	setParent (KNCollection::Ptr p)
void	syncIndex (bool force=false)
collectionType	type ()
bool	unloadHdrs (bool force=true)
void	updateListItem ()
bool	wasOpen () const
void	writeConfig ()
Public Member Functions inherited from KNArticleCollection
	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
void	setCount (int i)
void	setListItem (KNCollectionViewItem *i)
void	setName (const QString &s)

Protected Member Functions
void	closeFiles ()

Protected Attributes
int	i_d
bool	i_ndexDirty
QFile	i_ndexFile
QString	i_nfoPath
QFile	m_boxFile
int	p_arentId
bool	w_asOpen
Protected Attributes inherited from KNCollection
int	c_ount
KNCollectionViewItem *	l_istItem
QString	n_ame
KNCollection::Ptr	p_arent

Detailed Description

Representation of a folder.

This includes:

• Information about the folder (eg. name, parent)
• Methods to load the folder content from a mbox file.
• Methods to store the folder content in a mbox file.

Definition at line 30 of file knfolder.h.

Member Typedef Documentation

typedef QList<KNFolder::Ptr> KNFolder::List

List of folders.

Definition at line 42 of file knfolder.h.

typedef boost::shared_ptr<KNFolder> KNFolder::Ptr

Shared pointer to a KNFolder.

To be used instead of raw KNFolder*.

Definition at line 38 of file knfolder.h.

Constructor & Destructor Documentation

KNFolder::KNFolder

(

)

Definition at line 39 of file knfolder.cpp.

KNFolder::KNFolder	(	int	id,
		const QString &	name,
		KNFolder::Ptr	parent = KNFolder::Ptr()
	)

Definition at line 46 of file knfolder.cpp.

KNFolder::KNFolder	(	int	id,
		const QString &	name,
		const QString &	prefix,
		KNFolder::Ptr	parent = KNFolder::Ptr()
	)

Definition at line 65 of file knfolder.cpp.

KNFolder::~KNFolder

(

)

Definition at line 84 of file knfolder.cpp.

Member Function Documentation

KNLocalArticle::Ptr KNFolder::at ( int  i )

inline

Definition at line 70 of file knfolder.h.

KNLocalArticle::Ptr KNFolder::byId ( int  id )

inline

Definition at line 72 of file knfolder.h.

KNLocalArticle::Ptr KNFolder::byMessageId ( const QByteArray &  mId )

inline

Definition at line 74 of file knfolder.h.

void KNFolder::closeFiles ( )

protected

Definition at line 537 of file knfolder.cpp.

void KNFolder::deleteAll

(

)

Definition at line 489 of file knfolder.cpp.

void KNFolder::deleteFiles

(

)

Definition at line 505 of file knfolder.cpp.

int KNFolder::id ( ) const

inline

Definition at line 53 of file knfolder.h.

bool KNFolder::isRootFolder ( )

inline

Definition at line 57 of file knfolder.h.

bool KNFolder::isStandardFolder ( )

inline

Definition at line 56 of file knfolder.h.

bool KNFolder::loadArticle

(

KNLocalArticle::Ptr

a

)

Load the full content of an article.

Parameters

a	the article to load.

Returns

true if the article is successfully loaded.

Definition at line 314 of file knfolder.cpp.

bool KNFolder::loadHdrs

(

)

Definition at line 169 of file knfolder.cpp.

int KNFolder::parentId ( ) const

inline

Definition at line 55 of file knfolder.h.

QString KNFolder::path ( )

virtual

Implements KNCollection.

Definition at line 100 of file knfolder.cpp.

bool KNFolder::readInfo ( const QString &  confPath )

virtual

Load the properties/settings of this collection.

Implements KNCollection.

Definition at line 109 of file knfolder.cpp.

bool KNFolder::readInfo

(

)

Definition at line 140 of file knfolder.cpp.

void KNFolder::removeArticles	(	KNLocalArticle::List &	l,
		bool	del = true
	)

Definition at line 449 of file knfolder.cpp.

bool KNFolder::saveArticles

(

KNLocalArticle::List &

l

)

Definition at line 355 of file knfolder.cpp.

void KNFolder::setId ( int  i )

inline

Definition at line 54 of file knfolder.h.

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

virtual

Sets the parent collection.

Reimplemented from KNCollection.

Definition at line 162 of file knfolder.cpp.

void KNFolder::syncIndex

(

bool

force = false

)

Definition at line 513 of file knfolder.cpp.

collectionType KNFolder::type ( )

inlinevirtual

Returns the collection type.

Implements KNCollection.

Definition at line 50 of file knfolder.h.

bool KNFolder::unloadHdrs

(

bool

force = true

)

Definition at line 293 of file knfolder.cpp.

void KNFolder::updateListItem ( )

virtual

Updates the listview item after the collection has changed.

Reimplemented from KNCollection.

Definition at line 90 of file knfolder.cpp.

bool KNFolder::wasOpen ( ) const

inline

Definition at line 61 of file knfolder.h.

void KNFolder::writeConfig ( )

virtual

Save the properties/settings of this collection.

Implements KNCollection.

Definition at line 146 of file knfolder.cpp.

Member Data Documentation

int KNFolder::i_d

protected

Definition at line 99 of file knfolder.h.

bool KNFolder::i_ndexDirty

protected

Definition at line 101 of file knfolder.h.

QFile KNFolder::i_ndexFile

protected

Definition at line 104 of file knfolder.h.

QString KNFolder::i_nfoPath

protected

Definition at line 105 of file knfolder.h.

QFile KNFolder::m_boxFile

protected

Definition at line 103 of file knfolder.h.

int KNFolder::p_arentId

protected

Definition at line 100 of file knfolder.h.

bool KNFolder::w_asOpen

protected

Definition at line 102 of file knfolder.h.

---

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

• knfolder.h
• knfolder.cpp