Template for concrete boolean HTMLElement subclasses. More...
#include <cgicc/HTMLBooleanElement.h>
Public Member Functions | |
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. | |
virtual HTMLElement * | clone () const |
Clone this element. | |
virtual const char * | getName () const |
Get the name of this element. For example, "strong". | |
![]() | |
HTMLElement (const HTMLElement &element) | |
Copy constructor. | |
virtual | ~HTMLElement () |
Destructor. | |
bool | operator== (const HTMLElement &element) const |
Compare two HTMLElements for equality. | |
bool | operator!= (const HTMLElement &element) const |
Compare two HTMLElements for inequality. | |
HTMLElement & | operator= (const HTMLElement &element) |
Assignment operator. | |
std::string | getData () const |
Get the data contained in this element, if any. | |
EElementType | getType () const |
Get the type of this element. | |
void | setData (const std::string &data) |
Set the data contained in this element. | |
const HTMLElementList * | getEmbedded () const |
Get the HTMLElementList embedded in this element, if any. | |
void | setEmbedded (const HTMLElementList &embedded) |
Set the HTMLElementList associated with this element. | |
HTMLElement & | add (const HTMLElement &element) |
Add an embedded HTMLElement in this one. | |
HTMLElement & | add (HTMLElement *element) |
Add an embedded HTMLElement in this one. | |
const HTMLAttributeList * | getAttributes () const |
Get the attributes associated with this element. | |
void | setAttributes (const HTMLAttributeList &attributes) |
Set the attributes associated with this element. | |
HTMLElement & | set (const std::string &name) |
Set an HTMLAttribute on this HTMLElement. | |
HTMLElement & | set (const std::string &name, const std::string &value) |
Set an HTMLAttribute on this HTMLElement. | |
virtual void | render (std::ostream &out) const |
Render this HTMLElement to an ostream. | |
![]() | |
MStreamable () | |
Empty constructor. | |
virtual | ~MStreamable () |
Empty destructor. | |
virtual void | render (std::ostream &out) const =0 |
Write this object to a stream. | |
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. | |
Additional Inherited Members | |
![]() | |
enum | EElementType { eAtomic , eBoolean } |
Possible types of HTMLElements. More... | |
![]() | |
HTMLElement (const HTMLAttributeList *attributes, const HTMLElement *embedded, const std::string *data, EElementType type) | |
Subclass constructor. | |
bool | dataSpecified () const |
For subclasses only. | |
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.
Definition at line 62 of file HTMLBooleanElement.h.
|
inline |
Create a new empty boolean element.
Definition at line 75 of file HTMLBooleanElement.h.
|
inline |
Create a new element, specifying the enclosed text.
text | The text within the element. |
Definition at line 83 of file HTMLBooleanElement.h.
|
inline |
Create a new element, specifying the HTMLAttribute objects.
attributes | The HTMLAttributes contained within the element. |
Definition at line 91 of file HTMLBooleanElement.h.
|
inline |
Create a new element, specifying an embedded HTMLElement.
embedded | The HTMLElement embedded inside the element. |
Definition at line 99 of file HTMLBooleanElement.h.
|
inline |
Create a new element, specifying the enclosed text and HTMLAttribute objects.
attributes | The HTMLAttributes contained within the element. |
text | The text within the element. |
Definition at line 109 of file HTMLBooleanElement.h.
|
inline |
Create a new element, specifying the HTMLAttributes and embedded HTMLElement.
attributes | The HTMLAttributes contained within the element. |
embed | The HTMLElement embedded inside the element. |
Definition at line 120 of file HTMLBooleanElement.h.
|
inlinevirtual |
Destructor.
Definition at line 129 of file HTMLBooleanElement.h.
|
inlinevirtual |
Clone this element.
Implements cgicc::HTMLElement.
Definition at line 140 of file HTMLBooleanElement.h.
|
inlinevirtual |
Get the name of this element. For example, "strong".
Implements cgicc::HTMLElement.
Definition at line 150 of file HTMLBooleanElement.h.
|
inlinevirtual |
Get the state of this boolean element.
true
if this element is open, false
otherwise Reimplemented from cgicc::HTMLElement.
Definition at line 172 of file HTMLBooleanElement.h.
|
inlinestatic |
Reset the state of this boolean element to closed.
Definition at line 180 of file HTMLBooleanElement.h.
|
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.