KHTML
DOM::HTMLCollection Class Reference
AnHTMLCollection
is a list of nodes.
More...
#include <html_misc.h>
Public Member Functions | |
Node | base () const |
Node | firstItem () const |
HTMLCollectionImpl * | handle () const |
HTMLCollection (const HTMLCollection &other) | |
HTMLCollection () | |
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 |
HTMLCollection & | operator= (const HTMLCollection &other) |
~HTMLCollection () | |
Protected Member Functions | |
HTMLCollection (NodeImpl *base, int type) | |
Protected Attributes | |
HTMLCollectionImpl * | impl |
Detailed Description
AnHTMLCollection
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 126 of file html_misc.h.
Constructor & Destructor Documentation
HTMLCollection::HTMLCollection | ( | ) |
Definition at line 109 of file html_misc.cpp.
HTMLCollection::HTMLCollection | ( | const HTMLCollection & | other | ) |
Definition at line 114 of file html_misc.cpp.
HTMLCollection::HTMLCollection | ( | NodeImpl * | base, | |
int | type | |||
) | [protected] |
Definition at line 120 of file html_misc.cpp.
HTMLCollection::~HTMLCollection | ( | ) |
Definition at line 136 of file html_misc.cpp.
Member Function Documentation
Node HTMLCollection::base | ( | ) | const |
Node HTMLCollection::firstItem | ( | ) | const |
Definition at line 167 of file html_misc.cpp.
HTMLCollectionImpl * HTMLCollection::handle | ( | ) | const |
Definition at line 188 of file html_misc.cpp.
bool HTMLCollection::isNull | ( | ) | const |
Definition at line 193 of file html_misc.cpp.
This method retrieves a node specified by ordinal index.
Nodes are numbered in tree order (depth-first traversal order).
- Parameters:
-
index The index of the node to be fetched. The index origin is 0.
- Returns:
- The
Node
at the corresponding position upon success. A value ofnull
is returned if the index is out of range.
Definition at line 147 of file html_misc.cpp.
unsigned long HTMLCollection::length | ( | ) | const |
This attribute specifies the length or size of the list.
Definition at line 141 of file html_misc.cpp.
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:
-
name The name of the Node
to be fetched.
- Returns:
- The
Node
with aname
orid
attribute whose value corresponds to the specified string. Upon failure (e.g., no node with this name exists), returnsnull
.
Definition at line 153 of file html_misc.cpp.
Node HTMLCollection::nextItem | ( | ) | const |
Definition at line 174 of file html_misc.cpp.
Definition at line 181 of file html_misc.cpp.
HTMLCollection & HTMLCollection::operator= | ( | const HTMLCollection & | other | ) |
Definition at line 126 of file html_misc.cpp.
Member Data Documentation
HTMLCollectionImpl* DOM::HTMLCollection::impl [protected] |
Definition at line 201 of file html_misc.h.
The documentation for this class was generated from the following files: