Syndication::Atom::Entry Class Reference

#include <entry.h>

Public Member Functions
	Entry ()
	Entry (const QDomElement &element)
bool	accept (SpecificItemVisitor *visitor)
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

Detailed Description

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

Author

Frank Osterfeld

Definition at line 53 of file entry.h.

Constructor & Destructor Documentation

Entry() [1/2]

Syndication::Atom::Entry::Entry

(

)

creates a null entry object

Definition at line 40 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 44 of file entry.cpp.

Member Function Documentation

accept()

bool Syndication::Atom::Entry::accept

(

SpecificItemVisitor *

visitor

)

Used by visitors for double dispatch.

See SpecificVisitor for more information.

Parameters

visitor

the visitor calling the method

Definition at line 277 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 53 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 101 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 181 of file entry.cpp.

contributors()

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

(

)

const

list of persons contributing to this entry (optional)

Definition at line 82 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 220 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 120 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 127 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 157 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 146 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 48 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 151 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 171 of file entry.cpp.

title()

QString Syndication::Atom::Entry::title

(

)

const

title of the entry (required).

Returns

the title as HTML

Definition at line 176 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 187 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 164 of file entry.cpp.

---

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

• entry.h
• entry.cpp