XhtmlGenerator Class Reference

#include <xhtmlgenerator.h>

Inheritance diagram for XhtmlGenerator:

Signals
void	finished (bool status)

Public Member Functions
	XhtmlGenerator ()
virtual	~XhtmlGenerator ()
bool	generateXhtmlForProject ()
bool	generateXhtmlForProjectInto (const KUrl &destDir)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Slots
void	slotDocbookToXhtml (bool status)
void	slotHtmlGenerated (const QString &tmpFileName)
void	threadFinished ()

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

class XhtmlGenerator is a documentation generator for UML documents.

It uses first DocbookGenerator to convert the XMI generated by UMLDoc::saveToXMI to docbook and next libxslt through the XSLT file stored in resources to convert the docbook file to XHTML. The latter uses the XSLT available on the Web at http://docbook.sourceforge.net/release/xsl/snapshot/html/docbook.xsl

Todo:

allow to specify the destination and ensure that it works with distant ones

Definition at line 35 of file xhtmlgenerator.h.

Constructor & Destructor Documentation

XhtmlGenerator::XhtmlGenerator

(

)

Constructor.

Definition at line 35 of file xhtmlgenerator.cpp.

XhtmlGenerator::~XhtmlGenerator ( )

virtual

Destructor.

Definition at line 46 of file xhtmlgenerator.cpp.

Member Function Documentation

void XhtmlGenerator::finished ( bool  status )

signal

bool XhtmlGenerator::generateXhtmlForProject

(

)

Exports the current model to XHTML in a directory named as the model with the .xmi suffix removed.

The XHTML file will have the same name with the .html suffix. Figures will be named as the corresponding diagrams in the GUI

Todo:

change file naming to avoid paths with spaces or non-ASCII chars

better handling of error conditions

Returns

true if saving is successful and false otherwise.

Definition at line 59 of file xhtmlgenerator.cpp.

bool XhtmlGenerator::generateXhtmlForProjectInto

(

const KUrl &

destDir

)

Exports the current model to XHTML in the given directory.

Parameters

destDir

the directory where the XHTML file and the figures will be written

Todo:

better handling of error conditions

Returns

true if saving is successful and false otherwise.

Definition at line 76 of file xhtmlgenerator.cpp.

void XhtmlGenerator::slotDocbookToXhtml ( bool  status )

protectedslot

This slot is triggerd when the first part, xmi to docbook, is finished.

Parameters

status

status to continue with converting

Definition at line 93 of file xhtmlgenerator.cpp.

void XhtmlGenerator::slotHtmlGenerated ( const QString &  tmpFileName )

protectedslot

Triggered when the copying of the HTML result file is finished.

Emits the signal finished().

Parameters

tmpFileName

temporary file name

Definition at line 123 of file xhtmlgenerator.cpp.

void XhtmlGenerator::threadFinished ( )

protectedslot

Invoked when a thread is finished.

Definition at line 166 of file xhtmlgenerator.cpp.

---

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

• xhtmlgenerator.h
• xhtmlgenerator.cpp