akregator/src

Akregator::Feed Class Reference

represents a feed More...

#include <feed.h>

Inheritance diagram for Akregator::Feed:
Akregator::TreeNode

List of all members.

Public Types

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

Public Slots

void fetch (bool followDiscovery=false)
void slotAbortFetch ()
virtual void slotDeleteExpiredArticles ()
virtual void slotMarkAllArticlesAsRead ()
virtual void slotAddToFetchQueue (FetchQueue *queue, bool intervalFetchOnly=false)

Signals

void fetchStarted (Feed *)
void fetched (Feed *)
void fetchError (Feed *)
void fetchDiscovery (Feed *)
void fetchAborted (Feed *)

Public Member Functions

 Feed ()
virtual bool accept (TreeNodeVisitor *visitor)
virtual TQDomElement toOPML (TQDomElement parent, TQDomDocument document) const
bool useCustomFetchInterval () const
void setCustomFetchIntervalEnabled (bool enabled)
int fetchInterval () const
void setFetchInterval (int interval)
ArchiveMode archiveMode () const
void setArchiveMode (ArchiveMode archiveMode)
int maxArticleAge () const
void setMaxArticleAge (int maxArticleAge)
int maxArticleNumber () const
void setMaxArticleNumber (int maxArticleNumber)
bool markImmediatelyAsRead () const
void setMarkImmediatelyAsRead (bool enabled)
void setUseNotification (bool enabled)
bool useNotification () const
void setLoadLinkedWebsite (bool enabled)
bool loadLinkedWebsite () const
const TQPixmap & favicon () const
void setFavicon (const TQPixmap &p)
const TQPixmap & image () const
const TQString & xmlUrl () const
void setXmlUrl (const TQString &s)
const TQString & htmlUrl () const
void setHtmlUrl (const TQString &s)
const TQString & description () const
void setDescription (const TQString &s)
virtual TQValueList< Articlearticles (const TQString &tag=TQString())
virtual Article findArticle (const TQString &guid) const
virtual TQStringList tags () const
bool fetchErrorOccurred ()
virtual int unread () const
virtual int totalCount () const
bool isArticlesLoaded () const
virtual bool isGroup () const
virtual TreeNodenext ()
void loadFavicon ()
void loadImage ()

Static Public Member Functions

static ArchiveMode stringToArchiveMode (const TQString &str)
static TQString archiveModeToString (ArchiveMode mode)
static FeedfromOPML (TQDomElement e)

Protected Member Functions

void loadArticles ()
void recalcUnreadCount ()
virtual void doArticleNotification ()
void setUnread (int unread)

Friends

class Article

Detailed Description

represents a feed

Definition at line 62 of file feed.h.


Member Enumeration Documentation

the archiving modes:

  • 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 76 of file feed.h.


Constructor & Destructor Documentation

Akregator::Feed::Feed (  ) 

default constructor

Definition at line 269 of file feed.cpp.


Member Function Documentation

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

returns the archiving mode which is used for this feed

Definition at line 695 of file feed.cpp.

TQString Akregator::Feed::archiveModeToString ( ArchiveMode  mode  )  [static]

converts ArchiveMode values to corresponding strings

Definition at line 97 of file feed.cpp.

TQValueList< Article > Akregator::Feed::articles ( const TQString &  tag = TQString()  )  [virtual]

Returns a sequence of the articles this node contains.

For feed groups, this returns a concatenated list of all articles in the sub tree. If tag is not null, only articles tagged with tag are returned

Returns:
sequence of articles

Implements Akregator::TreeNode.

Definition at line 185 of file feed.cpp.

const TQString & Akregator::Feed::description (  )  const

returns the description of this feed

Definition at line 352 of file feed.cpp.

void Akregator::Feed::doArticleNotification (  )  [protected, virtual]

reimplement this in subclasses to do the actual notification called by articlesModified

Reimplemented from Akregator::TreeNode.

Definition at line 766 of file feed.cpp.

const TQPixmap & Akregator::Feed::favicon (  )  const

returns the favicon

Definition at line 340 of file feed.cpp.

void Akregator::Feed::fetch ( bool  followDiscovery = false  )  [slot]

starts fetching

Definition at line 541 of file feed.cpp.

void Akregator::Feed::fetchAborted ( Feed  )  [signal]

emitted when a fetch is aborted

void Akregator::Feed::fetchDiscovery ( Feed  )  [signal]

