html::document Class Reference
[Html Document preparation]

#include <document.hh>

Inheritance diagram for html::document:

List of all members.

Public Member Functions
	document (void)
	document (const document &x)
	document (const char *title)
	~document (void)
document *	clone (void) const
const char *	getTag (void) const
void	write (writer &out) const
void	setBackgroundColor (const color &color)
void	setRefresh (double t)
void	setStyle (const std::string &name, const StyleClass &c)

---

Detailed Description

The HTML document class defines the top level of an HTML document. A document is a compound HTML object, and includes in addition to the usual list of contained objects and attributes, a style directory and a few meta-data values (e.g. the title, refresh rate, etc.). brief HTML document class.

Author:

J. Zweizig

Version:

1.0; Modified January 11, 2001

---

Constructor & Destructor Documentation

html::document::document

(

void

)

Construct an empty document. brief Default constructor.

html::document::document

(

const document &

x

)

Make a copy of a document object. brief copy constructor.

Parameters:

x

HTML document to be copied.

html::document::document

(

const char *

title

)

Construct an empty document. Preset the title. brief Titled document constructor.

Parameters:

title

Document title string.

html::document::~document

(

void

)

Destroy a document. brief HTML document destructor.

---

Member Function Documentation

document* html::document::clone

(

void

)

const [virtual]

Copy a document into new storage and return the resulting pointer. brief clone a document.

Returns:

Pointer to the clone of this object.

Reimplemented from html::compound.

const char* html::document::getTag

(

void

)

const [virtual]

Get the tag name to be used. In this case it is document.

Reimplemented from html::compound.

void html::document::write

(

writer &

out

)

const [virtual]

Write out the document.

Reimplemented from html::compound.

void html::document::setBackgroundColor

(

const color &

color

)

Set the document background color.

void html::document::setRefresh

(

double

t

)

Set the document refresh time. A refresh time of zero indicates that the document is not to be refreshed. brief specify a refresh period.

void html::document::setStyle	(	const std::string &	name,
		const StyleClass &	c
	)

Add a new class to the style dictionary. brief Add a new styl class.

Parameters:

	name	Name of the new style class.
	c	Style class definition.

---

The documentation for this class was generated from the following file:

• html/document.hh

---