html::align Class Reference
[Html Document preparation]

Text alignment attribute class. More...

#include <align.hh>

Inheritance diagram for html::align:

html::attrib

List of all members.

Public Member Functions

 align (void)
 Default constructor.
 align (const std::string &clr)
 Default constructor.
 ~align (void)
 Destructor.
alignclone (void) const
 Clone alignment.
bool isDefault (void) const
void putAttr (writer &w) const
 Write the alignment.
void setDefault (void)
 Set default alignment.
void setAlign (const std::string &name)
 Set the aligment.
bool operator== (const align &x) const
 Compare operator.


Detailed Description

Text alignment attribute class.

Text alignment attribute class.

Author:
John Zweizig
Version:
1.1; Last modified March 4, 2008

Constructor & Destructor Documentation

html::align::align ( void   ) 

Default constructor.

Construct an alignment attribute object that specifies a default alignment.

html::align::align ( const std::string &  clr  ) 

Default constructor.

Construct an alignment atrribute object with specified alignment. Valid arguments and error recovery are as listed under setAlign().

Parameters:
clr Alignment specifier.

html::align::~align ( void   ) 

Destructor.

Destroy an alignment object.


Member Function Documentation

align* html::align::clone ( void   )  const [virtual]

Clone alignment.

Make an identical copy of the alignment object.

Returns:
Pointer to the cloned alignment object.

Implements html::attrib.

bool html::align::isDefault ( void   )  const [virtual]

Test whether the alignment is the default value.

Returns:
true if default alignment.

Reimplemented from html::attrib.

void html::align::putAttr ( writer w  )  const [virtual]

Write the alignment.

Write the alignment attribute to the specified html writer.

Parameters:
w Html writer reference.

Reimplemented from html::attrib.

void html::align::setDefault ( void   ) 

Set default alignment.

Set the alignment to the default.

void html::align::setAlign ( const std::string &  name  ) 

Set the aligment.

Set the alignment to the specified value. Valid alignment strings are "center", "right", "left" and "default". If an invalid alignment string is specified, setAlign() prints an error message to cerr and sets the alignment to "default".

Parameters:
name Alignment value string.

bool html::align::operator== ( const align x  )  const

Compare operator.

Test whether this alignnment is equal to the specified.

Parameters:
x Alignment object to be compared
Returns:
True if this alignment is equal to the argument.


The documentation for this class was generated from the following file:
Generated on Sun Mar 8 19:21:25 2009 for dmt by  doxygen 1.5.4