libosmscout  0.1
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules
osmscout::HTMLWriter Class Reference

#include <HTMLWriter.h>

Public Member Functions

void Close ()
 
void CloseFailsafe ()
 
std::string GetFilename () const
 
bool HasError () const
 
 HTMLWriter ()
 
bool IsOpen () const
 
void Open (const std::string &filename)
 
std::string Sanitize (const std::string &string) const
 
void WriteBodyEnd ()
 
void WriteBodyStart ()
 
void WriteDocumentEnd ()
 
void WriteDocumentStart ()
 
void WriteHeader (const std::string &title, const std::string &description, const std::string &keywords, const std::string &stylesheetLocation)
 
void WriteHeaderEnd ()
 
void WriteHeaderStart (const std::string &title, const std::string &description, const std::string &keywords, const std::string &stylesheetLocation)
 
void WriteLink (const std::string &url, const std::string &title)
 
void WriteListEnd ()
 
void WriteListEntryEnd ()
 
void WriteListEntryStart ()
 
void WriteListStart ()
 
void WriteMeta (const std::string &name, const std::string &content)
 
void WriteOSMObjectLink (const ObjectOSMRef &object, const std::string &name)
 
void WriteText (const std::string &text)
 
virtual ~HTMLWriter ()
 

Detailed Description

HTMLWriter allows easy generation of HTML web pages containing OSM based reports. It not only allows writing simple HTML primitives but also offers higher level methods.

Constructor & Destructor Documentation

◆ HTMLWriter()

osmscout::HTMLWriter::HTMLWriter ( )

◆ ~HTMLWriter()

osmscout::HTMLWriter::~HTMLWriter ( )
virtual

Member Function Documentation

◆ Close()

void osmscout::HTMLWriter::Close ( )
Exceptions
IOException

◆ CloseFailsafe()

void osmscout::HTMLWriter::CloseFailsafe ( )

Referenced by ~HTMLWriter().

◆ GetFilename()

std::string osmscout::HTMLWriter::GetFilename ( ) const
inline

◆ HasError()

bool osmscout::HTMLWriter::HasError ( ) const
inline

◆ IsOpen()

bool osmscout::HTMLWriter::IsOpen ( ) const
inline

◆ Open()

void osmscout::HTMLWriter::Open ( const std::string &  filename)
Exceptions
IOException

◆ Sanitize()

std::string osmscout::HTMLWriter::Sanitize ( const std::string &  string) const

◆ WriteBodyEnd()

void osmscout::HTMLWriter::WriteBodyEnd ( )

◆ WriteBodyStart()

void osmscout::HTMLWriter::WriteBodyStart ( )

◆ WriteDocumentEnd()

void osmscout::HTMLWriter::WriteDocumentEnd ( )

◆ WriteDocumentStart()

void osmscout::HTMLWriter::WriteDocumentStart ( )

◆ WriteHeader()

void osmscout::HTMLWriter::WriteHeader ( const std::string &  title,
const std::string &  description,
const std::string &  keywords,
const std::string &  stylesheetLocation 
)

◆ WriteHeaderEnd()

void osmscout::HTMLWriter::WriteHeaderEnd ( )

Referenced by WriteHeader().

◆ WriteHeaderStart()

void osmscout::HTMLWriter::WriteHeaderStart ( const std::string &  title,
const std::string &  description,
const std::string &  keywords,
const std::string &  stylesheetLocation 
)

References Sanitize(), and WriteMeta().

Referenced by WriteHeader().

◆ WriteLink()

void osmscout::HTMLWriter::WriteLink ( const std::string &  url,
const std::string &  title 
)

References Sanitize().

Referenced by WriteOSMObjectLink().

◆ WriteListEnd()

void osmscout::HTMLWriter::WriteListEnd ( )

◆ WriteListEntryEnd()

void osmscout::HTMLWriter::WriteListEntryEnd ( )

◆ WriteListEntryStart()

void osmscout::HTMLWriter::WriteListEntryStart ( )

◆ WriteListStart()

void osmscout::HTMLWriter::WriteListStart ( )

◆ WriteMeta()

void osmscout::HTMLWriter::WriteMeta ( const std::string &  name,
const std::string &  content 
)

References Sanitize().

Referenced by WriteHeaderStart().

◆ WriteOSMObjectLink()

void osmscout::HTMLWriter::WriteOSMObjectLink ( const ObjectOSMRef object,
const std::string &  name 
)

◆ WriteText()

void osmscout::HTMLWriter::WriteText ( const std::string &  text)

References Sanitize().


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