diff -r f0cb7579c0b4 -r e26d7d0c1088 Documentation/Source/eric6.Graphics.UMLDiagramBuilder.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric6.Graphics.UMLDiagramBuilder.html Sat Jul 05 12:29:15 2014 +0200 @@ -0,0 +1,145 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Graphics.UMLDiagramBuilder</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric6.Graphics.UMLDiagramBuilder</h1> +<p> +Module implementing the UML diagram builder base class. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#UMLDiagramBuilder">UMLDiagramBuilder</a></td> +<td>Class implementing the UML diagram builder base class.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="UMLDiagramBuilder" ID="UMLDiagramBuilder"></a> +<h2>UMLDiagramBuilder</h2> +<p> + Class implementing the UML diagram builder base class. +</p> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#UMLDiagramBuilder.__init__">UMLDiagramBuilder</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#UMLDiagramBuilder.buildDiagram">buildDiagram</a></td> +<td>Public method to build the diagram.</td> +</tr><tr> +<td><a href="#UMLDiagramBuilder.getPersistenceData">getPersistenceData</a></td> +<td>Public method to get a string for data to be persisted.</td> +</tr><tr> +<td><a href="#UMLDiagramBuilder.initialize">initialize</a></td> +<td>Public method to initialize the object.</td> +</tr><tr> +<td><a href="#UMLDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> +<td>Public method to parse persisted data.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="UMLDiagramBuilder.__init__" ID="UMLDiagramBuilder.__init__"></a> +<h4>UMLDiagramBuilder (Constructor)</h4> +<b>UMLDiagramBuilder</b>(<i>dialog, view, project</i>) +<p> + Constructor +</p><dl> +<dt><i>dialog</i></dt> +<dd> +reference to the UML dialog (UMLDialog) +</dd><dt><i>view</i></dt> +<dd> +reference to the view object (UMLGraphicsView) +</dd><dt><i>project</i></dt> +<dd> +reference to the project object (Project) +</dd> +</dl><a NAME="UMLDiagramBuilder.buildDiagram" ID="UMLDiagramBuilder.buildDiagram"></a> +<h4>UMLDiagramBuilder.buildDiagram</h4> +<b>buildDiagram</b>(<i></i>) +<p> + Public method to build the diagram. +</p><p> + This class must be implemented in subclasses. +</p><dl> +<dt>Raises <b>NotImplementedError</b>:</dt> +<dd> +raised to indicate that this class + must be subclassed +</dd> +</dl><a NAME="UMLDiagramBuilder.getPersistenceData" ID="UMLDiagramBuilder.getPersistenceData"></a> +<h4>UMLDiagramBuilder.getPersistenceData</h4> +<b>getPersistenceData</b>(<i></i>) +<p> + Public method to get a string for data to be persisted. +</p><dl> +<dt>Returns:</dt> +<dd> +persisted data string (string) +</dd> +</dl><a NAME="UMLDiagramBuilder.initialize" ID="UMLDiagramBuilder.initialize"></a> +<h4>UMLDiagramBuilder.initialize</h4> +<b>initialize</b>(<i></i>) +<p> + Public method to initialize the object. +</p><a NAME="UMLDiagramBuilder.parsePersistenceData" ID="UMLDiagramBuilder.parsePersistenceData"></a> +<h4>UMLDiagramBuilder.parsePersistenceData</h4> +<b>parsePersistenceData</b>(<i>version, data</i>) +<p> + Public method to parse persisted data. +</p><dl> +<dt><i>version</i></dt> +<dd> +version of the data (string) +</dd><dt><i>data</i></dt> +<dd> +persisted data to be parsed (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file