• Skip to content
• Skip to link menu

KDE 4.1 API Reference

• KDE API Reference
• kdepim

• Sitemap
• Contact Us

 

knode

KNGroup Class Reference

#include <kngroup.h>

Inheritance diagram for KNGroup:

[legend]

List of all members.

---

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 42 of file kngroup.h.

Public Types
typedef QList< KNGroup * >	List
enum	Status { unknown = 0, readOnly = 1, postingAllowed = 2, moderated = 3 }
Public Member Functions
KNNntpAccount *	account ()
KNode::Cleanup *	activeCleanupConfig ()
void	appendXPostID (const QString &id)
KNRemoteArticle *	at (int i)
KNRemoteArticle *	byId (int id)
KNRemoteArticle *	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
KNode::Identity *	identity () const
void	incNewCount (int i=1)
void	incReadCount (int i=1)
void	insortNewHeaders (const KIO::UDSEntryList &list, KNProtocolClient *client=0)
bool	isLocked ()
	KNGroup (KNCollection *p=0)
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)
void	saveInfo ()
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)
void	setIdentity (KNode::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 ()
	~KNGroup ()
Protected Member Functions
void	buildThreads (int cnt, KNProtocolClient *client=0)
KNRemoteArticle *	findReference (KNRemoteArticle *a)
Protected Attributes
QStringList	c_rosspostIDBuffer
QByteArray	d_efaultChSet
QString	d_escription
int	d_ynDataFormat
int	f_irstNew
int	f_irstNr
QString	g_roupname
KNode::Identity *	i_dentity
int	i_gnoreCount
int	l_astFetchCount
int	l_astNr
bool	l_ocked
int	m_axFetch
KNode::Cleanup *	mCleanupConf
QList< QByteArray >	mOptionalHeaders
int	n_ewCount
int	r_eadCount
Status	s_tatus
bool	u_seCharset
Classes
class	dynDataVer0
class	dynDataVer1

---

Member Typedef Documentation

typedef QList<KNGroup*> KNGroup::List

List of groups.

Definition at line 52 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 46 of file kngroup.h.

---

Constructor & Destructor Documentation

KNGroup::KNGroup

(

KNCollection *

p = 0

)

Definition at line 40 of file kngroup.cpp.

KNGroup::~KNGroup

(

)

Definition at line 49 of file kngroup.cpp.

---

Member Function Documentation

KNNntpAccount * KNGroup::account

(

)

Returns the account this group belongs to.

Definition at line 171 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 1133 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 676 of file kngroup.cpp.

KNRemoteArticle* KNGroup::at

(

int

i

)

[inline]

article access

Reimplemented from KNArticleCollection.

Definition at line 116 of file kngroup.h.

void KNGroup::buildThreads	(	int	cnt,
		KNProtocolClient *	client = 0
	)			[protected]

Definition at line 703 of file kngroup.cpp.

KNRemoteArticle* KNGroup::byId

(

int

id

)

[inline]

Reimplemented from KNArticleCollection.

Definition at line 117 of file kngroup.h.

KNRemoteArticle* KNGroup::byMessageId

(

const QByteArray &

mId

)

[inline]

Reimplemented from KNArticleCollection.

Definition at line 118 of file kngroup.h.

KNode::Cleanup* KNGroup::cleanupConfig

(

)

const [inline]

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

Definition at line 174 of file kngroup.h.

void KNGroup::decNewCount

(

int

i = 1

)

[inline]

Definition at line 81 of file kngroup.h.

void KNGroup::decReadCount

(

int

i = 1

)

[inline]

Definition at line 91 of file kngroup.h.

const QByteArray KNGroup::defaultCharset

(

)

[inline]

Returns the default charset for this group.

Definition at line 145 of file kngroup.h.

QString KNGroup::description

(

)

const [inline]

Returns the group description.

Definition at line 71 of file kngroup.h.

KNRemoteArticle * KNGroup::findReference

(

KNRemoteArticle *

a

)

[protected]

Definition at line 897 of file kngroup.cpp.

int KNGroup::firstNewIndex

(

)

const [inline]

Definition at line 82 of file kngroup.h.

int KNGroup::firstNr

(

)

const [inline]

Returns the smallest available article serial number in this group.

Definition at line 94 of file kngroup.h.

const QString& KNGroup::groupname

(

)

[inline]

Definition at line 68 of file kngroup.h.

bool KNGroup::hasName

(

)

const [inline]

name

Definition at line 66 of file kngroup.h.

KNode::Identity* KNGroup::identity

(

)

const [inline]

Returns the identity configured for this group (might be empty).

Definition at line 156 of file kngroup.h.

void KNGroup::incNewCount

(

int

i = 1

)

[inline]

Definition at line 80 of file kngroup.h.

void KNGroup::incReadCount

(

int

i = 1

)

[inline]

Definition at line 90 of file kngroup.h.

void KNGroup::insortNewHeaders	(	const KIO::UDSEntryList &	list,
		KNProtocolClient *	client = 0
	)

Definition at line 399 of file kngroup.cpp.

bool KNGroup::isLocked

(

)

[inline, virtual]

locking

Reimplemented from KNJobItem.

Definition at line 139 of file kngroup.h.

int KNGroup::lastFetchCount

(

)

const [inline]

Definition at line 85 of file kngroup.h.

int KNGroup::lastNr

(

)

const [inline]

Returns the largest used article serial number in this group.

Definition at line 100 of file kngroup.h.

bool KNGroup::loadHdrs

(

)

Load the stored headers from disk.

Definition at line 180 of file kngroup.cpp.

int KNGroup::maxFetch

(

)

const [inline]

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

Definition at line 106 of file kngroup.h.

const QString & KNGroup::name

(

)

[virtual]

Returns the collection name.

Reimplemented from KNCollection.

Definition at line 62 of file kngroup.cpp.

int KNGroup::newCount

(

)

const [inline]

count + numbers

Definition at line 78 of file kngroup.h.

QString KNGroup::path

(

)

[virtual]

info

Implements KNCollection.

Definition at line 56 of file kngroup.cpp.

QString KNGroup::prepareForExecution

(

)

[virtual]

Reimplemented from KNJobItem.

Definition at line 1076 of file kngroup.cpp.

void KNGroup::processXPostBuffer

(

bool

deleteAfterwards

)

Definition at line 682 of file kngroup.cpp.

int KNGroup::readCount

(

)

const [inline]

Definition at line 88 of file kngroup.h.

bool KNGroup::readInfo

(

const QString &

confPath

)

[virtual]

Load the properties/settings of this collection.

Implements KNCollection.

Definition at line 80 of file kngroup.cpp.

void KNGroup::reorganize

(

)

Definition at line 975 of file kngroup.cpp.

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

Definition at line 600 of file kngroup.cpp.

void KNGroup::saveInfo

(

)

[virtual]

Save the properties/settings of this collection.

Implements KNCollection.

Definition at line 122 of file kngroup.cpp.

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

Definition at line 529 of file kngroup.cpp.

void KNGroup::scoreArticles

(

bool

onlynew = true

)

Definition at line 919 of file kngroup.cpp.

void KNGroup::setDefaultCharset

(

const QByteArray &

s

)

[inline]

Sets the default charset for this group.

Parameters:

s

The new default charset.

Definition at line 149 of file kngroup.h.

void KNGroup::setDescription

(

const QString &

s

)

[inline]

Sets the group description.

Parameters:

s

The group description.

Definition at line 75 of file kngroup.h.

void KNGroup::setFirstNewIndex

(

int

i

)

[inline]

Definition at line 83 of file kngroup.h.

void KNGroup::setFirstNr

(

int

i

)

[inline]

Sets the smallest available serial number.

Parameters:

i

The serial number.

Definition at line 98 of file kngroup.h.

void KNGroup::setGroupname

(

const QString &

s

)

[inline]

Definition at line 69 of file kngroup.h.

void KNGroup::setIdentity

(

KNode::Identity *

i

)

[inline]

Sets the identity for this group.

Parameters:

i

The identity.

Definition at line 160 of file kngroup.h.

void KNGroup::setLastFetchCount

(

int

i

)

[inline]

Definition at line 86 of file kngroup.h.

void KNGroup::setLastNr

(

int

i

)

[inline]

Sets the largest used serial number.

Parameters:

i

The serial number.

Definition at line 104 of file kngroup.h.

void KNGroup::setLocked

(

bool

l

)

[inline, virtual]

Reimplemented from KNJobItem.

Definition at line 140 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 110 of file kngroup.h.

void KNGroup::setNewCount

(

int

i

)

[inline]

Definition at line 79 of file kngroup.h.

void KNGroup::setReadCount

(

int

i

)

[inline]

Definition at line 89 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 167 of file kngroup.h.

void KNGroup::setUseCharset

(

bool

b

)

[inline]

Definition at line 151 of file kngroup.h.

void KNGroup::showProperties

(

)

Shows the group properties dialog.

See also:

KNGroupPropDlg

Definition at line 1041 of file kngroup.cpp.

int KNGroup::statThrWithNew

(

)

Definition at line 1059 of file kngroup.cpp.

int KNGroup::statThrWithUnread

(

)

Definition at line 1068 of file kngroup.cpp.

Status KNGroup::status

(

)

const [inline]

Returns the posting rights of this group.

Definition at line 163 of file kngroup.h.

void KNGroup::syncDynamicData

(

)

Definition at line 632 of file kngroup.cpp.

collectionType KNGroup::type

(

)

[inline, virtual]

type

Implements KNCollection.

Definition at line 55 of file kngroup.h.

bool KNGroup::unloadHdrs

(

bool

force = true

)

Definition at line 377 of file kngroup.cpp.

void KNGroup::updateListItem

(

)

[virtual]

list-item handling

Reimplemented from KNCollection.

Definition at line 71 of file kngroup.cpp.

void KNGroup::updateThreadInfo

(

)

article handling

Definition at line 999 of file kngroup.cpp.

bool KNGroup::useCharset

(

)

[inline]

Definition at line 150 of file kngroup.h.

---

Member Data Documentation

QStringList KNGroup::c_rosspostIDBuffer [protected]

Definition at line 205 of file kngroup.h.

QByteArray KNGroup::d_efaultChSet [protected]

The default charset of this group.

Definition at line 196 of file kngroup.h.

QString KNGroup::d_escription [protected]

Definition at line 197 of file kngroup.h.

int KNGroup::d_ynDataFormat [protected]

Definition at line 185 of file kngroup.h.

int KNGroup::f_irstNew [protected]

Definition at line 185 of file kngroup.h.

int KNGroup::f_irstNr [protected]

Definition at line 185 of file kngroup.h.

QString KNGroup::g_roupname [protected]

Definition at line 197 of file kngroup.h.

KNode::Identity* KNGroup::i_dentity [protected]

Definition at line 212 of file kngroup.h.

int KNGroup::i_gnoreCount [protected]

Definition at line 185 of file kngroup.h.

int KNGroup::l_astFetchCount [protected]

Definition at line 185 of file kngroup.h.

int KNGroup::l_astNr [protected]

Definition at line 185 of file kngroup.h.

bool KNGroup::l_ocked [protected]

Definition at line 200 of file kngroup.h.

int KNGroup::m_axFetch [protected]

Definition at line 185 of file kngroup.h.

KNode::Cleanup* KNGroup::mCleanupConf [protected]

Definition at line 213 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 210 of file kngroup.h.

int KNGroup::n_ewCount [protected]

Definition at line 185 of file kngroup.h.

int KNGroup::r_eadCount [protected]

Definition at line 185 of file kngroup.h.

Status KNGroup::s_tatus [protected]

Definition at line 203 of file kngroup.h.

bool KNGroup::u_seCharset [protected]

Definition at line 200 of file kngroup.h.

---

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

• kngroup.h
• kngroup.cpp

knode

Skip menu "knode"

• Main Page
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Class Members
• Related Pages

kdepim

Skip menu "kdepim"

• akonadi
•   clients
•   kabc
•   kcal
•   kcm
• akregator
• console
•   kabcclient
•   konsolekalendar
• kaddressbook
• kalarm
•   lib
• kdgantt
• kdgantt1
• kjots
• kleopatra
• kmail
• kmobiletools
• knode
• knotes
• kontact
• kontactinterfaces
• korganizer
•   korgac
• kpilot
• ktimetracker
•   doc
• libkdepim
• libkholidays
• libkleo
• libkpgp
• maildir

Generated for kdepim by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal