--- a/src/eric7/Documentation/Source/eric7.Graphics.UMLGraphicsView.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Graphics.UMLGraphicsView.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Graphics.UMLGraphicsView</h1>
-
<p>
Module implementing a subclass of EricGraphicsView for our diagrams.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#UMLGraphicsView">UMLGraphicsView</a></td>
<td>Class implementing a specialized EricGraphicsView for our diagrams.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="UMLGraphicsView" ID="UMLGraphicsView"></a>
<h2>UMLGraphicsView</h2>
-
<p>
Class implementing a specialized EricGraphicsView for our diagrams.
</p>
+
<h3>Signals</h3>
<dl>
@@ -50,19 +49,17 @@
<h3>Derived from</h3>
EricGraphicsView
<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="#UMLGraphicsView.__init__">UMLGraphicsView</a></td>
<td>Constructor</td>
@@ -204,19 +201,20 @@
<td>Protected method to handle wheel events.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="UMLGraphicsView.__init__" ID="UMLGraphicsView.__init__"></a>
<h4>UMLGraphicsView (Constructor)</h4>
<b>UMLGraphicsView</b>(<i>scene, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>scene</i> (QGraphicsScene)</dt>
@@ -231,10 +229,10 @@
<a NAME="UMLGraphicsView.__alignShapes" ID="UMLGraphicsView.__alignShapes"></a>
<h4>UMLGraphicsView.__alignShapes</h4>
<b>__alignShapes</b>(<i>alignment</i>)
-
<p>
Private slot to align the selected shapes.
</p>
+
<dl>
<dt><i>alignment</i> (Qt.AlignmentFlag)</dt>
@@ -245,59 +243,59 @@
<a NAME="UMLGraphicsView.__checkSizeActions" ID="UMLGraphicsView.__checkSizeActions"></a>
<h4>UMLGraphicsView.__checkSizeActions</h4>
<b>__checkSizeActions</b>(<i></i>)
-
<p>
Private slot to set the enabled state of the size actions.
</p>
+
<a NAME="UMLGraphicsView.__decHeight" ID="UMLGraphicsView.__decHeight"></a>
<h4>UMLGraphicsView.__decHeight</h4>
<b>__decHeight</b>(<i></i>)
-
<p>
Private method to handle the decrease height context menu entry.
</p>
+
<a NAME="UMLGraphicsView.__decWidth" ID="UMLGraphicsView.__decWidth"></a>
<h4>UMLGraphicsView.__decWidth</h4>
<b>__decWidth</b>(<i></i>)
-
<p>
Private method to handle the decrease width context menu entry.
</p>
+
<a NAME="UMLGraphicsView.__deleteShape" ID="UMLGraphicsView.__deleteShape"></a>
<h4>UMLGraphicsView.__deleteShape</h4>
<b>__deleteShape</b>(<i></i>)
-
<p>
Private method to delete the selected shapes from the display.
</p>
+
<a NAME="UMLGraphicsView.__incHeight" ID="UMLGraphicsView.__incHeight"></a>
<h4>UMLGraphicsView.__incHeight</h4>
<b>__incHeight</b>(<i></i>)
-
<p>
Private method to handle the increase height context menu entry.
</p>
+
<a NAME="UMLGraphicsView.__incWidth" ID="UMLGraphicsView.__incWidth"></a>
<h4>UMLGraphicsView.__incWidth</h4>
<b>__incWidth</b>(<i></i>)
-
<p>
Private method to handle the increase width context menu entry.
</p>
+
<a NAME="UMLGraphicsView.__initActions" ID="UMLGraphicsView.__initActions"></a>
<h4>UMLGraphicsView.__initActions</h4>
<b>__initActions</b>(<i></i>)
-
<p>
Private method to initialize the view actions.
</p>
+
<a NAME="UMLGraphicsView.__itemsBoundingRect" ID="UMLGraphicsView.__itemsBoundingRect"></a>
<h4>UMLGraphicsView.__itemsBoundingRect</h4>
<b>__itemsBoundingRect</b>(<i>items</i>)
-
<p>
Private method to calculate the bounding rectangle of the given items.
</p>
+
<dl>
<dt><i>items</i> (list of UMLItem)</dt>
@@ -320,10 +318,10 @@
<a NAME="UMLGraphicsView.__printPreviewPrint" ID="UMLGraphicsView.__printPreviewPrint"></a>
<h4>UMLGraphicsView.__printPreviewPrint</h4>
<b>__printPreviewPrint</b>(<i>printer</i>)
-
<p>
Private slot to generate a print preview.
</p>
+
<dl>
<dt><i>printer</i> (QPrinter)</dt>
@@ -334,24 +332,24 @@
<a NAME="UMLGraphicsView.__relayout" ID="UMLGraphicsView.__relayout"></a>
<h4>UMLGraphicsView.__relayout</h4>
<b>__relayout</b>(<i></i>)
-
<p>
Private slot to handle the re-layout context menu entry.
</p>
+
<a NAME="UMLGraphicsView.__rescan" ID="UMLGraphicsView.__rescan"></a>
<h4>UMLGraphicsView.__rescan</h4>
<b>__rescan</b>(<i></i>)
-
<p>
Private slot to handle the re-scan context menu entry.
</p>
+
<a NAME="UMLGraphicsView.__sceneChanged" ID="UMLGraphicsView.__sceneChanged"></a>
<h4>UMLGraphicsView.__sceneChanged</h4>
<b>__sceneChanged</b>(<i>areas</i>)
-
<p>
Private slot called when the scene changes.
</p>
+
<dl>
<dt><i>areas</i> (list of QRectF)</dt>
@@ -362,17 +360,17 @@
<a NAME="UMLGraphicsView.__setSize" ID="UMLGraphicsView.__setSize"></a>
<h4>UMLGraphicsView.__setSize</h4>
<b>__setSize</b>(<i></i>)
-
<p>
Private method to handle the set size context menu entry.
</p>
+
<a NAME="UMLGraphicsView.autoAdjustSceneSize" ID="UMLGraphicsView.autoAdjustSceneSize"></a>
<h4>UMLGraphicsView.autoAdjustSceneSize</h4>
<b>autoAdjustSceneSize</b>(<i>limit=False</i>)
-
<p>
Public method to adjust the scene size to the diagram size.
</p>
+
<dl>
<dt><i>limit</i> (bool)</dt>
@@ -384,10 +382,10 @@
<a NAME="UMLGraphicsView.event" ID="UMLGraphicsView.event"></a>
<h4>UMLGraphicsView.event</h4>
<b>event</b>(<i>evt</i>)
-
<p>
Public method handling events.
</p>
+
<dl>
<dt><i>evt</i> (QEvent)</dt>
@@ -410,10 +408,10 @@
<a NAME="UMLGraphicsView.filteredItems" ID="UMLGraphicsView.filteredItems"></a>
<h4>UMLGraphicsView.filteredItems</h4>
<b>filteredItems</b>(<i>items, itemType=UMLItem</i>)
-
<p>
Public method to filter a list of items.
</p>
+
<dl>
<dt><i>items</i> (QGraphicsItem)</dt>
@@ -440,10 +438,10 @@
<a NAME="UMLGraphicsView.findItem" ID="UMLGraphicsView.findItem"></a>
<h4>UMLGraphicsView.findItem</h4>
<b>findItem</b>(<i>itemId</i>)
-
<p>
Public method to find an UML item based on the ID.
</p>
+
<dl>
<dt><i>itemId</i> (int)</dt>
@@ -466,10 +464,10 @@
<a NAME="UMLGraphicsView.findItemByName" ID="UMLGraphicsView.findItemByName"></a>
<h4>UMLGraphicsView.findItemByName</h4>
<b>findItemByName</b>(<i>name</i>)
-
<p>
Public method to find an UML item based on its name.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -492,10 +490,10 @@
<a NAME="UMLGraphicsView.fromDict" ID="UMLGraphicsView.fromDict"></a>
<h4>UMLGraphicsView.fromDict</h4>
<b>fromDict</b>(<i>version, data</i>)
-
<p>
Public method to populate the class with data persisted by 'toDict()'.
</p>
+
<dl>
<dt><i>version</i> (str)</dt>
@@ -522,10 +520,10 @@
<a NAME="UMLGraphicsView.gestureEvent" ID="UMLGraphicsView.gestureEvent"></a>
<h4>UMLGraphicsView.gestureEvent</h4>
<b>gestureEvent</b>(<i>evt</i>)
-
<p>
Protected method handling gesture events.
</p>
+
<dl>
<dt><i>evt</i> (QGestureEvent)</dt>
@@ -536,10 +534,10 @@
<a NAME="UMLGraphicsView.getItemId" ID="UMLGraphicsView.getItemId"></a>
<h4>UMLGraphicsView.getItemId</h4>
<b>getItemId</b>(<i></i>)
-
<p>
Public method to get the ID to be assigned to an item.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -555,10 +553,10 @@
<a NAME="UMLGraphicsView.initToolBar" ID="UMLGraphicsView.initToolBar"></a>
<h4>UMLGraphicsView.initToolBar</h4>
<b>initToolBar</b>(<i></i>)
-
<p>
Public method to populate a toolbar with our actions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -574,10 +572,10 @@
<a NAME="UMLGraphicsView.keyPressEvent" ID="UMLGraphicsView.keyPressEvent"></a>
<h4>UMLGraphicsView.keyPressEvent</h4>
<b>keyPressEvent</b>(<i>evt</i>)
-
<p>
Protected method handling key press events.
</p>
+
<dl>
<dt><i>evt</i> (QKeyEvent)</dt>
@@ -588,10 +586,10 @@
<a NAME="UMLGraphicsView.parsePersistenceData" ID="UMLGraphicsView.parsePersistenceData"></a>
<h4>UMLGraphicsView.parsePersistenceData</h4>
<b>parsePersistenceData</b>(<i>version, data</i>)
-
<p>
Public method to parse persisted data.
</p>
+
<dl>
<dt><i>version</i> (str)</dt>
@@ -619,31 +617,31 @@
<a NAME="UMLGraphicsView.printDiagram" ID="UMLGraphicsView.printDiagram"></a>
<h4>UMLGraphicsView.printDiagram</h4>
<b>printDiagram</b>(<i></i>)
-
<p>
Public slot called to print the diagram.
</p>
+
<a NAME="UMLGraphicsView.printPreviewDiagram" ID="UMLGraphicsView.printPreviewDiagram"></a>
<h4>UMLGraphicsView.printPreviewDiagram</h4>
<b>printPreviewDiagram</b>(<i></i>)
-
<p>
Public slot called to show a print preview of the diagram.
</p>
+
<a NAME="UMLGraphicsView.saveImage" ID="UMLGraphicsView.saveImage"></a>
<h4>UMLGraphicsView.saveImage</h4>
<b>saveImage</b>(<i></i>)
-
<p>
Public method to handle the save context menu entry.
</p>
+
<a NAME="UMLGraphicsView.selectItem" ID="UMLGraphicsView.selectItem"></a>
<h4>UMLGraphicsView.selectItem</h4>
<b>selectItem</b>(<i>item</i>)
-
<p>
Public method to select an item.
</p>
+
<dl>
<dt><i>item</i> (QGraphicsItemItem)</dt>
@@ -654,10 +652,10 @@
<a NAME="UMLGraphicsView.selectItems" ID="UMLGraphicsView.selectItems"></a>
<h4>UMLGraphicsView.selectItems</h4>
<b>selectItems</b>(<i>items</i>)
-
<p>
Public method to select the given items.
</p>
+
<dl>
<dt><i>items</i> (list of QGraphicsItemItem)</dt>
@@ -668,10 +666,10 @@
<a NAME="UMLGraphicsView.setDiagramName" ID="UMLGraphicsView.setDiagramName"></a>
<h4>UMLGraphicsView.setDiagramName</h4>
<b>setDiagramName</b>(<i>name</i>)
-
<p>
Public slot to set the diagram name.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -682,10 +680,10 @@
<a NAME="UMLGraphicsView.setLayoutActionsEnabled" ID="UMLGraphicsView.setLayoutActionsEnabled"></a>
<h4>UMLGraphicsView.setLayoutActionsEnabled</h4>
<b>setLayoutActionsEnabled</b>(<i>enable</i>)
-
<p>
Public method to enable or disable the layout related actions.
</p>
+
<dl>
<dt><i>enable</i> (bool)</dt>
@@ -696,10 +694,10 @@
<a NAME="UMLGraphicsView.toDict" ID="UMLGraphicsView.toDict"></a>
<h4>UMLGraphicsView.toDict</h4>
<b>toDict</b>(<i></i>)
-
<p>
Public method to collect data to be persisted.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -715,10 +713,10 @@
<a NAME="UMLGraphicsView.wheelEvent" ID="UMLGraphicsView.wheelEvent"></a>
<h4>UMLGraphicsView.wheelEvent</h4>
<b>wheelEvent</b>(<i>evt</i>)
-
<p>
Protected method to handle wheel events.
</p>
+
<dl>
<dt><i>evt</i> (QWheelEvent)</dt>
@@ -728,4 +726,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
