Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Graphics.SvgDiagram.html
src/eric7/Documentation/Source/eric7.Graphics.SvgDiagram.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Graphics.SvgDiagram</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Graphics.SvgDiagram</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog showing a SVG graphic. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#SvgDiagram">SvgDiagram</a></td> | |
| 25 <td>Class implementing a dialog showing a SVG graphic.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="SvgDiagram" ID="SvgDiagram"></a> | |
| 36 <h2>SvgDiagram</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog showing a SVG graphic. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 EricMainWindow | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>ZoomLevelDefault</td></tr><tr><td>ZoomLevels</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#SvgDiagram.__init__">SvgDiagram</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#SvgDiagram.__adjustScrollBar">__adjustScrollBar</a></td> | |
| 63 <td>Private method to adjust a scrollbar by a certain factor.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#SvgDiagram.__doZoom">__doZoom</a></td> | |
| 67 <td>Private method to set the zoom value in percent.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#SvgDiagram.__initActions">__initActions</a></td> | |
| 71 <td>Private method to initialize the view actions.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#SvgDiagram.__initContextMenu">__initContextMenu</a></td> | |
| 75 <td>Private method to initialize the context menu.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#SvgDiagram.__initToolBars">__initToolBars</a></td> | |
| 79 <td>Private method to populate the toolbars with our actions.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#SvgDiagram.__levelForZoom">__levelForZoom</a></td> | |
| 83 <td>Private method determining the zoom level index given a zoom factor.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#SvgDiagram.__print">__print</a></td> | |
| 87 <td>Private slot to the actual printing.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#SvgDiagram.__printDiagram">__printDiagram</a></td> | |
| 91 <td>Private slot called to print the diagram.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#SvgDiagram.__printPreviewDiagram">__printPreviewDiagram</a></td> | |
| 95 <td>Private slot called to show a print preview of the diagram.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#SvgDiagram.__showContextMenu">__showContextMenu</a></td> | |
| 99 <td>Private slot to show the context menu of the listview.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#SvgDiagram.__zoom">__zoom</a></td> | |
| 103 <td>Private method to get the current zoom factor in percent.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#SvgDiagram.__zoomIn">__zoomIn</a></td> | |
| 107 <td>Private method to zoom into the SVG.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#SvgDiagram.__zoomOut">__zoomOut</a></td> | |
| 111 <td>Private method to zoom out of the SVG.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#SvgDiagram.__zoomReset">__zoomReset</a></td> | |
| 115 <td>Private method to reset the zoom value.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#SvgDiagram.event">event</a></td> | |
| 119 <td>Public method handling events.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#SvgDiagram.gestureEvent">gestureEvent</a></td> | |
| 123 <td>Protected method handling gesture events.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#SvgDiagram.getDiagramName">getDiagramName</a></td> | |
| 127 <td>Public method to retrieve a name for the diagram.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#SvgDiagram.wheelEvent">wheelEvent</a></td> | |
| 131 <td>Protected method to handle wheel events.</td> | |
| 132 </tr> | |
| 133 </table> | |
| 134 <h3>Static Methods</h3> | |
| 135 | |
| 136 <table> | |
| 137 <tr><td>None</td></tr> | |
| 138 </table> | |
| 139 | |
| 140 <a NAME="SvgDiagram.__init__" ID="SvgDiagram.__init__"></a> | |
| 141 <h4>SvgDiagram (Constructor)</h4> | |
| 142 <b>SvgDiagram</b>(<i>svgFile, parent=None, name=None</i>) | |
| 143 | |
| 144 <p> | |
| 145 Constructor | |
| 146 </p> | |
| 147 <dl> | |
| 148 | |
| 149 <dt><i>svgFile</i> (str)</dt> | |
| 150 <dd> | |
| 151 filename of a SVG graphics file to show | |
| 152 </dd> | |
| 153 <dt><i>parent</i> (QWidget)</dt> | |
| 154 <dd> | |
| 155 parent widget of the view | |
| 156 </dd> | |
| 157 <dt><i>name</i> (str)</dt> | |
| 158 <dd> | |
| 159 name of the view widget | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <a NAME="SvgDiagram.__adjustScrollBar" ID="SvgDiagram.__adjustScrollBar"></a> | |
| 163 <h4>SvgDiagram.__adjustScrollBar</h4> | |
| 164 <b>__adjustScrollBar</b>(<i>scrollBar, factor</i>) | |
| 165 | |
| 166 <p> | |
| 167 Private method to adjust a scrollbar by a certain factor. | |
| 168 </p> | |
| 169 <dl> | |
| 170 | |
| 171 <dt><i>scrollBar</i> (QScrollBar)</dt> | |
| 172 <dd> | |
| 173 reference to the scrollbar object | |
| 174 </dd> | |
| 175 <dt><i>factor</i> (float)</dt> | |
| 176 <dd> | |
| 177 factor to adjust by | |
| 178 </dd> | |
| 179 </dl> | |
| 180 <a NAME="SvgDiagram.__doZoom" ID="SvgDiagram.__doZoom"></a> | |
| 181 <h4>SvgDiagram.__doZoom</h4> | |
| 182 <b>__doZoom</b>(<i>value</i>) | |
| 183 | |
| 184 <p> | |
| 185 Private method to set the zoom value in percent. | |
| 186 </p> | |
| 187 <dl> | |
| 188 | |
| 189 <dt><i>value</i> (int)</dt> | |
| 190 <dd> | |
| 191 zoom value in percent | |
| 192 </dd> | |
| 193 </dl> | |
| 194 <a NAME="SvgDiagram.__initActions" ID="SvgDiagram.__initActions"></a> | |
| 195 <h4>SvgDiagram.__initActions</h4> | |
| 196 <b>__initActions</b>(<i></i>) | |
| 197 | |
| 198 <p> | |
| 199 Private method to initialize the view actions. | |
| 200 </p> | |
| 201 <a NAME="SvgDiagram.__initContextMenu" ID="SvgDiagram.__initContextMenu"></a> | |
| 202 <h4>SvgDiagram.__initContextMenu</h4> | |
| 203 <b>__initContextMenu</b>(<i></i>) | |
| 204 | |
| 205 <p> | |
| 206 Private method to initialize the context menu. | |
| 207 </p> | |
| 208 <a NAME="SvgDiagram.__initToolBars" ID="SvgDiagram.__initToolBars"></a> | |
| 209 <h4>SvgDiagram.__initToolBars</h4> | |
| 210 <b>__initToolBars</b>(<i></i>) | |
| 211 | |
| 212 <p> | |
| 213 Private method to populate the toolbars with our actions. | |
| 214 </p> | |
| 215 <a NAME="SvgDiagram.__levelForZoom" ID="SvgDiagram.__levelForZoom"></a> | |
| 216 <h4>SvgDiagram.__levelForZoom</h4> | |
| 217 <b>__levelForZoom</b>(<i>zoom</i>) | |
| 218 | |
| 219 <p> | |
| 220 Private method determining the zoom level index given a zoom factor. | |
| 221 </p> | |
| 222 <dl> | |
| 223 | |
| 224 <dt><i>zoom</i> (int)</dt> | |
| 225 <dd> | |
| 226 zoom factor | |
| 227 </dd> | |
| 228 </dl> | |
| 229 <dl> | |
| 230 <dt>Return:</dt> | |
| 231 <dd> | |
| 232 index of zoom factor | |
| 233 </dd> | |
| 234 </dl> | |
| 235 <dl> | |
| 236 <dt>Return Type:</dt> | |
| 237 <dd> | |
| 238 int | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <a NAME="SvgDiagram.__print" ID="SvgDiagram.__print"></a> | |
| 242 <h4>SvgDiagram.__print</h4> | |
| 243 <b>__print</b>(<i>printer</i>) | |
| 244 | |
| 245 <p> | |
| 246 Private slot to the actual printing. | |
| 247 </p> | |
| 248 <dl> | |
| 249 | |
| 250 <dt><i>printer</i> (QPrinter)</dt> | |
| 251 <dd> | |
| 252 reference to the printer object | |
| 253 </dd> | |
| 254 </dl> | |
| 255 <a NAME="SvgDiagram.__printDiagram" ID="SvgDiagram.__printDiagram"></a> | |
| 256 <h4>SvgDiagram.__printDiagram</h4> | |
| 257 <b>__printDiagram</b>(<i></i>) | |
| 258 | |
| 259 <p> | |
| 260 Private slot called to print the diagram. | |
| 261 </p> | |
| 262 <a NAME="SvgDiagram.__printPreviewDiagram" ID="SvgDiagram.__printPreviewDiagram"></a> | |
| 263 <h4>SvgDiagram.__printPreviewDiagram</h4> | |
| 264 <b>__printPreviewDiagram</b>(<i></i>) | |
| 265 | |
| 266 <p> | |
| 267 Private slot called to show a print preview of the diagram. | |
| 268 </p> | |
| 269 <a NAME="SvgDiagram.__showContextMenu" ID="SvgDiagram.__showContextMenu"></a> | |
| 270 <h4>SvgDiagram.__showContextMenu</h4> | |
| 271 <b>__showContextMenu</b>(<i>coord</i>) | |
| 272 | |
| 273 <p> | |
| 274 Private slot to show the context menu of the listview. | |
| 275 </p> | |
| 276 <dl> | |
| 277 | |
| 278 <dt><i>coord</i> (QPoint)</dt> | |
| 279 <dd> | |
| 280 the position of the mouse pointer | |
| 281 </dd> | |
| 282 </dl> | |
| 283 <a NAME="SvgDiagram.__zoom" ID="SvgDiagram.__zoom"></a> | |
| 284 <h4>SvgDiagram.__zoom</h4> | |
| 285 <b>__zoom</b>(<i></i>) | |
| 286 | |
| 287 <p> | |
| 288 Private method to get the current zoom factor in percent. | |
| 289 </p> | |
| 290 <dl> | |
| 291 <dt>Return:</dt> | |
| 292 <dd> | |
| 293 current zoom factor in percent | |
| 294 </dd> | |
| 295 </dl> | |
| 296 <dl> | |
| 297 <dt>Return Type:</dt> | |
| 298 <dd> | |
| 299 int | |
| 300 </dd> | |
| 301 </dl> | |
| 302 <a NAME="SvgDiagram.__zoomIn" ID="SvgDiagram.__zoomIn"></a> | |
| 303 <h4>SvgDiagram.__zoomIn</h4> | |
| 304 <b>__zoomIn</b>(<i></i>) | |
| 305 | |
| 306 <p> | |
| 307 Private method to zoom into the SVG. | |
| 308 </p> | |
| 309 <a NAME="SvgDiagram.__zoomOut" ID="SvgDiagram.__zoomOut"></a> | |
| 310 <h4>SvgDiagram.__zoomOut</h4> | |
| 311 <b>__zoomOut</b>(<i></i>) | |
| 312 | |
| 313 <p> | |
| 314 Private method to zoom out of the SVG. | |
| 315 </p> | |
| 316 <a NAME="SvgDiagram.__zoomReset" ID="SvgDiagram.__zoomReset"></a> | |
| 317 <h4>SvgDiagram.__zoomReset</h4> | |
| 318 <b>__zoomReset</b>(<i></i>) | |
| 319 | |
| 320 <p> | |
| 321 Private method to reset the zoom value. | |
| 322 </p> | |
| 323 <a NAME="SvgDiagram.event" ID="SvgDiagram.event"></a> | |
| 324 <h4>SvgDiagram.event</h4> | |
| 325 <b>event</b>(<i>evt</i>) | |
| 326 | |
| 327 <p> | |
| 328 Public method handling events. | |
| 329 </p> | |
| 330 <dl> | |
| 331 | |
| 332 <dt><i>evt</i> (QEvent)</dt> | |
| 333 <dd> | |
| 334 reference to the event | |
| 335 </dd> | |
| 336 </dl> | |
| 337 <dl> | |
| 338 <dt>Return:</dt> | |
| 339 <dd> | |
| 340 flag indicating, if the event was handled | |
| 341 </dd> | |
| 342 </dl> | |
| 343 <dl> | |
| 344 <dt>Return Type:</dt> | |
| 345 <dd> | |
| 346 bool | |
| 347 </dd> | |
| 348 </dl> | |
| 349 <a NAME="SvgDiagram.gestureEvent" ID="SvgDiagram.gestureEvent"></a> | |
| 350 <h4>SvgDiagram.gestureEvent</h4> | |
| 351 <b>gestureEvent</b>(<i>evt</i>) | |
| 352 | |
| 353 <p> | |
| 354 Protected method handling gesture events. | |
| 355 </p> | |
| 356 <dl> | |
| 357 | |
| 358 <dt><i>evt</i> (QGestureEvent)</dt> | |
| 359 <dd> | |
| 360 reference to the gesture event | |
| 361 </dd> | |
| 362 </dl> | |
| 363 <a NAME="SvgDiagram.getDiagramName" ID="SvgDiagram.getDiagramName"></a> | |
| 364 <h4>SvgDiagram.getDiagramName</h4> | |
| 365 <b>getDiagramName</b>(<i></i>) | |
| 366 | |
| 367 <p> | |
| 368 Public method to retrieve a name for the diagram. | |
| 369 </p> | |
| 370 <dl> | |
| 371 <dt>Return:</dt> | |
| 372 <dd> | |
| 373 name for the diagram | |
| 374 </dd> | |
| 375 </dl> | |
| 376 <dl> | |
| 377 <dt>Return Type:</dt> | |
| 378 <dd> | |
| 379 str | |
| 380 </dd> | |
| 381 </dl> | |
| 382 <a NAME="SvgDiagram.wheelEvent" ID="SvgDiagram.wheelEvent"></a> | |
| 383 <h4>SvgDiagram.wheelEvent</h4> | |
| 384 <b>wheelEvent</b>(<i>evt</i>) | |
| 385 | |
| 386 <p> | |
| 387 Protected method to handle wheel events. | |
| 388 </p> | |
| 389 <dl> | |
| 390 | |
| 391 <dt><i>evt</i> (QWheelEvent)</dt> | |
| 392 <dd> | |
| 393 reference to the wheel event | |
| 394 </dd> | |
| 395 </dl> | |
| 396 <div align="right"><a href="#top">Up</a></div> | |
| 397 <hr /> | |
| 398 </body></html> |
