Akregator::FeedList Class Reference

#include <feedlist.h>

Inheritance diagram for Akregator::FeedList:

Signals
void	fetchAborted (Akregator::Feed *)
void	fetchDiscovery (Akregator::Feed *)
void	fetched (Akregator::Feed *)
void	fetchError (Akregator::Feed *)
void	fetchStarted (Akregator::Feed *)
void	signalAboutToRemoveNode (Akregator::TreeNode *)
void	signalDestroyed (Akregator::FeedList *)
void	signalNodeAdded (Akregator::TreeNode *)
void	signalNodeChanged (Akregator::TreeNode *)
void	signalNodeRemoved (Akregator::TreeNode *)
void	unreadCountChanged (int unread)

Public Member Functions
	FeedList (Akregator::Backend::Storage *storage)
	~FeedList ()
void	addToFetchQueue (FetchQueue *queue, bool intervalOnly=false)
const Folder *	allFeedsFolder () const
Folder *	allFeedsFolder ()
void	append (FeedList *list, Folder *parent=0, TreeNode *after=0)
KJob *	createMarkAsReadJob ()
QVector< int >	feedIds () const
QVector< const Feed * >	feeds () const
QVector< Feed * >	feeds ()
const Article	findArticle (const QString &feedURL, const QString &guid) const
const TreeNode *	findByID (int id) const
TreeNode *	findByID (int id)
QList< const TreeNode * >	findByTitle (const QString &title) const
QList< TreeNode * >	findByTitle (const QString &title)
const Feed *	findByURL (const QString &feedURL) const
Feed *	findByURL (const QString &feedURL)
QVector< const Folder * >	folders () const
QVector< Folder * >	folders ()
bool	isEmpty () const
bool	readFromOpml (const QDomDocument &doc)
void	setTitle (const QString &name)
QString	title () const
QDomDocument	toOpml () const
int	unread () const

Detailed Description

The model of a feed tree, represents an OPML document.

Contains an additional root node "All Feeds" which isn't stored. Note that a node instance must not be in more than one FeedList at a time! When deleting the feed list, all contained nodes are deleted!

Definition at line 77 of file feedlist.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 175 of file feedlist.cpp.

Akregator::FeedList::~FeedList

(

)

Destructor.

Contained nodes are deleted!

Definition at line 312 of file feedlist.cpp.

Member Function Documentation

void Akregator::FeedList::addToFetchQueue	(	FetchQueue *	queue,
		bool	intervalOnly = false
	)

Definition at line 486 of file feedlist.cpp.

const Folder * Akregator::FeedList::allFeedsFolder

(

)

const

Definition at line 406 of file feedlist.cpp.

Folder * Akregator::FeedList::allFeedsFolder

(

)

Definition at line 411 of file feedlist.cpp.

void Akregator::FeedList::append	(	FeedList *	list,
		Folder *	parent = 0,
		TreeNode *	after = 0
	)

appends another feed list as sub tree.

The root node of list is ignored. NOTE: nodes are moved from list to this feed list, not copied

Definition at line 343 of file feedlist.cpp.

KJob * Akregator::FeedList::createMarkAsReadJob

(

)

Definition at line 491 of file feedlist.cpp.

QVector< int > Akregator::FeedList::feedIds

(

)

const

Definition at line 183 of file feedlist.cpp.

QVector< const Feed * > Akregator::FeedList::feeds

(

)

const

returns all feeds in this list

Definition at line 191 of file feedlist.cpp.

QVector< Feed * > Akregator::FeedList::feeds

(

)

Definition at line 199 of file feedlist.cpp.

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

signal

emitted when a fetch is aborted

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

signal

emitted when a feed URL was found by auto discovery

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

signal

emitted when feed finished fetching

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

signal

emitted when a fetch error occurred

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

signal

emitted when fetching started

const Article Akregator::FeedList::findArticle	(	const QString &	feedURL,
		const QString &	guid
	)		const

Definition at line 337 of file feedlist.cpp.

const TreeNode * Akregator::FeedList::findByID

(

int

id

)

const

Definition at line 386 of file feedlist.cpp.

TreeNode * Akregator::FeedList::findByID

(

int

id

)

Definition at line 391 of file feedlist.cpp.

QList< const TreeNode * > Akregator::FeedList::findByTitle

(

const QString &

title

)

const

Definition at line 396 of file feedlist.cpp.

QList< TreeNode * > Akregator::FeedList::findByTitle

(

const QString &

title

)

Definition at line 401 of file feedlist.cpp.

const Feed * Akregator::FeedList::findByURL

(

const QString &

feedURL

)

const

returns a feed object for a given feed URL.

If the feed list does not contain a feed with url, NULL is returned. If it contains the same feed multiple times, any of the Feed objects is returned.

Definition at line 321 of file feedlist.cpp.

Feed * Akregator::FeedList::findByURL

(

const QString &

feedURL

)

Definition at line 329 of file feedlist.cpp.

QVector< const Folder * > Akregator::FeedList::folders

(

)

const

returns all folders in this list

Definition at line 204 of file feedlist.cpp.

QVector< Folder * > Akregator::FeedList::folders

(

)

Definition at line 212 of file feedlist.cpp.

bool Akregator::FeedList::isEmpty

(

)

const

Definition at line 416 of file feedlist.cpp.

bool Akregator::FeedList::readFromOpml

(

const QDomDocument &

doc

)

reads an OPML document and appends the items to this list

Parameters

doc	the OPML document to parse

Returns

whether parsing was successful or not (TODO: make errors more detailed)

Definition at line 263 of file feedlist.cpp.

void Akregator::FeedList::setTitle

(

const QString &

name

)

sets the title of the feed list

void Akregator::FeedList::signalAboutToRemoveNode ( Akregator::TreeNode *  )

signal

void Akregator::FeedList::signalDestroyed ( Akregator::FeedList *  )

signal

void Akregator::FeedList::signalNodeAdded ( Akregator::TreeNode *  )

signal

emitted when a node was added to the list

void Akregator::FeedList::signalNodeChanged ( Akregator::TreeNode *  )

signal

void Akregator::FeedList::signalNodeRemoved ( Akregator::TreeNode *  )

signal

emitted when a node was removed from the list

QString Akregator::FeedList::title

(

)

const

returns the title of the feed list (as used in the OPML document)

QDomDocument Akregator::FeedList::toOpml

(

)

const

exports the feed list as OPML.

The root node ("All Feeds") is ignored!

Definition at line 362 of file feedlist.cpp.

int Akregator::FeedList::unread

(

)

const

Definition at line 480 of file feedlist.cpp.

void Akregator::FeedList::unreadCountChanged ( int  unread )

signal

---

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

• feedlist.h
• feedlist.cpp