mirror of
https://bitbucket.org/smil3y/kde-extraapps.git
synced 2025-02-24 19:02:53 +00:00
106 lines
3.1 KiB
C++
106 lines
3.1 KiB
C++
/*
|
|
* This file is part of the syndication library
|
|
*
|
|
* Copyright (C) 2006 Frank Osterfeld <osterfeld@kde.org>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public License
|
|
* along with this library; see the file COPYING.LIB. If not, write to
|
|
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*
|
|
*/
|
|
|
|
#ifndef SYNDICATION_PERSON_H
|
|
#define SYNDICATION_PERSON_H
|
|
|
|
#include <QtCore/QString>
|
|
#include <boost/shared_ptr.hpp>
|
|
|
|
#include "ksyndication_export.h"
|
|
|
|
namespace Syndication {
|
|
|
|
class Person;
|
|
|
|
//@cond PRIVATE
|
|
typedef boost::shared_ptr<Person> PersonPtr;
|
|
//@endcond
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
class SYNDICATION_EXPORT Person
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* destructor
|
|
*/
|
|
virtual ~Person();
|
|
|
|
/**
|
|
* returns whether this object is a null person
|
|
*/
|
|
virtual bool isNull() const = 0;
|
|
|
|
/**
|
|
* the name of the person (optional)
|
|
*
|
|
* @return the name of the person as plain text,
|
|
* or a null string if not specified
|
|
*/
|
|
virtual QString name() const = 0;
|
|
|
|
/**
|
|
* a URI associated with the person. (optional)
|
|
* This is usually the URL of the
|
|
* person's homepage.
|
|
*
|
|
* @return URI of the person, or a null string if not specified
|
|
*/
|
|
virtual QString uri() const = 0;
|
|
|
|
/**
|
|
* e-mail address of the person (optional)
|
|
*
|
|
* @return email address, or a null string if not specified
|
|
*/
|
|
virtual QString email() const = 0;
|
|
|
|
/**
|
|
* description of the person for debugging purposes.
|
|
*
|
|
* @return debug string
|
|
*/
|
|
virtual QString debugInfo() const;
|
|
|
|
/**
|
|
* compares two person instances. Persons are equal if and only if
|
|
* their respective name(), uri() and email() values are equal.
|
|
* @param other another person instance
|
|
*/
|
|
virtual bool operator==(const Person& other) const;
|
|
};
|
|
|
|
} // namespace Syndication
|
|
|
|
#endif // SYNDICATION_PERSON_H
|