.TH "DOM::HTMLTableElement" 3 "28 Jan 2004" "khtml Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
DOM::HTMLTableElement \- The create* and delete* methods on the table allow authors to construct and modify tables.  

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

.in +1c
.ti -1c
.RI "\fBHTMLTableElement\fP (const  \fBHTMLTableElement\fP &other)"
.br
.ti -1c
.RI "\fBHTMLTableElement\fP (const  \fBNode\fP &other)"
.br
.ti -1c
.RI "\fBHTMLTableElement\fP & \fBoperator=\fP (const  \fBHTMLTableElement\fP &other)"
.br
.ti -1c
.RI "\fBHTMLTableElement\fP & \fBoperator=\fP (const  \fBNode\fP &other)"
.br
.ti -1c
.RI "\fBHTMLTableCaptionElement\fP \fBcaption\fP () const "
.br
.RI "\fIReturns the table's \fC CAPTION \fP , or void if none exists. \fP"
.ti -1c
.RI "void \fBsetCaption\fP (const  \fBHTMLTableCaptionElement\fP &)"
.br
.RI "\fIsee \fBcaption\fP \fP"
.ti -1c
.RI "\fBHTMLTableSectionElement\fP \fBtHead\fP () const "
.br
.RI "\fIReturns the table's \fC THEAD \fP , or \fC null \fP if none exists. \fP"
.ti -1c
.RI "void \fBsetTHead\fP (const  \fBHTMLTableSectionElement\fP &)"
.br
.RI "\fIsee \fBtHead\fP \fP"
.ti -1c
.RI "\fBHTMLTableSectionElement\fP \fBtFoot\fP () const "
.br
.RI "\fIReturns the table's \fC TFOOT \fP , or \fC null \fP if none exists. \fP"
.ti -1c
.RI "void \fBsetTFoot\fP (const  \fBHTMLTableSectionElement\fP &)"
.br
.RI "\fIsee \fBtFoot\fP \fP"
.ti -1c
.RI "\fBHTMLCollection\fP \fBrows\fP () const "
.br
.RI "\fIReturns a collection of all the rows in the table, including all in \fC THEAD \fP , \fC TFOOT \fP , all \fC TBODY \fP elements. \fP"
.ti -1c
.RI "\fBHTMLCollection\fP \fBtBodies\fP () const "
.br
.RI "\fIReturns a collection of the table bodies (including implicit ones). \fP"
.ti -1c
.RI "\fBDOMString\fP \fBalign\fP () const "
.br
.RI "\fISpecifies the table's position with respect to the rest of the document. \fP"
.ti -1c
.RI "void \fBsetAlign\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBalign\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBbgColor\fP () const "
.br
.RI "\fICell background color. \fP"
.ti -1c
.RI "void \fBsetBgColor\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBbgColor\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBborder\fP () const "
.br
.RI "\fIThe width of the border around the table. \fP"
.ti -1c
.RI "void \fBsetBorder\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBborder\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBcellPadding\fP () const "
.br
.RI "\fISpecifies the horizontal and vertical space between cell content and cell borders. \fP"
.ti -1c
.RI "void \fBsetCellPadding\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBcellPadding\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBcellSpacing\fP () const "
.br
.RI "\fISpecifies the horizontal and vertical separation between cells. \fP"
.ti -1c
.RI "void \fBsetCellSpacing\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBcellSpacing\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBframe\fP () const "
.br
.RI "\fISpecifies which external table borders to render. \fP"
.ti -1c
.RI "void \fBsetFrame\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBframe\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBrules\fP () const "
.br
.RI "\fISpecifies which internal table borders to render. \fP"
.ti -1c
.RI "void \fBsetRules\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBrules\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBsummary\fP () const "
.br
.RI "\fISupplementary description about the purpose or structure of a table. \fP"
.ti -1c
.RI "void \fBsetSummary\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBsummary\fP \fP"
.ti -1c
.RI "\fBDOMString\fP \fBwidth\fP () const "
.br
.RI "\fISpecifies the desired table width. \fP"
.ti -1c
.RI "void \fBsetWidth\fP (const  \fBDOMString\fP &)"
.br
.RI "\fIsee \fBwidth\fP \fP"
.ti -1c
.RI "\fBHTMLElement\fP \fBcreateTHead\fP ()"
.br
.RI "\fICreate a table header row or return an existing one. \fP"
.ti -1c
.RI "void \fBdeleteTHead\fP ()"
.br
.RI "\fIDelete the header from the table, if one exists. \fP"
.ti -1c
.RI "\fBHTMLElement\fP \fBcreateTFoot\fP ()"
.br
.RI "\fICreate a table footer row or return an existing one. \fP"
.ti -1c
.RI "void \fBdeleteTFoot\fP ()"
.br
.RI "\fIDelete the footer from the table, if one exists. \fP"
.ti -1c
.RI "\fBHTMLElement\fP \fBcreateCaption\fP ()"
.br
.RI "\fICreate a new table caption object or return an existing one. \fP"
.ti -1c
.RI "void \fBdeleteCaption\fP ()"
.br
.RI "\fIDelete the table caption, if one exists. \fP"
.ti -1c
.RI "\fBHTMLElement\fP \fBinsertRow\fP (long index)"
.br
.RI "\fIInsert a new empty row in the table. \fP"
.ti -1c
.RI "void \fBdeleteRow\fP (long index)"
.br
.RI "\fIDelete a table row. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBHTMLTableElement\fP (HTMLTableElementImpl *impl)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The create* and delete* methods on the table allow authors to construct and modify tables. 

