1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
/*
* 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
|