.TH "DOM::HTMLInputElement" 3 "28 Jan 2004" "khtml Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
DOM::HTMLInputElement \- Form control.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <html_form.h>\fP
.PP
Inherits \fBDOM::HTMLElement\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBHTMLInputElement\fP (const  \fBHTMLInputElement\fP &other)"
.br
.ti -1c
.RI "\fBHTMLInputElement\fP (const  \fBNode\fP &other)"
.br
.ti -1c
.RI "\fBHTMLInputElement\fP & \fBoperator=\fP (const  \fBHTMLInputElement\fP &other)"
.br
.ti -1c
.RI "\fBHTMLInputElement\fP & \fBoperator=\fP (const  \fBNode\fP &other)"
.br
.ti -1c
.RI "\fBDOMString\fP \fBdefaultValue\fP () const "
.br
.RI "\fIStores the initial control value (i.e., the initial value of \fC value \fP ). \fP"
.ti -1c
.RI "void \fBsetDefaultValue\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBdefaultValue\fP \fP"
.ti -1c
.RI "bool \fBdefaultChecked\fP () const "
.br
.RI "\fIWhen \fC type \fP has the value 'Radio' or 'Checkbox', stores the initial value of the \fC checked \fP attribute. \fP"
.ti -1c
.RI "void \fBsetDefaultChecked\fP (bool)"
.br
.RI "\fIsee \fBdefaultChecked\fP \fP"
.ti -1c
.RI "\fBHTMLFormElement\fP \fBform\fP () const "
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP. \fP"
.ti -1c
.RI "\fBDOMString\fP \fBaccept\fP () const "
.br
.RI "\fIA comma-separated list of content types that a server processing this form will handle correctly. \fP"
.ti -1c
.RI "void \fBsetAccept\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBaccept\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBaccessKey\fP () const "
.br
.RI "\fIA single character access key to give access to the form control. \fP"
.ti -1c
.RI "void \fBsetAccessKey\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBaccessKey\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBalign\fP () const "
.br
.RI "\fIAligns this object (vertically or horizontally) with respect to its surrounding text. \fP"
.ti -1c
.RI "void \fBsetAlign\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBalign\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBalt\fP () const "
.br
.RI "\fIAlternate text for user agents not rendering the normal content of this element. \fP"
.ti -1c
.RI "void \fBsetAlt\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBalt\fP \fP"
.ti -1c
.RI "bool \fBchecked\fP () const "
.br
.RI "\fIDescribes whether a radio or check box is checked, when \fC type \fP has the value 'Radio' or 'Checkbox'. \fP"
.ti -1c
.RI "void \fBsetChecked\fP (bool)"
.br
.RI "\fIsee \fBchecked\fP \fP"
.ti -1c
.RI "bool \fBdisabled\fP () const "
.br
.RI "\fIThe control is unavailable in this context. \fP"
.ti -1c
.RI "void \fBsetDisabled\fP (bool)"
.br
.RI "\fIsee \fBdisabled\fP \fP"
.ti -1c
.RI "long \fBmaxLength\fP () const "
.br
.RI "\fIMaximum number of characters for text fields, when \fC type \fP has the value 'Text' or 'Password'. \fP"
.ti -1c
.RI "void \fBsetMaxLength\fP (long)"
.br
.RI "\fIsee \fBmaxLength\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBname\fP () const "
.br
.RI "\fIForm control or object name when submitted with a form. \fP"
.ti -1c
.RI "void \fBsetName\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBname\fP \fP"
.ti -1c
.RI "bool \fBreadOnly\fP () const "
.br
.RI "\fIThis control is read-only. \fP"
.ti -1c
.RI "void \fBsetReadOnly\fP (bool)"
.br
.RI "\fIsee \fBreadOnly\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBsize\fP () const "
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP \fP"
.ti -1c
.RI "void \fBsetSize\fP (const  \fBDOMString\fP &)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP \fP"
.ti -1c
.RI "long \fBgetSize\fP () const "
.br
.RI "\fISize information. \fP"
.ti -1c
.RI "void \fBsetSize\fP (long)"
.br
.RI "\fIsee \fBgetSize\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBsrc\fP () const "
.br
.RI "\fIWhen the \fC type \fP attribute has the value 'Image', this attribute specifies the location of the image to be used to decorate the graphical submit button. \fP"
.ti -1c
.RI "void \fBsetSrc\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBsrc\fP \fP"
.ti -1c
.RI "long \fBtabIndex\fP () const "
.br
.RI "\fIIndex that represents the element's position in the tabbing order. \fP"
.ti -1c
.RI "void \fBsetTabIndex\fP (long)"
.br
.RI "\fIsee \fBtabIndex\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBtype\fP () const "
.br
.RI "\fIThe type of control created. \fP"
.ti -1c
.RI "void \fBsetType\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBtype\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBuseMap\fP () const "
.br
.RI "\fIUse client-side image map. \fP"
.ti -1c
.RI "void \fBsetUseMap\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBuseMap\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBvalue\fP () const "
.br
.RI "\fIThe current form control value. \fP"
.ti -1c
.RI "void \fBsetValue\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBvalue\fP \fP"
.ti -1c
.RI "void \fBblur\fP ()"
.br
.RI "\fIRemoves keyboard focus from this element. \fP"
.ti -1c
.RI "void \fBfocus\fP ()"
.br
.RI "\fIGives keyboard focus to this element. \fP"
.ti -1c
.RI "void \fBselect\fP ()"
.br
.RI "\fISelect the contents of the text area. \fP"
.ti -1c
.RI "void \fBclick\fP ()"
.br
.RI "\fISimulate a mouse-click. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBHTMLInputElement\fP (HTMLInputElementImpl *impl)"
.br
.in -1c
.SH "Detailed Description"
.PP 
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 \fCINPUT element definition \fP in HTML 4.0. 
.PP
Definition at line 336 of file html_form.h.
.SH "Member Function Documentation"
.PP 
.SS "\fBDOMString\fP HTMLInputElement::defaultValue () const"
.PP
Stores the initial control value (i.e., the initial value of \fC value \fP ). Definition at line 317 of file html_form.cpp.
.PP
References DOM::DOMString::isNull().
.SS "void HTMLInputElement::setDefaultValue (const \fBDOMString\fP &)"
.PP
see \fBdefaultValue\fP Definition at line 326 of file html_form.cpp.
.SS "bool HTMLInputElement::defaultChecked () const"
.PP
When \fC type \fP has the value 'Radio' or 'Checkbox', stores the initial value of the \fC checked \fP attribute. Definition at line 331 of file html_form.cpp.
.SS "void HTMLInputElement::setDefaultChecked (bool)"
.PP
see \fBdefaultChecked\fP Definition at line 337 of file html_form.cpp.
.SS "\fBHTMLFormElement\fP HTMLInputElement::form () const"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP. ### \fBKDE\fP 4.0: remove. Reimplemented from \fBDOM::Element\fP.
.PP
Definition at line 343 of file html_form.cpp.
.SS "\fBDOMString\fP HTMLInputElement::accept () const"
.PP
A comma-separated list of content types that a server processing this form will handle correctly. See the \fCaccept attribute definition \fP in HTML 4.0. Definition at line 348 of file html_form.cpp.
.SS "void HTMLInputElement::setAccept (const \fBDOMString\fP &)"
.PP
see \fBaccept\fP Definition at line 354 of file html_form.cpp.
.SS "\fBDOMString\fP HTMLInputElement::accessKey () const"
.PP
A single character access key to give access to the form control. See the \fCaccesskey attribute definition \fP in HTML 4.0. Definition at line 359 of file html_form.cpp.
.SS "void HTMLInputElement::setAccessKey (const \fBDOMString\fP &)"
.PP
see \fBaccessKey\fP Definition at line 365 of file html_form.cpp.
.SS "\fBDOMString\fP HTMLInputElement::align () const"
.PP
Aligns this object (vertically or horizontally) with respect to its surrounding text. See the \fCalign attribute definition \fP in HTML 4.0. This attribute is deprecated in HTML 4.0. Definition at line 370 of file html_form.cpp.
.SS "void HTMLInputElement::setAlign (const \fBDOMString\fP &)"
.PP
see \fBalign\fP Definition at line 376 of file html_form.cpp.
.SS "\fBDOMString\fP HTMLInputElement::alt () const"
.PP
Alternate text for user agents not rendering the normal content of this element. See the \fCalt attribute definition \fP in HTML 4.0. Definition at line 381 of file html_form.cpp.
.SS "void HTMLInputElement::setAlt (const \fBDOMString\fP &)"
.PP
see \fBalt\fP Definition at line 387 of file html_form.cpp.
.SS "bool HTMLInputElement::checked () const"
.PP
Describes whether a radio or check box is checked, when \fC type \fP 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 \fCchecked attribute definition \fP in HTML 4.0. Definition at line 392 of file html_form.cpp.
.SS "void HTMLInputElement::setChecked (bool)"
.PP
see \fBchecked\fP Definition at line 398 of file html_form.cpp.
.SS "bool HTMLInputElement::disabled () const"
.PP
The control is unavailable in this context. See the \fCdisabled attribute definition \fP in HTML 4.0. Definition at line 404 of file html_form.cpp.
.SS "void HTMLInputElement::setDisabled (bool)"
.PP
see \fBdisabled\fP Definition at line 410 of file html_form.cpp.
.SS "long HTMLInputElement::maxLength () const"
.PP
Maximum number of characters for text fields, when \fC type \fP has the value 'Text' or 'Password'. See the \fCmaxlength attribute definition \fP in HTML 4.0. Definition at line 418 of file html_form.cpp.
.SS "void HTMLInputElement::setMaxLength (long)"
.PP
see \fBmaxLength\fP Definition at line 424 of file html_form.cpp.
.PP
References QString::number(), and value().
.SS "\fBDOMString\fP HTMLInputElement::name () const"
.PP
Form control or object name when submitted with a form. See the \fCname attribute definition \fP in HTML 4.0. Definition at line 432 of file html_form.cpp.
.SS "void HTMLInputElement::setName (const \fBDOMString\fP &)"
.PP
see \fBname\fP Definition at line 438 of file html_form.cpp.
.SS "bool HTMLInputElement::readOnly () const"
.PP
This control is read-only. When \fC type \fP has the value 'text' or 'password' only. See the \fCreadonly attribute definition \fP in HTML 4.0. Definition at line 443 of file html_form.cpp.
.SS "void HTMLInputElement::setReadOnly (bool)"
.PP
see \fBreadOnly\fP Definition at line 449 of file html_form.cpp.
.SS "\fBDOMString\fP HTMLInputElement::size () const"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP Definition at line 456 of file html_form.cpp.
.SS "void HTMLInputElement::setSize (const \fBDOMString\fP &)"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP Definition at line 462 of file html_form.cpp.
.SS "long HTMLInputElement::getSize () const"
.PP
Size information. The precise meaning is specific to each type of field. See the \fCsize attribute definition \fP in HTML 4.0. Definition at line 467 of file html_form.cpp.
.SS "void HTMLInputElement::setSize (long)"
.PP
see \fBgetSize\fP Definition at line 473 of file html_form.cpp.
.PP
References QString::number().
.SS "\fBDOMString\fP HTMLInputElement::src () const"
.PP
When the \fC type \fP attribute has the value 'Image', this attribute specifies the location of the image to be used to decorate the graphical submit button. See the \fCsrc attribute definition \fP in HTML 4.0. Definition at line 478 of file html_form.cpp.
.PP
References DOM::Document::completeURL(), DOM::DOMString::isEmpty(), and DOM::Node::ownerDocument().
.SS "void HTMLInputElement::setSrc (const \fBDOMString\fP &)"
.PP
see \fBsrc\fP Definition at line 489 of file html_form.cpp.
.SS "long HTMLInputElement::tabIndex () const"
.PP
Index that represents the element's position in the tabbing order. See the \fCtabindex attribute definition \fP in HTML 4.0. Definition at line 494 of file html_form.cpp.
.SS "void HTMLInputElement::setTabIndex (long)"
.PP
see \fBtabIndex\fP Definition at line 500 of file html_form.cpp.
.SS "\fBDOMString\fP HTMLInputElement::type () const"
.PP
The type of control created. See the \fCtype attribute definition \fP in HTML 4.0. Definition at line 506 of file html_form.cpp.
.SS "void HTMLInputElement::setType (const \fBDOMString\fP &)"
.PP
see \fBtype\fP Definition at line 512 of file html_form.cpp.
.SS "\fBDOMString\fP HTMLInputElement::useMap () const"
.PP
Use client-side image map. See the \fCusemap attribute definition \fP in HTML 4.0. Definition at line 518 of file html_form.cpp.
.SS "void HTMLInputElement::setUseMap (const \fBDOMString\fP &)"
.PP
see \fBuseMap\fP Definition at line 524 of file html_form.cpp.
.SS "\fBDOMString\fP HTMLInputElement::value () const"
.PP
The current form control value. Used for radio buttons and check boxes. See the \fCvalue attribute definition \fP in HTML 4.0. Definition at line 529 of file html_form.cpp.
.PP
Referenced by setMaxLength().
.SS "void HTMLInputElement::setValue (const \fBDOMString\fP &)"
.PP
see \fBvalue\fP Definition at line 535 of file html_form.cpp.
.SS "void HTMLInputElement::blur ()"
.PP
Removes keyboard focus from this element. Definition at line 542 of file html_form.cpp.
.SS "void HTMLInputElement::focus ()"
.PP
Gives keyboard focus to this element. Definition at line 548 of file html_form.cpp.
.SS "void HTMLInputElement::select ()"
.PP
Select the contents of the text area. For \fC INPUT \fP elements whose \fC type \fP attribute has one of the following values: 'Text', 'File', or 'Password'. Definition at line 554 of file html_form.cpp.
.SS "void HTMLInputElement::click ()"
.PP
Simulate a mouse-click. For \fC INPUT \fP elements whose \fC type \fP attribute has one of the following values: 'Button', 'Checkbox', 'Radio', 'Reset', or 'Submit'. Definition at line 560 of file html_form.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for khtml Library from the source code.
