#include <html_misc.h>
Inherited by DOM::HTMLFormCollection, and DOM::HTMLMappedNameCollection.
Public Member Functions | |
HTMLCollection (const HTMLCollection &other) | |
HTMLCollection & | operator= (const HTMLCollection &other) |
unsigned long | length () const |
Node | item (unsigned long index) const |
Node | namedItem (const DOMString &name) const |
Node | base () const |
HTMLCollectionImpl * | handle () const |
bool | isNull () const |
Node | firstItem () const |
Node | nextItem () const |
Node | nextNamedItem (const DOMString &name) const |
Protected Member Functions | |
HTMLCollection (NodeImpl *base, int type) | |
Protected Attributes | |
HTMLCollectionImpl * | impl |
Friends | |
class | HTMLDocument |
class | HTMLSelectElement |
class | HTMLImageElement |
class | HTMLMapElement |
class | HTMLTableElement |
class | HTMLTableRowElement |
class | HTMLTableSectionElement |
class | HTMLLayerElement |
class | HTMLElement |
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 126 of file html_misc.h.
Constructor & Destructor Documentation
◆ HTMLCollection() [1/3]
HTMLCollection::HTMLCollection | ( | ) |
Definition at line 109 of file html_misc.cpp.
◆ HTMLCollection() [2/3]
HTMLCollection::HTMLCollection | ( | const HTMLCollection & | other | ) |
Definition at line 114 of file html_misc.cpp.
◆ HTMLCollection() [3/3]
|
protected |
Definition at line 120 of file html_misc.cpp.
◆ ~HTMLCollection()
HTMLCollection::~HTMLCollection | ( | ) |
Definition at line 136 of file html_misc.cpp.
Member Function Documentation
◆ base()
Node HTMLCollection::base | ( | ) | const |
Definition at line 159 of file html_misc.cpp.
◆ firstItem()
Node HTMLCollection::firstItem | ( | ) | const |
Definition at line 167 of file html_misc.cpp.
◆ handle()
HTMLCollectionImpl * HTMLCollection::handle | ( | ) | const |
Definition at line 188 of file html_misc.cpp.
◆ isNull()
bool HTMLCollection::isNull | ( | ) | const |
Definition at line 193 of file html_misc.cpp.
◆ item()
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
-
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.
◆ length()
unsigned long HTMLCollection::length | ( | ) | const |
This attribute specifies the length or size of the list.
Definition at line 141 of file html_misc.cpp.
◆ namedItem()
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.
◆ nextItem()
Node HTMLCollection::nextItem | ( | ) | const |
Definition at line 174 of file html_misc.cpp.
◆ nextNamedItem()
Definition at line 181 of file html_misc.cpp.
◆ operator=()
HTMLCollection & HTMLCollection::operator= | ( | const HTMLCollection & | other | ) |
Definition at line 126 of file html_misc.cpp.
Friends And Related Function Documentation
◆ HTMLDocument
|
friend |
Definition at line 128 of file html_misc.h.
◆ HTMLElement
|
friend |
Definition at line 136 of file html_misc.h.
◆ HTMLImageElement
|
friend |
Definition at line 130 of file html_misc.h.
◆ HTMLLayerElement
|
friend |
Definition at line 135 of file html_misc.h.
◆ HTMLMapElement
|
friend |
Definition at line 131 of file html_misc.h.
◆ HTMLSelectElement
|
friend |
Definition at line 129 of file html_misc.h.
◆ HTMLTableElement
|
friend |
Definition at line 132 of file html_misc.h.
◆ HTMLTableRowElement
|
friend |
Definition at line 133 of file html_misc.h.
◆ HTMLTableSectionElement
|
friend |
Definition at line 134 of file html_misc.h.
Member Data Documentation
◆ impl
|
protected |
Definition at line 201 of file html_misc.h.
The documentation for this class was generated from the following files: