diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.Graphics.UMLGraphicsView.html --- a/Documentation/Source/eric5.Graphics.UMLGraphicsView.html Thu Jan 14 17:27:31 2010 +0000 +++ b/Documentation/Source/eric5.Graphics.UMLGraphicsView.html Thu Jan 14 18:35:52 2010 +0000 @@ -22,7 +22,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.Graphics.UMLGraphicsView</h1> <p> -Module implementing a subclass of E5GraphicsView for our diagrams. +Module implementing a subclass of E5GraphicsView for our diagrams. </p> <h3>Global Attributes</h3> <table> @@ -32,7 +32,7 @@ <table> <tr> <td><a href="#UMLGraphicsView">UMLGraphicsView</a></td> -<td>Class implementing a specialized E5GraphicsView for our diagrams.</td> +<td>Class implementing a specialized E5GraphicsView for our diagrams.</td> </tr> </table> <h3>Functions</h3> @@ -43,13 +43,13 @@ <a NAME="UMLGraphicsView" ID="UMLGraphicsView"></a> <h2>UMLGraphicsView</h2> <p> - Class implementing a specialized E5GraphicsView for our diagrams. + Class implementing a specialized E5GraphicsView for our diagrams. </p><h4>Signals</h4> <dl> <dt>relayout()</dt> <dd> -emitted to indicate a relayout of the diagram - is requested +emitted to indicate a relayout of the diagram + is requested </dd> </dl> <h3>Derived from</h3> @@ -62,228 +62,228 @@ <table> <tr> <td><a href="#UMLGraphicsView.__init__">UMLGraphicsView</a></td> -<td>Constructor</td> +<td>Constructor</td> </tr><tr> <td><a href="#UMLGraphicsView.__alignShapes">__alignShapes</a></td> -<td>Private slot to align the selected shapes.</td> +<td>Private slot to align the selected shapes.</td> </tr><tr> <td><a href="#UMLGraphicsView.__checkSizeActions">__checkSizeActions</a></td> -<td>Private slot to set the enabled state of the size actions.</td> +<td>Private slot to set the enabled state of the size actions.</td> </tr><tr> <td><a href="#UMLGraphicsView.__decHeight">__decHeight</a></td> -<td>Private method to handle the decrease height context menu entry.</td> +<td>Private method to handle the decrease height context menu entry.</td> </tr><tr> <td><a href="#UMLGraphicsView.__decWidth">__decWidth</a></td> -<td>Private method to handle the decrease width context menu entry.</td> +<td>Private method to handle the decrease width context menu entry.</td> </tr><tr> <td><a href="#UMLGraphicsView.__deleteShape">__deleteShape</a></td> -<td>Private method to delete the selected shapes from the display.</td> +<td>Private method to delete the selected shapes from the display.</td> </tr><tr> <td><a href="#UMLGraphicsView.__incHeight">__incHeight</a></td> -<td>Private method to handle the increase height context menu entry.</td> +<td>Private method to handle the increase height context menu entry.</td> </tr><tr> <td><a href="#UMLGraphicsView.__incWidth">__incWidth</a></td> -<td>Private method to handle the increase width context menu entry.</td> +<td>Private method to handle the increase width context menu entry.</td> </tr><tr> <td><a href="#UMLGraphicsView.__initActions">__initActions</a></td> -<td>Private method to initialize the view actions.</td> +<td>Private method to initialize the view actions.</td> </tr><tr> <td><a href="#UMLGraphicsView.__printDiagram">__printDiagram</a></td> -<td>Private slot called to print the diagram.</td> +<td>Private slot called to print the diagram.</td> </tr><tr> <td><a href="#UMLGraphicsView.__printPreviewDiagram">__printPreviewDiagram</a></td> -<td>Private slot called to show a print preview of the diagram.</td> +<td>Private slot called to show a print preview of the diagram.</td> </tr><tr> <td><a href="#UMLGraphicsView.__relayout">__relayout</a></td> -<td>Private method to handle the re-layout context menu entry.</td> +<td>Private method to handle the re-layout context menu entry.</td> </tr><tr> <td><a href="#UMLGraphicsView.__saveImage">__saveImage</a></td> -<td>Private method to handle the save context menu entry.</td> +<td>Private method to handle the save context menu entry.</td> </tr><tr> <td><a href="#UMLGraphicsView.__sceneChanged">__sceneChanged</a></td> -<td>Private slot called when the scene changes.</td> +<td>Private slot called when the scene changes.</td> </tr><tr> <td><a href="#UMLGraphicsView.__setSize">__setSize</a></td> -<td>Private method to handle the set size context menu entry.</td> +<td>Private method to handle the set size context menu entry.</td> </tr><tr> <td><a href="#UMLGraphicsView.__zoom">__zoom</a></td> -<td>Private method to handle the zoom context menu action.</td> +<td>Private method to handle the zoom context menu action.</td> </tr><tr> <td><a href="#UMLGraphicsView.filteredItems">filteredItems</a></td> -<td>Public method to filter a list of items.</td> +<td>Public method to filter a list of items.</td> </tr><tr> <td><a href="#UMLGraphicsView.initToolBar">initToolBar</a></td> -<td>Public method to populate a toolbar with our actions.</td> +<td>Public method to populate a toolbar with our actions.</td> </tr><tr> <td><a href="#UMLGraphicsView.selectItem">selectItem</a></td> -<td>Public method to select an item.</td> +<td>Public method to select an item.</td> </tr><tr> <td><a href="#UMLGraphicsView.selectItems">selectItems</a></td> -<td>Public method to select the given items.</td> +<td>Public method to select the given items.</td> </tr><tr> <td><a href="#UMLGraphicsView.setDiagramName">setDiagramName</a></td> -<td>Public slot to set the diagram name.</td> +<td>Public slot to set the diagram name.</td> </tr> </table> <a NAME="UMLGraphicsView.__init__" ID="UMLGraphicsView.__init__"></a> <h4>UMLGraphicsView (Constructor)</h4> <b>UMLGraphicsView</b>(<i>scene, diagramName = "Unnamed", parent = None, name = None</i>) <p> - Constructor + Constructor </p><dl> <dt><i>scene</i></dt> <dd> -reference to the scene object (QGraphicsScene) +reference to the scene object (QGraphicsScene) </dd><dt><i>diagramName</i></dt> <dd> -name of the diagram (string) +name of the diagram (string) </dd><dt><i>parent</i></dt> <dd> -parent widget of the view (QWidget) +parent widget of the view (QWidget) </dd><dt><i>name</i></dt> <dd> -name of the view widget (string) +name of the view widget (string) </dd> </dl><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. + Private slot to align the selected shapes. </p><dl> <dt><i>alignment</i></dt> <dd> -alignment type (Qt.AlignmentFlag) +alignment type (Qt.AlignmentFlag) </dd> </dl><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. + 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. + 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. + 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. + 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. + 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. + 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. + Private method to initialize the view actions. </p><a NAME="UMLGraphicsView.__printDiagram" ID="UMLGraphicsView.__printDiagram"></a> <h4>UMLGraphicsView.__printDiagram</h4> <b>__printDiagram</b>(<i></i>) <p> - Private slot called to print the diagram. + Private 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> - Private slot called to show a print preview of the diagram. + Private slot called to show a print preview of the diagram. </p><a NAME="UMLGraphicsView.__relayout" ID="UMLGraphicsView.__relayout"></a> <h4>UMLGraphicsView.__relayout</h4> <b>__relayout</b>(<i></i>) <p> - Private method to handle the re-layout context menu entry. + Private method to handle the re-layout context menu entry. </p><a NAME="UMLGraphicsView.__saveImage" ID="UMLGraphicsView.__saveImage"></a> <h4>UMLGraphicsView.__saveImage</h4> <b>__saveImage</b>(<i></i>) <p> - Private method to handle the save context menu entry. + Private method to handle the save 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. + Private slot called when the scene changes. </p><dl> <dt><i>areas</i></dt> <dd> -list of rectangles that contain changes (list of QRectF) +list of rectangles that contain changes (list of QRectF) </dd> </dl><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. + Private method to handle the set size context menu entry. </p><a NAME="UMLGraphicsView.__zoom" ID="UMLGraphicsView.__zoom"></a> <h4>UMLGraphicsView.__zoom</h4> <b>__zoom</b>(<i></i>) <p> - Private method to handle the zoom context menu action. + Private method to handle the zoom context menu action. </p><a NAME="UMLGraphicsView.filteredItems" ID="UMLGraphicsView.filteredItems"></a> <h4>UMLGraphicsView.filteredItems</h4> <b>filteredItems</b>(<i>items</i>) <p> - Public method to filter a list of items. + Public method to filter a list of items. </p><dl> <dt><i>items</i></dt> <dd> -list of items as returned by the scene object - (QGraphicsItem) +list of items as returned by the scene object + (QGraphicsItem) </dd> </dl><dl> <dt>Returns:</dt> <dd> -list of interesting collision items (QGraphicsItem) +list of interesting collision items (QGraphicsItem) </dd> </dl><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. + Public method to populate a toolbar with our actions. </p><dl> <dt>Returns:</dt> <dd> -the populated toolBar (QToolBar) +the populated toolBar (QToolBar) </dd> </dl><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. + Public method to select an item. </p><dl> <dt><i>item</i></dt> <dd> -item to be selected (QGraphicsItemItem) +item to be selected (QGraphicsItemItem) </dd> </dl><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. + Public method to select the given items. </p><dl> <dt><i>items</i></dt> <dd> -list of items to be selected (list of QGraphicsItemItem) +list of items to be selected (list of QGraphicsItemItem) </dd> </dl><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. + Public slot to set the diagram name. </p><dl> <dt><i>name</i></dt> <dd> -diagram name (string) +diagram name (string) </dd> </dl> <div align="right"><a href="#top">Up</a></div>