akregator/src/librss
RSS::TextInput Class Reference
#include <textinput.h>
Detailed Description
Represents a text input facility as stored in a RSS file for the purpose of allowing users to submit queries back to the publisher's site.You don't have to instantiate one of these yourself, the common way to access instances is via Document::textInput().
- See also:
- Document::textInput()
Definition at line 30 of file textinput.h.
Public Member Functions | |
TextInput () | |
TextInput (const TextInput &other) | |
TextInput (const QDomNode &node) | |
TextInput & | operator= (const TextInput &other) |
bool | operator== (const TextInput &other) const |
bool | operator!= (const TextInput &other) const |
virtual | ~TextInput () |
QString | title () const |
QString | description () const |
QString | name () const |
const KURL & | link () const |
Constructor & Destructor Documentation
RSS::TextInput::TextInput | ( | ) |
Default constructor.
RSS::TextInput::TextInput | ( | const TextInput & | other | ) |
RSS::TextInput::TextInput | ( | const QDomNode & | node | ) |
virtual RSS::TextInput::~TextInput | ( | ) | [virtual] |
Destructor.
Member Function Documentation
QString RSS::TextInput::description | ( | ) | const |
RSS 0.90 and upwards.
- Returns:
- The description (usually used as a tooltip which appears if the mouse hovers above the input field for a short time) of the text input, or QString::null if no description is available.
const KURL& RSS::TextInput::link | ( | ) | const |
RSS 0.90 and upwards.
- Returns:
- A link to which the contents of the input field should be sent after the user specified them. This is often a CGI program on a remote server which evaluates the entered information. An empty KURL is returned in case no link is available. Note that the RSS 0.91 Specification dictates that URLs not starting with "http://" or "ftp://" are considered invalid.
QString RSS::TextInput::name | ( | ) | const |
RSS 0.90 and upwards.
- Returns:
- The name of the text input (what's this for?) of the text input, or QString::null, if no name is available.
bool RSS::TextInput::operator!= | ( | const TextInput & | other | ) | const [inline] |
Convenience method.
Simply calls !operator==().
- Parameters:
-
other The text input to compared with.
- Returns:
- Whether the two text inputs are unequal.
Definition at line 72 of file textinput.h.
bool RSS::TextInput::operator== | ( | const TextInput & | other | ) | const |
Compares two text inputs.
Two text inputs are considered identical if their properties (title, description, link etc.) are identical.
- Parameters:
-
other The text input to compare with.
- Returns:
- Whether the two text inputs are equal.
QString RSS::TextInput::title | ( | ) | const |
RSS 0.90 and upwards.
- Returns:
- The title (often a label to be used for the input field) of the text input, or QString::null if no title is available.
The documentation for this class was generated from the following file: