cgicc::HTMLBooleanElement< Tag > Class Template Reference

Template for concrete boolean HTMLElement subclasses. More...

#include <cgicc/HTMLBooleanElement.h>

Inheritance diagram for cgicc::HTMLBooleanElement< Tag >:

Public Member Functions
Constructors and Destructor
	HTMLBooleanElement ()
	Create a new empty boolean element. More...
	HTMLBooleanElement (const std::string &text)
	Create a new element, specifying the enclosed text. More...
	HTMLBooleanElement (const HTMLAttributeList &attributes)
	Create a new element, specifying the HTMLAttribute objects. More...
	HTMLBooleanElement (const HTMLElement &embedded)
	Create a new element, specifying an embedded HTMLElement. More...
	HTMLBooleanElement (const std::string &text, const HTMLAttributeList &attributes)
	Create a new element, specifying the enclosed text and HTMLAttribute objects. More...
	HTMLBooleanElement (const HTMLAttributeList &attributes, const HTMLElement &embed)
	Create a new element, specifying the HTMLAttributes and embedded HTMLElement. More...
virtual	~HTMLBooleanElement ()
	Destructor. More...
virtual HTMLElement *	clone () const
	Clone this element. More...
virtual const char *	getName () const
	Get the name of this element. For example, "strong". More...
Public Member Functions inherited from cgicc::HTMLElement
	HTMLElement (const HTMLElement &element)
	Copy constructor. More...
virtual	~HTMLElement ()
	Destructor. More...
bool	operator== (const HTMLElement &element) const
	Compare two HTMLElements for equality. More...
bool	operator!= (const HTMLElement &element) const
	Compare two HTMLElements for inequality. More...
HTMLElement &	operator= (const HTMLElement &element)
	Assignment operator. More...
std::string	getData () const
	Get the data contained in this element, if any. More...
EElementType	getType () const
	Get the type of this element. More...
void	setData (const std::string &data)
	Set the data contained in this element. More...
const HTMLElementList *	getEmbedded () const
	Get the HTMLElementList embedded in this element, if any. More...
void	setEmbedded (const HTMLElementList &embedded)
	Set the HTMLElementList associated with this element. More...
HTMLElement &	add (const HTMLElement &element)
	Add an embedded HTMLElement in this one. More...
HTMLElement &	add (HTMLElement *element)
	Add an embedded HTMLElement in this one. More...
const HTMLAttributeList *	getAttributes () const
	Get the attributes associated with this element. More...
void	setAttributes (const HTMLAttributeList &attributes)
	Set the attributes associated with this element. More...
HTMLElement &	set (const std::string &name)
	Set an HTMLAttribute on this HTMLElement. More...
HTMLElement &	set (const std::string &name, const std::string &value)
	Set an HTMLAttribute on this HTMLElement. More...
virtual void	render (std::ostream &out) const
	Render this HTMLElement to an ostream. More...
Public Member Functions inherited from cgicc::MStreamable
	MStreamable ()
	Empty constructor. More...
virtual	~MStreamable ()
	Empty destructor. More...

State Management
virtual void	swapState () const
	Swap the state of this boolean element. More...
virtual bool	getState () const
	Get the state of this boolean element. More...
static void	reset ()
	Reset the state of this boolean element to closed. More...

Additional Inherited Members
Public Types inherited from cgicc::HTMLElement
enum	EElementType { eAtomic, eBoolean }
	Possible types of HTMLElements. More...
Protected Member Functions inherited from cgicc::HTMLElement
	HTMLElement (const HTMLAttributeList *attributes, const HTMLElement *embedded, const std::string *data, EElementType type)
	Subclass constructor. More...
bool	dataSpecified () const
	For subclasses only. More...

Detailed Description

template<class Tag>
class cgicc::HTMLBooleanElement< Tag >

Template for concrete boolean HTMLElement subclasses.

A boolean HTML element is an element having a boolean (open or closed) state. Most commonly used HTML tags are boolean elements:

<a href="http://www.gnu.org">GNU Project</a>

The a element is boolean, since it is either open or closed. Boolean elements are often additive:

<b>bold text<i>bold italic text</i></b>

Note than under the XHTML 1.0 standard, elements may not overlap; ie, in the example above, it would be illegal to close the b tag before the i tag.

See also

HTMLElement

HTMLAtomicElement

Definition at line 62 of file HTMLBooleanElement.h.

Constructor & Destructor Documentation

HTMLBooleanElement() [1/6]

template<class Tag >

cgicc::HTMLBooleanElement< Tag >::HTMLBooleanElement ( )

inline

Create a new empty boolean element.

Definition at line 75 of file HTMLBooleanElement.h.

HTMLBooleanElement() [2/6]

template<class Tag >

cgicc::HTMLBooleanElement< Tag >::HTMLBooleanElement ( const std::string &  text )

inline

Create a new element, specifying the enclosed text.

Parameters

text	The text within the element.

Definition at line 83 of file HTMLBooleanElement.h.

HTMLBooleanElement() [3/6]

template<class Tag >

cgicc::HTMLBooleanElement< Tag >::HTMLBooleanElement ( const HTMLAttributeList &  attributes )

inline

Create a new element, specifying the HTMLAttribute objects.

Parameters

attributes

The HTMLAttributes contained within the element.

Definition at line 91 of file HTMLBooleanElement.h.

HTMLBooleanElement() [4/6]

template<class Tag >

cgicc::HTMLBooleanElement< Tag >::HTMLBooleanElement ( const HTMLElement &  embedded )

inline

Create a new element, specifying an embedded HTMLElement.

Parameters

embedded

The HTMLElement embedded inside the element.

Definition at line 99 of file HTMLBooleanElement.h.

HTMLBooleanElement() [5/6]

template<class Tag >

cgicc::HTMLBooleanElement< Tag >::HTMLBooleanElement ( const std::string &  text, const HTMLAttributeList &  attributes  )

inline

Create a new element, specifying the enclosed text and HTMLAttribute objects.

Parameters

attributes	The HTMLAttributes contained within the element.
text	The text within the element.

Definition at line 109 of file HTMLBooleanElement.h.

HTMLBooleanElement() [6/6]

template<class Tag >

cgicc::HTMLBooleanElement< Tag >::HTMLBooleanElement ( const HTMLAttributeList &  attributes, const HTMLElement &  embed  )

inline

Create a new element, specifying the HTMLAttributes and embedded HTMLElement.

Parameters

attributes	The HTMLAttributes contained within the element.
embed	The HTMLElement embedded inside the element.

Definition at line 120 of file HTMLBooleanElement.h.

~HTMLBooleanElement()

template<class Tag >

virtual cgicc::HTMLBooleanElement< Tag >::~HTMLBooleanElement ( )

inlinevirtual

Destructor.

Definition at line 129 of file HTMLBooleanElement.h.

Member Function Documentation

clone()

template<class Tag >

virtual HTMLElement* cgicc::HTMLBooleanElement< Tag >::clone ( ) const

inlinevirtual

Clone this element.

Returns

A newly-allocated copy of this element

Implements cgicc::HTMLElement.

Definition at line 140 of file HTMLBooleanElement.h.

getName()

template<class Tag >

virtual const char* cgicc::HTMLBooleanElement< Tag >::getName ( ) const

inlinevirtual

Get the name of this element. For example, "strong".

Returns

The name of this element

Implements cgicc::HTMLElement.

Definition at line 150 of file HTMLBooleanElement.h.

getState()

template<class Tag >

virtual bool cgicc::HTMLBooleanElement< Tag >::getState ( ) const

inlinevirtual

Get the state of this boolean element.

Returns

true if this element is open, false otherwise

Reimplemented from cgicc::HTMLElement.

Definition at line 172 of file HTMLBooleanElement.h.

reset()

template<class Tag >

static void cgicc::HTMLBooleanElement< Tag >::reset ( )

inlinestatic

Reset the state of this boolean element to closed.

Definition at line 180 of file HTMLBooleanElement.h.

swapState()

template<class Tag >

virtual void cgicc::HTMLBooleanElement< Tag >::swapState ( ) const

inlinevirtual

Swap the state of this boolean element.

A state of true indicates the element is currently open

Reimplemented from cgicc::HTMLElement.

Definition at line 164 of file HTMLBooleanElement.h.

---

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

• HTMLBooleanElement.h