--- a/src/eric7/Documentation/Source/eric7.Graphics.AssociationItem.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Graphics.AssociationItem.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Graphics.AssociationItem</h1>
-
<p>
Module implementing a graphics item for an association between two items.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#AssociationItem">AssociationItem</a></td>
<td>Class implementing a graphics item for an association between two items.</td>
@@ -33,16 +31,16 @@
<td>Class defining the association types.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="AssociationItem" ID="AssociationItem"></a>
<h2>AssociationItem</h2>
-
<p>
Class implementing a graphics item for an association between two items.
</p>
@@ -50,17 +48,16 @@
The association is drawn as an arrow starting at the first items and
ending at the second.
</p>
+
<h3>Derived from</h3>
EricArrowItem
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
-
<tr>
<td><a href="#AssociationItem.fromDict">fromDict</a></td>
<td>Class method to create an association item from persisted data.</td>
@@ -70,10 +67,9 @@
<td>Class method to parse the given persistence data.</td>
</tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#AssociationItem.__init__">AssociationItem</a></td>
<td>Constructor</td>
@@ -123,19 +119,20 @@
<td>Public method to recalculate the association after a widget was moved.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="AssociationItem.fromDict" ID="AssociationItem.fromDict"></a>
<h4>AssociationItem.fromDict (class method)</h4>
<b>fromDict</b>(<i>data, umlItems, colors=None</i>)
-
<p>
Class method to create an association item from persisted data.
</p>
+
<dl>
<dt><i>data</i> (dict)</dt>
@@ -167,10 +164,10 @@
<a NAME="AssociationItem.parseAssociationItemDataString" ID="AssociationItem.parseAssociationItemDataString"></a>
<h4>AssociationItem.parseAssociationItemDataString (class method)</h4>
<b>parseAssociationItemDataString</b>(<i>data</i>)
-
<p>
Class method to parse the given persistence data.
</p>
+
<dl>
<dt><i>data</i> (str)</dt>
@@ -195,10 +192,10 @@
<a NAME="AssociationItem.__init__" ID="AssociationItem.__init__"></a>
<h4>AssociationItem (Constructor)</h4>
<b>AssociationItem</b>(<i>itemA, itemB, assocType=AssociationType.NORMAL, topToBottom=False, colors=None, parent=None, </i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>itemA</i> (UMLItem)</dt>
@@ -230,7 +227,6 @@
<a NAME="AssociationItem.__calculateEndingPoints_center" ID="AssociationItem.__calculateEndingPoints_center"></a>
<h4>AssociationItem.__calculateEndingPoints_center</h4>
<b>__calculateEndingPoints_center</b>(<i></i>)
-
<p>
Private method to calculate the ending points of the association item.
</p>
@@ -238,10 +234,10 @@
The ending points are calculated from the centers of the
two associated items.
</p>
+
<a NAME="AssociationItem.__calculateEndingPoints_rectangle" ID="AssociationItem.__calculateEndingPoints_rectangle"></a>
<h4>AssociationItem.__calculateEndingPoints_rectangle</h4>
<b>__calculateEndingPoints_rectangle</b>(<i></i>)
-
<p>
Private method to calculate the ending points of the association item.
</p>
@@ -281,10 +277,10 @@
To calculate the end point we repeat the above but in the opposite
direction (from itemB to itemA)
</p>
+
<a NAME="AssociationItem.__calculateEndingPoints_topToBottom" ID="AssociationItem.__calculateEndingPoints_topToBottom"></a>
<h4>AssociationItem.__calculateEndingPoints_topToBottom</h4>
<b>__calculateEndingPoints_topToBottom</b>(<i></i>)
-
<p>
Private method to calculate the ending points of the association item.
</p>
@@ -292,10 +288,10 @@
The ending points are calculated from the top center of the lower item
to the bottom center of the upper item.
</p>
+
<a NAME="AssociationItem.__findIntersection" ID="AssociationItem.__findIntersection"></a>
<h4>AssociationItem.__findIntersection</h4>
<b>__findIntersection</b>(<i>p1, p2, p3, p4</i>)
-
<p>
Private method to calculate the intersection point of two lines.
</p>
@@ -322,6 +318,7 @@
In order for the linear function calculations to work in this method
we must switch x and y values (x values become y values and viceversa)
</p>
+
<dl>
<dt><i>p1</i> (QPointF)</dt>
@@ -356,11 +353,11 @@
<a NAME="AssociationItem.__findPointRegion" ID="AssociationItem.__findPointRegion"></a>
<h4>AssociationItem.__findPointRegion</h4>
<b>__findPointRegion</b>(<i>rect, posX, posY</i>)
-
<p>
Private method to find out, which region of rectangle rect contains
the point (PosX, PosY) and returns the region number.
</p>
+
<dl>
<dt><i>rect</i> (QRectF)</dt>
@@ -400,11 +397,11 @@
<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 intersection point of a line with a
rectangle.
</p>
+
<dl>
<dt><i>item</i> (UMLItem)</dt>
@@ -435,11 +432,11 @@
<a NAME="AssociationItem.__mapRectFromItem" ID="AssociationItem.__mapRectFromItem"></a>
<h4>AssociationItem.__mapRectFromItem</h4>
<b>__mapRectFromItem</b>(<i>item</i>)
-
<p>
Private method to map item's rectangle to this item's coordinate
system.
</p>
+
<dl>
<dt><i>item</i> (QGraphicsRectItem)</dt>
@@ -462,10 +459,10 @@
<a NAME="AssociationItem.__updateEndPoint" ID="AssociationItem.__updateEndPoint"></a>
<h4>AssociationItem.__updateEndPoint</h4>
<b>__updateEndPoint</b>(<i>region, isWidgetA</i>)
-
<p>
Private method to update an endpoint.
</p>
+
<dl>
<dt><i>region</i> (AssociationPointRegion)</dt>
@@ -480,10 +477,10 @@
<a NAME="AssociationItem.toDict" ID="AssociationItem.toDict"></a>
<h4>AssociationItem.toDict</h4>
<b>toDict</b>(<i></i>)
-
<p>
Public method to collect data to be persisted.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -499,81 +496,92 @@
<a NAME="AssociationItem.unassociate" ID="AssociationItem.unassociate"></a>
<h4>AssociationItem.unassociate</h4>
<b>unassociate</b>(<i></i>)
-
<p>
Public method to unassociate from the widgets.
</p>
+
<a NAME="AssociationItem.widgetMoved" ID="AssociationItem.widgetMoved"></a>
<h4>AssociationItem.widgetMoved</h4>
<b>widgetMoved</b>(<i></i>)
-
<p>
Public method to recalculate the association after a widget was moved.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="AssociationPointRegion" ID="AssociationPointRegion"></a>
<h2>AssociationPointRegion</h2>
-
<p>
Class defining the regions for an association end point.
</p>
+
<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
+<table>
+<tr><td>CENTER</td></tr>
+<tr><td>EAST</td></tr>
+<tr><td>NORTH</td></tr>
+<tr><td>NORTH_EAST</td></tr>
+<tr><td>NORTH_WEST</td></tr>
+<tr><td>NO_REGION</td></tr>
+<tr><td>SOUTH</td></tr>
+<tr><td>SOUTH_EAST</td></tr>
+<tr><td>SOUTH_WEST</td></tr>
+<tr><td>WEST</td></tr>
+</table>
-<table>
-<tr><td>CENTER</td></tr><tr><td>EAST</td></tr><tr><td>NORTH</td></tr><tr><td>NORTH_EAST</td></tr><tr><td>NORTH_WEST</td></tr><tr><td>NO_REGION</td></tr><tr><td>SOUTH</td></tr><tr><td>SOUTH_EAST</td></tr><tr><td>SOUTH_WEST</td></tr><tr><td>WEST</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="AssociationType" ID="AssociationType"></a>
<h2>AssociationType</h2>
-
<p>
Class defining the association types.
</p>
+
<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
-
<table>
-<tr><td>GENERALISATION</td></tr><tr><td>IMPORTS</td></tr><tr><td>NORMAL</td></tr>
+<tr><td>GENERALISATION</td></tr>
+<tr><td>IMPORTS</td></tr>
+<tr><td>NORMAL</td></tr>
</table>
-<h3>Class Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Methods</h3>
-
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Static Methods</h3>
-
+<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
+<h3>Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
