Nebula
Loading...
Searching...
No Matches
Http::HtmlPageWriter Class Reference

#include <htmlpagewriter.h>

Detailed Description

A stream writer which supports writing a HTML-formatted page into a stream.

Copyright
(C) 2007 Radon Labs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file

Inherits IO::StreamWriter.

Public Member Functions

 HtmlPageWriter ()
 constructor
virtual ~HtmlPageWriter ()
 destructor
void SetTitle (const Util::String &title)
 set the title of the page
void SetStyle (const Util::String &style)
 set the styling of the page
virtual bool Open ()
 begin writing the stream
virtual void Close ()
 end writing the stream
void AddAttr (const Util::String &name, const Util::String &value)
 add an attribute for the next element
void Begin (HtmlElement::Code e)
 begin a generic element
void End (HtmlElement::Code e)
 end a generic element
void Element (HtmlElement::Code e, const Util::String &text)
 shortcut for Begin()/Text()/End()
void LineBreak ()
 write a line break
void HorizontalRule ()
 write a horizontal rule
void Text (const Util::String &t)
 add inline text
void Raw (const Util::String &r)
 add inline raw HTML
void TableRow2 (const Util::String &col0, const Util::String &col1)
 write a 2-element table row
Public Member Functions inherited from IO::StreamWriter
 StreamWriter ()
 constructor
virtual ~StreamWriter ()
 destructor
void SetStream (const Ptr< Stream > &s)
 set stream to write to
const Ptr< Stream > & GetStream () const
 get currently set stream
bool HasStream () const
 return true if a stream is set
bool IsOpen () const
 return true if currently open
Public Member Functions inherited from Core::RefCounted
 RefCounted ()
 constructor
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::String & GetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Private Member Functions

 __DeclareClass (HtmlPageWriter)

Private Attributes

Util::String title
Util::String style
Ptr< IO::XmlWriter > xmlWriter
Util::Array< Util::KeyValuePair< Util::String, Util::String > > attrs
Util::Stack< HtmlElement::Code > elementStack

Additional Inherited Members

Static Public Member Functions inherited from Core::RefCounted
static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
Protected Member Functions inherited from Core::RefCounted
virtual ~RefCounted ()
 destructor (called when refcount reaches zero)
Protected Attributes inherited from IO::StreamWriter
Ptr< Stream > stream
bool isOpen
bool streamWasOpen

Constructor & Destructor Documentation

◆ HtmlPageWriter()

Http::HtmlPageWriter::HtmlPageWriter ( )

constructor

◆ ~HtmlPageWriter()

Http::HtmlPageWriter::~HtmlPageWriter ( )
virtual

destructor

Member Function Documentation

◆ __DeclareClass()

Http::HtmlPageWriter::__DeclareClass ( HtmlPageWriter )
private

◆ AddAttr()

void Http::HtmlPageWriter::AddAttr ( const Util::String & name,
const Util::String & value )

add an attribute for the next element

Adds an attribute for the next HTML element.

Any number of attributes can be defined before calling Begin(). The attribute stack will be cleared as Begin() returns.

◆ Begin()

void Http::HtmlPageWriter::Begin ( HtmlElement::Code element)

begin a generic element

Begin a generic HTML element.

Elements can be nested.

◆ Close()

void Http::HtmlPageWriter::Close ( )
virtual

end writing the stream

Reimplemented from IO::StreamWriter.

◆ Element()

void Http::HtmlPageWriter::Element ( HtmlElement::Code e,
const Util::String & text )

shortcut for Begin()/Text()/End()

◆ End()

void Http::HtmlPageWriter::End ( HtmlElement::Code element)

end a generic element

End a generic HTML element.

The element must match the last Begin() call!

◆ HorizontalRule()

void Http::HtmlPageWriter::HorizontalRule ( )

write a horizontal rule

◆ LineBreak()

void Http::HtmlPageWriter::LineBreak ( )

write a line break

◆ Open()

bool Http::HtmlPageWriter::Open ( )
virtual

begin writing the stream

Reimplemented from IO::StreamWriter.

◆ Raw()

void Http::HtmlPageWriter::Raw ( const Util::String & r)

add inline raw HTML

◆ SetStyle()

void Http::HtmlPageWriter::SetStyle ( const Util::String & style)
inline

set the styling of the page

◆ SetTitle()

void Http::HtmlPageWriter::SetTitle ( const Util::String & title)
inline

set the title of the page

◆ TableRow2()

void Http::HtmlPageWriter::TableRow2 ( const Util::String & col0,
const Util::String & col1 )

write a 2-element table row

◆ Text()

void Http::HtmlPageWriter::Text ( const Util::String & t)

add inline text

Member Data Documentation

◆ attrs

Util::Array<Util::KeyValuePair<Util::String,Util::String> > Http::HtmlPageWriter::attrs
private

◆ elementStack

Util::Stack<HtmlElement::Code> Http::HtmlPageWriter::elementStack
private

◆ style

Util::String Http::HtmlPageWriter::style
private

◆ title

Util::String Http::HtmlPageWriter::title
private

◆ xmlWriter

Ptr<IO::XmlWriter> Http::HtmlPageWriter::xmlWriter
private
The documentation for this class was generated from the following files: