Documentation/Source/eric5.Graphics.ModuleItem.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
--- a/Documentation/Source/eric5.Graphics.ModuleItem.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Graphics.ModuleItem.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Graphics.ModuleItem</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#109;&#111;&#100;&#117;&#108;&#101; &#105;&#116;&#101;&#109;.
+Module implementing a module item.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,10 +32,10 @@
 <table>
 <tr>
 <td><a href="#ModuleItem">ModuleItem</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#109;&#111;&#100;&#117;&#108;&#101; &#105;&#116;&#101;&#109;.</td>
+<td>Class implementing a module item.</td>
 </tr><tr>
 <td><a href="#ModuleModel">ModuleModel</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#109;&#111;&#100;&#101;&#108;.</td>
+<td>Class implementing the module model.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -46,7 +46,7 @@
 <a NAME="ModuleItem" ID="ModuleItem"></a>
 <h2>ModuleItem</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#109;&#111;&#100;&#117;&#108;&#101; &#105;&#116;&#101;&#109;.
+    Class implementing a module item.
 </p>
 <h3>Derived from</h3>
 UMLItem
@@ -58,81 +58,81 @@
 <table>
 <tr>
 <td><a href="#ModuleItem.__init__">ModuleItem</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#ModuleItem.__calculateSize">__calculateSize</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#97;&#108;&#99;&#117;&#108;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#105;z&#101; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#105;&#116;&#101;&#109;.</td>
+<td>Private method to calculate the size of the module item.</td>
 </tr><tr>
 <td><a href="#ModuleItem.__createTexts">__createTexts</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#116;&#101;x&#116; &#105;&#116;&#101;&#109;&#115; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#105;&#116;&#101;&#109;.</td>
+<td>Private method to create the text items of the module item.</td>
 </tr><tr>
 <td><a href="#ModuleItem.paint">paint</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#97;&#105;&#110;&#116; &#116;&#104;&#101; &#105;&#116;&#101;&#109; &#105;&#110; &#108;&#111;&#99;&#97;&#108; &#99;&#111;&#111;&#114;&#100;&#105;&#110;&#97;&#116;&#101;&#115;.</td>
+<td>Public method to paint the item in local coordinates.</td>
 </tr><tr>
 <td><a href="#ModuleItem.setModel">setModel</a></td>
-<td>&#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#109;&#111;&#100;&#101;&#108;.</td>
+<td>Method to set the module model.</td>
 </tr>
 </table>
 <a NAME="ModuleItem.__init__" ID="ModuleItem.__init__"></a>
 <h4>ModuleItem (Constructor)</h4>
 <b>ModuleItem</b>(<i>model = None, x = 0, y = 0, rounded = False, parent = None, scene = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>model</i></dt>
 <dd>
-&#109;&#111;&#100;&#117;&#108;&#101; &#109;&#111;&#100;&#101;&#108; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#100;&#97;&#116;&#97; (&#77;&#111;&#100;&#117;&#108;&#101;&#77;&#111;&#100;&#101;&#108;)
+module model containing the module data (ModuleModel)
 </dd><dt><i>x</i></dt>
 <dd>
-x-&#99;&#111;&#111;&#114;&#100;&#105;&#110;&#97;&#116;&#101; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+x-coordinate (integer)
 </dd><dt><i>y</i></dt>
 <dd>
-y-&#99;&#111;&#111;&#114;&#100;&#105;&#110;&#97;&#116;&#101; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+y-coordinate (integer)
 </dd><dt><i>rounded=</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97; &#114;&#111;&#117;&#110;&#100;&#101;&#100; &#99;&#111;&#114;&#110;&#101;&#114; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating a rounded corner (boolean)
 </dd><dt><i>parent=</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#71;&#114;&#97;&#112;&#104;&#105;&#99;&#115;&#73;&#116;&#101;&#109;)
+reference to the parent object (QGraphicsItem)
 </dd><dt><i>scene=</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#115;&#99;&#101;&#110;&#101; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#71;&#114;&#97;&#112;&#104;&#105;&#99;&#115;&#83;&#99;&#101;&#110;&#101;)
+reference to the scene object (QGraphicsScene)
 </dd>
 </dl><a NAME="ModuleItem.__calculateSize" ID="ModuleItem.__calculateSize"></a>
 <h4>ModuleItem.__calculateSize</h4>
 <b>__calculateSize</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#97;&#108;&#99;&#117;&#108;&#97;&#116;&#101; &#116;&#104;&#101; &#115;&#105;z&#101; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#105;&#116;&#101;&#109;.
+        Private method to calculate the size of the module item.
 </p><a NAME="ModuleItem.__createTexts" ID="ModuleItem.__createTexts"></a>
 <h4>ModuleItem.__createTexts</h4>
 <b>__createTexts</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#116;&#101;x&#116; &#105;&#116;&#101;&#109;&#115; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#105;&#116;&#101;&#109;.
+        Private method to create the text items of the module item.
 </p><a NAME="ModuleItem.paint" ID="ModuleItem.paint"></a>
 <h4>ModuleItem.paint</h4>
 <b>paint</b>(<i>painter, option, widget = None</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#97;&#105;&#110;&#116; &#116;&#104;&#101; &#105;&#116;&#101;&#109; &#105;&#110; &#108;&#111;&#99;&#97;&#108; &#99;&#111;&#111;&#114;&#100;&#105;&#110;&#97;&#116;&#101;&#115;.
+        Public method to paint the item in local coordinates.
 </p><dl>
 <dt><i>painter</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#105;&#110;&#116;&#101;&#114; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#80;&#97;&#105;&#110;&#116;&#101;&#114;)
+reference to the painter object (QPainter)
 </dd><dt><i>option</i></dt>
 <dd>
-&#115;&#116;y&#108;&#101; &#111;&#112;&#116;&#105;&#111;&#110;&#115; (&#81;&#83;&#116;y&#108;&#101;&#79;&#112;&#116;&#105;&#111;&#110;&#71;&#114;&#97;&#112;&#104;&#105;&#99;&#115;&#73;&#116;&#101;&#109;)
+style options (QStyleOptionGraphicsItem)
 </dd><dt><i>widget</i></dt>
 <dd>
-&#111;&#112;&#116;&#105;&#111;&#110;&#97;&#108; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; w&#105;&#100;&#103;&#101;&#116; &#112;&#97;&#105;&#110;&#116;&#101;&#100; &#111;&#110; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+optional reference to the widget painted on (QWidget)
 </dd>
 </dl><a NAME="ModuleItem.setModel" ID="ModuleItem.setModel"></a>
 <h4>ModuleItem.setModel</h4>
 <b>setModel</b>(<i>model</i>)
 <p>
-        &#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#109;&#111;&#100;&#101;&#108;.
+        Method to set the module model.
 </p><dl>
 <dt><i>model</i></dt>
 <dd>
-&#109;&#111;&#100;&#117;&#108;&#101; &#109;&#111;&#100;&#101;&#108; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#100;&#97;&#116;&#97; (&#77;&#111;&#100;&#117;&#108;&#101;&#77;&#111;&#100;&#101;&#108;)
+module model containing the module data (ModuleModel)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -140,7 +140,7 @@
 <a NAME="ModuleModel" ID="ModuleModel"></a>
 <h2>ModuleModel</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#109;&#111;&#100;&#101;&#108;.
+    Class implementing the module model.
 </p>
 <h3>Derived from</h3>
 object
@@ -152,60 +152,60 @@
 <table>
 <tr>
 <td><a href="#ModuleModel.__init__">ModuleModel</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#ModuleModel.addClass">addClass</a></td>
-<td>&#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; &#99;&#108;&#97;&#115;&#115; &#116;&#111; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#109;&#111;&#100;&#101;&#108;.</td>
+<td>Method to add a class to the module model.</td>
 </tr><tr>
 <td><a href="#ModuleModel.getClasses">getClasses</a></td>
-<td>&#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;.</td>
+<td>Method to retrieve the classes of the module.</td>
 </tr><tr>
 <td><a href="#ModuleModel.getName">getName</a></td>
-<td>&#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#110;&#97;&#109;&#101;.</td>
+<td>Method to retrieve the module name.</td>
 </tr>
 </table>
 <a NAME="ModuleModel.__init__" ID="ModuleModel.__init__"></a>
 <h4>ModuleModel (Constructor)</h4>
 <b>ModuleModel</b>(<i>name, classlist=[]</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>name</i></dt>
 <dd>
-&#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#110;&#97;&#109;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+the module name (string)
 </dd><dt><i>classlist</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#99;&#108;&#97;&#115;&#115; &#110;&#97;&#109;&#101;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of class names (list of strings)
 </dd>
 </dl><a NAME="ModuleModel.addClass" ID="ModuleModel.addClass"></a>
 <h4>ModuleModel.addClass</h4>
 <b>addClass</b>(<i>classname</i>)
 <p>
-        &#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; &#99;&#108;&#97;&#115;&#115; &#116;&#111; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#109;&#111;&#100;&#101;&#108;.
+        Method to add a class to the module model.
 </p><dl>
 <dt><i>classname</i></dt>
 <dd>
-&#99;&#108;&#97;&#115;&#115; &#110;&#97;&#109;&#101; &#116;&#111; &#98;&#101; &#97;&#100;&#100;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+class name to be added (string)
 </dd>
 </dl><a NAME="ModuleModel.getClasses" ID="ModuleModel.getClasses"></a>
 <h4>ModuleModel.getClasses</h4>
 <b>getClasses</b>(<i></i>)
 <p>
-        &#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#111;&#102; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;.
+        Method to retrieve the classes of the module.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#99;&#108;&#97;&#115;&#115; &#110;&#97;&#109;&#101;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of class names (list of strings)
 </dd>
 </dl><a NAME="ModuleModel.getName" ID="ModuleModel.getName"></a>
 <h4>ModuleModel.getName</h4>
 <b>getName</b>(<i></i>)
 <p>
-        &#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#110;&#97;&#109;&#101;.
+        Method to retrieve the module name.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#109;&#111;&#100;&#117;&#108;&#101; &#110;&#97;&#109;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+module name (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial