File indexing completed on 2023-11-26 07:40:12
0001 /* 0002 This file is part of the syndication library 0003 SPDX-FileCopyrightText: 2005 Frank Osterfeld <osterfeld@kde.org> 0004 0005 SPDX-License-Identifier: LGPL-2.0-or-later 0006 */ 0007 0008 #ifndef SYNDICATION_RSS2_TEXTINPUT_H 0009 #define SYNDICATION_RSS2_TEXTINPUT_H 0010 0011 #include <syndication/elementwrapper.h> 0012 0013 class QString; 0014 class QDomElement; 0015 0016 namespace Syndication 0017 { 0018 namespace RSS2 0019 { 0020 /** 0021 * "The purpose of the <textInput> element is something of a mystery. 0022 * You can use it to specify a search engine box. Or to allow a 0023 * reader to provide feedback. Most aggregators ignore it." 0024 * 0025 * @author Frank Osterfeld 0026 */ 0027 class SYNDICATION_EXPORT TextInput : public ElementWrapper 0028 { 0029 public: 0030 /** 0031 * Default constructor, creates a null object, for which isNull() is 0032 * @c true. 0033 */ 0034 TextInput(); 0035 0036 /** 0037 * Creates a TextInput object wrapping a @c <textInput> XML element. 0038 * 0039 * @param element The @c <textInput> element to wrap 0040 */ 0041 explicit TextInput(const QDomElement &element); 0042 0043 /** 0044 * The label of the Submit button in the text input area. 0045 * 0046 * @return TODO 0047 */ 0048 QString title() const; 0049 0050 /** 0051 * The name of the text object in the text input area. 0052 * 0053 * @return TODO 0054 */ 0055 QString name() const; 0056 0057 /** 0058 * Explains the text input area. 0059 * 0060 * @return TODO 0061 */ 0062 QString description() const; 0063 0064 /** 0065 * The URL of the CGI script that processes text input requests. 0066 * 0067 * @return TODO 0068 */ 0069 QString link() const; 0070 0071 /** 0072 * Returns a description of the object for debugging purposes. 0073 * 0074 * @return debug string 0075 */ 0076 QString debugInfo() const; 0077 }; 0078 0079 } // namespace RSS2 0080 } // namespace Syndication 0081 0082 #endif // SYNDICATION_RSS2_TEXTINPUT_H