# khtml Library API Documentation

Overview | Class Hierarchy | Classes | Classes (annotated) | Members | Namespaces | Source Files

# DOM::HTMLInputElement Class Reference

Form control. More...

`#include <html_form.h>`

Inheritance diagram for DOM::HTMLInputElement:

[legend]
Collaboration diagram for DOM::HTMLInputElement:

[legend]
List of all members.

## Public Member Functions

| HTMLInputElement (const HTMLInputElement &other)
| HTMLInputElement (const Node &other)
HTMLInputElement & | operator= (const HTMLInputElement &other)
HTMLInputElement & | operator= (const Node &other)
DOMString | defaultValue () const
void | setDefaultValue (const DOMString &)
bool | defaultChecked () const
void | setDefaultChecked (bool)
HTMLFormElement | form () const
DOMString | accept () const
void | setAccept (const DOMString &)
DOMString | accessKey () const
void | setAccessKey (const DOMString &)
DOMString | align () const
void | setAlign (const DOMString &)
DOMString | alt () const
void | setAlt (const DOMString &)
bool | checked () const
void | setChecked (bool)
bool | disabled () const
void | setDisabled (bool)
long | maxLength () const
void | setMaxLength (long)
DOMString | name () const
void | setName (const DOMString &)
bool | readOnly () const
void | setReadOnly (bool)
DOMString | size () const KDE_DEPRECATED
void | setSize (const DOMString &) KDE_DEPRECATED
long | getSize () const
void | setSize (long)
DOMString | src () const
void | setSrc (const DOMString &)
long | tabIndex () const
void | setTabIndex (long)
DOMString | type () const
void | setType (const DOMString &)
DOMString | useMap () const
void | setUseMap (const DOMString &)
DOMString | value () const
void | setValue (const DOMString &)
void | blur ()
void | focus ()
void | select ()
void | click ()

## Protected Member Functions

| HTMLInputElement (HTMLInputElementImpl *impl)

## Detailed Description

Form control.

Note. Depending upon the environment the page is being viewed, the value property may be read-only for the file upload input type. For the "password" input type, the actual value returned may be masked to prevent unauthorized use. See the INPUT element definition in HTML 4.0.

Definition at line 337 of file html_form.h.

## Member Function Documentation

DOMString HTMLInputElement::defaultValue | ( |  | ) | const

| Stores the initial control value (i.e., the initial value of `value` ). Definition at line 316 of file html_form.cpp. References DOM::DOMString::isNull().

void HTMLInputElement::setDefaultValue | ( | const DOMString & |  | ) |

| see defaultValue Definition at line 325 of file html_form.cpp. References value().

bool HTMLInputElement::defaultChecked | ( |  | ) | const

| When `type` has the value "Radio" or "Checkbox", stores the initial value of the `checked` attribute. Definition at line 330 of file html_form.cpp. References DOM::DOMString::isNull().

void HTMLInputElement::setDefaultChecked | ( | bool |  | ) |

| see defaultChecked Definition at line 336 of file html_form.cpp.

HTMLFormElement HTMLInputElement::form | ( |  | ) | const

| ### KDE 4.0: remove. Reimplemented from DOM::Element. Definition at line 342 of file html_form.cpp. References DOM::Element::form().

DOMString HTMLInputElement::accept | ( |  | ) | const

| A comma-separated list of content types that a server processing this form will handle correctly. See the accept attribute definition in HTML 4.0. Definition at line 347 of file html_form.cpp.

void HTMLInputElement::setAccept | ( | const DOMString & |  | ) |

| see accept Definition at line 353 of file html_form.cpp. References value().

DOMString HTMLInputElement::accessKey | ( |  | ) | const

| A single character access key to give access to the form control. See the accesskey attribute definition in HTML 4.0. Definition at line 358 of file html_form.cpp.

void HTMLInputElement::setAccessKey | ( | const DOMString & |  | ) |

| see accessKey Definition at line 364 of file html_form.cpp. References value().

DOMString HTMLInputElement::align | ( |  | ) | const

| Aligns this object (vertically or horizontally) with respect to its surrounding text. See the align attribute definition in HTML 4.0. This attribute is deprecated in HTML 4.0. Definition at line 369 of file html_form.cpp.

void HTMLInputElement::setAlign | ( | const DOMString & |  | ) |

| see align Definition at line 375 of file html_form.cpp. References value().

DOMString HTMLInputElement::alt | ( |  | ) | const

| Alternate text for user agents not rendering the normal content of this element. See the alt attribute definition in HTML 4.0. Definition at line 380 of file html_form.cpp.

void HTMLInputElement::setAlt | ( | const DOMString & |  | ) |

| see alt Definition at line 386 of file html_form.cpp. References value().

bool HTMLInputElement::checked | ( |  | ) | const

| Describes whether a radio or check box is checked, when `type` has the value "Radio" or "Checkbox". The value is true if explicitly set. Represents the current state of the checkbox or radio button. See the checked attribute definition in HTML 4.0. Definition at line 391 of file html_form.cpp.

void HTMLInputElement::setChecked | ( | bool |  | ) |

| see checked Definition at line 397 of file html_form.cpp.

bool HTMLInputElement::disabled | ( |  | ) | const

| The control is unavailable in this context. See the disabled attribute definition in HTML 4.0. Definition at line 403 of file html_form.cpp. References DOM::DOMString::isNull().

void HTMLInputElement::setDisabled | ( | bool |  | ) |

| see disabled Definition at line 409 of file html_form.cpp.

long HTMLInputElement::maxLength | ( |  | ) | const

| Maximum number of characters for text fields, when `type` has the value "Text" or "Password". See the maxlength attribute definition in HTML 4.0. Definition at line 417 of file html_form.cpp. References DOM::DOMString::toInt().

void HTMLInputElement::setMaxLength | ( | long |  | ) |

| see maxLength Definition at line 423 of file html_form.cpp. References value().

DOMString HTMLInputElement::name | ( |  | ) | const

| Form control or object name when submitted with a form. See the name attribute definition in HTML 4.0. Definition at line 431 of file html_form.cpp.

void HTMLInputElement::setName | ( | const DOMString & |  | ) |

| see name Definition at line 437 of file html_form.cpp. References value().

bool HTMLInputElement::readOnly | ( |  | ) | const

| This control is read-only. When `type` has the value "text" or "password" only. See the readonly attribute definition in HTML 4.0. Definition at line 442 of file html_form.cpp. References DOM::DOMString::isNull().

void HTMLInputElement::setReadOnly | ( | bool |  | ) |

| see readOnly Definition at line 448 of file html_form.cpp.

DOMString HTMLInputElement::size | ( |  | ) | const

Deprecated:

Definition at line 455 of file html_form.cpp.

void HTMLInputElement::setSize | ( | const DOMString & |  | ) |

Deprecated:

Definition at line 461 of file html_form.cpp.

References value().

long HTMLInputElement::getSize | ( |  | ) | const

| Size information. The precise meaning is specific to each type of field. See the size attribute definition in HTML 4.0. Definition at line 466 of file html_form.cpp. References DOM::DOMString::toInt().

void HTMLInputElement::setSize | ( | long |  | ) |

| see getSize Definition at line 472 of file html_form.cpp.

DOMString HTMLInputElement::src | ( |  | ) | const

| When the `type` attribute has the value "Image", this attribute specifies the location of the image to be used to decorate the graphical submit button. See the src attribute definition in HTML 4.0. Definition at line 477 of file html_form.cpp. References DOM::DOMString::isNull(), and DOM::DOMString::string().

void HTMLInputElement::setSrc | ( | const DOMString & |  | ) |

| see src Definition at line 484 of file html_form.cpp. References value().

long HTMLInputElement::tabIndex | ( |  | ) | const

| Index that represents the element's position in the tabbing order. See the tabindex attribute definition in HTML 4.0. Definition at line 489 of file html_form.cpp.

void HTMLInputElement::setTabIndex | ( | long |  | ) |

| see tabIndex Definition at line 495 of file html_form.cpp.

DOMString HTMLInputElement::type | ( |  | ) | const

| The type of control created. See the type attribute definition in HTML 4.0. Definition at line 501 of file html_form.cpp.

void HTMLInputElement::setType | ( | const DOMString & |  | ) |

| see type Definition at line 507 of file html_form.cpp.

DOMString HTMLInputElement::useMap | ( |  | ) | const

| Use client-side image map. See the usemap attribute definition in HTML 4.0. Definition at line 513 of file html_form.cpp.

void HTMLInputElement::setUseMap | ( | const DOMString & |  | ) |

| see useMap Definition at line 519 of file html_form.cpp. References value().

DOMString HTMLInputElement::value | ( |  | ) | const

| The current form control value. Used for radio buttons and check boxes. See the value attribute definition in HTML 4.0. Definition at line 524 of file html_form.cpp. References DOM::DOMString::isNull(). Referenced by setAccept(), setAccessKey(), setAlign(), setAlt(), setDefaultValue(), setMaxLength(), setName(), setSize(), setSrc(), setUseMap(), and setValue().

void HTMLInputElement::setValue | ( | const DOMString & |  | ) |

| see value Definition at line 531 of file html_form.cpp. References value().

void HTMLInputElement::blur | ( |  | ) |

| Removes keyboard focus from this element. Definition at line 538 of file html_form.cpp.

void HTMLInputElement::focus | ( |  | ) |

| Gives keyboard focus to this element. Definition at line 544 of file html_form.cpp.

void HTMLInputElement::select | ( |  | ) |

| Select the contents of the text area. For `INPUT` elements whose `type` attribute has one of the following values: "Text", "File", or "Password". Definition at line 550 of file html_form.cpp.

void HTMLInputElement::click | ( |  | ) |

| Simulate a mouse-click. For `INPUT` elements whose `type` attribute has one of the following values: "Button", "Checkbox", "Radio", "Reset", or "Submit". Definition at line 556 of file html_form.cpp.

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

- html_form.h
- html_form.cpp

This file is part of the documentation for khtml Library Version 3.4.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Jun 11 20:34:09 2005 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003