akregator/src/librss
RSS::Document Class Reference#include <document.h>
List of all members.
Detailed Description
Represents a RSS document and provides all the features and properties as stored in it.
You usually don't need to instantiate this one yourself but rather use Loader::loadFrom() to produce a Document object. - See also:
- Loader::loadForm()
Definition at line 31 of file document.h.
Constructor & Destructor Documentation
RSS::Document::Document |
( |
|
) |
|
|
RSS::Document::Document |
( |
const Document & |
other |
) |
|
|
|
Copy constructor.
- Parameters:
-
|
RSS::Document::Document |
( |
const QDomDocument & |
doc |
) |
|
|
|
Constructs a Document from a piece of XML markup.
|
RSS::Document::~Document |
( |
|
) |
|
|
Member Function Documentation
|
RSS 0.90 and upwards.
- Returns:
- A list of Article objects as stored in the RSS document, or a null pointer if there were no articles available. Every RSS DTD requires that there is at least one article defined, so a null pointer indicates an invalid RSS file!
- See also:
- Article
|
QString RSS::Document::copyright |
( |
|
) |
const |
|
|
RSS 0.91 and upwards.
- Returns:
- A copyright of the information contained in the RSS document, or QString::null if no copyright is available.
|
QString RSS::Document::description |
( |
|
) |
const |
|
|
RSS 0.90 and upwards.
- Returns:
- The description of the RSS document, or QString::null if no description was available. This is usually a short slogan or description of the news source from which the RSS document was retrieved.
|
const KURL& RSS::Document::docs |
( |
|
) |
const |
|
|
RSS 0.91 and upwards.
- Returns:
- This tag should contain either a URL that references a description of the channel, or a pointer to the documentation for the format used in the RSS file.
|
const Image* RSS::Document::image |
( |
|
) |
const |
|
|
A version of the method above, with stricter const-ness.
|
Image* RSS::Document::image |
( |
|
) |
|
|
|
RSS 0.90 and upwards.
- Returns:
- An Image object as stored in the RSS document, or a null pointer if there was no image available.
- See also:
- Image
|
bool RSS::Document::isValid |
( |
|
) |
const |
|
|
- Returns:
- If document is valid
|
Language RSS::Document::language |
( |
|
) |
const |
|
|
RSS 0.91 and upwards.
- Returns:
- The language used in the RSS document (for the article headlines etc.). This was originally introduced to assist with determining the correct page encoding but acts as a solely optional information in this library since you don't have to care about the encoding as Unicode is used in the whole library.
- See also:
- RSS::Language
|
const QDateTime& RSS::Document::lastBuildDate |
( |
|
) |
const |
|
|
RSS 0.91 and upwards.
- Returns:
- The last time the channel was modified.
|
const KURL& RSS::Document::link |
( |
|
) |
const |
|
|
RSS 0.90 and upwards.
- Returns:
- A link pointing to some website, or an empty KURL if no link was available. This URL mostly points to the homepage of the news site from which the RSS document was retrieved. Note that the RSS 0.91 Specification dictates that URLs not starting with "http://" or "ftp://" are considered invalid.
|
QString RSS::Document::managingEditor |
( |
|
) |
const |
|
|
RSS 0.91 and upwards.
- Returns:
- The email address of the managing editor of the site, the person to contact for editorial inquiries. The suggested format for email addresses in RSS documents is bull@mancuso.com (Bull Mancuso).
- See also:
- webMaster()
|
|
Assignment operator.
- Parameters:
-
- Returns:
- A reference to the cloned Document object.
|
const QDateTime& RSS::Document::pubDate |
( |
|
) |
const |
|
|
RSS 0.91 and upwards.
- Returns:
- The date when the RSS document was published.
|
QString RSS::Document::rating |
( |
|
) |
const |
|
|
RSS 0.91 and upwards.
- Returns:
- A PICS rating for this page.
|
const DayList& RSS::Document::skipDays |
( |
|
) |
const |
|
|
RSS 0.91 and upwards.
- Returns:
- A list of <day>s of the week, in English, indicating the days of the week when the RSS document will not be updated.
- See also:
- skipHours(), DayList, Day
|
const HourList& RSS::Document::skipHours |
( |
|
) |
const |
|
|
RSS 0.91 and upwards.
- Returns:
- A list of hours indicating the hours in the day, GMT, when the channel is unlikely to be updated. If this item is omitted, the channel is assumed to be updated hourly. Each hour should be an integer value between 0 and 23.
- See also:
- skipDays()
|
const TextInput* RSS::Document::textInput |
( |
|
) |
const |
|
|
A version of the method above, with stricter const-ness.
|
|
RSS 0.90 and upwards.
- Returns:
- A TextInput object as stored in the RSS document, or a null pointer if there was no text input available.
- See also:
- TextInput
|
QString RSS::Document::title |
( |
|
) |
const |
|
|
RSS 0.90 and upwards.
- Returns:
- The title of the RSS document, or QString::null if no title was available. This is often the name of the news source from which the RSS document was retrieved.
|
QString RSS::Document::verbVersion |
( |
|
) |
const |
|
|
Convenience method.
Differs from version() only in how the result is returned. - Returns:
- A QString representing the verbose version of the document.
- See also:
- version()
|
Version RSS::Document::version |
( |
|
) |
const |
|
|
- Returns:
- The version of this document (one of the values of the enum RSS::Version). This value can be used to determine which features this RSS document provides.
- See also:
- verbVersion()
|
QString RSS::Document::webMaster |
( |
|
) |
const |
|
|
RSS 0.91 and upwards.
- Returns:
- The email address of the webmaster for the site, the person to contact if there are technical problems with the channel, or QString::null if this information isn't available.
- See also:
- managingEditor()
|
The documentation for this class was generated from the following file:
|