Syndication

atom/person.h
1 /*
2  This file is part of the syndication library
3  SPDX-FileCopyrightText: 2006 Frank Osterfeld <[email protected]>
4 
5  SPDX-License-Identifier: LGPL-2.0-or-later
6 */
7 
8 #ifndef SYNDICATION_ATOM_PERSON_H
9 #define SYNDICATION_ATOM_PERSON_H
10 
11 #include <syndication/elementwrapper.h>
12 
13 class QDomElement;
14 class QString;
15 
16 namespace Syndication
17 {
18 namespace Atom
19 {
20 /**
21  * describes a person, with name and optional URI and e-mail address.
22  * Used to describe authors and contributors of feeds/entries
23  *
24  * @author Frank Osterfeld
25  */
26 class SYNDICATION_EXPORT Person : public ElementWrapper
27 {
28 public:
29  /**
30  * creates a null person object
31  */
32  Person();
33 
34  /**
35  * creates a Person object wrapping an Atom Person Construct (atom:author,
36  * atom:contributor tags)
37  * @param element a DOM element, should be a Atom Person Construct
38  * (although not enforced), otherwise this object will not parse
39  * anything useful
40  */
41  explicit Person(const QDomElement &element);
42 
43  /**
44  * a human-readable name for the person. (required)
45  * The name is a required attribute of person constructs.
46  *
47  * @return a human-readable name of the person
48  */
49  Q_REQUIRED_RESULT QString name() const;
50 
51  /**
52  * A URI associated with the person (optional). Usually the homepage.
53  *
54  * @return the URI of the person, or a null string if not specified
55  */
56  Q_REQUIRED_RESULT QString uri() const;
57 
58  /**
59  * returns an e-mail address associated with the person. (optional)
60  *
61  * @return an e-mail address, or a null string if not specified
62  */
63  Q_REQUIRED_RESULT QString email() const;
64 
65  /**
66  * description for debugging purposes
67  *
68  * @return debug string
69  */
70  Q_REQUIRED_RESULT QString debugInfo() const;
71 };
72 
73 } // namespace Atom
74 } // namespace Syndication
75 
76 #endif // SYNDICATION_ATOM_PERSON_H
describes a person, with name and optional URI and e-mail address.
Definition: atom/person.h:26
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Jun 6 2023 03:56:27 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.