Syndication::FeedAtomImpl Class Reference

#include <feedatomimpl.h>

Inheritance diagram for Syndication::FeedAtomImpl:

Public Member Functions
	FeedAtomImpl (Syndication::Atom::FeedDocumentPtr doc)
QMultiMap< QString, QDomElement >	additionalProperties () const override
QList< PersonPtr >	authors () const override
QList< CategoryPtr >	categories () const override
QString	copyright () const override
QString	description () const override
ImagePtr	icon () const override
ImagePtr	image () const override
QList< Syndication::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 feedatomimpl.h.

Constructor & Destructor Documentation

FeedAtomImpl()

Syndication::FeedAtomImpl::FeedAtomImpl ( Syndication::Atom::FeedDocumentPtr doc )

explicit

Definition at line 25 of file feedatomimpl.cpp.

Member Function Documentation

additionalProperties()

QMultiMap< QString, QDomElement > Syndication::FeedAtomImpl::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 117 of file feedatomimpl.cpp.

authors()

QList< PersonPtr > Syndication::FeedAtomImpl::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 83 of file feedatomimpl.cpp.

categories()

QList< Syndication::CategoryPtr > Syndication::FeedAtomImpl::categories ( ) const

overridevirtual

returns a list of categories this feed is associated with.

See Category for more information.

Implements Syndication::Feed.

Definition at line 49 of file feedatomimpl.cpp.

copyright()

QString Syndication::FeedAtomImpl::copyright ( ) const

overridevirtual

returns copyright information about the feed

Implements Syndication::Feed.

Definition at line 102 of file feedatomimpl.cpp.

description()

QString Syndication::FeedAtomImpl::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 78 of file feedatomimpl.cpp.

icon()

ImagePtr Syndication::FeedAtomImpl::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 112 of file feedatomimpl.cpp.

image()

ImagePtr Syndication::FeedAtomImpl::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 107 of file feedatomimpl.cpp.

items()

QList< Syndication::ItemPtr > Syndication::FeedAtomImpl::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 35 of file feedatomimpl.cpp.

language()

QString Syndication::FeedAtomImpl::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 97 of file feedatomimpl.cpp.

link()

QString Syndication::FeedAtomImpl::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 67 of file feedatomimpl.cpp.

specificDocument()

Syndication::SpecificDocumentPtr Syndication::FeedAtomImpl::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 30 of file feedatomimpl.cpp.

title()

QString Syndication::FeedAtomImpl::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 62 of file feedatomimpl.cpp.

---

The documentation for this class was generated from the following files:

• feedatomimpl.h
• feedatomimpl.cpp