The Nebula Device 3: Http::HtmlPageWriter Class Reference

The Nebula Device 3

Http::HtmlPageWriter Class Reference

#include <htmlpagewriter.h>

Inheritance diagram for Http::HtmlPageWriter:

IO::StreamWriter Core::RefCounted


Detailed Description

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

(C) 2007 Radon Labs GmbH

Public Member Functions

 HtmlPageWriter ()
 constructor
virtual ~HtmlPageWriter ()
 destructor
void SetTitle (const Util::String &title)
 set the title 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 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
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::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Member Function Documentation

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.

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

begin a generic element

Begin a generic HTML element. Elements can be nested.

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

end a generic element

End a generic HTML element. The element must match the last Begin() call!

void IO::StreamWriter::SetStream ( const Ptr< Stream > &  s  )  [inherited]

set stream to write to

Attaches the writer to a stream. This will imcrement the refcount of the stream.

Reimplemented in Messaging::MessageWriter.

const Ptr< Stream > & IO::StreamWriter::GetStream (  )  const [inherited]

get currently set stream

Get pointer to the attached stream. If there is no stream attached, an assertion will be thrown. Use HasStream() to determine if a stream is attached.

bool IO::StreamWriter::HasStream (  )  const [inherited]

return true if a stream is set

Returns true if a stream is attached to the writer.

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.