Akregator::FeedList Class Reference

#include <feedlist.h>

Inherits Akregator::NodeList.

Signals
void	signalDestroyed (FeedList *)

Public Member Functions
	FeedList (TQObject *parent=0, const char *name=0)
	~FeedList ()
void	append (FeedList *list, Folder *parent=0, TreeNode *after=0)
virtual bool	readFromXML (const TQDomDocument &doc)
virtual TQDomDocument	toXML () const
Feed *	findByURL (const TQString &feedURL) const
Article	findArticle (const TQString &feedURL, const TQString &guid) const
void	parseChildNodes (TQDomNode &node, Folder *parent)
	FeedList (const FeedList &)
FeedList &	operator= (const FeedList &)

Public Attributes
FeedListPrivate *	d

Protected Member Functions
virtual void	addNode (TreeNode *node, bool preserveID)
virtual void	removeNode (TreeNode *node)

Friends
class	AddNodeVisitor
class	RemoveNodeVisitor

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 44 of file feedlist.h.

Constructor & Destructor Documentation

FeedList() [1/2]

Akregator::FeedList::FeedList	(	TQObject *	parent = 0,
		const char *	name = 0
	)

Definition at line 85 of file feedlist.cpp.

~FeedList()

Akregator::FeedList::~FeedList

(

)

Destructor.

Contained nodes are deleted!

Definition at line 194 of file feedlist.cpp.

FeedList() [2/2]

Akregator::FeedList::FeedList ( const FeedList &  )

inline

Definition at line 88 of file feedlist.h.

Member Function Documentation

addNode()

void Akregator::FeedList::addNode ( TreeNode *  node, bool  preserveID  )

protectedvirtual

Definition at line 97 of file feedlist.cpp.

append()

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 219 of file feedlist.cpp.

findArticle()

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

Definition at line 212 of file feedlist.cpp.

findByURL()

Feed * Akregator::FeedList::findByURL

(

const TQString &

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 204 of file feedlist.cpp.

operator=()

FeedList & Akregator::FeedList::operator= ( const FeedList &  )

inline

Definition at line 89 of file feedlist.h.

parseChildNodes()

void Akregator::FeedList::parseChildNodes	(	TQDomNode &	node,
		Folder *	parent
	)

Definition at line 109 of file feedlist.cpp.

readFromXML()

bool Akregator::FeedList::readFromXML ( const TQDomDocument &  doc )

virtual

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 145 of file feedlist.cpp.

removeNode()

void Akregator::FeedList::removeNode ( TreeNode *  node )

protectedvirtual

Definition at line 103 of file feedlist.cpp.

toXML()

TQDomDocument Akregator::FeedList::toXML ( ) const

virtual

exports the feed list as OPML.

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

Definition at line 238 of file feedlist.cpp.

Friends And Related Function Documentation

AddNodeVisitor

friend class AddNodeVisitor

friend

Definition at line 91 of file feedlist.h.

RemoveNodeVisitor

friend class RemoveNodeVisitor

friend

Definition at line 94 of file feedlist.h.

Member Data Documentation

d

FeedListPrivate* Akregator::FeedList::d

Definition at line 98 of file feedlist.h.

---

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

• feedlist.h
• feedlist.cpp