umbrello/umbrello
#include <dotgenerator.h>
Public Member Functions | |
DotGenerator () | |
bool | createDotFile (UMLScene *scene, const QString &fileName, const QString &variant=QLatin1String("default")) |
bool | readConfigFile (QString diagramType, const QString &variant=QLatin1String("default")) |
void | setUseFullNodeLabels (bool state) |
void | setUsePosition (bool state) |
bool | useFullNodeLabels () |
bool | usePosition () |
Static Public Member Functions | |
static bool | availableConfigFiles (UMLScene *scene, QHash< QString, QString > &configFiles) |
Protected Member Functions | |
bool | findItem (QStringList ¶ms, const QString &search) |
QString | fixID (const QString &_id) |
Protected Attributes | |
QString | m_configFileName |
QHash< QString, QString > | m_dotParameters |
QHash< QString, QString > | m_edgeParameters |
QString | m_generator |
QHash< QString, QString > | m_nodeParameters |
QPointF | m_origin |
double | m_scale |
bool | m_useFullNodeLabels |
bool | m_usePosition |
Friends | |
QDebug | operator<< (QDebug out, DotGenerator &c) |
Detailed Description
The class DotGenerator provides export of diagrams as dot files.
Definition at line 23 of file dotgenerator.h.
Constructor & Destructor Documentation
DotGenerator::DotGenerator | ( | ) |
constructor
Definition at line 128 of file dotgenerator.cpp.
Member Function Documentation
|
static |
Return a list of available templates for a given scene type.
- Parameters
-
scene The diagram configFiles will contain the collected list of config files
- Returns
- true if collecting succeeds
Definition at line 185 of file dotgenerator.cpp.
bool DotGenerator::createDotFile | ( | UMLScene * | scene, |
const QString & | fileName, | ||
const QString & | variant = QLatin1String("default") |
||
) |
Create dot file using displayed widgets and associations of the provided scene.
- Note
- This method could also be used as a base to export diagrams as dot file
- Parameters
-
scene The diagram from which the widget information is fetched fileName Filename where to create the dot file variant Variant string passed to readConfigFile()
- Returns
- true if generating finished successfully
Definition at line 294 of file dotgenerator.cpp.
|
protected |
Find string starting with the search string in string list.
- Parameters
-
params string list to search in search string
- Returns
- true when search string has been found
Definition at line 457 of file dotgenerator.cpp.
There are id wrapped with '"', remove it.
Definition at line 469 of file dotgenerator.cpp.
bool DotGenerator::readConfigFile | ( | QString | diagramType, |
const QString & | variant = QLatin1String("default") |
||
) |
Read a layout config file.
- Parameters
-
diagramType String identifing the diagram variant String identifing the variant
- Returns
- true on success
Definition at line 213 of file dotgenerator.cpp.
void DotGenerator::setUseFullNodeLabels | ( | bool | state | ) |
Set usage of full node labels.
When set to true labels are extracted from the text output generated by the widget's paint method.
- Parameters
-
state The new state
Definition at line 173 of file dotgenerator.cpp.
void DotGenerator::setUsePosition | ( | bool | state | ) |
set usage of position attribute in dot file
- Parameters
-
state The new state
Definition at line 151 of file dotgenerator.cpp.
bool DotGenerator::useFullNodeLabels | ( | ) |
return usage of full node labels
- Returns
- true if position are used
Definition at line 161 of file dotgenerator.cpp.
bool DotGenerator::usePosition | ( | ) |
return usage of position attribute
- Returns
- true if position are used
Definition at line 141 of file dotgenerator.cpp.
Friends And Related Function Documentation
|
friend |
Member Data Documentation
|
protected |
template filename
Definition at line 44 of file dotgenerator.h.
contains global graph parameters
Definition at line 45 of file dotgenerator.h.
contains global edge parameters
Definition at line 46 of file dotgenerator.h.
|
protected |
name of graphviz generator
Definition at line 49 of file dotgenerator.h.
contains global node parameters
Definition at line 47 of file dotgenerator.h.
|
protected |
Definition at line 48 of file dotgenerator.h.
|
protected |
scale factor
Definition at line 43 of file dotgenerator.h.
|
protected |
use full node labels
Definition at line 51 of file dotgenerator.h.
|
protected |
use position tag from dot (not used yet)
Definition at line 50 of file dotgenerator.h.
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.