namespace html class compound : public object

Compound object container.

Inheritance:


Public Methods

compound(void)
Null constructor.
compound(const compound& x)
Copy constructor.
virtual ~compound(void)
Compound destructor.
virtual void write(writer& out) const
Write the compound.
virtual object* clone(void) const
clone the compound object
virtual const char* getTag(void) const
Get the compound tag name.
object& addObject(const object& thing)
Add the specified object to the compound.
object& back(void)
Get back object reference.
const object& back(void) const
Get back object reference.
object& front(void)
Get front object reference.
const object& front(void) const
Get front object reference.
object& lineBreak(void)
Add a line-break marker
void clear(void)
clear the compound.
void remObject(const object* thing)
remove a constituent object from a compound.
void addAttr(const std::string& name, const attrib& a)
Add an attribute.
void clearAttr(void)
clear the compound.
void repAttr(const std::string& name, const attrib& a)
Replace an attribute.
void remAttr(const std::string& name)
remove the named attribute

Inherited from object:

Public Methods

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

Documentation

Compound objects are HTML object containing one of more simple or compound sub-objects. In addition to a list of constituent objects, the compound object contains an attribute list that is valid through the scope of the compound.
compound(void)
Construct an empty compound.

compound(const compound& x)
Construct a compound that is identical to the argument. All constituents of the argument are cloned and added into the new compound.
Parameters:
x - compound to be copied.

virtual ~compound(void)
Destroy the compound object and all its constituent objects.

virtual void write(writer& out) const
Set the compound scope attributes and Write out all the consituent objects.
Parameters:
HTML - writer to receive the compound and its constituents.

virtual object* clone(void) const
A new compound object is created from clones of all attributes and constituent objects found in the original.
Returns:
pointer to the clone.

virtual const char* getTag(void) const
Get the tag name to be used to describe this compound object.
Returns:
Pointer to a character string containing the tag name.

object& addObject(const object& thing)
The argument object is cloned and the clone is added to the end of the compound object list. A reference to the cloned object is returned.
Returns:
Reference to the cloned object in the compound.
Parameters:
thing - Object to be added to the compound.

object& back(void)
Get a reference to the last object in the compound object list.

const object& back(void) const
Get a constant reference to the last object in the compound object list.

object& front(void)
Get a reference to the first object in the compound object list.

const object& front(void) const
Get a constant reference to the first object in the compound object list.

object& lineBreak(void)
Add a line-break marker

void clear(void)
Remove all objects from the constituent list.

void remObject(const object* thing)
The specified object us removed from the constitent list and deleted.
Parameters:
thing - Pointer to the object to be removed.

void addAttr(const std::string& name, const attrib& a)
A clone of the specified attribute is added to the compound scope attribute list with the given name.
Parameters:
name - Name of attribute to be added.
a - Attribute to be added to the compound scope.

void clearAttr(void)
Remove all attributess from the compound scope.

void repAttr(const std::string& name, const attrib& a)
Replace the named attribute in the compound scope with a clone of the specified attribute.
Parameters:
name - Name of attribute to be replaced.
a - Replacement attribute.

void remAttr(const std::string& name)
remove the named attribute
Parameters:
name - Attribute to be removed from the compound scope.


Direct child classes:
document
cell
block
Author:
John Zweizig
Version:
1.0; Modified January 5, 2001

alphabetic index hierarchy of classes


generated by doc++