umbrello/umbrello
#include <docbookgenerator.h>
Signals | |
void | finished (bool status) |
Public Member Functions | |
DocbookGenerator () | |
virtual | ~DocbookGenerator () |
bool | generateDocbookForProject () |
void | generateDocbookForProjectInto (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 ®Exp) 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 |
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 DocbookGenerator is a documentation generator for UML documents.
It uses libxslt to convert the XMI generated by UMLDoc::saveToXMI through the XSLT file stored in resources.
- Todo:
Add configure checks for libxml2 and libxslt and use conditional compilation of this library and its callers
allow to specify the destination and ensure that it works with distant ones
Definition at line 31 of file docbookgenerator.h.
Constructor & Destructor Documentation
DocbookGenerator::DocbookGenerator | ( | ) |
Constructor.
Definition at line 35 of file docbookgenerator.cpp.
|
virtual |
Destructor.
Definition at line 46 of file docbookgenerator.cpp.
Member Function Documentation
|
signal |
bool DocbookGenerator::generateDocbookForProject | ( | ) |
Exports the current model to docbook in a directory named as the model with the .xmi suffix removed.
The docbook file will have the same name with the .docbook 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 docbookgenerator.cpp.
void DocbookGenerator::generateDocbookForProjectInto | ( | const KUrl & | destDir | ) |
Exports the current model to docbook in the given directory.
- Parameters
-
destDir the directory where the docbook 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 77 of file docbookgenerator.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:40:28 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.