WocHtmlOut Class Reference

Output target for HTML documentation. More...

#include <htmlout.h>

Inheritance diagram for WocHtmlOut:

Public Member Functions
	WocHtmlOut (QDomElement &)
	generates the output object from the corresponding XML tag that describes it More...
	~WocHtmlOut ()
Public Member Functions inherited from WocOutput
	WocOutput ()
	the constructor should set up and initialize the environment of the generator More...
virtual	~WocOutput ()
	currently there is no guarantee that the destructor is ever called. More...

Protected Member Functions
virtual void	finalize ()
	called to finalize all output, creates the index More...
virtual void	newClass (const WocClass &)
	creates an HTML page for a class More...
virtual void	newTable (const WocTable &)
	creates an HTML page for a DB table More...
virtual void	newTransaction (const WocTransaction &)
	creates an HTML page for a transaction More...

Private Member Functions
void	classEnums (const WocClass &, QFile &)
	helper: generate enums for classes More...
void	classProperties (const WocClass &, QFile &)
	helper: generate properties More...
void	classMappings (const WocClass &, QFile &)
	helper: generate mappings More...

Private Attributes
QString	m_basedir
QString	m_subdir
QFile	m_index

Additional Inherited Members
Signals inherited from WocOutput
void	errorFound ()
Protected Slots inherited from WocOutput

Detailed Description

Output target for HTML documentation.

This class does not create actual code, but documentation for the WOLF file.

Constructor & Destructor Documentation

WocHtmlOut::WocHtmlOut ( QDomElement &  el )

explicit

generates the output object from the corresponding XML tag that describes it

WocHtmlOut::~WocHtmlOut

(

)

Member Function Documentation

void WocHtmlOut::classEnums ( const WocClass &  cls, QFile &  hdr  )

private

helper: generate enums for classes

void WocHtmlOut::classMappings ( const WocClass &  cls, QFile &  hdr  )

private

helper: generate mappings

void WocHtmlOut::classProperties ( const WocClass &  cls, QFile &  hdr  )

private

helper: generate properties

void WocHtmlOut::finalize ( )

protectedvirtual

called to finalize all output, creates the index

Implements WocOutput.

void WocHtmlOut::newClass ( const WocClass &  cls )

protectedvirtual

creates an HTML page for a class

Implements WocOutput.

void WocHtmlOut::newTable ( const WocTable &  tbl )

protectedvirtual

creates an HTML page for a DB table

Implements WocOutput.

void WocHtmlOut::newTransaction ( const WocTransaction &  trn )

protectedvirtual

creates an HTML page for a transaction

Implements WocOutput.

Member Data Documentation

QString WocHtmlOut::m_basedir

private

QFile WocHtmlOut::m_index

private

QString WocHtmlOut::m_subdir

private

---

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

• htmlout.h
• htmlout.cpp