Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Graphics.PixmapDiagram.html
src/eric7/Documentation/Source/eric7.Graphics.PixmapDiagram.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.PixmapDiagram</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.PixmapDiagram</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog showing a pixmap. | |
| 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="#PixmapDiagram">PixmapDiagram</a></td> | |
| 25 <td>Class implementing a dialog showing a pixmap.</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="PixmapDiagram" ID="PixmapDiagram"></a> | |
| 36 <h2>PixmapDiagram</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog showing a pixmap. | |
| 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="#PixmapDiagram.__init__">PixmapDiagram</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#PixmapDiagram.__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="#PixmapDiagram.__doZoom">__doZoom</a></td> | |
| 67 <td>Private method to set the zoom value in percent.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#PixmapDiagram.__initActions">__initActions</a></td> | |
| 71 <td>Private method to initialize the view actions.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#PixmapDiagram.__initContextMenu">__initContextMenu</a></td> | |
| 75 <td>Private method to initialize the context menu.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#PixmapDiagram.__initToolBars">__initToolBars</a></td> | |
| 79 <td>Private method to populate the toolbars with our actions.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#PixmapDiagram.__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="#PixmapDiagram.__print">__print</a></td> | |
| 87 <td>Private slot to the actual printing.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#PixmapDiagram.__printDiagram">__printDiagram</a></td> | |
| 91 <td>Private slot called to print the diagram.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#PixmapDiagram.__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="#PixmapDiagram.__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="#PixmapDiagram.__showPixmap">__showPixmap</a></td> | |
| 103 <td>Private method to show a file.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#PixmapDiagram.__zoom">__zoom</a></td> | |
| 107 <td>Private method to get the current zoom factor in percent.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#PixmapDiagram.__zoomIn">__zoomIn</a></td> | |
| 111 <td>Private method to zoom into the pixmap.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#PixmapDiagram.__zoomOut">__zoomOut</a></td> | |
| 115 <td>Private method to zoom out of the pixmap.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#PixmapDiagram.__zoomReset">__zoomReset</a></td> | |
| 119 <td>Private method to reset the zoom value.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#PixmapDiagram.event">event</a></td> | |
| 123 <td>Public method handling events.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#PixmapDiagram.gestureEvent">gestureEvent</a></td> | |
| 127 <td>Protected method handling gesture events.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#PixmapDiagram.getDiagramName">getDiagramName</a></td> | |
| 131 <td>Public method to retrieve a name for the diagram.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#PixmapDiagram.getStatus">getStatus</a></td> | |
| 135 <td>Public method to retrieve the status of the canvas.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#PixmapDiagram.wheelEvent">wheelEvent</a></td> | |
| 139 <td>Protected method to handle wheel events.</td> | |
| 140 </tr> | |
| 141 </table> | |
| 142 <h3>Static Methods</h3> | |
| 143 | |
| 144 <table> | |
| 145 <tr><td>None</td></tr> | |
| 146 </table> | |
| 147 | |
| 148 <a NAME="PixmapDiagram.__init__" ID="PixmapDiagram.__init__"></a> | |
| 149 <h4>PixmapDiagram (Constructor)</h4> | |
| 150 <b>PixmapDiagram</b>(<i>pixmap, parent=None, name=None</i>) | |
| 151 | |
| 152 <p> | |
| 153 Constructor | |
| 154 </p> | |
| 155 <dl> | |
| 156 | |
| 157 <dt><i>pixmap</i> (str)</dt> | |
| 158 <dd> | |
| 159 filename of a graphics file to show | |
| 160 </dd> | |
| 161 <dt><i>parent</i> (QWidget)</dt> | |
| 162 <dd> | |
| 163 parent widget of the view | |
| 164 </dd> | |
| 165 <dt><i>name</i> (str)</dt> | |
| 166 <dd> | |
| 167 name of the view widget | |
| 168 </dd> | |
| 169 </dl> | |
| 170 <a NAME="PixmapDiagram.__adjustScrollBar" ID="PixmapDiagram.__adjustScrollBar"></a> | |
| 171 <h4>PixmapDiagram.__adjustScrollBar</h4> | |
| 172 <b>__adjustScrollBar</b>(<i>scrollBar, factor</i>) | |
| 173 | |
| 174 <p> | |
| 175 Private method to adjust a scrollbar by a certain factor. | |
| 176 </p> | |
| 177 <dl> | |
| 178 | |
| 179 <dt><i>scrollBar</i> (QScrollBar)</dt> | |
| 180 <dd> | |
| 181 reference to the scrollbar object | |
| 182 </dd> | |
| 183 <dt><i>factor</i> (float)</dt> | |
| 184 <dd> | |
| 185 factor to adjust by | |
| 186 </dd> | |
| 187 </dl> | |
| 188 <a NAME="PixmapDiagram.__doZoom" ID="PixmapDiagram.__doZoom"></a> | |
| 189 <h4>PixmapDiagram.__doZoom</h4> | |
| 190 <b>__doZoom</b>(<i>value</i>) | |
| 191 | |
| 192 <p> | |
| 193 Private method to set the zoom value in percent. | |
| 194 </p> | |
| 195 <dl> | |
| 196 | |
| 197 <dt><i>value</i> (int)</dt> | |
| 198 <dd> | |
| 199 zoom value in percent | |
| 200 </dd> | |
| 201 </dl> | |
| 202 <a NAME="PixmapDiagram.__initActions" ID="PixmapDiagram.__initActions"></a> | |
| 203 <h4>PixmapDiagram.__initActions</h4> | |
| 204 <b>__initActions</b>(<i></i>) | |
| 205 | |
| 206 <p> | |
| 207 Private method to initialize the view actions. | |
| 208 </p> | |
| 209 <a NAME="PixmapDiagram.__initContextMenu" ID="PixmapDiagram.__initContextMenu"></a> | |
| 210 <h4>PixmapDiagram.__initContextMenu</h4> | |
| 211 <b>__initContextMenu</b>(<i></i>) | |
| 212 | |
| 213 <p> | |
| 214 Private method to initialize the context menu. | |
| 215 </p> | |
| 216 <a NAME="PixmapDiagram.__initToolBars" ID="PixmapDiagram.__initToolBars"></a> | |
| 217 <h4>PixmapDiagram.__initToolBars</h4> | |
| 218 <b>__initToolBars</b>(<i></i>) | |
| 219 | |
| 220 <p> | |
| 221 Private method to populate the toolbars with our actions. | |
| 222 </p> | |
| 223 <a NAME="PixmapDiagram.__levelForZoom" ID="PixmapDiagram.__levelForZoom"></a> | |
| 224 <h4>PixmapDiagram.__levelForZoom</h4> | |
| 225 <b>__levelForZoom</b>(<i>zoom</i>) | |
| 226 | |
| 227 <p> | |
| 228 Private method determining the zoom level index given a zoom factor. | |
| 229 </p> | |
| 230 <dl> | |
| 231 | |
| 232 <dt><i>zoom</i> (int)</dt> | |
| 233 <dd> | |
| 234 zoom factor | |
| 235 </dd> | |
| 236 </dl> | |
| 237 <dl> | |
| 238 <dt>Return:</dt> | |
| 239 <dd> | |
| 240 index of zoom factor | |
| 241 </dd> | |
| 242 </dl> | |
| 243 <dl> | |
| 244 <dt>Return Type:</dt> | |
| 245 <dd> | |
| 246 int | |
| 247 </dd> | |
| 248 </dl> | |
| 249 <a NAME="PixmapDiagram.__print" ID="PixmapDiagram.__print"></a> | |
| 250 <h4>PixmapDiagram.__print</h4> | |
| 251 <b>__print</b>(<i>printer</i>) | |
| 252 | |
| 253 <p> | |
| 254 Private slot to the actual printing. | |
| 255 </p> | |
| 256 <dl> | |
| 257 | |
| 258 <dt><i>printer</i> (QPrinter)</dt> | |
| 259 <dd> | |
| 260 reference to the printer object | |
| 261 </dd> | |
| 262 </dl> | |
| 263 <a NAME="PixmapDiagram.__printDiagram" ID="PixmapDiagram.__printDiagram"></a> | |
| 264 <h4>PixmapDiagram.__printDiagram</h4> | |
| 265 <b>__printDiagram</b>(<i></i>) | |
| 266 | |
| 267 <p> | |
| 268 Private slot called to print the diagram. | |
| 269 </p> | |
| 270 <a NAME="PixmapDiagram.__printPreviewDiagram" ID="PixmapDiagram.__printPreviewDiagram"></a> | |
| 271 <h4>PixmapDiagram.__printPreviewDiagram</h4> | |
| 272 <b>__printPreviewDiagram</b>(<i></i>) | |
| 273 | |
| 274 <p> | |
| 275 Private slot called to show a print preview of the diagram. | |
| 276 </p> | |
| 277 <a NAME="PixmapDiagram.__showContextMenu" ID="PixmapDiagram.__showContextMenu"></a> | |
| 278 <h4>PixmapDiagram.__showContextMenu</h4> | |
| 279 <b>__showContextMenu</b>(<i>coord</i>) | |
| 280 | |
| 281 <p> | |
| 282 Private slot to show the context menu of the listview. | |
| 283 </p> | |
| 284 <dl> | |
| 285 | |
| 286 <dt><i>coord</i> (QPoint)</dt> | |
| 287 <dd> | |
| 288 the position of the mouse pointer | |
| 289 </dd> | |
| 290 </dl> | |
| 291 <a NAME="PixmapDiagram.__showPixmap" ID="PixmapDiagram.__showPixmap"></a> | |
| 292 <h4>PixmapDiagram.__showPixmap</h4> | |
| 293 <b>__showPixmap</b>(<i>filename</i>) | |
| 294 | |
| 295 <p> | |
| 296 Private method to show a file. | |
| 297 </p> | |
| 298 <dl> | |
| 299 | |
| 300 <dt><i>filename</i> (str)</dt> | |
| 301 <dd> | |
| 302 name of the file to be shown | |
| 303 </dd> | |
| 304 </dl> | |
| 305 <dl> | |
| 306 <dt>Return:</dt> | |
| 307 <dd> | |
| 308 flag indicating success | |
| 309 </dd> | |
| 310 </dl> | |
| 311 <dl> | |
| 312 <dt>Return Type:</dt> | |
| 313 <dd> | |
| 314 bool | |
| 315 </dd> | |
| 316 </dl> | |
| 317 <a NAME="PixmapDiagram.__zoom" ID="PixmapDiagram.__zoom"></a> | |
| 318 <h4>PixmapDiagram.__zoom</h4> | |
| 319 <b>__zoom</b>(<i></i>) | |
| 320 | |
| 321 <p> | |
| 322 Private method to get the current zoom factor in percent. | |
| 323 </p> | |
| 324 <dl> | |
| 325 <dt>Return:</dt> | |
| 326 <dd> | |
| 327 current zoom factor in percent | |
| 328 </dd> | |
| 329 </dl> | |
| 330 <dl> | |
| 331 <dt>Return Type:</dt> | |
| 332 <dd> | |
| 333 int | |
| 334 </dd> | |
| 335 </dl> | |
| 336 <a NAME="PixmapDiagram.__zoomIn" ID="PixmapDiagram.__zoomIn"></a> | |
| 337 <h4>PixmapDiagram.__zoomIn</h4> | |
| 338 <b>__zoomIn</b>(<i></i>) | |
| 339 | |
| 340 <p> | |
| 341 Private method to zoom into the pixmap. | |
| 342 </p> | |
| 343 <a NAME="PixmapDiagram.__zoomOut" ID="PixmapDiagram.__zoomOut"></a> | |
| 344 <h4>PixmapDiagram.__zoomOut</h4> | |
| 345 <b>__zoomOut</b>(<i></i>) | |
| 346 | |
| 347 <p> | |
| 348 Private method to zoom out of the pixmap. | |
| 349 </p> | |
| 350 <a NAME="PixmapDiagram.__zoomReset" ID="PixmapDiagram.__zoomReset"></a> | |
| 351 <h4>PixmapDiagram.__zoomReset</h4> | |
| 352 <b>__zoomReset</b>(<i></i>) | |
| 353 | |
| 354 <p> | |
| 355 Private method to reset the zoom value. | |
| 356 </p> | |
| 357 <a NAME="PixmapDiagram.event" ID="PixmapDiagram.event"></a> | |
| 358 <h4>PixmapDiagram.event</h4> | |
| 359 <b>event</b>(<i>evt</i>) | |
| 360 | |
| 361 <p> | |
| 362 Public method handling events. | |
| 363 </p> | |
| 364 <dl> | |
| 365 | |
| 366 <dt><i>evt</i> (QEvent)</dt> | |
| 367 <dd> | |
| 368 reference to the event | |
| 369 </dd> | |
| 370 </dl> | |
| 371 <dl> | |
| 372 <dt>Return:</dt> | |
| 373 <dd> | |
| 374 flag indicating, if the event was handled | |
| 375 </dd> | |
| 376 </dl> | |
| 377 <dl> | |
| 378 <dt>Return Type:</dt> | |
| 379 <dd> | |
| 380 bool | |
| 381 </dd> | |
| 382 </dl> | |
| 383 <a NAME="PixmapDiagram.gestureEvent" ID="PixmapDiagram.gestureEvent"></a> | |
| 384 <h4>PixmapDiagram.gestureEvent</h4> | |
| 385 <b>gestureEvent</b>(<i>evt</i>) | |
| 386 | |
| 387 <p> | |
| 388 Protected method handling gesture events. | |
| 389 </p> | |
| 390 <dl> | |
| 391 | |
| 392 <dt><i>evt</i> (QGestureEvent)</dt> | |
| 393 <dd> | |
| 394 reference to the gesture event | |
| 395 </dd> | |
| 396 </dl> | |
| 397 <a NAME="PixmapDiagram.getDiagramName" ID="PixmapDiagram.getDiagramName"></a> | |
| 398 <h4>PixmapDiagram.getDiagramName</h4> | |
| 399 <b>getDiagramName</b>(<i></i>) | |
| 400 | |
| 401 <p> | |
| 402 Public method to retrieve a name for the diagram. | |
| 403 </p> | |
| 404 <dl> | |
| 405 <dt>Return:</dt> | |
| 406 <dd> | |
| 407 name for the diagram | |
| 408 </dd> | |
| 409 </dl> | |
| 410 <dl> | |
| 411 <dt>Return Type:</dt> | |
| 412 <dd> | |
| 413 str | |
| 414 </dd> | |
| 415 </dl> | |
| 416 <a NAME="PixmapDiagram.getStatus" ID="PixmapDiagram.getStatus"></a> | |
| 417 <h4>PixmapDiagram.getStatus</h4> | |
| 418 <b>getStatus</b>(<i></i>) | |
| 419 | |
| 420 <p> | |
| 421 Public method to retrieve the status of the canvas. | |
| 422 </p> | |
| 423 <dl> | |
| 424 <dt>Return:</dt> | |
| 425 <dd> | |
| 426 flag indicating a successful pixmap loading | |
| 427 </dd> | |
| 428 </dl> | |
| 429 <dl> | |
| 430 <dt>Return Type:</dt> | |
| 431 <dd> | |
| 432 bool | |
| 433 </dd> | |
| 434 </dl> | |
| 435 <a NAME="PixmapDiagram.wheelEvent" ID="PixmapDiagram.wheelEvent"></a> | |
| 436 <h4>PixmapDiagram.wheelEvent</h4> | |
| 437 <b>wheelEvent</b>(<i>evt</i>) | |
| 438 | |
| 439 <p> | |
| 440 Protected method to handle wheel events. | |
| 441 </p> | |
| 442 <dl> | |
| 443 | |
| 444 <dt><i>evt</i> (QWheelEvent)</dt> | |
| 445 <dd> | |
| 446 reference to the wheel event | |
| 447 </dd> | |
| 448 </dl> | |
| 449 <div align="right"><a href="#top">Up</a></div> | |
| 450 <hr /> | |
| 451 </body></html> |