HTML 4.0 specifies that only one of each of the \fC CAPTION \fP , \fC THEAD \fP , and \fC TFOOT \fP elements may exist in a table. Therefore, if one exists, and the \fBcreateTHead()\fP or \fBcreateTFoot()\fP method is called, the method returns the existing THead or TFoot element. See the \fCTABLE element definition \fP in HTML 4.0. 
.PP
Definition at line 441 of file html_table.h.
.SH "Member Function Documentation"
.PP 
.SS "\fBHTMLTableCaptionElement\fP HTMLTableElement::caption () const"
.PP
Returns the table's \fC CAPTION \fP , or void if none exists. Definition at line 419 of file html_table.cpp.
.SS "void HTMLTableElement::setCaption (const \fBHTMLTableCaptionElement\fP &)"
.PP
see \fBcaption\fP Definition at line 425 of file html_table.cpp.
.PP
References DOM::Node::impl.
.SS "\fBHTMLTableSectionElement\fP HTMLTableElement::tHead () const"
.PP
Returns the table's \fC THEAD \fP , or \fC null \fP if none exists. Definition at line 432 of file html_table.cpp.
.SS "void HTMLTableElement::setTHead (const \fBHTMLTableSectionElement\fP &)"
.PP
see \fBtHead\fP Definition at line 438 of file html_table.cpp.
.PP
References DOM::Node::impl.
.SS "\fBHTMLTableSectionElement\fP HTMLTableElement::tFoot () const"
.PP
Returns the table's \fC TFOOT \fP , or \fC null \fP if none exists. Definition at line 446 of file html_table.cpp.
.SS "void HTMLTableElement::setTFoot (const \fBHTMLTableSectionElement\fP &)"
.PP
see \fBtFoot\fP Definition at line 452 of file html_table.cpp.
.PP
References DOM::Node::impl.
.SS "\fBHTMLCollection\fP HTMLTableElement::rows () const"
.PP
Returns a collection of all the rows in the table, including all in \fC THEAD \fP , \fC TFOOT \fP , all \fC TBODY \fP elements. Definition at line 460 of file html_table.cpp.
.SS "\fBHTMLCollection\fP HTMLTableElement::tBodies () const"
.PP
Returns a collection of the table bodies (including implicit ones). Definition at line 466 of file html_table.cpp.
.SS "\fBDOMString\fP HTMLTableElement::align () const"
.PP
Specifies the table's position with respect to the rest of the document. See the \fCalign attribute definition \fP in HTML 4.0. This attribute is deprecated in HTML 4.0. Definition at line 472 of file html_table.cpp.
.SS "void HTMLTableElement::setAlign (const \fBDOMString\fP &)"
.PP
see \fBalign\fP Definition at line 478 of file html_table.cpp.
.SS "\fBDOMString\fP HTMLTableElement::bgColor () const"
.PP
Cell background color. See the \fCbgcolor attribute definition \fP in HTML 4.0. This attribute is deprecated in HTML 4.0. Definition at line 483 of file html_table.cpp.
.SS "void HTMLTableElement::setBgColor (const \fBDOMString\fP &)"
.PP
see \fBbgColor\fP Definition at line 489 of file html_table.cpp.
.SS "\fBDOMString\fP HTMLTableElement::border () const"
.PP
The width of the border around the table. See the \fCborder attribute definition \fP in HTML 4.0. Definition at line 494 of file html_table.cpp.
.SS "void HTMLTableElement::setBorder (const \fBDOMString\fP &)"
.PP
see \fBborder\fP Definition at line 500 of file html_table.cpp.
.SS "\fBDOMString\fP HTMLTableElement::cellPadding () const"
.PP
Specifies the horizontal and vertical space between cell content and cell borders. See the \fCcellpadding attribute definition \fP in HTML 4.0. Definition at line 505 of file html_table.cpp.
.SS "void HTMLTableElement::setCellPadding (const \fBDOMString\fP &)"
.PP
see \fBcellPadding\fP Definition at line 511 of file html_table.cpp.
.SS "\fBDOMString\fP HTMLTableElement::cellSpacing () const"
.PP
Specifies the horizontal and vertical separation between cells. See the \fCcellspacing attribute definition \fP in HTML 4.0. Definition at line 516 of file html_table.cpp.
.SS "void HTMLTableElement::setCellSpacing (const \fBDOMString\fP &)"
.PP
see \fBcellSpacing\fP Definition at line 522 of file html_table.cpp.
.SS "\fBDOMString\fP HTMLTableElement::frame () const"
.PP
Specifies which external table borders to render. See the \fCframe attribute definition \fP in HTML 4.0. Definition at line 527 of file html_table.cpp.
.SS "void HTMLTableElement::setFrame (const \fBDOMString\fP &)"
.PP
see \fBframe\fP Definition at line 533 of file html_table.cpp.
.SS "\fBDOMString\fP HTMLTableElement::rules () const"
.PP
Specifies which internal table borders to render. See the \fCrules attribute definition \fP in HTML 4.0. Definition at line 538 of file html_table.cpp.
.SS "void HTMLTableElement::setRules (const \fBDOMString\fP &)"
.PP
see \fBrules\fP Definition at line 544 of file html_table.cpp.
.SS "\fBDOMString\fP HTMLTableElement::summary () const"
.PP
Supplementary description about the purpose or structure of a table. See the \fCsummary attribute definition \fP in HTML 4.0. Definition at line 549 of file html_table.cpp.
.SS "void HTMLTableElement::setSummary (const \fBDOMString\fP &)"
.PP
see \fBsummary\fP Definition at line 555 of file html_table.cpp.
.SS "\fBDOMString\fP HTMLTableElement::width () const"
.PP
Specifies the desired table width. See the \fCwidth attribute definition \fP in HTML 4.0. Definition at line 560 of file html_table.cpp.
.SS "void HTMLTableElement::setWidth (const \fBDOMString\fP &)"
.PP
see \fBwidth\fP Definition at line 566 of file html_table.cpp.
.SS "\fBHTMLElement\fP HTMLTableElement::createTHead ()"
.PP
Create a table header row or return an existing one. \fBReturns:\fP
.RS 4
A new table header element ( \fC THEAD \fP ). 
.RE
.PP
Definition at line 571 of file html_table.cpp.
.SS "void HTMLTableElement::deleteTHead ()"
.PP
Delete the header from the table, if one exists. \fBReturns:\fP
.RS 4
.RE
.PP
Definition at line 577 of file html_table.cpp.
.SS "\fBHTMLElement\fP HTMLTableElement::createTFoot ()"
.PP
Create a table footer row or return an existing one. \fBReturns:\fP
.RS 4
A footer element ( \fC TFOOT \fP ). 
.RE
.PP
Definition at line 583 of file html_table.cpp.
.SS "void HTMLTableElement::deleteTFoot ()"
.PP
Delete the footer from the table, if one exists. \fBReturns:\fP
.RS 4
.RE
.PP
Definition at line 589 of file html_table.cpp.
.SS "\fBHTMLElement\fP HTMLTableElement::createCaption ()"
.PP
Create a new table caption object or return an existing one. \fBReturns:\fP
.RS 4
A \fC CAPTION \fP element. 
.RE
.PP
Definition at line 595 of file html_table.cpp.
.SS "void HTMLTableElement::deleteCaption ()"
.PP
Delete the table caption, if one exists. \fBReturns:\fP
.RS 4
.RE
.PP
Definition at line 601 of file html_table.cpp.
.SS "\fBHTMLElement\fP HTMLTableElement::insertRow (long index)"
.PP
Insert a new empty row in the table. The new row is inserted immediately before and in the same section as the current indexth row in the table. If index is -1 or equal to the number of rows, the new row is appended. In addition, when the table is empty the row is inserted into a TBODY which is created and inserted into the table. Note. A table row cannot be empty according to HTML 4.0 Recommendation.
.PP
\fBParameters:\fP
.RS 4
\fIindex\fP The row number where to insert a new row. The index starts from 0 and is relative to the logical order (not document order) of all the rows contained inside the table.
.RE
.PP
\fBReturns:\fP
.RS 4
The newly created row. 
.RE
.PP
Definition at line 607 of file html_table.cpp.
.SS "void HTMLTableElement::deleteRow (long index)"
.PP
Delete a table row. \fBParameters:\fP
.RS 4
\fIindex\fP The index of the row to be deleted. This index starts from 0 and is relative to the logical order (not document order) of all the rows contained inside the table. If the index is -1 the last row in the table is deleted.
.RE
.PP
\fBReturns:\fP
.RS 4
.RE
.PP
Definition at line 617 of file html_table.cpp.

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