KNGroup Class Reference

#include <kngroup.h>

Inheritance diagram for KNGroup:

Classes
class	dynDataVer0
class	dynDataVer1

Public Types
typedef QList< KNGroup::Ptr >	List
typedef boost::shared_ptr < KNGroup >	Ptr
enum	Status { unknown =0, readOnly =1, postingAllowed =2, moderated =3 }
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 Types inherited from KNJobItem
typedef boost::shared_ptr < KNJobItem >	Ptr

Public Member Functions
	KNGroup (KNCollection::Ptr p=KNCollection::Ptr())
	~KNGroup ()
KNNntpAccount::Ptr	account ()
KNode::Cleanup *	activeCleanupConfig ()
void	appendXPostID (const QString &id)
KNRemoteArticle::Ptr	at (int i)
KNRemoteArticle::Ptr	byId (int id)
KNRemoteArticle::Ptr	byMessageId (const QByteArray &mId)
KNode::Cleanup *	cleanupConfig () const
void	decNewCount (int i=1)
void	decReadCount (int i=1)
const QByteArray	defaultCharset ()
QString	description () const
int	firstNewIndex () const
int	firstNr () const
const QString &	groupname ()
bool	hasName () const
virtual const KPIMIdentities::Identity &	identity () const
void	incNewCount (int i=1)
void	incReadCount (int i=1)
void	insortNewHeaders (const KIO::UDSEntryList &list, KNJobData *job=0)
bool	isLocked ()
int	lastFetchCount () const
int	lastNr () const
bool	loadHdrs ()
int	maxFetch () const
const QString &	name ()
int	newCount () const
QString	path ()
QString	prepareForExecution ()
void	processXPostBuffer (bool deleteAfterwards)
int	readCount () const
bool	readInfo (const QString &confPath)
void	reorganize ()
void	saveDynamicData (int cnt, bool ovr=false)
int	saveStaticData (int cnt, bool ovr=false)
void	scoreArticles (bool onlynew=true)
void	setDefaultCharset (const QByteArray &s)
void	setDescription (const QString &s)
void	setFirstNewIndex (int i)
void	setFirstNr (int i)
void	setGroupname (const QString &s)
virtual void	setIdentity (const KPIMIdentities::Identity &i)
void	setLastFetchCount (int i)
void	setLastNr (int i)
void	setLocked (bool l)
void	setMaxFetch (int i)
void	setNewCount (int i)
void	setReadCount (int i)
void	setStatus (Status s)
void	setUseCharset (bool b)
void	showProperties ()
int	statThrWithNew ()
int	statThrWithUnread ()
Status	status () const
void	syncDynamicData ()
collectionType	type ()
bool	unloadHdrs (bool force=true)
void	updateListItem ()
void	updateThreadInfo ()
bool	useCharset ()
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
KNCollection::Ptr	parent () const
void	setCount (int i)
void	setListItem (KNCollectionViewItem *i)
void	setName (const QString &s)
virtual void	setParent (KNCollection::Ptr p)
Public Member Functions inherited from KNJobItem
	KNJobItem ()
virtual	~KNJobItem ()
Public Member Functions inherited from KNode::SettingsContainerInterface
virtual	~SettingsContainerInterface ()

Protected Member Functions
void	buildThreads (int cnt, KNJobData *parent=0)
KNRemoteArticle::Ptr	findReference (KNRemoteArticle::Ptr a)
virtual KNCollection::Ptr	selfPtr ()
KNGroup::Ptr	thisGroupPtr ()
Protected Member Functions inherited from KNode::SettingsContainerInterface
	SettingsContainerInterface ()

Protected Attributes
QStringList	c_rosspostIDBuffer
QByteArray	d_efaultChSet
QString	d_escription
int	d_ynDataFormat
int	f_irstNew
int	f_irstNr
QString	g_roupname
int	i_gnoreCount
int	l_astFetchCount
int	l_astNr
bool	l_ocked
int	m_axFetch
KNode::Cleanup *	mCleanupConf
int	mIdentityUoid
QList< QByteArray >	mOptionalHeaders
int	n_ewCount
int	r_eadCount
Status	s_tatus
bool	u_seCharset
Protected Attributes inherited from KNCollection
int	c_ount
KNCollectionViewItem *	l_istItem
QString	n_ame
KNCollection::Ptr	p_arent

