eric6/Documentation/Source/eric6.Graphics.AssociationItem.html

changeset 8289
871b40c5a77a
parent 8270
6ba3564b7161
child 8294
cb4e5bbf3a2c
--- a/eric6/Documentation/Source/eric6.Graphics.AssociationItem.html	Tue May 04 19:30:25 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Graphics.AssociationItem.html	Tue May 04 20:03:40 2021 +0200
@@ -110,7 +110,7 @@
 </tr>
 <tr>
 <td><a href="#AssociationItem.__findRectIntersectionPoint">__findRectIntersectionPoint</a></td>
-<td>Private method to find the intersetion point of a line with a rectangle.</td>
+<td>Private method to find the intersection point of a line with a rectangle.</td>
 </tr>
 <tr>
 <td><a href="#AssociationItem.__mapRectFromItem">__mapRectFromItem</a></td>
@@ -148,9 +148,9 @@
 </p>
 <dl>
 
-<dt><i>data</i></dt>
+<dt><i>data</i> (str)</dt>
 <dd>
-persisted data to be parsed (string)
+persisted data to be parsed
 </dd>
 </dl>
 <dl>
@@ -158,7 +158,13 @@
 <dd>
 tuple with the IDs of the source and destination items,
             the association type and a flag indicating to associate from top
-            to bottom (integer, integer, integer, boolean)
+            to bottom
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int, int, bool)
 </dd>
 </dl>
 <a NAME="AssociationItem.__init__" ID="AssociationItem.__init__"></a>
@@ -293,27 +299,33 @@
 </p>
 <dl>
 
-<dt><i>p1</i></dt>
+<dt><i>p1</i> (QPointF)</dt>
 <dd>
-first point of first line (QPointF)
+first point of first line
 </dd>
-<dt><i>p2</i></dt>
+<dt><i>p2</i> (QPointF)</dt>
 <dd>
-second point of first line (QPointF)
+second point of first line
 </dd>
-<dt><i>p3</i></dt>
+<dt><i>p3</i> (QPointF)</dt>
 <dd>
-first point of second line (QPointF)
+first point of second line
 </dd>
-<dt><i>p4</i></dt>
+<dt><i>p4</i> (QPointF)</dt>
 <dd>
-second point of second line (QPointF)
+second point of second line
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-the intersection point (QPointF)
+the intersection point
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QPointF
 </dd>
 </dl>
 <a NAME="AssociationItem.__findPointRegion" ID="AssociationItem.__findPointRegion"></a>
@@ -326,17 +338,17 @@
 </p>
 <dl>
 
-<dt><i>rect</i></dt>
+<dt><i>rect</i> (QRectF)</dt>
 <dd>
-rectangle to calculate the region for (QRectF)
+rectangle to calculate the region for
 </dd>
-<dt><i>posX</i></dt>
+<dt><i>posX</i> (float)</dt>
 <dd>
-x position of point (float)
+x position of point
 </dd>
-<dt><i>posY</i></dt>
+<dt><i>posY</i> (float)</dt>
 <dd>
-y position of point (float)
+y position of point
 </dd>
 </dl>
 <dl>
@@ -354,33 +366,45 @@
             Center = On diagonal 1 and On diagonal 2 (the center)<br />
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+AssociationPointRegion
+</dd>
+</dl>
 <a NAME="AssociationItem.__findRectIntersectionPoint" ID="AssociationItem.__findRectIntersectionPoint"></a>
 <h4>AssociationItem.__findRectIntersectionPoint</h4>
 <b>__findRectIntersectionPoint</b>(<i>item, p1, p2</i>)
 
 <p>
-        Private method to find the intersetion point of a line with a
+        Private method to find the intersection point of a line with a
         rectangle.
 </p>
 <dl>
 
-<dt><i>item</i></dt>
+<dt><i>item</i> (UMLItem)</dt>
 <dd>
 item to check against
 </dd>
-<dt><i>p1</i></dt>
+<dt><i>p1</i> (QPointF)</dt>
 <dd>
-first point of the line (QPointF)
+first point of the line
 </dd>
-<dt><i>p2</i></dt>
+<dt><i>p2</i> (QPointF)</dt>
 <dd>
-second point of the line (QPointF)
+second point of the line
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-the intersection point (QPointF)
+the intersection point
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QPointF
 </dd>
 </dl>
 <a NAME="AssociationItem.__mapRectFromItem" ID="AssociationItem.__mapRectFromItem"></a>
@@ -393,15 +417,21 @@
 </p>
 <dl>
 
-<dt><i>item</i></dt>
+<dt><i>item</i> (QGraphicsRectItem)</dt>
 <dd>
-reference to the item to be mapped (QGraphicsRectItem)
+reference to the item to be mapped
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-item's rectangle in local coordinates (QRectF)
+item's rectangle in local coordinates
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QRectF
 </dd>
 </dl>
 <a NAME="AssociationItem.__updateEndPoint" ID="AssociationItem.__updateEndPoint"></a>
@@ -413,13 +443,13 @@
 </p>
 <dl>
 
-<dt><i>region</i></dt>
+<dt><i>region</i> (AssociationPointRegion)</dt>
 <dd>
-the region for the endpoint (integer)
+the region for the endpoint
 </dd>
-<dt><i>isWidgetA</i></dt>
+<dt><i>isWidgetA</i> (bool)</dt>
 <dd>
-flag indicating update for itemA is done (boolean)
+flag indicating update for itemA is done
 </dd>
 </dl>
 <a NAME="AssociationItem.buildAssociationItemDataString" ID="AssociationItem.buildAssociationItemDataString"></a>
@@ -436,7 +466,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-persistence data (string)
+persistence data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="AssociationItem.unassociate" ID="AssociationItem.unassociate"></a>

eric ide

mercurial