syndication/rss2
#include <item.h>
Inherits ElementWrapper, and SpecificItem.
Public Member Functions | |
Item (boost::shared_ptr< Document > doc=boost::shared_ptr< Document >()) | |
Item (const QDomElement &element, boost::shared_ptr< Document > doc=boost::shared_ptr< Document >()) | |
Item (const Item &other) | |
~Item () | |
bool | accept (SpecificItemVisitor *visitor) |
QString | author () const |
QList< Category > | categories () const |
QString | comments () const |
QString | content () const |
QString | debugInfo () const |
QString | description () const |
QList< Enclosure > | enclosures () const |
time_t | expirationDate () const |
QString | guid () const |
bool | guidIsPermaLink () const |
QString | link () const |
Item & | operator= (const Item &other) |
time_t | pubDate () const |
QString | rating () const |
Source | source () const |
QString | title () const |
QList< QDomElement > | unhandledElements () const |
Detailed Description
Constructor & Destructor Documentation
Syndication::RSS2::Item::Item | ( | const Item & | other | ) |
Member Function Documentation
bool Syndication::RSS2::Item::accept | ( | SpecificItemVisitor * | visitor | ) |
QString Syndication::RSS2::Item::author | ( | ) | const |
The email address of the author of this item.
For newspapers and magazines syndicating via RSS, the author is the person who wrote the article that this item describes. For collaborative weblogs, the author of the item might be different from the managing editor or webmaster. This method returns the content of the <author>
element. If <author>
is not available, the method returns <dc:creator>
instead, if available.
- Returns
- an email address of the author, or a null string if not specified
QList< Category > Syndication::RSS2::Item::categories | ( | ) | const |
QString Syndication::RSS2::Item::comments | ( | ) | const |
QString Syndication::RSS2::Item::content | ( | ) | const |
Returns the actual content of the item.
In RSS2, this can be stored in various elements, e.g. in content:encoded, xhtml:body or xhtml:div. If this is not set, description() might also contain the content of the item.
- Returns
- the content in HTML format (whitespace is irrelevant, <br/> is used for newlines, "&", "<", ">" are escaped) If no content is specified, a null string is returned.
QString Syndication::RSS2::Item::debugInfo | ( | ) | const |
QString Syndication::RSS2::Item::description | ( | ) | const |
The item synopsis.
This might contain a short summary of the item, but also the full content. If content() is set, that usually contains the full content instead.
- Returns
- a string in HTML format (whitespace is irrelevant,
<br/>
is used for newlines, "&", "<", ">" are escaped) summarizing the item. A null string if no description was specified.
QList< Enclosure > Syndication::RSS2::Item::enclosures | ( | ) | const |
Descriptions of media objects that are attached to the item.
Note that the RSS2 spec is a bit unclear about whether an item can have multiple enclosures or not. Originally it was not intended, but in reality, some tools out there specify multiple enclosures. So most of the time, this list be either empty or contains a single item, but don't take that for granted
time_t Syndication::RSS2::Item::expirationDate | ( | ) | const |
QString Syndication::RSS2::Item::guid | ( | ) | const |
"guid stands for globally unique identifier.
It's a string that uniquely identifies the item. When present, an aggregator may choose to use this string to determine if an item is new. There are no rules for the syntax of a guid. Aggregators must view them as a string. It's up to the source of the feed to establish the uniqueness of the string."
- Returns
- a guid string, or a null string if none specified in the feed
bool Syndication::RSS2::Item::guidIsPermaLink | ( | ) | const |
QString Syndication::RSS2::Item::link | ( | ) | const |
time_t Syndication::RSS2::Item::pubDate | ( | ) | const |
Indicates when the item was published.
If it's a date in the future, you may choose to not display the item until that date. This returns the content of the <pubDate>
element. If <pubDate>
is not available, the method returns <dc:date>
instead, if available.
- Returns
- the publication date, or 0 if no date was specified or parsing failed
QString Syndication::RSS2::Item::rating | ( | ) | const |
A Platform for Internet Content Selection (PICS) rating tag.
More information on the format of the rating tag can be found here: http://www.w3.org/PICS/
- Returns
- PICS rating information, or a null string if not specified
Source Syndication::RSS2::Item::source | ( | ) | const |
QString Syndication::RSS2::Item::title | ( | ) | const |
QList< QDomElement > Syndication::RSS2::Item::unhandledElements | ( | ) | const |
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:26:36 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.