Syndication::RDF::TextInput

Search for usage in LXR

Syndication::RDF::TextInput Class Reference

#include <textinput.h>

Inheritance diagram for Syndication::RDF::TextInput:

Public Member Functions

 TextInput ()
 
 TextInput (ResourcePtr resource)
 
 ~TextInput () override
 
QString debugInfo () const
 
QString description () const
 
QString link () const
 
QString name () const
 
QString title () const
 
- Public Member Functions inherited from Syndication::RDF::ResourceWrapper
 ResourceWrapper ()
 
 ResourceWrapper (const ResourceWrapper &other)
 
 ResourceWrapper (ResourcePtr resource)
 
virtual ~ResourceWrapper ()
 
bool isNull () const
 
ResourceWrapperoperator= (const ResourceWrapper &other)
 
bool operator== (const ResourceWrapper &other) const
 
ResourcePtr resource () const
 

Detailed Description

"The textinput element affords a method for submitting form data to an arbitrary URL - usually located at the parent website.

The field is typically used as a search box or subscription form"

Author
Frank Osterfeld

Definition at line 25 of file rdf/textinput.h.

Constructor & Destructor Documentation

Syndication::RDF::TextInput::TextInput ( )

creates an object wrapping a null resource.

isNull() is true.

Definition at line 18 of file rdf/textinput.cpp.

Syndication::RDF::TextInput::TextInput ( ResourcePtr  resource)
explicit

creates a text input object wrapping a rss:textinput resource

Parameters
resourceresource to wrap, must be of type rss:textinput, otherwise this object will not return useful information.

Definition at line 23 of file rdf/textinput.cpp.

Syndication::RDF::TextInput::~TextInput ( )
override

destructor

Definition at line 28 of file rdf/textinput.cpp.

Member Function Documentation

QString Syndication::RDF::TextInput::debugInfo ( ) const

Returns a description of the text input for debugging purposes.

Returns
debug string

Definition at line 52 of file rdf/textinput.cpp.

QString Syndication::RDF::TextInput::description ( ) const

A brief description of the textinput field's purpose.

For example: "Subscribe to our newsletter for..." or "Search our site's archive of..."

Returns
description TODO: specify format (HTML/plain text), or a null string if not specified.

Definition at line 37 of file rdf/textinput.cpp.

QString Syndication::RDF::TextInput::link ( ) const

The URL to which a textinput submission will be directed (using GET).

Returns
URL, or a null string if not specified

Definition at line 42 of file rdf/textinput.cpp.

QString Syndication::RDF::TextInput::name ( ) const

The text input field's (variable) name.

Returns
name, or a null string if not specified

Definition at line 47 of file rdf/textinput.cpp.

QString Syndication::RDF::TextInput::title ( ) const

A descriptive title for the textinput field.

For example: "Subscribe" or "Search!"

Returns
title of the text input, or a null string if not specified

Definition at line 32 of file rdf/textinput.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Fri Nov 26 2021 23:04:18 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.