emitted when a feed URL was found by auto discovery

void Akregator::Feed::fetched ( Feed  )  [signal]

emitted when feed finished fetching

void Akregator::Feed::fetchError ( Feed  )  [signal]

emitted when a fetch error occurred

bool Akregator::Feed::fetchErrorOccurred (  ) 

returns whether a fetch error has occurred

Definition at line 356 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 299 of file feed.cpp.

void Akregator::Feed::fetchStarted ( Feed  )  [signal]

emitted when fetching started

Article Akregator::Feed::findArticle ( const TQString &  guid  )  const [virtual]

returns the article with the given guid, or a null article if it not exists

Definition at line 180 of file feed.cpp.

Feed * Akregator::Feed::fromOPML ( TQDomElement  e  )  [static]

creates a Feed object from a description in OPML format

Definition at line 118 of file feed.cpp.

const TQString & Akregator::Feed::htmlUrl (  )  const

returns the URL of the HTML page of this feed

Definition at line 348 of file feed.cpp.

const TQPixmap & Akregator::Feed::image (  )  const

returns the feed image

Definition at line 342 of file feed.cpp.

bool Akregator::Feed::isArticlesLoaded (  )  const

returns if the article archive of this feed is loaded

Definition at line 358 of file feed.cpp.

virtual bool Akregator::Feed::isGroup (  )  const [inline, virtual]

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

Implements Akregator::TreeNode.

Definition at line 203 of file feed.h.

void Akregator::Feed::loadArticles (  )  [protected]

loads articles from archive

Definition at line 210 of file feed.cpp.

void Akregator::Feed::loadFavicon (  ) 

downloads the favicon

Definition at line 647 of file feed.cpp.

void Akregator::Feed::loadImage (  ) 

load the image from the cache if it is in there

Definition at line 202 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 311 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 303 of file feed.cpp.

int Akregator::Feed::maxArticleNumber (  )  const

returns the article count limit used in limitArticleNumber archive mode

Definition at line 307 of file feed.cpp.

TreeNode * Akregator::Feed::next (  )  [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 750 of file feed.cpp.

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

sets the archiving mode for this feed

Definition at line 700 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 297 of file feed.cpp.

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

sets the description of this feed

Definition at line 354 of file feed.cpp.

void Akregator::Feed::setFavicon ( const TQPixmap &  p  ) 

sets the favicon (used in the tree view)

Definition at line 689 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 301 of file feed.cpp.

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

sets the URL of the HTML page of this feed

Definition at line 350 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 330 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 305 of file feed.cpp.

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

sets the article count limit used in limitArticleNumber archive mode

Definition at line 309 of file feed.cpp.

void Akregator::Feed::setUnread ( int  unread  )  [protected]

sets the unread count for this feed

Definition at line 710 of file feed.cpp.

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

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

Definition at line 346 of file feed.cpp.

void Akregator::Feed::slotAddToFetchQueue ( FetchQueue *  queue,
bool  intervalFetchOnly = false 
) [virtual, slot]

add this feed to the fetch queue queue

Implements Akregator::TreeNode.

Definition at line 402 of file feed.cpp.

void Akregator::Feed::slotDeleteExpiredArticles (  )  [virtual, slot]

deletes expired articles

Implements Akregator::TreeNode.

Definition at line 652 of file feed.cpp.

void Akregator::Feed::slotMarkAllArticlesAsRead (  )  [virtual, slot]

mark all articles in this feed as read

Implements Akregator::TreeNode.

Definition at line 388 of file feed.cpp.

Feed::ArchiveMode Akregator::Feed::stringToArchiveMode ( const TQString &  str  )  [static]

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

Definition at line 253 of file feed.cpp.

TQStringList Akregator::Feed::tags (  )  const [virtual]

returns a list of all tags occurring in this node (sub tree for folders)

Implements Akregator::TreeNode.

Definition at line 175 of file feed.cpp.

TQDomElement Akregator::Feed::toOPML ( TQDomElement  parent,
TQDomDocument  document 
) const [virtual]

exports the feed settings to OPML

Implements Akregator::TreeNode.

Definition at line 361 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 745 of file feed.cpp.

int Akregator::Feed::unread (  )  const [virtual]

returns the unread count for this feed

Implements Akregator::TreeNode.

Definition at line 705 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 295 of file feed.cpp.

const TQString & Akregator::Feed::xmlUrl (  )  const

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

Definition at line 344 of file feed.cpp.


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