Syndication::Person Class Reference

#include <person.h>

Public Member Functions
virtual	~Person ()
virtual QString	debugInfo () const
virtual QString	email () const =0
virtual bool	isNull () const =0
virtual QString	name () const =0
virtual bool	operator== (const Person &other) const
virtual QString	uri () const =0

Detailed Description

Person objects hold information about a person, such as the author of the content syndicated in the feed.

Depending on the feed format, different information is available. While according to the RSS2 spec, RSS2 author elements must contain only an e-mail address, Atom requires the person's name and the e-mail address is optional. Also, in reality, feeds often contain other information than what is specified in the specs. Syndication tries to find out what author information is contained and maps it to this representation.

Author

Frank Osterfeld

Definition at line 36 of file person.h.

Constructor & Destructor Documentation

~Person()

Syndication::Person::~Person ( )

virtual

destructor

Definition at line 12 of file person.cpp.

Member Function Documentation

debugInfo()

QString Syndication::Person::debugInfo ( ) const

virtual

description of the person for debugging purposes.

Returns

debug string

Definition at line 16 of file person.cpp.

email()

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

pure virtual

e-mail address of the person (optional)

Returns

email address, or a null string if not specified

isNull()

virtual bool Syndication::Person::isNull ( ) const

pure virtual

returns whether this object is a null person

name()

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

pure virtual

the name of the person (optional)

Returns

the name of the person as plain text, or a null string if not specified

operator==()

bool Syndication::Person::operator== ( const Person & other ) const

virtual

compares two person instances.

Persons are equal if and only if their respective name(), uri() and email() values are equal.

Parameters

other

another person instance

Definition at line 43 of file person.cpp.

uri()

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

pure virtual

a URI associated with the person.

(optional) This is usually the URL of the person's homepage.

Returns

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

---

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

• person.h
• person.cpp