Syndication

rss2/textinput.h
1 /*
2  This file is part of the syndication library
3  SPDX-FileCopyrightText: 2005 Frank Osterfeld <[email protected]>
4 
5  SPDX-License-Identifier: LGPL-2.0-or-later
6 */
7 
8 #ifndef SYNDICATION_RSS2_TEXTINPUT_H
9 #define SYNDICATION_RSS2_TEXTINPUT_H
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 &lt;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 SYNDICATION_EXPORT TextInput : public ElementWrapper
28 {
29 public:
30  /**
31  * Default constructor, creates a null object, for which isNull() is
32  * @c true.
33  */
34  TextInput();
35 
36  /**
37  * Creates a TextInput object wrapping a @c &lt;textInput> XML element.
38  *
39  * @param element The @c &lt;textInput> element to wrap
40  */
41  explicit TextInput(const QDomElement &element);
42 
43  /**
44  * The label of the Submit button in the text input area.
45  *
46  * @return TODO
47  */
48  QString title() const;
49 
50  /**
51  * The name of the text object in the text input area.
52  *
53  * @return TODO
54  */
55  QString name() const;
56 
57  /**
58  * Explains the text input area.
59  *
60  * @return TODO
61  */
62  QString description() const;
63 
64  /**
65  * The URL of the CGI script that processes text input requests.
66  *
67  * @return TODO
68  */
69  QString link() const;
70 
71  /**
72  * Returns a description of the object for debugging purposes.
73  *
74  * @return debug string
75  */
76  QString debugInfo() const;
77 };
78 
79 } // namespace RSS2
80 } // namespace Syndication
81 
82 #endif // SYNDICATION_RSS2_TEXTINPUT_H
"The purpose of the <textInput> element is something of a mystery.
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.