• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KHTML

DOM::HTMLCollection

DOM::HTMLCollection Class Reference

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

#include <html_misc.h>

Inheritance diagram for DOM::HTMLCollection:
DOM::HTMLFormCollection

List of all members.

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)
 HTMLCollection (HTMLCollectionImpl *impl)

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 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 119 of file html_misc.cpp.

HTMLCollection::HTMLCollection ( HTMLCollectionImpl *  impl  )  [protected]

Definition at line 114 of file html_misc.cpp.

HTMLCollection::HTMLCollection ( NodeImpl *  base,
int  type 
) [protected]

Definition at line 125 of file html_misc.cpp.

HTMLCollection::~HTMLCollection (  ) 

Definition at line 141 of file html_misc.cpp.


Member Function Documentation

Node HTMLCollection::base (  )  const

For internal use only.

not part of the DOM

Definition at line 164 of file html_misc.cpp.

Node HTMLCollection::firstItem (  )  const

Definition at line 172 of file html_misc.cpp.

HTMLCollectionImpl * HTMLCollection::handle (  )  const

Definition at line 193 of file html_misc.cpp.

bool HTMLCollection::isNull (  )  const

Definition at line 198 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:
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 of null is returned if the index is out of range.

Definition at line 152 of file html_misc.cpp.

unsigned long HTMLCollection::length (  )  const

This attribute specifies the length or size of the list.

Definition at line 146 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:
name The 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 158 of file html_misc.cpp.

Node HTMLCollection::nextItem (  )  const

Definition at line 179 of file html_misc.cpp.

Node HTMLCollection::nextNamedItem ( const DOMString &  name  )  const

Definition at line 186 of file html_misc.cpp.

HTMLCollection & HTMLCollection::operator= ( const HTMLCollection &  other  ) 

Definition at line 131 of file html_misc.cpp.


Member Data Documentation

HTMLCollectionImpl* DOM::HTMLCollection::impl [protected]

Definition at line 202 of file html_misc.h.


The documentation for this class was generated from the following files:
  • html_misc.h
  • html_misc.cpp

KHTML

Skip menu "KHTML"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal