#include <feed.h>

Inheritance diagram for Akregator::Feed:

Public Types
enum	ArchiveMode { globalDefault, keepAllArticles, disableArchiving, limitArticleNumber, limitArticleAge }

Public Slots
void	fetch (bool followDiscovery=false)

void	slotAbortFetch ()

void	slotAddFeedIconListener ()

void	slotAddToFetchQueue (Akregator::FetchQueue *queue, bool intervalFetchOnly=false)

Public Slots inherited from Akregator::TreeNode
virtual void	slotAddToFetchQueue (Akregator::FetchQueue *queue, bool intervalFetchesOnly=false)=0

Signals
void	fetchAborted (Akregator::Feed *)

void	fetchDiscovery (Akregator::Feed *)

void	fetched (Akregator::Feed *)

void	fetchError (Akregator::Feed *)

void	fetchStarted (Akregator::Feed *)

Signals inherited from Akregator::TreeNode
void	signalArticlesAdded (Akregator::TreeNode *, const QList< Akregator::Article > &guids)

void	signalArticlesRemoved (Akregator::TreeNode *, const QList< Akregator::Article > &guids)

void	signalArticlesUpdated (Akregator::TreeNode *, const QList< Akregator::Article > &guids)

void	signalChanged (Akregator::TreeNode *)

void	signalDestroyed (Akregator::TreeNode *)

Public Member Functions
	Feed (Akregator::Backend::Storage *storage)

	~Feed ()

bool	accept (TreeNodeVisitor *visitor)

ArchiveMode	archiveMode () const

KJob *	createMarkAsReadJob ()

void	deleteExpiredArticles (Akregator::ArticleDeleteJob *job)

QString	description () const

QVector< const Feed * >	feeds () const

QVector< Feed * >	feeds ()

Syndication::ErrorCode	fetchErrorCode () const

bool	fetchErrorOccurred () const

int	fetchInterval () const

Article	findArticle (const QString &guid) const

QVector< const Folder * >	folders () const

QVector< Folder * >	folders ()

QString	htmlUrl () const

QIcon	icon () const

QPixmap	image () const

bool	isAggregation () const

bool	isArticlesLoaded () const

bool	isFetching () const

bool	isGroup () const

bool	loadLinkedWebsite () const

bool	markImmediatelyAsRead () const

int	maxArticleAge () const

int	maxArticleNumber () const

const TreeNode *	next () const

TreeNode *	next ()

void	setArchiveMode (ArchiveMode archiveMode)

void	setCustomFetchIntervalEnabled (bool enabled)

void	setDescription (const QString &s)

void	setFavicon (const QIcon &icon)

void	setFetchInterval (int interval)

void	setHtmlUrl (const QString &s)

void	setImage (const QPixmap &p)

void	setLoadLinkedWebsite (bool enabled)

void	setMarkImmediatelyAsRead (bool enabled)

void	setMaxArticleAge (int maxArticleAge)

void	setMaxArticleNumber (int maxArticleNumber)

void	setUseNotification (bool enabled)

void	setXmlUrl (const QString &s)

QDomElement	toOPML (QDomElement parent, QDomDocument document) const

int	totalCount () const

int	unread () const

bool	useCustomFetchInterval () const

bool	useNotification () const

QString	xmlUrl () const

Public Member Functions inherited from Akregator::TreeNode
	TreeNode ()

virtual	~TreeNode ()

virtual TreeNode *	childAt (int pos)

virtual const TreeNode *	childAt (int pos) const

virtual QList< const TreeNode * >	children () const

virtual QList< TreeNode * >	children ()

ArticleListJob *	createListJob ()

virtual uint	id () const

QPoint	listViewScrollBarPositions () const

virtual const TreeNode *	nextSibling () const

virtual TreeNode *	nextSibling ()

virtual const Folder *	parent () const

virtual Folder *	parent ()

virtual const TreeNode *	prevSibling () const

virtual TreeNode *	prevSibling ()

virtual void	setId (uint id)

void	setListViewScrollBarPositions (const QPoint &pos)

virtual void	setNotificationMode (bool doNotify)

virtual void	setParent (Folder *parent)

void	setTitle (const QString &title)

QString	title () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from Akregator::FaviconListener
virtual	~FaviconListener ()

Static Public Member Functions
static QString	archiveModeToString (ArchiveMode mode)

static Feed *	fromOPML (QDomElement e, Akregator::Backend::Storage *storage)

static ArchiveMode	stringToArchiveMode (const QString &str)

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Additional Inherited Members
Protected Member Functions inherited from Akregator::TreeNode
virtual void	articlesModified ()

void	emitSignalDestroyed ()

virtual void	nodeModified ()

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

represents a feed

Definition at line 53 of file feed.h.

Member Enumeration Documentation

enum Akregator::Feed::ArchiveMode

the archiving modes

Enumerator
globalDefault	use default from Settings (default)
keepAllArticles	Don't delete any articles.
disableArchiving	Don't save any articles except articles with keep flag set (equal to maxArticleNumber() == 0)
limitArticleNumber	Save maxArticleNumber() articles, plus the ones with keep flag set.
limitArticleAge	Save articles not older than maxArticleAge() (or keep flag set)

