| 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 | * \class Syndication::Atom::Generator |
|---|
| 22 | * \inmodule Syndication |
|---|
| 23 | * \inheaderfile Syndication/Atom/Generator |
|---|
| 24 | * |
|---|
| 25 | * \brief Description of the agent used to generate the feed. |
|---|
| 26 | */ |
|---|
| 27 | class SYNDICATION_EXPORT Generator : public ElementWrapper |
|---|
| 28 | { |
|---|
| 29 | public: |
|---|
| 30 | /*! |
|---|
| 31 | * default constructor, creates a null generator |
|---|
| 32 | */ |
|---|
| 33 | Generator(); |
|---|
| 34 | |
|---|
| 35 | /*! |
|---|
| 36 | * creates a Generator wrapping an atom:generator element. |
|---|
| 37 | * |
|---|
| 38 | * \a element a DOM element, should be a atom:generator element |
|---|
| 39 | * (although not enforced), otherwise this object will not parse |
|---|
| 40 | * anything useful |
|---|
| 41 | */ |
|---|
| 42 | explicit Generator(const QDomElement &element); |
|---|
| 43 | |
|---|
| 44 | /*! |
|---|
| 45 | * A URI for the generator (e.g. its homepage) (optional) |
|---|
| 46 | */ |
|---|
| 47 | Q_REQUIRED_RESULT QString uri() const; |
|---|
| 48 | |
|---|
| 49 | /*! |
|---|
| 50 | * version of the agent (optional) |
|---|
| 51 | */ |
|---|
| 52 | Q_REQUIRED_RESULT QString version() const; |
|---|
| 53 | |
|---|
| 54 | /*! |
|---|
| 55 | * human-readable name of the generator. (optional) |
|---|
| 56 | */ |
|---|
| 57 | Q_REQUIRED_RESULT QString name() const; |
|---|
| 58 | |
|---|
| 59 | /*! |
|---|
| 60 | * a description of this generator for debugging purposes. |
|---|
| 61 | */ |
|---|
| 62 | Q_REQUIRED_RESULT QString debugInfo() const; |
|---|
| 63 | }; |
|---|
| 64 | |
|---|
| 65 | } // namespace Atom |
|---|
| 66 | } // namespace Syndication |
|---|
| 67 | |
|---|
| 68 | #endif // SYNDICATION_ATOM_GENERATOR_H |
|---|
| 69 | |
|---|
