eric6/Documentation/Source/eric6.Graphics.UMLGraphicsView.html

changeset 8289
871b40c5a77a
parent 7989
a21d673a8f99
child 8294
cb4e5bbf3a2c
--- a/eric6/Documentation/Source/eric6.Graphics.UMLGraphicsView.html	Tue May 04 19:30:25 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Graphics.UMLGraphicsView.html	Tue May 04 20:03:40 2021 +0200
@@ -225,13 +225,13 @@
 </p>
 <dl>
 
-<dt><i>scene</i></dt>
+<dt><i>scene</i> (QGraphicsScene)</dt>
 <dd>
-reference to the scene object (QGraphicsScene)
+reference to the scene object
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget of the view (QWidget)
+parent widget of the view
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.__alignShapes" ID="UMLGraphicsView.__alignShapes"></a>
@@ -243,9 +243,9 @@
 </p>
 <dl>
 
-<dt><i>alignment</i></dt>
+<dt><i>alignment</i> (Qt.AlignmentFlag)</dt>
 <dd>
-alignment type (Qt.AlignmentFlag)
+alignment type
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.__checkSizeActions" ID="UMLGraphicsView.__checkSizeActions"></a>
@@ -306,15 +306,21 @@
 </p>
 <dl>
 
-<dt><i>items</i></dt>
+<dt><i>items</i> (list of UMLItem)</dt>
 <dd>
-list of items to operate on (list of UMLItem)
+list of items to operate on
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-bounding rectangle (QRectF)
+bounding rectangle
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QRectF
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.__printPreviewPrint" ID="UMLGraphicsView.__printPreviewPrint"></a>
@@ -326,9 +332,9 @@
 </p>
 <dl>
 
-<dt><i>printer</i></dt>
+<dt><i>printer</i> (QPrinter)</dt>
 <dd>
-reference to the printer object (QPrinter)
+reference to the printer object
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.__relayout" ID="UMLGraphicsView.__relayout"></a>
@@ -354,9 +360,9 @@
 </p>
 <dl>
 
-<dt><i>areas</i></dt>
+<dt><i>areas</i> (list of QRectF)</dt>
 <dd>
-list of rectangles that contain changes (list of QRectF)
+list of rectangles that contain changes
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.__setSize" ID="UMLGraphicsView.__setSize"></a>
@@ -375,10 +381,10 @@
 </p>
 <dl>
 
-<dt><i>limit</i></dt>
+<dt><i>limit</i> (bool)</dt>
 <dd>
 flag indicating to limit the scene to the
-            initial size (boolean)
+            initial size
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.event" ID="UMLGraphicsView.event"></a>
@@ -390,15 +396,21 @@
 </p>
 <dl>
 
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QEvent)</dt>
 <dd>
-reference to the event (QEvent)
+reference to the event
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating, if the event was handled (boolean)
+flag indicating, if the event was handled
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.filteredItems" ID="UMLGraphicsView.filteredItems"></a>
@@ -410,20 +422,25 @@
 </p>
 <dl>
 
-<dt><i>items</i></dt>
+<dt><i>items</i> (QGraphicsItem)</dt>
 <dd>
 list of items as returned by the scene object
-            (QGraphicsItem)
 </dd>
-<dt><i>itemType</i></dt>
+<dt><i>itemType</i> (class)</dt>
 <dd>
-type to be filtered (class)
+type to be filtered
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of interesting collision items (QGraphicsItem)
+list of interesting collision items
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QGraphicsItem
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.findItem" ID="UMLGraphicsView.findItem"></a>
@@ -435,15 +452,21 @@
 </p>
 <dl>
 
-<dt><i>itemId</i></dt>
+<dt><i>itemId</i> (int)</dt>
 <dd>
-of the item to search for (integer)
+of the item to search for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-item found (UMLItem) or None
+item found or None
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+UMLItem
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.findItemByName" ID="UMLGraphicsView.findItemByName"></a>
@@ -455,15 +478,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name to look for (string)
+name to look for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-item found (UMLItem) or None
+item found or None
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+UMLItem
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.gestureEvent" ID="UMLGraphicsView.gestureEvent"></a>
@@ -475,9 +504,9 @@
 </p>
 <dl>
 
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QGestureEvent)</dt>
 <dd>
-reference to the gesture event (QGestureEvent
+reference to the gesture event
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.getItemId" ID="UMLGraphicsView.getItemId"></a>
@@ -490,7 +519,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-item ID (integer)
+item ID
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.getPersistenceData" ID="UMLGraphicsView.getPersistenceData"></a>
@@ -503,7 +538,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of data to be persisted (list of strings)
+list of data to be persisted
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.initToolBar" ID="UMLGraphicsView.initToolBar"></a>
@@ -516,7 +557,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-the populated toolBar (QToolBar)
+the populated toolBar
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QToolBar
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.keyPressEvent" ID="UMLGraphicsView.keyPressEvent"></a>
@@ -528,9 +575,9 @@
 </p>
 <dl>
 
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QKeyEvent)</dt>
 <dd>
-reference to the key event (QKeyEvent)
+reference to the key event
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.parsePersistenceData" ID="UMLGraphicsView.parsePersistenceData"></a>
@@ -542,20 +589,26 @@
 </p>
 <dl>
 
-<dt><i>version</i></dt>
+<dt><i>version</i> (str)</dt>
 <dd>
-version of the data (string)
+version of the data
 </dd>
-<dt><i>data</i></dt>
+<dt><i>data</i> (list of str)</dt>
 <dd>
-persisted data to be parsed (list of string)
+persisted data to be parsed
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 tuple of flag indicating success (boolean) and faulty line
-            number (integer)
+            number
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.printDiagram" ID="UMLGraphicsView.printDiagram"></a>
@@ -588,9 +641,9 @@
 </p>
 <dl>
 
-<dt><i>item</i></dt>
+<dt><i>item</i> (QGraphicsItemItem)</dt>
 <dd>
-item to be selected (QGraphicsItemItem)
+item to be selected
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.selectItems" ID="UMLGraphicsView.selectItems"></a>
@@ -602,9 +655,9 @@
 </p>
 <dl>
 
-<dt><i>items</i></dt>
+<dt><i>items</i> (list of QGraphicsItemItem)</dt>
 <dd>
-list of items to be selected (list of QGraphicsItemItem)
+list of items to be selected
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.setDiagramName" ID="UMLGraphicsView.setDiagramName"></a>
@@ -616,9 +669,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-diagram name (string)
+diagram name
 </dd>
 </dl>
 <a NAME="UMLGraphicsView.wheelEvent" ID="UMLGraphicsView.wheelEvent"></a>
@@ -630,9 +683,9 @@
 </p>
 <dl>
 
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QWheelEvent)</dt>
 <dd>
-reference to the wheel event (QWheelEvent)
+reference to the wheel event
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial