Mercurial Repositories > eric / file revision

Documentation/Source/eric5.Graphics.ClassItem.html@2f2a4a76dd22

Documentation/Source/eric5.Graphics.ClassItem.html

Sun, 18 May 2014 14:13:09 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 18 May 2014 14:13:09 +0200
changeset 3591
2f2a4a76dd22
parent 3018
70924c0bdaf1
permissions
-rw-r--r--

Corrected a bunch of source docu issues.

<!DOCTYPE html>
<html><head>
<title>eric5.Graphics.ClassItem</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>eric5.Graphics.ClassItem</h1>
<p>
Module implementing an UML like class item.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#ClassItem">ClassItem</a></td>
<td>Class implementing an UML like class item.</td>
</tr><tr>
<td><a href="#ClassModel">ClassModel</a></td>
<td>Class implementing the class model.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="ClassItem" ID="ClassItem"></a>
<h2>ClassItem</h2>
<p>
    Class implementing an UML like class item.
</p>
<h3>Derived from</h3>
UMLItem
<h3>Class Attributes</h3>
<table>
<tr><td>ItemType</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#ClassItem.__init__">ClassItem</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#ClassItem.__calculateSize">__calculateSize</a></td>
<td>Private method to calculate the size of the class item.</td>
</tr><tr>
<td><a href="#ClassItem.__createTexts">__createTexts</a></td>
<td>Private method to create the text items of the class item.</td>
</tr><tr>
<td><a href="#ClassItem.buildItemDataString">buildItemDataString</a></td>
<td>Public method to build a string to persist the specific item data.</td>
</tr><tr>
<td><a href="#ClassItem.isExternal">isExternal</a></td>
<td>Public method returning the external state.</td>
</tr><tr>
<td><a href="#ClassItem.paint">paint</a></td>
<td>Public method to paint the item in local coordinates.</td>
</tr><tr>
<td><a href="#ClassItem.parseItemDataString">parseItemDataString</a></td>
<td>Public method to parse the given persistence data.</td>
</tr><tr>
<td><a href="#ClassItem.setModel">setModel</a></td>
<td>Public method to set the class model.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="ClassItem.__init__" ID="ClassItem.__init__"></a>
<h4>ClassItem (Constructor)</h4>
<b>ClassItem</b>(<i>model=None, external=False, x=0, y=0, rounded=False, noAttrs=False, parent=None, scene=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>model</i></dt>
<dd>
class model containing the class data (ClassModel)
</dd><dt><i>external</i></dt>
<dd>
flag indicating a class defined outside our scope
            (boolean)
</dd><dt><i>x</i></dt>
<dd>
x-coordinate (integer)
</dd><dt><i>y</i></dt>
<dd>
y-coordinate (integer)
</dd><dt><i>rounded=</i></dt>
<dd>
flag indicating a rounded corner (boolean)
</dd><dt><i>noAttrs=</i></dt>
<dd>
flag indicating, that no attributes should be shown
            (boolean)
</dd><dt><i>parent=</i></dt>
<dd>
reference to the parent object (QGraphicsItem)
</dd><dt><i>scene=</i></dt>
<dd>
reference to the scene object (QGraphicsScene)
</dd>
</dl><a NAME="ClassItem.__calculateSize" ID="ClassItem.__calculateSize"></a>
<h4>ClassItem.__calculateSize</h4>
<b>__calculateSize</b>(<i></i>)
<p>
        Private method to calculate the size of the class item.
</p><a NAME="ClassItem.__createTexts" ID="ClassItem.__createTexts"></a>
<h4>ClassItem.__createTexts</h4>
<b>__createTexts</b>(<i></i>)
<p>
        Private method to create the text items of the class item.
</p><a NAME="ClassItem.buildItemDataString" ID="ClassItem.buildItemDataString"></a>
<h4>ClassItem.buildItemDataString</h4>
<b>buildItemDataString</b>(<i></i>)
<p>
        Public method to build a string to persist the specific item data.
</p><p>
        This string must start with ", " and should be built like
        "attribute=value" with pairs separated by ", ". value must not
        contain ", " or newlines.
</p><dl>
<dt>Returns:</dt>
<dd>
persistence data (string)
</dd>
</dl><a NAME="ClassItem.isExternal" ID="ClassItem.isExternal"></a>
<h4>ClassItem.isExternal</h4>
<b>isExternal</b>(<i></i>)
<p>
        Public method returning the external state.
</p><dl>
<dt>Returns:</dt>
<dd>
external state (boolean)
</dd>
</dl><a NAME="ClassItem.paint" ID="ClassItem.paint"></a>
<h4>ClassItem.paint</h4>
<b>paint</b>(<i>painter, option, widget=None</i>)
<p>
        Public method to paint the item in local coordinates.
</p><dl>
<dt><i>painter</i></dt>
<dd>
reference to the painter object (QPainter)
</dd><dt><i>option</i></dt>
<dd>
style options (QStyleOptionGraphicsItem)
</dd><dt><i>widget</i></dt>
<dd>
optional reference to the widget painted on (QWidget)
</dd>
</dl><a NAME="ClassItem.parseItemDataString" ID="ClassItem.parseItemDataString"></a>
<h4>ClassItem.parseItemDataString</h4>
<b>parseItemDataString</b>(<i>version, data</i>)
<p>
        Public method to parse the given persistence 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><a NAME="ClassItem.setModel" ID="ClassItem.setModel"></a>
<h4>ClassItem.setModel</h4>
<b>setModel</b>(<i>model</i>)
<p>
        Public method to set the class model.
</p><dl>
<dt><i>model</i></dt>
<dd>
class model containing the class data (ClassModel)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="ClassModel" ID="ClassModel"></a>
<h2>ClassModel</h2>
<p>
    Class implementing the class model.
</p>
<h3>Derived from</h3>
UMLModel
<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="#ClassModel.__init__">ClassModel</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#ClassModel.addAttribute">addAttribute</a></td>
<td>Public method to add an attribute to the class model.</td>
</tr><tr>
<td><a href="#ClassModel.addMethod">addMethod</a></td>
<td>Public method to add a method to the class model.</td>
</tr><tr>
<td><a href="#ClassModel.getAttributes">getAttributes</a></td>
<td>Public method to retrieve the attributes of the class.</td>
</tr><tr>
<td><a href="#ClassModel.getMethods">getMethods</a></td>
<td>Public method to retrieve the methods of the class.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="ClassModel.__init__" ID="ClassModel.__init__"></a>
<h4>ClassModel (Constructor)</h4>
<b>ClassModel</b>(<i>name, methods=[], attributes=[]</i>)
<p>
        Constructor
</p><dl>
<dt><i>name</i></dt>
<dd>
the class name (string)
</dd><dt><i>methods</i></dt>
<dd>
list of method names of the class
            (list of strings)
</dd><dt><i>attributes</i></dt>
<dd>
list of attribute names of the class
            (list of strings)
</dd>
</dl><a NAME="ClassModel.addAttribute" ID="ClassModel.addAttribute"></a>
<h4>ClassModel.addAttribute</h4>
<b>addAttribute</b>(<i>attribute</i>)
<p>
        Public method to add an attribute to the class model.
</p><dl>
<dt><i>attribute</i></dt>
<dd>
attribute name to be added (string)
</dd>
</dl><a NAME="ClassModel.addMethod" ID="ClassModel.addMethod"></a>
<h4>ClassModel.addMethod</h4>
<b>addMethod</b>(<i>method</i>)
<p>
        Public method to add a method to the class model.
</p><dl>
<dt><i>method</i></dt>
<dd>
method name to be added (string)
</dd>
</dl><a NAME="ClassModel.getAttributes" ID="ClassModel.getAttributes"></a>
<h4>ClassModel.getAttributes</h4>
<b>getAttributes</b>(<i></i>)
<p>
        Public method to retrieve the attributes of the class.
</p><dl>
<dt>Returns:</dt>
<dd>
list of class attributes (list of strings)
</dd>
</dl><a NAME="ClassModel.getMethods" ID="ClassModel.getMethods"></a>
<h4>ClassModel.getMethods</h4>
<b>getMethods</b>(<i></i>)
<p>
        Public method to retrieve the methods of the class.
</p><dl>
<dt>Returns:</dt>
<dd>
list of class methods (list of strings)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

Mercurial Repository: eric

eric ide

mercurial