Syndication::RDF::Document

Search for usage in LXR

Syndication::RDF::Document Class Reference

#include <document.h>

Inheritance diagram for Syndication::RDF::Document:

Public Member Functions

 Document ()
 
 Document (const Document &other)
 
 Document (ResourcePtr resource)
 
 ~Document () override
 
bool accept (DocumentVisitor *visitor) override
 
DublinCore dc () const
 
QString debugInfo () const override
 
QString description () const
 
Image image () const
 
bool isValid () const override
 
QList< Itemitems () const
 
QString link () const
 
Documentoperator= (const Document &other)
 
bool operator== (const Document &other) const
 
SyndicationInfo syn () const
 
TextInput textInput () const
 
QString title () const
 
- Public Member Functions inherited from Syndication::SpecificDocument
virtual ~SpecificDocument ()
 
- Public Member Functions inherited from Syndication::RDF::ResourceWrapper
 ResourceWrapper ()
 
 ResourceWrapper (const ResourceWrapper &other)
 
 ResourceWrapper (ResourcePtr resource)
 
virtual ~ResourceWrapper ()
 
bool isNull () const
 
ResourceWrapperoperator= (const ResourceWrapper &other)
 
bool operator== (const ResourceWrapper &other) const
 
ResourcePtr resource () const
 

Detailed Description

Document implementation for RDF, representing an RSS 1.0 feed.

Author
Frank Osterfeld

Definition at line 38 of file rdf/document.h.

Constructor & Destructor Documentation

◆ Document() [1/3]

Document::Document ( )

creates a wrapper wrapping a null resource

Definition at line 52 of file rdf/document.cpp.

◆ Document() [2/3]

Document::Document ( ResourcePtr  resource)
explicit

creates a document by wrapping a channel resource

Parameters
resourcethe channel resource to wrap

Definition at line 60 of file rdf/document.cpp.

◆ Document() [3/3]

Document::Document ( const Document other)

creates a copy of another document

Parameters
otherthe document to copy

Definition at line 68 of file rdf/document.cpp.

◆ ~Document()

Document::~Document ( )
override

destructor

Definition at line 76 of file rdf/document.cpp.

Member Function Documentation

◆ accept()

bool Document::accept ( DocumentVisitor visitor)
overridevirtual

Used by visitors for double dispatch.

See DocumentVisitor for more information.

Parameters
visitorthe visitor calling the method

Implements Syndication::SpecificDocument.

Definition at line 94 of file rdf/document.cpp.

◆ dc()

DublinCore Document::dc ( ) const

returns a dublin core description of the document.

Definition at line 121 of file rdf/document.cpp.

◆ debugInfo()

QString Document::debugInfo ( ) const
overridevirtual

PRIVATE.

/** Returns a description of the document for debugging purposes.

Returns
debug string

Implements Syndication::SpecificDocument.

Definition at line 282 of file rdf/document.cpp.

◆ description()

QString Document::description ( ) const

A brief description of the channel's content, function, source, etc.

Returns
TODO: define format etc.

Definition at line 110 of file rdf/document.cpp.

◆ image()

Image Document::image ( ) const

An image to be associated with an HTML rendering of the channel.

Definition at line 209 of file rdf/document.cpp.

◆ isValid()

bool Document::isValid ( ) const
overridevirtual

returns whether this document is valid or not.

Invalid documents do not contain any useful information.

Implements Syndication::SpecificDocument.

Definition at line 99 of file rdf/document.cpp.

◆ items()

QList< Item > Document::items ( ) const

list of items contained in this feed

Definition at line 171 of file rdf/document.cpp.

◆ link()

QString 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 116 of file rdf/document.cpp.

◆ operator=()

Document & Document::operator= ( const Document other)

assigns another document

Parameters
otherthe document to assign

Definition at line 86 of file rdf/document.cpp.

◆ operator==()

bool Document::operator== ( const Document other) const

compares two documents.

Two documents are equal if they wrap the same resource. See ResourceWrapper::operator==()

Parameters
otherthe document to compare to

Definition at line 81 of file rdf/document.cpp.

◆ syn()

SyndicationInfo Document::syn ( ) const

returns syndication information describing how often this feed is updated.

Definition at line 126 of file rdf/document.cpp.

◆ textInput()

TextInput Document::textInput ( ) const

An optional text input element associated with the channel.

Definition at line 216 of file rdf/document.cpp.

◆ title()

QString Document::title ( ) const

title of the feed (required)

Returns
feed title as TODO: define format

Definition at line 104 of file rdf/document.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Wed May 25 2022 03:50:50 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.