DOM::HTMLCollection

#include <html_misc.h>

Inherited by DOM::HTMLFormCollection.

Public Member Functions

 HTMLCollection (const HTMLCollection &other)
 
Node base () const
 
Node firstItem () const
 
HTMLCollectionImpl * handle () const
 
bool isNull () const
 
Node item (unsigned long index) const
 
unsigned long length () const
 
Node namedItem (const DOMString &name) const
 
Node nextItem () const
 
Node nextNamedItem (const DOMString &name) const
 
HTMLCollectionoperator= (const HTMLCollection &other)
 

Protected Member Functions

 HTMLCollection (HTMLCollectionImpl *impl)
 
 HTMLCollection (NodeImpl *base, int type)
 

Protected Attributes

HTMLCollectionImpl * impl
 

Detailed Description

An HTMLCollection is a list of nodes.

An individual node may be accessed by either ordinal index or the node's name or id attributes. Note: Collections in the HTML DOM are assumed to be live meaning that they are automatically updated when the underlying document is changed.

Definition at line 133 of file html_misc.h.

Member Function Documentation

Node HTMLCollection::base ( ) const

not part of the DOM

Definition at line 195 of file html_misc.cpp.

Node HTMLCollection::item ( unsigned long  index) const

This method retrieves a node specified by ordinal index.

Nodes are numbered in tree order (depth-first traversal order).

Parameters
indexThe index of the node to be fetched. The index origin is 0.
Returns
The Node at the corresponding position upon success. A value of null is returned if the index is out of range.

Definition at line 179 of file html_misc.cpp.

unsigned long HTMLCollection::length ( ) const

This attribute specifies the length or size of the list.

Definition at line 171 of file html_misc.cpp.

Node HTMLCollection::namedItem ( const DOMString name) const

This method retrieves a Node using a name.

It first searches for a Node with a matching id attribute. If it doesn't find one, it then searches for a Node with a matching name attribute, but only on those elements that are allowed a name attribute.

Parameters
nameThe name of the Node to be fetched.
Returns
The Node with a name or id attribute whose value corresponds to the specified string. Upon failure (e.g., no node with this name exists), returns null .

Definition at line 187 of file html_misc.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Sep 24 2020 22:46:48 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.