Detailed Description

Representation of a news group.

This class contains:

• Static information about a news group (eg. the name and account)
• Dynamic information about a news group (eg. article serial numbers)
• Group specific settings (eg. identities or cleanup settings)
• Load and store methods for the header list of this group

Definition at line 41 of file kngroup.h.

Member Typedef Documentation

typedef QList<KNGroup::Ptr> KNGroup::List

List of groups.

Definition at line 56 of file kngroup.h.

typedef boost::shared_ptr<KNGroup> KNGroup::Ptr

Shared pointer to a KNGroup.

To be used instead of raw KNGroup*.

Definition at line 47 of file kngroup.h.

Member Enumeration Documentation

enum KNGroup::Status

The posting rights status of this group.

Enumerator
unknown
readOnly
postingAllowed
moderated

Definition at line 50 of file kngroup.h.

Constructor & Destructor Documentation

KNGroup::KNGroup ( KNCollection::Ptr  p = KNCollection::Ptr() )

explicit

Definition at line 46 of file kngroup.cpp.

KNGroup::~KNGroup

(

)

Definition at line 56 of file kngroup.cpp.

Member Function Documentation

KNNntpAccount::Ptr KNGroup::account

(

)

Returns the account this group belongs to.

Definition at line 161 of file kngroup.cpp.

KNode::Cleanup * KNGroup::activeCleanupConfig

(

)

Returns the active cleanup configuration of this group, ie.

the "lowest" available cleanup configuration.

Definition at line 1119 of file kngroup.cpp.

void KNGroup::appendXPostID

(

const QString &

id

)

mark articles with this id as read when we later load the headers / fetch new articles

Definition at line 670 of file kngroup.cpp.

KNRemoteArticle::Ptr KNGroup::at ( int  i )

inline

Definition at line 120 of file kngroup.h.

void KNGroup::buildThreads ( int  cnt, KNJobData *  parent = 0  )

protected

Definition at line 697 of file kngroup.cpp.

KNRemoteArticle::Ptr KNGroup::byId ( int  id )

inline

Definition at line 122 of file kngroup.h.

KNRemoteArticle::Ptr KNGroup::byMessageId ( const QByteArray &  mId )

inline

Definition at line 124 of file kngroup.h.

KNode::Cleanup* KNGroup::cleanupConfig ( ) const

inline

Returns the cleanup configuration of this group (might be empty).

Definition at line 187 of file kngroup.h.

void KNGroup::decNewCount ( int  i = 1 )

inline

Definition at line 85 of file kngroup.h.

void KNGroup::decReadCount ( int  i = 1 )

inline

Definition at line 95 of file kngroup.h.

const QByteArray KNGroup::defaultCharset ( )

inline

Returns the default charset for this group.

Definition at line 152 of file kngroup.h.

QString KNGroup::description ( ) const

inline

Returns the group description.

Definition at line 75 of file kngroup.h.

KNRemoteArticle::Ptr KNGroup::findReference ( KNRemoteArticle::Ptr  a )

protected

Returns the first message that appears in the References header of a and which exists in this group.

Definition at line 888 of file kngroup.cpp.

int KNGroup::firstNewIndex ( ) const

inline

Definition at line 86 of file kngroup.h.

int KNGroup::firstNr ( ) const

inline

Returns the smallest available article serial number in this group.

Definition at line 98 of file kngroup.h.

const QString& KNGroup::groupname ( )

inline

Definition at line 72 of file kngroup.h.

bool KNGroup::hasName ( ) const

inline

name

Definition at line 70 of file kngroup.h.

const KPIMIdentities::Identity & KNGroup::identity ( ) const

virtual

Returns the identity configured for this group.

It is the null identity if there is none.

Implements KNode::SettingsContainerInterface.

Definition at line 169 of file kngroup.cpp.

void KNGroup::incNewCount ( int  i = 1 )

inline

Definition at line 84 of file kngroup.h.

void KNGroup::incReadCount ( int  i = 1 )

inline

Definition at line 94 of file kngroup.h.

