syndication/rdf
Syndication::RDF::Document Class Reference
#include <document.h>

Detailed Description
Document implementation for RDF, representing an RSS 1.0 feed.
Definition at line 50 of file document.h.
Public Member Functions | |
Document () | |
Document (ResourcePtr resource) | |
Document (const Document &other) | |
virtual | ~Document () |
bool | operator== (const Document &other) const |
Document & | operator= (const Document &other) |
virtual bool | accept (DocumentVisitor *visitor) |
bool | isValid () const |
QString | title () const |
QString | description () const |
QString | link () const |
DublinCore | dc () const |
SyndicationInfo | syn () const |
QList< Item > | items () const |
Image | image () const |
TextInput | textInput () const |
virtual PRIVATE QString | debugInfo () const |
Constructor & Destructor Documentation
Syndication::RDF::Document::Document | ( | ) |
Syndication::RDF::Document::Document | ( | ResourcePtr | resource | ) | [explicit] |
creates a document by wrapping a channel resource
- Parameters:
-
resource the channel resource to wrap
Definition at line 64 of file document.cpp.
Syndication::RDF::Document::Document | ( | const Document & | other | ) |
creates a copy of another document
- Parameters:
-
other the document to copy
Definition at line 70 of file document.cpp.
Syndication::RDF::Document::~Document | ( | ) | [virtual] |
Member Function Documentation
bool Syndication::RDF::Document::operator== | ( | const Document & | other | ) | const |
compares two documents.
Two documents are equal if they wrap the same resource. See ResourceWrapper::operator==()
- Parameters:
-
other the document to compare to
Definition at line 83 of file document.cpp.
assigns another document
- Parameters:
-
other the document to assign
Definition at line 89 of file document.cpp.
bool Syndication::RDF::Document::accept | ( | DocumentVisitor * | visitor | ) | [virtual] |
Used by visitors for double dispatch.
See DocumentVisitor for more information.
- Parameters:
-
visitor the visitor calling the method
Definition at line 98 of file document.cpp.
bool Syndication::RDF::Document::isValid | ( | ) | const |
returns whether this document is valid or not.
Invalid documents do not contain any useful information.
Definition at line 103 of file document.cpp.
QString Syndication::RDF::Document::title | ( | ) | const |
title of the feed (required)
- Returns:
- feed title as TODO: define format
Definition at line 108 of file document.cpp.
QString Syndication::RDF::Document::description | ( | ) | const |
A brief description of the channel's content, function, source, etc.
- Returns:
- TODO: define format etc.
Definition at line 115 of file document.cpp.
QString Syndication::RDF::Document::link | ( | ) | const |
The URL to which an HTML rendering of the channel title will link, commonly the parent site's home or news page.
Definition at line 121 of file document.cpp.
DublinCore Syndication::RDF::Document::dc | ( | ) | const |
SyndicationInfo Syndication::RDF::Document::syn | ( | ) | const |
returns syndication information describing how often this feed is updated.
Definition at line 131 of file document.cpp.
QList< Item > Syndication::RDF::Document::items | ( | ) | const |
Image Syndication::RDF::Document::image | ( | ) | const |
An image to be associated with an HTML rendering of the channel.
Definition at line 170 of file document.cpp.
TextInput Syndication::RDF::Document::textInput | ( | ) | const |
An optional text input element associated with the channel.
Definition at line 177 of file document.cpp.
QString Syndication::RDF::Document::debugInfo | ( | ) | const [virtual] |
Returns a description of the document for debugging purposes.
- Returns:
- debug string
Definition at line 250 of file document.cpp.
The documentation for this class was generated from the following files: