| 1 | /* |
| 2 | This file is part of the syndication library |
| 3 | SPDX-FileCopyrightText: 2005 Frank Osterfeld <osterfeld@kde.org> |
| 4 | |
| 5 | SPDX-License-Identifier: LGPL-2.0-or-later |
| 6 | */ |
| 7 | |
| 8 | #ifndef SYNDICATION_RSS2_TEXTINPUT_H |
| 9 | #define |
| 10 | |
| 11 | #include <syndication/elementwrapper.h> |
| 12 | |
| 13 | class QString; |
| 14 | class QDomElement; |
| 15 | |
| 16 | namespace Syndication |
| 17 | { |
| 18 | namespace RSS2 |
| 19 | { |
| 20 | /*! |
| 21 | * "The purpose of the <textInput> element is something of a mystery. |
| 22 | * You can use it to specify a search engine box. Or to allow a |
| 23 | * reader to provide feedback. Most aggregators ignore it." |
| 24 | * |
| 25 | * @author Frank Osterfeld |
| 26 | */ |
| 27 | class : public ElementWrapper |
| 28 | { |
| 29 | public: |
| 30 | /*! |
| 31 | * Default constructor, creates a null object, for which isNull() is |
| 32 | * @c true. |
| 33 | */ |
| 34 | (); |
| 35 | |
| 36 | /*! |
| 37 | * Creates a TextInput object wrapping a @c <textInput> XML element. |
| 38 | * |
| 39 | * \a element The @c <textInput> element to wrap |
| 40 | */ |
| 41 | explicit (const QDomElement &element); |
| 42 | |
| 43 | /*! |
| 44 | * The label of the Submit button in the text input area. |
| 45 | * |
| 46 | * @return TODO |
| 47 | */ |
| 48 | QString () const; |
| 49 | |
| 50 | /*! |
| 51 | * The name of the text object in the text input area. |
| 52 | * |
| 53 | * @return TODO |
| 54 | */ |
| 55 | QString () const; |
| 56 | |
| 57 | /*! |
| 58 | * Explains the text input area. |
| 59 | * |
| 60 | * @return TODO |
| 61 | */ |
| 62 | QString () const; |
| 63 | |
| 64 | /*! |
| 65 | * The URL of the CGI script that processes text input requests. |
| 66 | * |
| 67 | * @return TODO |
| 68 | */ |
| 69 | QString () const; |
| 70 | |
| 71 | /*! |
| 72 | * Returns a description of the object for debugging purposes. |
| 73 | * |
| 74 | * @return debug string |
| 75 | */ |
| 76 | QString () const; |
| 77 | }; |
| 78 | |
| 79 | } // namespace RSS2 |
| 80 | } // namespace Syndication |
| 81 | |
| 82 | #endif // SYNDICATION_RSS2_TEXTINPUT_H |
| 83 | |