• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

syndication/rdf

Syndication::RDF::TextInput

Syndication::RDF::TextInput Class Reference

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

#include <textinput.h>

Inheritance diagram for Syndication::RDF::TextInput:

Inheritance graph
[legend]

List of all members.


Public Member Functions

QString debugInfo () const
QString description () const
QString link () const
QString name () const
 TextInput (ResourcePtr resource)
 TextInput ()
QString title () const
virtual ~TextInput ()

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 37 of file textinput.h.


Constructor & Destructor Documentation

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

creates an object wrapping a null resource.

isNull() is true.

Definition at line 34 of file textinput.cpp.

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

creates a text input object wrapping a rss:textinput resource

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

Definition at line 38 of file textinput.cpp.

Syndication::RDF::TextInput::~TextInput (  )  [virtual]

destructor

Definition at line 42 of file 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 66 of file 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 51 of file 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 56 of file 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 61 of file 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 46 of file textinput.cpp.


The documentation for this class was generated from the following files:
  • textinput.h
  • textinput.cpp

syndication/rdf

Skip menu "syndication/rdf"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.9
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal