class HTMLDocument

# class HTMLDocument | An `HTMLDocument` is the root of the HTML hierarchy and holds the entire content. More...
Full name | `DOM::HTMLDocument`
Definition | `#include <html_document.h>`
Inherits | DOM::Document [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- HTMLDocument ()
- HTMLDocument (KHTMLView *parent)
- HTMLDocument (const HTMLDocument &other)
- HTMLDocument (const Node &other)
- HTMLDocument & operator = (const HTMLDocument &other)
- HTMLDocument & operator = (const Node &other)
- ~HTMLDocument ()
- DOMString title () const
- void setTitle ( const DOMString & )
- DOMString referrer () const
- DOMString domain () const
- DOMString URL () const
- HTMLElement body () const
- void setBody (const HTMLElement &)
- HTMLCollection images () const
- HTMLCollection applets () const
- HTMLCollection links () const
- HTMLCollection forms () const
- HTMLCollection anchors () const
- DOMString cookie () const
- void setCookie ( const DOMString & )
- void open ( )
- void close ( )
- void write ( const DOMString &text )
- void writeln ( const DOMString &text )
- NodeList getElementsByName ( const DOMString &elementName )
- DOMString completeURL ( const DOMString& url) const
- DOMString lastModified () const
- HTMLCollection all () const

#### Protected Methods

- HTMLDocument (HTMLDocumentImpl *impl)

## Detailed Description

An `HTMLDocument` 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:

alinkColor

background

bgColor

fgColor

linkColor

vlinkColor

HTMLDocument () | ### HTMLDocument

HTMLDocument (KHTMLView *parent) | ### HTMLDocument

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

HTMLDocument (const HTMLDocument &other) | ### HTMLDocument

HTMLDocument (const Node &other) | ### HTMLDocument

HTMLDocument (HTMLDocumentImpl *impl) | ### HTMLDocument

[protected]

HTMLDocument & operator = (const HTMLDocument &other) | ### operator =

Reimplemented from Document.

HTMLDocument & operator = (const Node &other) | ### operator =

Reimplemented from Document.

~HTMLDocument () | ### ~HTMLDocument

DOMString title () | ### title

[const]

The title of a document as specified by the `TITLE` element in the head of the document.

void setTitle ( const DOMString & ) | ### setTitle

see title

DOMString referrer () | ### 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 () | ### 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 () | ### URL

[const]

The absolute URI of the document.

HTMLElement body () | ### body

[const]

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

void setBody (const HTMLElement &) | ### setBody

see body

HTMLCollection images () | ### images

[const]

A collection of all the `IMG` elements in a document. The behavior is limited to `IMG` elements for backwards compatibility.

HTMLCollection applets () | ### applets

[const]

A collection of all the `OBJECT` elements that include applets and `APPLET` ( deprecated ) elements in a document.

HTMLCollection links () | ### links

[const]

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

HTMLCollection forms () | ### forms

[const]

A collection of all the forms of a document.

HTMLCollection anchors () | ### anchors

[const]

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

DOMString cookie () | ### 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, `name=value;expires=date` .

void setCookie ( const DOMString & ) | ### setCookie

see cookie

void open ( ) | ### 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 ( ) | ### close

Closes a document stream opened by `open()` and forces rendering.

void write ( const DOMString &text ) | ### write

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

Parameters:

text | The string to be parsed into some structure in the document structure model.

void writeln ( const DOMString &text ) | ### writeln

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

Parameters:

text | The string to be parsed into some structure in the document structure model.

NodeList getElementsByName ( const DOMString &elementName ) | ### getElementsByName

Returns the (possibly empty) collection of elements whose `name` value is given by `elementName` .

Parameters:

elementName | The `name` attribute value for an element.

Returns: The matching elements.

DOMString completeURL ( const DOMString& url) | ### completeURL

[const]

not part of the DOM

converts the given (potentially relative) URL in a full-qualified one, using the baseURL / document URL for the missing parts.

Reimplemented from Document.

DOMString lastModified () | ### lastModified

[const]

Not part of the DOM

The date the document was last modified.

HTMLCollection all () | ### all

[const]

Not part of the DOM

A collection of all the `IMG`, `OBJECT`, `AREA`, `A`, forms and anchor elements of a document.

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:37:43 2003, using kdoc 2.0a54.