class HTMLDocument

 An <code> HTMLDocument </code> is the root of the HTML hierarchy and holds the entire content. More...
Full nameDOM::HTMLDocument
Definition#include <html_document.h>
InheritsDOM::Document
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods

Detailed Description

An <code> HTMLDocument </code> is the root of the HTML hierarchy and holds the entire content. Beside providing access to the hierarchy, it also provides some convenience methods for accessing certain sets of information from the document.

The following properties have been deprecated in favor of the corresponding ones for the BODY element:

<ulist> <item> alinkColor

</item> <item> background

</item> <item> bgColor

</item> <item> fgColor

</item> <item> linkColor

</item> <item> vlinkColor

</item> </ulist>

 HTMLDocument (KHTMLView *parent)

The parent is the widget the document should render itself in. Rendering information (like sizes, etc...) is only created if parent != 0

DOMString  title ()

[const]

The title of a document as specified by the <code> TITLE </code> element in the head of the document.

void  setTitle ( const DOMString & )

see title

DOMString  referrer ()

[const]

Returns the URI of the page that linked to this page. The value is an empty string if the user navigated to the page directly (not through a link, but, for example, via a bookmark).

DOMString  domain ()

[const]

The domain name of the server that served the document, or a null string if the server cannot be identified by a domain name.

DOMString  URL ()

[const]

The complete URI of the document.

HTMLElement  body ()

[const]

The element that contains the content for the document. In documents with <code> BODY </code> contents, returns the <code> BODY </code> element, and in frameset documents, this returns the outermost <code> FRAMESET </code> element.

void  setBody (const HTMLElement &)

see body

HTMLCollection  images ()

[const]

A collection of all the <code> IMG </code> elements in a document. The behavior is limited to <code> IMG </code> elements for backwards compatibility.

HTMLCollection  applets ()

[const]

A collection of all the <code> OBJECT </code> elements that include applets and <code> APPLET </code> ( deprecated ) elements in a document.

HTMLCollection  links ()

[const]

A collection of all <code> AREA </code> elements and anchor ( <code> A </code> ) elements in a document with a value for the <code> href </code> attribute.

HTMLCollection  forms ()

[const]

A collection of all the forms of a document.

HTMLCollection  anchors ()

[const]

A collection of all the anchor ( <code> A </code> ) elements in a document with a value for the <code> name </code> attribute. Note. For reasons of backwards compatibility, the returned set of anchors only contains those anchors created with the <code> name </code> attribute, not those created with the <code> id </code> attribute.

HTMLCollection  all ()

[const]

A collection of all the <code>IMG</code>, <code>OBJECT</code>, <code>AREA</code>, <code>A</code>, forms and anchor elements of a document.

DOMString  cookie ()

[const]

The cookies associated with this document. If there are none, the value is an empty string. Otherwise, the value is a string: a semicolon-delimited list of "name, value" pairs for all the cookies associated with the page. For example, <code> name=value;expires=date </code> .

void  setCookie ( const DOMString & )

see cookie

void  open ( )

Note. This method and the ones following allow a user to add to or replace the structure model of a document using strings of unparsed HTML. At the time of writing alternate methods for providing similar functionality for both HTML and XML documents were being considered. The following methods may be deprecated at some point in the future in favor of a more general-purpose mechanism.

Open a document stream for writing. If a document exists in the target, this method clears it.

void  close ( )

Closes a document stream opened by <code> open() </code> and forces rendering.

void  write ( const DOMString &text )

Write a string of text to a document stream opened by <code> open() </code> . The text is parsed into the document's structure model.

Parameters:
textThe string to be parsed into some structure in the document structure model.

void  writeln ( const DOMString &text )

Write a string of text followed by a newline character to a document stream opened by <code> open() </code> . The text is parsed into the document's structure model.

Parameters:
textThe string to be parsed into some structure in the document structure model.

Element  getElementById ( const DOMString &elementId )

Returns the Element whose <code> id </code> is given by elementId. If no such element exists, returns <code> null </code> . Behavior is not defined if more than one element has this <code> id </code> .

Parameters:
elementIdThe unique <code> id </code> value for an element.

Returns: The matching element.

NodeList  getElementsByName ( const DOMString &elementName )

Returns the (possibly empty) collection of elements whose <code> name </code> value is given by <code> elementName </code> .

Parameters:
elementNameThe <code> name </code> attribute value for an element.

Returns: The matching elements.

Generated by: ssk@tauon.ph.unimelb.EDU.AU on Wed May 23 05:55:52 2001, using kdoc 2.0a35.