RSS::TextInput Class Reference

#include <textinput.h>

Public Member Functions
	TextInput ()
	TextInput (const TextInput &other)
	TextInput (const TQDomNode &node)
TextInput &	operator= (const TextInput &other)
bool	operator== (const TextInput &other) const
bool	operator!= (const TextInput &other) const
virtual	~TextInput ()
TQString	title () const
TQString	description () const
TQString	name () const
const KURL &	link () const

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.

Constructor & Destructor Documentation

TextInput() [1/3]

TextInput::TextInput

(

)

Default constructor.

Definition at line 28 of file textinput.cpp.

TextInput() [2/3]

TextInput::TextInput

(

const TextInput &

other

)

Copy constructor.

Parameters

other

The TextInput object to copy.

Definition at line 32 of file textinput.cpp.

TextInput() [3/3]

TextInput::TextInput

(

const TQDomNode &

node

)

Constructs a TextInput from a piece of RSS markup.

Parameters

node	A TQDomNode which references the DOM leaf to be used for constructing the TextInput.

Definition at line 37 of file textinput.cpp.

~TextInput()

TextInput::~TextInput ( )

virtual

Destructor.

Definition at line 51 of file textinput.cpp.

Member Function Documentation

description()

TQString 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 TQString() if no description is available.

Definition at line 62 of file textinput.cpp.

link()

const KURL & 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.

Definition at line 72 of file textinput.cpp.

name()

TQString TextInput::name

(

)

const

RSS 0.90 and upwards.

Returns

The name of the text input (what's this for?) of the text input, or TQString(), if no name is available.

Definition at line 67 of file textinput.cpp.

operator!=()

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.

operator=()

TextInput & TextInput::operator=

(

const TextInput &

other

)

Assignment operator.

Parameters

other

The TextInput object to clone.

Returns

A reference to the cloned TextInput object.

Definition at line 77 of file textinput.cpp.

operator==()

bool 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.

Definition at line 88 of file textinput.cpp.

title()

TQString 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 TQString() if no title is available.

Definition at line 57 of file textinput.cpp.

---

The documentation for this class was generated from the following files:

• textinput.h
• textinput.cpp