Syndication::Atom::Person

Syndication::Atom::Person Class Reference

#include <person.h>

Inheritance diagram for Syndication::Atom::Person:

Public Member Functions

 Person ()
 
 Person (const QDomElement &element)
 
QString debugInfo () const
 
QString email () const
 
QString name () const
 
QString uri () 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

describes a person, with name and optional URI and e-mail address.

Used to describe authors and contributors of feeds/entries

Author
Frank Osterfeld

Definition at line 27 of file atom/person.h.

Constructor & Destructor Documentation

Syndication::Atom::Person::Person ( )

creates a null person object

Definition at line 18 of file atom/person.cpp.

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

creates a Person object wrapping an Atom Person Construct (atom:author, atom:contributor tags)

Parameters
elementa DOM element, should be a Atom Person Construct (although not enforced), otherwise this object will not parse anything useful

Definition at line 22 of file atom/person.cpp.

Member Function Documentation

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

description for debugging purposes

Returns
debug string

Definition at line 45 of file atom/person.cpp.

QString Syndication::Atom::Person::email ( ) const

returns an e-mail address associated with the person.

(optional)

Returns
an e-mail address, or a null string if not specified

Definition at line 39 of file atom/person.cpp.

QString Syndication::Atom::Person::name ( ) const

a human-readable name for the person.

(required) The name is a required attribute of person constructs.

Returns
a human-readable name of the person

Definition at line 26 of file atom/person.cpp.

QString Syndication::Atom::Person::uri ( ) const

A URI associated with the person (optional).

Usually the homepage.

Returns
the URI of the person, or a null string if not specified

Definition at line 32 of file atom/person.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Nov 30 2020 23:03:28 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.