syndication/rdf
#include <document.h>

Public Member Functions | |
Document () | |
Document (const Document &other) | |
Document (ResourcePtr resource) | |
virtual | ~Document () |
virtual bool | accept (DocumentVisitor *visitor) |
DublinCore | dc () const |
virtual QString | debugInfo () const |
QString | description () const |
Image | image () const |
bool | isValid () const |
QList< Item > | items () const |
QString | link () const |
Document & | operator= (const Document &other) |
bool | operator== (const Document &other) const |
SyndicationInfo | syn () const |
TextInput | textInput () const |
QString | title () const |
![]() | |
ResourceWrapper () | |
ResourceWrapper (const ResourceWrapper &other) | |
ResourceWrapper (ResourcePtr resource) | |
virtual | ~ResourceWrapper () |
bool | isNull () const |
ResourceWrapper & | operator= (const ResourceWrapper &other) |
bool | operator== (const ResourceWrapper &other) const |
ResourcePtr | resource () const |
Detailed Description
Document implementation for RDF, representing an RSS 1.0 feed.
Definition at line 51 of file document.h.
Constructor & Destructor Documentation
◆ Document() [1/3]
Syndication::RDF::Document::Document | ( | ) |
creates a wrapper wrapping a null resource
Definition at line 64 of file document.cpp.
◆ Document() [2/3]
|
explicit |
creates a document by wrapping a channel resource
- Parameters
-
resource the channel resource to wrap
Definition at line 71 of file document.cpp.
◆ Document() [3/3]
Syndication::RDF::Document::Document | ( | const Document & | other | ) |
creates a copy of another document
- Parameters
-
other the document to copy
Definition at line 78 of file document.cpp.
◆ ~Document()
|
virtual |
destructor
Definition at line 84 of file document.cpp.
Member Function Documentation
◆ accept()
|
virtual |
Used by visitors for double dispatch.
See DocumentVisitor for more information.
- Parameters
-
visitor the visitor calling the method
Definition at line 105 of file document.cpp.
◆ dc()
DublinCore Syndication::RDF::Document::dc | ( | ) | const |
returns a dublin core description of the document.
Definition at line 133 of file document.cpp.
◆ debugInfo()
|
virtual |
PRIVATE.
/** Returns a description of the document for debugging purposes.
- Returns
- debug string
Definition at line 285 of file document.cpp.
◆ description()
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 122 of file document.cpp.
◆ image()
Image Syndication::RDF::Document::image | ( | ) | const |
An image to be associated with an HTML rendering of the channel.
Definition at line 205 of file document.cpp.
◆ isValid()
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 110 of file document.cpp.
◆ items()
QList< Item > Syndication::RDF::Document::items | ( | ) | const |
list of items contained in this feed
Definition at line 175 of file document.cpp.
◆ link()
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 128 of file document.cpp.
◆ operator=()
assigns another document
- Parameters
-
other the document to assign
Definition at line 96 of file document.cpp.
◆ operator==()
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 90 of file document.cpp.
◆ syn()
SyndicationInfo Syndication::RDF::Document::syn | ( | ) | const |
returns syndication information describing how often this feed is updated.
Definition at line 138 of file document.cpp.
◆ textInput()
TextInput Syndication::RDF::Document::textInput | ( | ) | const |
An optional text input element associated with the channel.
Definition at line 212 of file document.cpp.
◆ title()
QString Syndication::RDF::Document::title | ( | ) | const |
title of the feed (required)
- Returns
- feed title as TODO: define format
Definition at line 115 of file document.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.