Syndication::FeedRDFImpl

Search for usage in LXR

Syndication::FeedRDFImpl Class Reference

#include <feedrdfimpl.h>

Inheritance diagram for Syndication::FeedRDFImpl:

Public Member Functions

 FeedRDFImpl (Syndication::RDF::DocumentPtr doc)
 
QMultiMap< QString, QDomElementadditionalProperties () const override
 
QList< PersonPtr > authors () const override
 
QList< CategoryPtrcategories () const override
 
QString copyright () const override
 
QString description () const override
 
ImagePtr icon () const override
 
ImagePtr image () const override
 
QList< ItemPtr > items () const override
 
QString language () const override
 
QString link () const override
 
Syndication::SpecificDocumentPtr specificDocument () const override
 
QString title () const override
 
- Public Member Functions inherited from Syndication::Feed
virtual ~Feed ()
 
virtual QString debugInfo () const
 

Detailed Description

Definition at line 24 of file feedrdfimpl.h.

Constructor & Destructor Documentation

◆ FeedRDFImpl()

Syndication::FeedRDFImpl::FeedRDFImpl ( Syndication::RDF::DocumentPtr doc)
explicit

Definition at line 26 of file feedrdfimpl.cpp.

Member Function Documentation

◆ additionalProperties()

QMultiMap< QString, QDomElement > Syndication::FeedRDFImpl::additionalProperties ( ) const
overridevirtual

returns a list of feed metadata not covered by this class.

Can be used e.g. to access format extensions.

The returned map contains key value pairs, where the key is the tag name of the element, namespace prefix are resolved to the corresponding URIs. The value is the XML element as read from the document.

For example, to access the <itunes:subtitle> element, use additionalProperties()["http://www.itunes.com/dtds/podcast-1.0.dtdsubtitle"].

Currently this is only supported for RSS 0.91..0.94/2.0 and Atom formats, but not for RDF (RSS 0.9 and 1.0).

Implements Syndication::Feed.

Definition at line 110 of file feedrdfimpl.cpp.

◆ authors()

QList< PersonPtr > Syndication::FeedRDFImpl::authors ( ) const
overridevirtual

returns a list of persons who created the feed content.

If there is a distinction between authors and contributors (Atom), both are added to the list, where authors are added first.

Returns
list of authors (and possibly other contributing persons)

Implements Syndication::Feed.

Definition at line 71 of file feedrdfimpl.cpp.

◆ categories()

QList< Syndication::CategoryPtr > Syndication::FeedRDFImpl::categories ( ) const
overridevirtual

returns a list of categories this feed is associated with.

See Category for more information.

Implements Syndication::Feed.

Definition at line 50 of file feedrdfimpl.cpp.

◆ copyright()

QString Syndication::FeedRDFImpl::copyright ( ) const
overridevirtual

returns copyright information about the feed

Implements Syndication::Feed.

Definition at line 93 of file feedrdfimpl.cpp.

◆ description()

QString Syndication::FeedRDFImpl::description ( ) const
overridevirtual

A description of the feed.

This string may contain HTML markup.(Importantly, occurrences of the characters <,'
', '&', '\'' and '"' are escaped).

Returns
the description as HTML, or a null string if none is specified

Implements Syndication::Feed.

Definition at line 66 of file feedrdfimpl.cpp.

◆ icon()

ImagePtr Syndication::FeedRDFImpl::icon ( ) const
overridevirtual

returns an icon associated with this item.

Returns
an icon object, or a null icon (Not a null pointer! I.e., icon()->isNull() is true) if no image is specified in the feed

Implements Syndication::Feed.

Definition at line 104 of file feedrdfimpl.cpp.

◆ image()

ImagePtr Syndication::FeedRDFImpl::image ( ) const
overridevirtual

returns an image associated with this item.

Returns
an image object, or a null image (Not a null pointer! I.e., image()->isNull() is true) if no image is specified in the feed

Implements Syndication::Feed.

Definition at line 98 of file feedrdfimpl.cpp.

◆ items()

QList< Syndication::ItemPtr > Syndication::FeedRDFImpl::items ( ) const
overridevirtual

A list of items, in the order they were parsed from the feed source.

(usually reverse chronological order, see also Item::datePublished() for sorting purposes).

Returns
list of items

Implements Syndication::Feed.

Definition at line 36 of file feedrdfimpl.cpp.

◆ language()

QString Syndication::FeedRDFImpl::language ( ) const
overridevirtual

The language used in the feed.

This is a global setting, which can be overridden by the contained items.

TODO: describe concrete format (language codes)

Implements Syndication::Feed.

Definition at line 88 of file feedrdfimpl.cpp.

◆ link()

QString Syndication::FeedRDFImpl::link ( ) const
overridevirtual

returns a link pointing to a website associated with this channel.

(blog, news site etc.)

Returns
a WWW link, or a null string if none is specified

Implements Syndication::Feed.

Definition at line 61 of file feedrdfimpl.cpp.

◆ specificDocument()

Syndication::SpecificDocumentPtr Syndication::FeedRDFImpl::specificDocument ( ) const
overridevirtual

returns the format-specific document this abstraction wraps.

If you want to access format-specific properties, this can be used, in combination with a DocumentVisitor.

Returns
a shared pointer to the wrapped document.

Implements Syndication::Feed.

Definition at line 31 of file feedrdfimpl.cpp.

◆ title()

QString Syndication::FeedRDFImpl::title ( ) const
overridevirtual

The title of the feed.

This string may contain HTML markup.(Importantly, occurrences of the characters <,'
', '&', '\'' and '"' are escaped).

Returns
the title, or a null string if none is specified

Implements Syndication::Feed.

Definition at line 56 of file feedrdfimpl.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 8 2024 11:52:05 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.