Definition at line 61 of file feed.h.

Constructor & Destructor Documentation

Akregator::Feed::Feed ( Akregator::Backend::Storage * storage )

explicit

default constructor

Definition at line 310 of file feed.cpp.

Akregator::Feed::~Feed ( )

Definition at line 314 of file feed.cpp.

Member Function Documentation

bool Akregator::Feed::accept ( TreeNodeVisitor * visitor )

virtual

Implements Akregator::TreeNode.

Definition at line 178 of file feed.cpp.

Akregator::Feed::ArchiveMode Akregator::Feed::archiveMode ( ) const

returns the archiving mode which is used for this feed

Definition at line 736 of file feed.cpp.

QString Akregator::Feed::archiveModeToString ( ArchiveMode mode )

static

converts ArchiveMode values to corresponding strings

Definition at line 116 of file feed.cpp.

KJob * Akregator::Feed::createMarkAsReadJob ( )

virtual

Implements Akregator::TreeNode.

Definition at line 422 of file feed.cpp.

void Akregator::Feed::deleteExpiredArticles ( Akregator::ArticleDeleteJob * job )

deletes expired articles

Definition at line 696 of file feed.cpp.

QString Akregator::Feed::description ( ) const

returns the description of this feed

Definition at line 385 of file feed.cpp.

QVector< const Akregator::Feed * > Akregator::Feed::feeds ( ) const

virtual

Implements Akregator::TreeNode.

Definition at line 196 of file feed.cpp.

QVector< Akregator::Feed * > Akregator::Feed::feeds ( )

virtual

Implements Akregator::TreeNode.

Definition at line 203 of file feed.cpp.

void Akregator::Feed::fetch ( bool followDiscovery = false )

slot

starts fetching

Definition at line 572 of file feed.cpp.

void Akregator::Feed::fetchAborted ( Akregator::Feed * )

signal

emitted when a fetch is aborted

void Akregator::Feed::fetchDiscovery ( Akregator::Feed * )

signal

emitted when a feed URL was found by auto discovery

void Akregator::Feed::fetched ( Akregator::Feed * )

signal

emitted when feed finished fetching

void Akregator::Feed::fetchError ( Akregator::Feed * )

signal

emitted when a fetch error occurred

Syndication::ErrorCode Akregator::Feed::fetchErrorCode ( ) const

Definition at line 391 of file feed.cpp.

bool Akregator::Feed::fetchErrorOccurred ( ) const

returns whether a fetch error has occurred

Definition at line 389 of file feed.cpp.

int Akregator::Feed::fetchInterval ( ) const

Returns custom auto fetch interval of this feed.

Returns: custom fetch interval in minutes, 0 if disabled

Definition at line 327 of file feed.cpp.

void Akregator::Feed::fetchStarted ( Akregator::Feed * )

signal

emitted when fetching started

Article Akregator::Feed::findArticle ( const QString & guid ) const

returns article by guid

Parameters

guid	the guid of the article to be returned

Returns: the article object with the given guid, or a null article if non-existent

Definition at line 210 of file feed.cpp.

QVector< const Folder * > Akregator::Feed::folders ( ) const

virtual

Implements Akregator::TreeNode.

Definition at line 186 of file feed.cpp.

QVector< Folder * > Akregator::Feed::folders ( )

virtual

Implements Akregator::TreeNode.

Definition at line 191 of file feed.cpp.

Akregator::Feed * Akregator::Feed::fromOPML	(	QDomElement	e,
		Akregator::Backend::Storage *	storage
	)

static

creates a Feed object from a description in OPML format

Definition at line 134 of file feed.cpp.

QString Akregator::Feed::htmlUrl ( ) const

returns the URL of the HTML page of this feed

Definition at line 381 of file feed.cpp.

QIcon Akregator::Feed::icon ( ) const

virtual

Implements Akregator::TreeNode.

Definition at line 688 of file feed.cpp.

QPixmap Akregator::Feed::image ( ) const

returns the feed image

Definition at line 370 of file feed.cpp.

bool Akregator::Feed::isAggregation ( ) const

inlinevirtual

returns if the node represents an aggregation, i.e.

containing items from more than once source feed. Folders and virtual folders are aggregations, feeds are not.

Implements Akregator::TreeNode.

Definition at line 198 of file feed.h.

bool Akregator::Feed::isArticlesLoaded ( ) const

returns if the article archive of this feed is loaded

Definition at line 393 of file feed.cpp.

bool Akregator::Feed::isFetching ( ) const

Definition at line 341 of file feed.cpp.

bool Akregator::Feed::isGroup ( ) const

inlinevirtual

returns if this node is a feed group (false here)

Implements Akregator::TreeNode.

Definition at line 195 of file feed.h.

bool Akregator::Feed::loadLinkedWebsite ( ) const

Definition at line 365 of file feed.cpp.

bool Akregator::Feed::markImmediatelyAsRead ( ) const

if true, new articles are marked immediately as read instead of new/unread.

Useful for high-traffic feeds.

Definition at line 339 of file feed.cpp.

int Akregator::Feed::maxArticleAge ( ) const

returns the maximum age of articles used for expiration by age (used in limitArticleAge archive mode)

Returns: expiry age in days

Definition at line 331 of file feed.cpp.

int Akregator::Feed::maxArticleNumber ( ) const

returns the article count limit used in limitArticleNumber archive mode

Definition at line 335 of file feed.cpp.

const TreeNode * Akregator::Feed::next ( ) const

virtual

returns the next node in the tree.

Calling next() unless it returns 0 iterates through the tree in pre-order

Implements Akregator::TreeNode.

Definition at line 809 of file feed.cpp.

TreeNode * Akregator::Feed::next ( )

virtual

Implements Akregator::TreeNode.

Definition at line 792 of file feed.cpp.

void Akregator::Feed::setArchiveMode ( ArchiveMode archiveMode )

sets the archiving mode for this feed

Definition at line 741 of file feed.cpp.

void Akregator::Feed::setCustomFetchIntervalEnabled ( bool enabled )

set if the feed has its custom fetch interval or uses the global setting

Parameters

enabled true: use custom interval, false: use global default

Definition at line 325 of file feed.cpp.

void Akregator::Feed::setDescription ( const QString & s )

sets the description of this feed

Definition at line 387 of file feed.cpp.

void Akregator::Feed::setFavicon ( const QIcon & icon )

virtual

sets the favicon (used in the tree view)

Implements Akregator::FaviconListener.

Definition at line 721 of file feed.cpp.

void Akregator::Feed::setFetchInterval ( int interval )

Sets custom auto fetch interval.

Parameters

interval interval in minutes, -1 for disabling auto fetching

Definition at line 329 of file feed.cpp.

void Akregator::Feed::setHtmlUrl ( const QString & s )

sets the URL of the HTML page of this feed

Definition at line 383 of file feed.cpp.

void Akregator::Feed::setImage ( const QPixmap & p )

sets the feed image

Definition at line 727 of file feed.cpp.

void Akregator::Feed::setLoadLinkedWebsite ( bool enabled )

if true, the linked URL is loaded directly in the article viewer instead of showing the description

Definition at line 360 of file feed.cpp.

void Akregator::Feed::setMarkImmediatelyAsRead ( bool enabled )

Definition at line 343 of file feed.cpp.

void Akregator::Feed::setMaxArticleAge ( int maxArticleAge )

sets the maximum age of articles used for expiration by age (used in limitArticleAge archive mode)

Parameters

maxArticleAge expiry age in days

Definition at line 333 of file feed.cpp.

void Akregator::Feed::setMaxArticleNumber ( int maxArticleNumber )

sets the article count limit used in limitArticleNumber archive mode

Definition at line 337 of file feed.cpp.

void Akregator::Feed::setUseNotification ( bool enabled )

Definition at line 350 of file feed.cpp.

void Akregator::Feed::setXmlUrl ( const QString & s )

sets the url of the actual feed source (rss/rdf/atom file)

Definition at line 374 of file feed.cpp.

void Akregator::Feed::slotAbortFetch ( )

slot

Definition at line 594 of file feed.cpp.

void Akregator::Feed::slotAddFeedIconListener ( )

slot

Definition at line 456 of file feed.cpp.

void Akregator::Feed::slotAddToFetchQueue	(	Akregator::FetchQueue *	queue,
		bool	intervalFetchOnly = `false`
	)

slot

add this feed to the fetch queue queue

Definition at line 433 of file feed.cpp.

Akregator::Feed::ArchiveMode Akregator::Feed::stringToArchiveMode ( const QString & str )

static

converts strings to ArchiveMode value if parsing fails, it returns ArchiveMode::globalDefault

Definition at line 270 of file feed.cpp.

QDomElement Akregator::Feed::toOPML	(	QDomElement	parent,
		QDomDocument	document
	)		const

virtual

exports the feed settings to OPML

Implements Akregator::TreeNode.

Definition at line 395 of file feed.cpp.

int Akregator::Feed::totalCount ( ) const

virtual

returns the number of total articles in this feed

Returns: number of articles

Implements Akregator::TreeNode.

Definition at line 785 of file feed.cpp.

int Akregator::Feed::unread ( ) const

virtual

returns the unread count for this feed

Implements Akregator::TreeNode.

Definition at line 746 of file feed.cpp.

bool Akregator::Feed::useCustomFetchInterval ( ) const

returns whether this feed uses its own fetch interval or the global setting

Returns: true iff this feed has a custom fetch interval

Definition at line 323 of file feed.cpp.

bool Akregator::Feed::useNotification ( ) const

Definition at line 355 of file feed.cpp.

QString Akregator::Feed::xmlUrl ( ) const

returns the url of the actual feed source (rss/rdf/atom file)

Definition at line 372 of file feed.cpp.

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

akregator

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

akregator

kdepim API Reference

Search