1 | /* |
2 | This file is part of the syndication library |
3 | SPDX-FileCopyrightText: 2006 Frank Osterfeld <osterfeld@kde.org> |
4 | |
5 | SPDX-License-Identifier: LGPL-2.0-or-later |
6 | */ |
7 | |
8 | #ifndef SYNDICATION_ATOM_GENERATOR_H |
9 | #define SYNDICATION_ATOM_GENERATOR_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 | * Description of the agent used to generate the feed. |
22 | * |
23 | * @author Frank Osterfeld |
24 | */ |
25 | class SYNDICATION_EXPORT Generator : public ElementWrapper |
26 | { |
27 | public: |
28 | /** |
29 | * default constructor, creates a null generator |
30 | */ |
31 | Generator(); |
32 | |
33 | /** |
34 | * creates a Generator wrapping an atom:generator element. |
35 | * @param element a DOM element, should be a atom:generator element |
36 | * (although not enforced), otherwise this object will not parse |
37 | * anything useful |
38 | */ |
39 | explicit Generator(const QDomElement &element); |
40 | |
41 | /** |
42 | * A URI for the generator (e.g. its homepage) (optional) |
43 | */ |
44 | Q_REQUIRED_RESULT QString uri() const; |
45 | |
46 | /** |
47 | * version of the agent (optional) |
48 | */ |
49 | Q_REQUIRED_RESULT QString version() const; |
50 | |
51 | /** |
52 | * human-readable name of the generator. (optional) |
53 | * |
54 | * @return generator name as plain text |
55 | */ |
56 | Q_REQUIRED_RESULT QString name() const; |
57 | |
58 | /** |
59 | * a description of this generator for debugging purposes. |
60 | * |
61 | * @return debug info |
62 | */ |
63 | Q_REQUIRED_RESULT QString debugInfo() const; |
64 | }; |
65 | |
66 | } // namespace Atom |
67 | } // namespace Syndication |
68 | |
69 | #endif // SYNDICATION_ATOM_GENERATOR_H |
70 | |