Public Member Functions
cgicc::HTMLBooleanElement< Tag > Class Template Reference

Template for concrete boolean HTMLElement subclasses. More...

#include <cgicc/HTMLBooleanElement.h>

Inheritance diagram for cgicc::HTMLBooleanElement< Tag >:
cgicc::HTMLElement cgicc::MStreamable

List of all members.

Public Member Functions

virtual HTMLElementclone () const
 Clone this element.
virtual const char * getName () const
 Get the name of this element. For example, "strong".
Constructors and Destructor
 HTMLBooleanElement ()
 Create a new empty boolean element.
 HTMLBooleanElement (const std::string &text)
 Create a new element, specifying the enclosed text.
 HTMLBooleanElement (const HTMLAttributeList &attributes)
 Create a new element, specifying the HTMLAttribute objects.
 HTMLBooleanElement (const HTMLElement &embedded)
 Create a new element, specifying an embedded HTMLElement.
 HTMLBooleanElement (const std::string &text, const HTMLAttributeList &attributes)
 Create a new element, specifying the enclosed text and HTMLAttribute objects.
 HTMLBooleanElement (const HTMLAttributeList &attributes, const HTMLElement &embed)
 Create a new element, specifying the HTMLAttributes and embedded HTMLElement.
virtual ~HTMLBooleanElement ()
 Destructor.

State Management

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

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

template<class Tag>
cgicc::HTMLBooleanElement< Tag >::HTMLBooleanElement ( const std::string &  text) [inline]

Create a new element, specifying the enclosed text.

Parameters:
textThe text within the element.

Definition at line 83 of file HTMLBooleanElement.h.

template<class Tag>
cgicc::HTMLBooleanElement< Tag >::HTMLBooleanElement ( const HTMLAttributeList attributes) [inline]

Create a new element, specifying the HTMLAttribute objects.

Parameters:
attributesThe HTMLAttributes contained within the element.

Definition at line 91 of file HTMLBooleanElement.h.

template<class Tag>
cgicc::HTMLBooleanElement< Tag >::HTMLBooleanElement ( const HTMLElement embedded) [inline]

Create a new element, specifying an embedded HTMLElement.

Parameters:
embeddedThe HTMLElement embedded inside the element.

Definition at line 99 of file HTMLBooleanElement.h.

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:
attributesThe HTMLAttributes contained within the element.
textThe text within the element.

Definition at line 109 of file HTMLBooleanElement.h.

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:
attributesThe HTMLAttributes contained within the element.
embedThe HTMLElement embedded inside the element.

Definition at line 120 of file HTMLBooleanElement.h.


Member Function Documentation

template<class Tag>
virtual HTMLElement* cgicc::HTMLBooleanElement< Tag >::clone ( ) const [inline, virtual]

Clone this element.

Returns:
A newly-allocated copy of this element

Implements cgicc::HTMLElement.

Definition at line 140 of file HTMLBooleanElement.h.

template<class Tag>
virtual const char* cgicc::HTMLBooleanElement< Tag >::getName ( ) const [inline, virtual]

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.

Referenced by cgicc::HTMLBooleanElement< nullTag >::getName().

template<class Tag>
virtual bool cgicc::HTMLBooleanElement< Tag >::getState ( ) const [inline, virtual]

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.

template<class Tag>
virtual void cgicc::HTMLBooleanElement< Tag >::swapState ( ) const [inline, virtual]

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:

GNU cgicc - A C++ class library for writing CGI applications
Copyright © 1996 - 2004 Stephen F. Booth
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front Cover Texts, and with no Back-Cover Texts.
Documentation generated Wed Dec 7 2011 03:22:08 for cgicc by doxygen 1.7.5.1