Syndication::Atom::Source

Syndication::Atom::Source Class Reference

#include <source.h>

Inheritance diagram for Syndication::Atom::Source:

Public Member Functions

 Source ()
 
 Source (const QDomElement &element)
 
QList< Personauthors () const
 
QList< Categorycategories () const
 
QList< Personcontributors () const
 
QString debugInfo () const
 
Generator generator () const
 
QString icon () const
 
QString id () const
 
QList< Linklinks () const
 
QString logo () const
 
QString rights () const
 
QString subtitle () const
 
QString title () 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 QDomElementelement () const
 
QList< QDomElementelementsByTagName (const QString &tagName) const
 
QList< QDomElementelementsByTagNameNS (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
 
ElementWrapperoperator= (const ElementWrapper &other)
 
bool operator== (const ElementWrapper &other) const
 
QString text () const
 
QString xmlBase () const
 
QString xmlLang () const
 

Additional Inherited Members

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

Detailed Description

If an entry was copied from another feed, this class contains a description of the source feed.

Author
Frank Osterfeld

Definition at line 36 of file atom/source.h.

Constructor & Destructor Documentation

Syndication::Atom::Source::Source ( )

creates a null source object

Definition at line 27 of file atom/source.cpp.

Syndication::Atom::Source::Source ( const QDomElement element)
explicit

creates a Source object wrapping a atom:source element.

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

Definition at line 31 of file atom/source.cpp.

Member Function Documentation

QList< Person > Syndication::Atom::Source::authors ( ) const

authors of the original content (optional)

Definition at line 35 of file atom/source.cpp.

QList< Category > Syndication::Atom::Source::categories ( ) const

categories the source feed is assigned to (optional)

Definition at line 71 of file atom/source.cpp.

QList< Person > Syndication::Atom::Source::contributors ( ) const

contributors to the original content (optional)

Definition at line 53 of file atom/source.cpp.

QString Syndication::Atom::Source::debugInfo ( ) const

description of this source object for debugging purposes

Returns
debug string

Definition at line 153 of file atom/source.cpp.

Generator Syndication::Atom::Source::generator ( ) const

description of the software which generated the source feed (optional)

Definition at line 89 of file atom/source.cpp.

QString Syndication::Atom::Source::icon ( ) const

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

Returns
icon URL, or a null string if not specified

Definition at line 95 of file atom/source.cpp.

QString Syndication::Atom::Source::id ( ) const

a string that unambigously identifies the source feed (optional)

Returns
the ID of the source feed, or a null string if not specified.

Definition at line 101 of file atom/source.cpp.

QList< Link > Syndication::Atom::Source::links ( ) const

a list of links.

See Link for more information on link types.

Definition at line 107 of file atom/source.cpp.

QString Syndication::Atom::Source::logo ( ) const

URL of an image, the logo of the source feed (optional)

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

Definition at line 125 of file atom/source.cpp.

QString Syndication::Atom::Source::rights ( ) const

copyright information (optional)

Returns
copyright information for the source, or a null string if not specified

Definition at line 131 of file atom/source.cpp.

QString Syndication::Atom::Source::subtitle ( ) const

description or subtitle of the source feed (optional).

Returns
subtitle string as HTML, or a null string if not specified.

Definition at line 136 of file atom/source.cpp.

QString Syndication::Atom::Source::title ( ) const

source feed title (optional).

Returns
title string as HTML, or a null string if not specified

Definition at line 141 of file atom/source.cpp.

time_t Syndication::Atom::Source::updated ( ) const

The datetime of the last modification of the source feed content.

(optional)

Returns
the modification date in seconds since epoch

Definition at line 146 of file atom/source.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Jan 19 2021 23:05:17 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.