void KNGroup::insortNewHeaders	(	const KIO::UDSEntryList &	list,
		KNJobData *	job = 0
	)

Insert headers of new articles into this group, and then sort.

Definition at line 390 of file kngroup.cpp.

bool KNGroup::isLocked ( )

inlinevirtual

locking

Reimplemented from KNJobItem.

Definition at line 146 of file kngroup.h.

int KNGroup::lastFetchCount ( ) const

inline

Definition at line 89 of file kngroup.h.

int KNGroup::lastNr ( ) const

inline

Returns the largest used article serial number in this group.

Definition at line 104 of file kngroup.h.

bool KNGroup::loadHdrs

(

)

Load the stored headers from disk.

Definition at line 178 of file kngroup.cpp.

int KNGroup::maxFetch ( ) const

inline

Returns the maximal number of articles to download from the server.

Definition at line 110 of file kngroup.h.

const QString & KNGroup::name ( )

virtual

Returns the collection name.

Reimplemented from KNCollection.

Definition at line 68 of file kngroup.cpp.

int KNGroup::newCount ( ) const

inline

count + numbers

Definition at line 82 of file kngroup.h.

QString KNGroup::path ( )

virtual

info

Implements KNCollection.

Definition at line 62 of file kngroup.cpp.

QString KNGroup::prepareForExecution ( )

virtual

Reimplemented from KNJobItem.

Definition at line 1061 of file kngroup.cpp.

void KNGroup::processXPostBuffer

(

bool

deleteAfterwards

)

Definition at line 676 of file kngroup.cpp.

int KNGroup::readCount ( ) const

inline

Definition at line 92 of file kngroup.h.

bool KNGroup::readInfo ( const QString &  confPath )

virtual

Load the properties/settings of this collection.

Implements KNCollection.

Definition at line 90 of file kngroup.cpp.

void KNGroup::reorganize

(

)

Definition at line 965 of file kngroup.cpp.

void KNGroup::saveDynamicData	(	int	cnt,
		bool	ovr = false
	)

Definition at line 594 of file kngroup.cpp.

int KNGroup::saveStaticData	(	int	cnt,
		bool	ovr = false
	)

Definition at line 523 of file kngroup.cpp.

void KNGroup::scoreArticles

(

bool

onlynew = true

)

Definition at line 909 of file kngroup.cpp.

virtual KNCollection::Ptr KNGroup::selfPtr ( )

inlineprotectedvirtual

Reimplemented from KNArticleCollection::selfPtr().

Implements KNCollection.

Definition at line 274 of file kngroup.h.

void KNGroup::setDefaultCharset ( const QByteArray &  s )

inline

Sets the default charset for this group.

Parameters

s	The new default charset.

Definition at line 156 of file kngroup.h.

void KNGroup::setDescription ( const QString &  s )

inline

Sets the group description.

Parameters

s	The group description.

Definition at line 79 of file kngroup.h.

void KNGroup::setFirstNewIndex ( int  i )

inline

Definition at line 87 of file kngroup.h.

void KNGroup::setFirstNr ( int  i )

inline

Sets the smallest available serial number.

Parameters

i	The serial number.

Definition at line 102 of file kngroup.h.

void KNGroup::setGroupname ( const QString &  s )

inline

Definition at line 73 of file kngroup.h.

virtual void KNGroup::setIdentity ( const KPIMIdentities::Identity &  i )

inlinevirtual

Sets the identity for this group.

Parameters

i	The identity or a null Identity to unset it.

Implements KNode::SettingsContainerInterface.

Definition at line 171 of file kngroup.h.

void KNGroup::setLastFetchCount ( int  i )

inline

Definition at line 90 of file kngroup.h.

void KNGroup::setLastNr ( int  i )

inline

Sets the largest used serial number.

Parameters

i	The serial number.

Definition at line 108 of file kngroup.h.

void KNGroup::setLocked ( bool  l )

inlinevirtual

Reimplemented from KNJobItem.

Definition at line 147 of file kngroup.h.

void KNGroup::setMaxFetch ( int  i )

inline

Sets the maximal number of articles to download from the server.

Parameters

i	The maximal number of articles to download.

