Documentation/Source/eric5.Graphics.UMLGraphicsView.html

changeset 2031
c36c2eb62a75
parent 2027
144463496a54
child 2033
4b99609f6a87
equal deleted inserted replaced
2030:db11a2fe9bbc 2031:c36c2eb62a75
99 <td>Private slot called to show a print preview of the diagram.</td> 99 <td>Private slot called to show a print preview of the diagram.</td>
100 </tr><tr> 100 </tr><tr>
101 <td><a href="#UMLGraphicsView.__relayout">__relayout</a></td> 101 <td><a href="#UMLGraphicsView.__relayout">__relayout</a></td>
102 <td>Private method to handle the re-layout context menu entry.</td> 102 <td>Private method to handle the re-layout context menu entry.</td>
103 </tr><tr> 103 </tr><tr>
104 <td><a href="#UMLGraphicsView.__save">__save</a></td>
105 <td>Private slot to save the diagram with the current name.</td>
106 </tr><tr>
107 <td><a href="#UMLGraphicsView.__saveAs">__saveAs</a></td>
108 <td>Private slot to save the diagram.</td>
109 </tr><tr>
104 <td><a href="#UMLGraphicsView.__saveImage">__saveImage</a></td> 110 <td><a href="#UMLGraphicsView.__saveImage">__saveImage</a></td>
105 <td>Private method to handle the save context menu entry.</td> 111 <td>Private method to handle the save context menu entry.</td>
106 </tr><tr> 112 </tr><tr>
107 <td><a href="#UMLGraphicsView.__sceneChanged">__sceneChanged</a></td> 113 <td><a href="#UMLGraphicsView.__sceneChanged">__sceneChanged</a></td>
108 <td>Private slot called when the scene changes.</td> 114 <td>Private slot called when the scene changes.</td>
120 <td>Protected method handling events.</td> 126 <td>Protected method handling events.</td>
121 </tr><tr> 127 </tr><tr>
122 <td><a href="#UMLGraphicsView.filteredItems">filteredItems</a></td> 128 <td><a href="#UMLGraphicsView.filteredItems">filteredItems</a></td>
123 <td>Public method to filter a list of items.</td> 129 <td>Public method to filter a list of items.</td>
124 </tr><tr> 130 </tr><tr>
131 <td><a href="#UMLGraphicsView.findItem">findItem</a></td>
132 <td>Public method to find an UML item based on the ID.</td>
133 </tr><tr>
125 <td><a href="#UMLGraphicsView.gestureEvent">gestureEvent</a></td> 134 <td><a href="#UMLGraphicsView.gestureEvent">gestureEvent</a></td>
126 <td>Protected method handling gesture events.</td> 135 <td>Protected method handling gesture events.</td>
127 </tr><tr> 136 </tr><tr>
137 <td><a href="#UMLGraphicsView.getItemId">getItemId</a></td>
138 <td>Public method to get the ID to be assigned to an item.</td>
139 </tr><tr>
140 <td><a href="#UMLGraphicsView.getPersistenceData">getPersistenceData</a></td>
141 <td>Public method to get the additional persistence data.</td>
142 </tr><tr>
128 <td><a href="#UMLGraphicsView.initToolBar">initToolBar</a></td> 143 <td><a href="#UMLGraphicsView.initToolBar">initToolBar</a></td>
129 <td>Public method to populate a toolbar with our actions.</td> 144 <td>Public method to populate a toolbar with our actions.</td>
130 </tr><tr> 145 </tr><tr>
131 <td><a href="#UMLGraphicsView.selectItem">selectItem</a></td> 146 <td><a href="#UMLGraphicsView.selectItem">selectItem</a></td>
132 <td>Public method to select an item.</td> 147 <td>Public method to select an item.</td>
134 <td><a href="#UMLGraphicsView.selectItems">selectItems</a></td> 149 <td><a href="#UMLGraphicsView.selectItems">selectItems</a></td>
135 <td>Public method to select the given items.</td> 150 <td>Public method to select the given items.</td>
136 </tr><tr> 151 </tr><tr>
137 <td><a href="#UMLGraphicsView.setDiagramName">setDiagramName</a></td> 152 <td><a href="#UMLGraphicsView.setDiagramName">setDiagramName</a></td>
138 <td>Public slot to set the diagram name.</td> 153 <td>Public slot to set the diagram name.</td>
154 </tr><tr>
155 <td><a href="#UMLGraphicsView.setPersistenceData">setPersistenceData</a></td>
156 <td>Public method to set additional persistence data.</td>
139 </tr><tr> 157 </tr><tr>
140 <td><a href="#UMLGraphicsView.wheelEvent">wheelEvent</a></td> 158 <td><a href="#UMLGraphicsView.wheelEvent">wheelEvent</a></td>
141 <td>Protected method to handle wheel events.</td> 159 <td>Protected method to handle wheel events.</td>
142 </tr> 160 </tr>
143 </table> 161 </table>
145 <table> 163 <table>
146 <tr><td>None</td></tr> 164 <tr><td>None</td></tr>
147 </table> 165 </table>
148 <a NAME="UMLGraphicsView.__init__" ID="UMLGraphicsView.__init__"></a> 166 <a NAME="UMLGraphicsView.__init__" ID="UMLGraphicsView.__init__"></a>
149 <h4>UMLGraphicsView (Constructor)</h4> 167 <h4>UMLGraphicsView (Constructor)</h4>
150 <b>UMLGraphicsView</b>(<i>scene, diagramName="Unnamed", parent=None, name=None</i>) 168 <b>UMLGraphicsView</b>(<i>scene, diagramType, parent=None</i>)
151 <p> 169 <p>
152 Constructor 170 Constructor
153 </p><dl> 171 </p><dl>
154 <dt><i>scene</i></dt> 172 <dt><i>scene</i></dt>
155 <dd> 173 <dd>
156 reference to the scene object (QGraphicsScene) 174 reference to the scene object (QGraphicsScene)
157 </dd><dt><i>diagramName</i></dt> 175 </dd><dt><i>diagramType</i></dt>
158 <dd> 176 <dd>
159 name of the diagram (string) 177 type of the diagram (string)
160 </dd><dt><i>parent</i></dt> 178 </dd><dt><i>parent</i></dt>
161 <dd> 179 <dd>
162 parent widget of the view (QWidget) 180 parent widget of the view (QWidget)
163 </dd><dt><i>name</i></dt>
164 <dd>
165 name of the view widget (string)
166 </dd> 181 </dd>
167 </dl><a NAME="UMLGraphicsView.__alignShapes" ID="UMLGraphicsView.__alignShapes"></a> 182 </dl><a NAME="UMLGraphicsView.__alignShapes" ID="UMLGraphicsView.__alignShapes"></a>
168 <h4>UMLGraphicsView.__alignShapes</h4> 183 <h4>UMLGraphicsView.__alignShapes</h4>
169 <b>__alignShapes</b>(<i>alignment</i>) 184 <b>__alignShapes</b>(<i>alignment</i>)
170 <p> 185 <p>
222 </p><a NAME="UMLGraphicsView.__relayout" ID="UMLGraphicsView.__relayout"></a> 237 </p><a NAME="UMLGraphicsView.__relayout" ID="UMLGraphicsView.__relayout"></a>
223 <h4>UMLGraphicsView.__relayout</h4> 238 <h4>UMLGraphicsView.__relayout</h4>
224 <b>__relayout</b>(<i></i>) 239 <b>__relayout</b>(<i></i>)
225 <p> 240 <p>
226 Private method to handle the re-layout context menu entry. 241 Private method to handle the re-layout context menu entry.
227 </p><a NAME="UMLGraphicsView.__saveImage" ID="UMLGraphicsView.__saveImage"></a> 242 </p><a NAME="UMLGraphicsView.__save" ID="UMLGraphicsView.__save"></a>
243 <h4>UMLGraphicsView.__save</h4>
244 <b>__save</b>(<i></i>)
245 <p>
246 Private slot to save the diagram with the current name.
247 </p><a NAME="UMLGraphicsView.__saveAs" ID="UMLGraphicsView.__saveAs"></a>
248 <h4>UMLGraphicsView.__saveAs</h4>
249 <b>__saveAs</b>(<i>filename=""</i>)
250 <p>
251 Private slot to save the diagram.
252 </p><dl>
253 <dt><i>filename</i></dt>
254 <dd>
255 name of the file to write to (string)
256 </dd>
257 </dl><a NAME="UMLGraphicsView.__saveImage" ID="UMLGraphicsView.__saveImage"></a>
228 <h4>UMLGraphicsView.__saveImage</h4> 258 <h4>UMLGraphicsView.__saveImage</h4>
229 <b>__saveImage</b>(<i></i>) 259 <b>__saveImage</b>(<i></i>)
230 <p> 260 <p>
231 Private method to handle the save context menu entry. 261 Private method to handle the save context menu entry.
232 </p><a NAME="UMLGraphicsView.__sceneChanged" ID="UMLGraphicsView.__sceneChanged"></a> 262 </p><a NAME="UMLGraphicsView.__sceneChanged" ID="UMLGraphicsView.__sceneChanged"></a>
275 <dd> 305 <dd>
276 flag indicating, if the event was handled (boolean) 306 flag indicating, if the event was handled (boolean)
277 </dd> 307 </dd>
278 </dl><a NAME="UMLGraphicsView.filteredItems" ID="UMLGraphicsView.filteredItems"></a> 308 </dl><a NAME="UMLGraphicsView.filteredItems" ID="UMLGraphicsView.filteredItems"></a>
279 <h4>UMLGraphicsView.filteredItems</h4> 309 <h4>UMLGraphicsView.filteredItems</h4>
280 <b>filteredItems</b>(<i>items</i>) 310 <b>filteredItems</b>(<i>items, itemType=UMLItem</i>)
281 <p> 311 <p>
282 Public method to filter a list of items. 312 Public method to filter a list of items.
283 </p><dl> 313 </p><dl>
284 <dt><i>items</i></dt> 314 <dt><i>items</i></dt>
285 <dd> 315 <dd>
286 list of items as returned by the scene object 316 list of items as returned by the scene object
287 (QGraphicsItem) 317 (QGraphicsItem)
318 </dd><dt><i>itemType</i></dt>
319 <dd>
320 type to be filtered (class)
288 </dd> 321 </dd>
289 </dl><dl> 322 </dl><dl>
290 <dt>Returns:</dt> 323 <dt>Returns:</dt>
291 <dd> 324 <dd>
292 list of interesting collision items (QGraphicsItem) 325 list of interesting collision items (QGraphicsItem)
326 </dd>
327 </dl><a NAME="UMLGraphicsView.findItem" ID="UMLGraphicsView.findItem"></a>
328 <h4>UMLGraphicsView.findItem</h4>
329 <b>findItem</b>(<i>id</i>)
330 <p>
331 Public method to find an UML item based on the ID.
332 </p><dl>
333 <dt><i>id</i></dt>
334 <dd>
335 of the item to search for (integer)
336 </dd>
337 </dl><dl>
338 <dt>Returns:</dt>
339 <dd>
340 item found (UMLItem) or None
293 </dd> 341 </dd>
294 </dl><a NAME="UMLGraphicsView.gestureEvent" ID="UMLGraphicsView.gestureEvent"></a> 342 </dl><a NAME="UMLGraphicsView.gestureEvent" ID="UMLGraphicsView.gestureEvent"></a>
295 <h4>UMLGraphicsView.gestureEvent</h4> 343 <h4>UMLGraphicsView.gestureEvent</h4>
296 <b>gestureEvent</b>(<i>evt</i>) 344 <b>gestureEvent</b>(<i>evt</i>)
297 <p> 345 <p>
299 </p><dl> 347 </p><dl>
300 <dt><i>evt</i></dt> 348 <dt><i>evt</i></dt>
301 <dd> 349 <dd>
302 reference to the gesture event (QGestureEvent 350 reference to the gesture event (QGestureEvent
303 </dd> 351 </dd>
352 </dl><a NAME="UMLGraphicsView.getItemId" ID="UMLGraphicsView.getItemId"></a>
353 <h4>UMLGraphicsView.getItemId</h4>
354 <b>getItemId</b>(<i></i>)
355 <p>
356 Public method to get the ID to be assigned to an item.
357 </p><dl>
358 <dt>Returns:</dt>
359 <dd>
360 item ID (integer)
361 </dd>
362 </dl><a NAME="UMLGraphicsView.getPersistenceData" ID="UMLGraphicsView.getPersistenceData"></a>
363 <h4>UMLGraphicsView.getPersistenceData</h4>
364 <b>getPersistenceData</b>(<i></i>)
365 <p>
366 Public method to get the additional persistence data.
367 </p><dl>
368 <dt>Returns:</dt>
369 <dd>
370 additional persistence data (string)
371 </dd>
304 </dl><a NAME="UMLGraphicsView.initToolBar" ID="UMLGraphicsView.initToolBar"></a> 372 </dl><a NAME="UMLGraphicsView.initToolBar" ID="UMLGraphicsView.initToolBar"></a>
305 <h4>UMLGraphicsView.initToolBar</h4> 373 <h4>UMLGraphicsView.initToolBar</h4>
306 <b>initToolBar</b>(<i></i>) 374 <b>initToolBar</b>(<i></i>)
307 <p> 375 <p>
308 Public method to populate a toolbar with our actions. 376 Public method to populate a toolbar with our actions.
338 Public slot to set the diagram name. 406 Public slot to set the diagram name.
339 </p><dl> 407 </p><dl>
340 <dt><i>name</i></dt> 408 <dt><i>name</i></dt>
341 <dd> 409 <dd>
342 diagram name (string) 410 diagram name (string)
411 </dd>
412 </dl><a NAME="UMLGraphicsView.setPersistenceData" ID="UMLGraphicsView.setPersistenceData"></a>
413 <h4>UMLGraphicsView.setPersistenceData</h4>
414 <b>setPersistenceData</b>(<i>data</i>)
415 <p>
416 Public method to set additional persistence data.
417 </p><dl>
418 <dt><i>data</i></dt>
419 <dd>
420 string of additional data to be made persistent (string)
343 </dd> 421 </dd>
344 </dl><a NAME="UMLGraphicsView.wheelEvent" ID="UMLGraphicsView.wheelEvent"></a> 422 </dl><a NAME="UMLGraphicsView.wheelEvent" ID="UMLGraphicsView.wheelEvent"></a>
345 <h4>UMLGraphicsView.wheelEvent</h4> 423 <h4>UMLGraphicsView.wheelEvent</h4>
346 <b>wheelEvent</b>(<i>evt</i>) 424 <b>wheelEvent</b>(<i>evt</i>)
347 <p> 425 <p>

eric ide

mercurial