umbrello API Documentation
	Overview Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files

XhtmlGenerator Class Reference

class XhtmlGenerator is a documentation generator for UML documents. More...

#include <xhtmlgenerator.h>

List of all members.

Signals
void	finished ()
	Emited when the documentation generation is finished.
Public Member Functions
	XhtmlGenerator ()
	Constructor.
virtual	~XhtmlGenerator ()
	Empty Destructor.
bool	generateXhtmlForProject ()
	Exports the current model to XHTML in a directory named as the model with the .xmi suffix removed.
bool	generateXhtmlForProjectInto (const KURL &destDir)
	Exports the current model to XHTML in the given directory.
Protected Slots
void	slotDocbookToXhtml (KIO::Job *docbookJob)
	This slot is triggerd when the first part, xmi to docbook, is finished.
void	slotHtmlCopyFinished (KIO::Job *)
	Triggered when the copying of the HTML result file is finished.

---

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

Definition at line 41 of file xhtmlgenerator.h.

---

Constructor & Destructor Documentation

XhtmlGenerator::XhtmlGenerator (   )

Constructor. Definition at line 45 of file xhtmlgenerator.cpp.

XhtmlGenerator::~XhtmlGenerator (   )  [virtual]

Empty Destructor. Definition at line 49 of file xhtmlgenerator.cpp.

---

Member Function Documentation

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 Returns: true if saving is successful and false otherwise. Definition at line 52 of file xhtmlgenerator.cpp. References generateXhtmlForProjectInto(), UMLApp::getDocument(), and UMLDoc::URL(). Referenced by UMLApp::slotFileExportXhtml().

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 Returns: true if saving is successful and false otherwise. Definition at line 64 of file xhtmlgenerator.cpp. References slotDocbookToXhtml(). Referenced by generateXhtmlForProject().

void XhtmlGenerator::finished (   )  [signal]

Emited when the documentation generation is finished. Referenced by slotHtmlCopyFinished().

void XhtmlGenerator::slotDocbookToXhtml (  KIO::Job *  docbookJob  )  [protected, slot]

This slot is triggerd when the first part, xmi to docbook, is finished. Parameters: docbookJob  the job copying the docbook file to its destination. Used only for error reporting Definition at line 79 of file xhtmlgenerator.cpp. References UMLApp::getDocument(), slotHtmlCopyFinished(), and UMLDoc::URL(). Referenced by generateXhtmlForProjectInto().

void XhtmlGenerator::slotHtmlCopyFinished (  KIO::Job *   )  [protected, slot]

Triggered when the copying of the HTML result file is finished. Emits the signal finished(). Definition at line 165 of file xhtmlgenerator.cpp. References finished(). Referenced by slotDocbookToXhtml().

---

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

• xhtmlgenerator.h
• xhtmlgenerator.cpp

This file is part of the documentation for umbrello Version 3.1.0.

Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Jun 26 08:08:08 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003