class document : public compound

HTML document class.

Inheritance:


Public Methods

document(void)
Default constructor.
document(const document& x)
copy constructor.
document(const char* title)
Titled document constructor.
~document(void)
HTML document destructor.
object* clone(void) const
clone a document.
const char* getTag(void) const
Get the tag name to be used
void write(writer& out) const
Write out the document
void setBackgroundColor(const color& color)
Set the document background color
void setRefresh(double t)
specify a refresh period.
void setStyle(const std::string& name, const StyleClass& c)
Add a new styl class.

Inherited from compound:

Public Methods

object& addObject(const object& thing)
object& back(void)
const object& back(void) const
object& front(void)
const object& front(void) const
object& lineBreak(void)
void clear(void)
void remObject(const object* thing)
void addAttr(const std::string& name, const attrib& a)
void clearAttr(void)
void repAttr(const std::string& name, const attrib& a)
void remAttr(const std::string& name)

Inherited from object:

Public Methods

virtual dim_t getXSize(void) const
virtual dim_t getYSize(void) const

Documentation

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 ( the title, refresh rate, etc.).
document(void)
Construct an empty document.

document(const document& x)
Make a cpoy of a document object.
Parameters:
x - HTML document to be copied.

document(const char* title)
Construct an empty document. Preset the title.
Parameters:
title - Document title string.

~document(void)
HTML document destructor.

object* clone(void) const
Copy a document into new storage and return the resulting pointer.
Returns:
Pointer to the clone of this object.

const char* getTag(void) const
Get the tag name to be used. In this case it is document.

void write(writer& out) const
Write out the document

void setBackgroundColor(const color& color)
Set the document background color

void setRefresh(double t)
Set the document refresh time. A refresh time of zero indicates that the document is not to be refreshed.

void setStyle(const std::string& name, const StyleClass& c)
Add a new class to the style dictionary.
Parameters:
name - Name of the new style class.
c - Style class definition.


This class has no child classes.
Author:
J. Zweizig
Version:
1.0; Modified January 11, 2001

alphabetic index hierarchy of classes


generated by doc++