umbrello/umbrello
#include <xhtmlgenerator.h>
Signals | |
void | finished (bool status) |
Public Member Functions | |
XhtmlGenerator () | |
virtual | ~XhtmlGenerator () |
bool | generateXhtmlForProject () |
bool | generateXhtmlForProjectInto (const KUrl &destDir) |
Protected Slots | |
void | slotDocbookToXhtml (bool status) |
void | slotHtmlGenerated (const QString &tmpFileName) |
void | threadFinished () |
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.
|
virtual |
Destructor.
Definition at line 46 of file xhtmlgenerator.cpp.
Member Function Documentation
|
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.
|
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.
|
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.
|
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:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:06:03 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.