Syndication::Atom::FeedDocument Class Reference

#include <document.h>

Inherits SpecificDocument, and ElementWrapper.

Public Member Functions
	FeedDocument ()
	FeedDocument (const QDomElement &element)
bool	accept (DocumentVisitor *visitor)
QList< Person >	authors () const
QList< Category >	categories () const
QList< Person >	contributors () const
QString	debugInfo () const
QList< Entry >	entries () const
Generator	generator () const
QString	icon () const
QString	id () const
bool	isValid () const
QList< Link >	links () const
QString	logo () const
QString	rights () const
QString	subtitle () const
QString	title () const
QList< QDomElement >	unhandledElements () const
time_t	updated () const

Detailed Description

An Atom 1.0 Feed Document, containing metadata describing the feed and a number of entries.

Author

Frank Osterfeld

Definition at line 57 of file document.h.

Constructor & Destructor Documentation

Syndication::Atom::FeedDocument::FeedDocument

(

)

default constructor, creates a null feed, which is invalid.

See also

isValid()

Definition at line 42 of file document.cpp.

Syndication::Atom::FeedDocument::FeedDocument ( const QDomElement &  element )

explicit

creates a FeedDocument wrapping an atom:feed element.

Parameters

element

a DOM element, should be a atom:feed document (although not enforced), otherwise this object will not parse anything useful

Definition at line 46 of file document.cpp.

Member Function Documentation

bool Syndication::Atom::FeedDocument::accept

(

DocumentVisitor *

visitor

)

Used by visitors for double dispatch.

See DocumentVisitor for more information.

Parameters

visitor

the visitor calling the method

Definition at line 50 of file document.cpp.

QList< Person > Syndication::Atom::FeedDocument::authors

(

)

const

a list of persons who are the authors of this feed.

According to the Atom 1.0 spec, a feed must have an author unless all entries in it have one.

Definition at line 55 of file document.cpp.

QList< Category > Syndication::Atom::FeedDocument::categories

(

)

const

a list of categories this feed is assigned to (optional)

Definition at line 93 of file document.cpp.

QList< Person > Syndication::Atom::FeedDocument::contributors

(

)

const

a list of persons who contribute to this feed.

(optional)

Definition at line 74 of file document.cpp.

QString Syndication::Atom::FeedDocument::debugInfo

(

)

const

returns a description of this feed document for debugging purposes.

Returns

debug string

Definition at line 240 of file document.cpp.

QList< Entry > Syndication::Atom::FeedDocument::entries

(

)

const

a list of the entries (items) in this feed.

Definition at line 179 of file document.cpp.

Generator Syndication::Atom::FeedDocument::generator

(

)

const

description of the agent used to generate the feed.

See Generator for more information (optional).

Returns

description of the generator, or a null Generator object if not specified in the feed.

Definition at line 112 of file document.cpp.

QString Syndication::Atom::FeedDocument::icon

(

)

const

URL of an image serving as a feed icon (optional)

Returns

icon URL, or a null string if not specified in the feed.

Definition at line 118 of file document.cpp.

QString Syndication::Atom::FeedDocument::id

(

)

const

a string that unambigously identifies the feed (required)

Returns

the ID of the feed. As defined in the Atom spec it must be a valid URI (which is neither checked nor enforced by this parser)

Definition at line 131 of file document.cpp.

bool Syndication::Atom::FeedDocument::isValid

(

)

const

returns whether this document is valid or not.

Invalid documents do not contain any useful information.

Definition at line 235 of file document.cpp.

QList< Link > Syndication::Atom::FeedDocument::links

(

)

const

a list of links.

See Link for more information on link types.

Definition at line 160 of file document.cpp.

QString Syndication::Atom::FeedDocument::logo

(

)

const

URL of an image serving as a feed logo (optional)

Returns

image URL, or a null string if not specified in the feed.

Definition at line 125 of file document.cpp.

QString Syndication::Atom::FeedDocument::rights

(

)

const

copyright information (optional)

Returns

copyright information for the feed (intended for human readers), or a null string if not specified

Definition at line 137 of file document.cpp.

QString Syndication::Atom::FeedDocument::subtitle

(

)

const

description or subtitle of the feed (optional).

Returns

subtitle string as HTML, or a null string if not specified in the feed.

Definition at line 148 of file document.cpp.

QString Syndication::Atom::FeedDocument::title

(

)

const

feed title (required).

Returns

title string as HTML.

Definition at line 143 of file document.cpp.

QList< QDomElement > Syndication::Atom::FeedDocument::unhandledElements

(

)

const

returns all child elements of this feed not covered by this class.

This can be used to access additional metadata from Atom extensions.

Definition at line 201 of file document.cpp.

time_t Syndication::Atom::FeedDocument::updated

(

)

const

The datetime of the last modification of the feed content.

Returns

the modification date in seconds since epoch

Definition at line 153 of file document.cpp.

---

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

• document.h
• document.cpp