class HTMLCollection

An HTMLCollection is a list of nodes. More...

Full nameDOM::HTMLCollection
Definition#include <html_misc.h>
Inherited byHTMLFormCollection
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods

Protected Members


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.

 HTMLCollection ()

HTMLCollection

 HTMLCollection (const HTMLCollection &other)

HTMLCollection

 HTMLCollection (NodeImpl *base, int type)

HTMLCollection

[protected]

HTMLCollection &  operator = (const HTMLCollection &other)

operator =

 ~HTMLCollection ()

~HTMLCollection

unsigned long  length ()

length

[const]

This attribute specifies the length or size of the list.

Node  item ( unsigned long index )

item

[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.

Node  namedItem ( const DOMString &name )

namedItem

[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 .

Node  base ()

base

[const]

not part of the DOM

HTMLCollectionImpl * handle ()

handle

[const]

bool  isNull ()

isNull

[const]

HTMLCollectionImpl * impl

impl

[protected]


Generated by: dfaure on kde.faure.org on Thu Jan 17 22:18:15 2002, using kdoc 2.0a53.