Syndication::Atom::Entry Class Reference

#include <entry.h>

Inheritance diagram for Syndication::Atom::Entry:

Public Member Functions
	Entry ()
	Entry (const QDomElement &element)
bool	accept (SpecificItemVisitor *visitor) override
QList< Person >	authors () const
QList< Category >	categories () const
Content	content () const
QList< Person >	contributors () const
QString	debugInfo () const
QString	id () const
QList< Link >	links () const
time_t	published () const
QString	rights () const
void	setFeedAuthors (const QList< Person > &feedAuthors)
Source	source () const
QString	summary () const
QString	title () const
QList< QDomElement >	unhandledElements () const
time_t	updated () const
Public Member Functions inherited from Syndication::ElementWrapper
	ElementWrapper ()
	ElementWrapper (const ElementWrapper &other)
	ElementWrapper (const QDomElement &element)
virtual	~ElementWrapper ()
QString	attribute (const QString &name, const QString &defValue=QString()) const
QString	attributeNS (const QString &nsURI, const QString &localName, const QString &defValue=QString()) const
QString	childNodesAsXML () const
QString	completeURI (const QString &uri) const
const QDomElement &	element () const
QList< QDomElement >	elementsByTagName (const QString &tagName) const
QList< QDomElement >	elementsByTagNameNS (const QString &nsURI, const QString &tagName) const
QString	extractElementText (const QString &tagName) const
QString	extractElementTextNS (const QString &namespaceURI, const QString &localName) const
QDomElement	firstElementByTagNameNS (const QString &nsURI, const QString &tagName) const
bool	hasAttribute (const QString &name) const
bool	hasAttributeNS (const QString &nsURI, const QString &localName) const
bool	isNull () const
ElementWrapper &	operator= (const ElementWrapper &other)
bool	operator== (const ElementWrapper &other) const
QString	text () const
QString	xmlBase () const
QString	xmlLang () const
Public Member Functions inherited from Syndication::SpecificItem
virtual	~SpecificItem ()

Additional Inherited Members
Static Public Member Functions inherited from Syndication::ElementWrapper
static QString	childNodesAsXML (const QDomElement &parent)

Detailed Description

an Atom entry, equivalent to the "items" in the RSS world.

Author

Frank Osterfeld

Definition at line 38 of file entry.h.

Constructor & Destructor Documentation

Entry() [1/2]

Syndication::Atom::Entry::Entry

(

)

creates a null entry object

Definition at line 29 of file entry.cpp.

Entry() [2/2]

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

explicit

creates an Entry object wrapping an atom:entry element.

Parameters

element

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

Definition at line 34 of file entry.cpp.

Member Function Documentation

accept()

bool Syndication::Atom::Entry::accept ( SpecificItemVisitor * visitor )

overridevirtual

Used by visitors for double dispatch.

See SpecificVisitor for more information.

Parameters

visitor

the visitor calling the method

Implements Syndication::SpecificItem.

Definition at line 242 of file entry.cpp.

authors()

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

(

)

const

list of persons who are authors of this entry.

(required)

If the entry itself does not have explicit author description, its source author description is used. If none of these exist, the list of authors of the containing feed is used. That list is set by setFeedAuthors().

Definition at line 44 of file entry.cpp.

categories()

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

(

)

const

a list of categories this entry is filed to (optional)

Definition at line 75 of file entry.cpp.

content()

Content Syndication::Atom::Entry::content

(

)

const

content of the entry (optional) See Content for details

Returns

entry content, or a null content object if not specified

Definition at line 138 of file entry.cpp.

contributors()

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

(

)

const

list of persons contributing to this entry (optional)

Definition at line 62 of file entry.cpp.

debugInfo()

QString Syndication::Atom::Entry::debugInfo

(

)

const

returns a description of this entry for debugging purposes

Returns

debug string

Definition at line 178 of file entry.cpp.

id()

QString Syndication::Atom::Entry::id

(

)

const

ID of the article.

(required) The ID must be unique inside this feed. The atom spec defines it as a URI (which is not enforced by this parser)

Definition at line 88 of file entry.cpp.

links()

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

(

)

const

links pointing to associated web sites and other resources.

Links are optional if the entry provides Content. Otherwise, it must contain at least one link with a rel value of "alternate". (see Link).

Definition at line 93 of file entry.cpp.

published()

time_t Syndication::Atom::Entry::published

(

)

const

The datetime of the publication of this entry (optional).

Returns

the publication date in seconds since epoch

Definition at line 116 of file entry.cpp.

rights()

QString Syndication::Atom::Entry::rights

(

)

const

copyright information (optional)

Returns

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

Definition at line 106 of file entry.cpp.

setFeedAuthors()

void Syndication::Atom::Entry::setFeedAuthors

(

const QList< Person > &

feedAuthors

)

Sets the list of the containing feed's authors, which will be used as a fallback in authors() in case both the entry itself and its source have no explicit author description.

Parameters

feedAuthors

the list of feed's authors

Definition at line 39 of file entry.cpp.

source()

Source Syndication::Atom::Entry::source

(

)

const

source description of the content (optional)

If the content was copied from another feed, this object contains information about the source feed.

Returns

source description, or a null object if not specified

Definition at line 111 of file entry.cpp.

summary()

QString Syndication::Atom::Entry::summary

(

)

const

a short summary, abstract or excerpt of an entry.

(optional) This is usually more verbose than title() and but does not contain the whole content as content() does.

Returns

the summary as HTML, or a null string if not specified

Definition at line 128 of file entry.cpp.

title()

QString Syndication::Atom::Entry::title

(

)

const

title of the entry (required).

Returns

the title as HTML

Definition at line 133 of file entry.cpp.

unhandledElements()

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

(

)

const

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

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

Definition at line 143 of file entry.cpp.

updated()

time_t Syndication::Atom::Entry::updated

(

)

const

The datetime of the last modification of this entry (required).

Returns

the modification date in seconds since epoch

Definition at line 122 of file entry.cpp.

---

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

• entry.h
• entry.cpp