Definition at line 114 of file kngroup.h.

void KNGroup::setNewCount ( int  i )

inline

Definition at line 83 of file kngroup.h.

void KNGroup::setReadCount ( int  i )

inline

Definition at line 93 of file kngroup.h.

void KNGroup::setStatus ( Status  s )

inline

Sets the posting rights for this group.

Parameters

s	The new posting rights.

Definition at line 180 of file kngroup.h.

void KNGroup::setUseCharset ( bool  b )

inline

Definition at line 158 of file kngroup.h.

void KNGroup::showProperties

(

)

Shows the group properties dialog.

See also

KNGroupPropDlg

Definition at line 1030 of file kngroup.cpp.

int KNGroup::statThrWithNew

(

)

Definition at line 1044 of file kngroup.cpp.

int KNGroup::statThrWithUnread

(

)

Definition at line 1053 of file kngroup.cpp.

Status KNGroup::status ( ) const

inline

Returns the posting rights of this group.

Definition at line 176 of file kngroup.h.

void KNGroup::syncDynamicData

(

)

Definition at line 626 of file kngroup.cpp.

KNGroup::Ptr KNGroup::thisGroupPtr ( )

protected

Returns a shared pointer pointing to this group.

Definition at line 1126 of file kngroup.cpp.

collectionType KNGroup::type ( )

inlinevirtual

type

Implements KNCollection.

Definition at line 59 of file kngroup.h.

bool KNGroup::unloadHdrs

(

bool

force = true

)

Definition at line 367 of file kngroup.cpp.

void KNGroup::updateListItem ( )

virtual

list-item handling

Reimplemented from KNCollection.

Definition at line 77 of file kngroup.cpp.

void KNGroup::updateThreadInfo

(

)

article handling

Definition at line 988 of file kngroup.cpp.

bool KNGroup::useCharset ( )

inline

Definition at line 157 of file kngroup.h.

void KNGroup::writeConfig ( )

virtual

Save the configuration to disk.

Implements KNode::SettingsContainerInterface.

Definition at line 124 of file kngroup.cpp.

Member Data Documentation

QStringList KNGroup::c_rosspostIDBuffer

protected

Definition at line 222 of file kngroup.h.

QByteArray KNGroup::d_efaultChSet

protected

The default charset of this group.

Definition at line 213 of file kngroup.h.

QString KNGroup::d_escription

protected

Definition at line 214 of file kngroup.h.

int KNGroup::d_ynDataFormat

protected

Definition at line 202 of file kngroup.h.

int KNGroup::f_irstNew

protected

Definition at line 202 of file kngroup.h.

int KNGroup::f_irstNr

protected

Definition at line 202 of file kngroup.h.

QString KNGroup::g_roupname

protected

Definition at line 214 of file kngroup.h.

int KNGroup::i_gnoreCount

protected

Definition at line 202 of file kngroup.h.

int KNGroup::l_astFetchCount

protected

Definition at line 202 of file kngroup.h.

int KNGroup::l_astNr

protected

Definition at line 202 of file kngroup.h.

bool KNGroup::l_ocked

protected

Definition at line 217 of file kngroup.h.

int KNGroup::m_axFetch

protected

Definition at line 202 of file kngroup.h.

KNode::Cleanup* KNGroup::mCleanupConf

protected

Definition at line 236 of file kngroup.h.

int KNGroup::mIdentityUoid

protected

Unique object identifier of the identity of this group.

-1 means there is no specific identity for this group (because KPIMIdentities::Identity::uoid() returns an unsigned int.

Definition at line 234 of file kngroup.h.

QList<QByteArray> KNGroup::mOptionalHeaders

protected

Optional headers provided by the XOVER command.

These headers will be saved within the static data.

Definition at line 227 of file kngroup.h.

int KNGroup::n_ewCount

protected

Definition at line 202 of file kngroup.h.

int KNGroup::r_eadCount

protected

Definition at line 202 of file kngroup.h.

Status KNGroup::s_tatus

protected

Definition at line 220 of file kngroup.h.

bool KNGroup::u_seCharset

protected

Definition at line 217 of file kngroup.h.

---

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

• kngroup.h
• kngroup.cpp