Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / akregator / src / librss

akregator/src/librss RSS::Article Class Reference #include <article.h> List of all members. Detailed Description Represents an article as stored in a RSS file. You don't have to instantiate one of these yourself, the common way to access instances is via Document::articles(). See also: Document::articles() Definition at line 37 of file article.h. Public Types typedef QValueList< Article >  List typedef QMap< QString, QString >  MetaInfoMap Public Member Functions   Article ()   Article (const Article &other)   Article (const QDomNode &node, Format format, Version version) Article &  operator= (const Article &other) bool  operator== (const Article &other) const bool  operator!= (const Article &other) const virtual  ~Article () QString  title () const const KURL &  link () const QString  description () const QString  author () const QString  guid () const bool  guidIsPermaLink () const const QDateTime &  pubDate () const const KURL &  commentsLink () const int  comments () const Enclosure  enclosure () const QValueList< Category >  categories () const QString  meta (const QString &key) const KURLLabel *  widget (QWidget *parent=0, const char *name=0) const Member Typedef Documentation typedef QValueList<Article> RSS::Article::List   A list of articles. Definition at line 43 of file article.h. Constructor & Destructor Documentation RSS::Article::Article (   )    Default constructor. RSS::Article::Article (  const Article &  other  )    Copy constructor. Parameters: other  The Article object to copy. RSS::Article::Article (  const QDomNode &  node, Format  format, Version  version )    Constructs an Article from a piece of RSS markup. Parameters: node  A QDomNode which references the DOM leaf to be used for constructing the Article. virtual RSS::Article::~Article (   )  [virtual]   Destructor. Member Function Documentation QString RSS::Article::author (   )  const   a string desribing the author of the item. QValueList<Category> RSS::Article::categories (   )  const   returns a list of categories this article is assigned to. (RSS2 only, Atom is not supported yet) QString RSS::Article::description (   )  const   RSS 0.91 and upwards. Returns: A story synopsis, or QString::null if no description was available. QString RSS::Article::guid (   )  const   RSS 2.0 and upwards. Returns: An article GUID (globally unique identifier). bool RSS::Article::guidIsPermaLink (   )  const   RSS 2.0 and upwards. Returns: If this article GUID is permalink. Has no meaning when guid() is QString::null. const KURL& RSS::Article::link (   )  const   RSS 0.90 and upwards. Returns: A URL referencing the complete text for this article, or an empty KURL if no link was available. Note that the RSS 0.91 Specification dictates that URLs not starting with "http://" or "ftp://" are considered invalid. bool RSS::Article::operator!= (  const Article &  other  )  const [inline]   Convenience method. Simply calls !operator==(). Parameters: other  The article this article should be compared with. Returns: Whether the two articles are unequal. Definition at line 84 of file article.h. Article& RSS::Article::operator= (  const Article &  other  )    Assignment operator. Parameters: other  The Article object to clone. Returns: A reference to the cloned Article object. bool RSS::Article::operator== (  const Article &  other  )  const   Compares two articles. Two articles are treated to be identical if all their properties (title, link, description etc.) are equal. Parameters: other  The article this article should be compared with. Returns: Whether the two articles are equal. const QDateTime& RSS::Article::pubDate (   )  const   RSS 2.0 and upwards. Returns: The date when the article was published. QString RSS::Article::title (   )  const   RSS 0.90 and upwards. Returns: The headline of this article, or QString::null if no headline was available. KURLLabel* RSS::Article::widget (  QWidget *  parent = 0, const char *  name = 0 )  const   Parameters: parent  The parent widget for the KURLLabel. name  A name for the widget which will be used internally. Returns: a widget (a KURLLabel in this case) for the Article. This makes building a user-interface which contains the information in this Article object more convenient. The returned KURLLabel's caption will be the title(), clicking on it will emit the URL link(), and it has a QToolTip attached to it which displays the description() (in case it has one, if there is no description, the URL which the label links to will be used). Note that you have to delete the KURLLabel object returned by this method yourself. The documentation for this class was generated from the following file: article.h

akregator/src/librss Main Page Namespace List Class Hierarchy Alphabetical List Class List File List Directories Namespace Members Class Members API Dox akregator   src     librss certmanager   lib kaddressbook kalarm   lib kandy karm kdgantt kgantt kioslaves   imap4   mbox kitchensync kmail knotes konsolekalendar kontact korganizer kpilot   kpilot   lib libemailfunctions libkcal libkdepim libkholidays libkmime libkpgp libkpimidentities

KDE Home | KDE Accessibility Home | Description of Access Keys

Maintained by Adriaan de Groot and Allen Winter.
KDE and K Desktop Environment are trademarks of KDE e.V. | Legal