Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Graphics.PixmapDiagram.html
Documentation/Source/eric5.Graphics.PixmapDiagram.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Graphics.PixmapDiagram</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Graphics.PixmapDiagram</h1> | |
| 12 <p> | |
| 13 Module implementing a dialog showing a pixmap. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#PixmapDiagram">PixmapDiagram</a></td> | |
| 23 <td>Class implementing a dialog showing a pixmap.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="PixmapDiagram" ID="PixmapDiagram"></a> | |
| 32 <h2>PixmapDiagram</h2> | |
| 33 <p> | |
| 34 Class implementing a dialog showing a pixmap. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 QMainWindow | |
| 38 <h3>Class Attributes</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Methods</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#PixmapDiagram.__init__">PixmapDiagram</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#PixmapDiagram.__adjustScrollBar">__adjustScrollBar</a></td> | |
| 49 <td>Private method to adjust a scrollbar by a certain factor.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#PixmapDiagram.__doZoom">__doZoom</a></td> | |
| 52 <td>Private method to perform the zooming.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#PixmapDiagram.__initActions">__initActions</a></td> | |
| 55 <td>Private method to initialize the view actions.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#PixmapDiagram.__initContextMenu">__initContextMenu</a></td> | |
| 58 <td>Private method to initialize the context menu.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#PixmapDiagram.__initToolBars">__initToolBars</a></td> | |
| 61 <td>Private method to populate the toolbars with our actions.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#PixmapDiagram.__print">__print</a></td> | |
| 64 <td>Private slot to the actual printing.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#PixmapDiagram.__printDiagram">__printDiagram</a></td> | |
| 67 <td>Private slot called to print the diagram.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#PixmapDiagram.__printPreviewDiagram">__printPreviewDiagram</a></td> | |
| 70 <td>Private slot called to show a print preview of the diagram.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#PixmapDiagram.__showContextMenu">__showContextMenu</a></td> | |
| 73 <td>Private slot to show the context menu of the listview.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#PixmapDiagram.__showPixmap">__showPixmap</a></td> | |
| 76 <td>Private method to show a file.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#PixmapDiagram.__zoom">__zoom</a></td> | |
| 79 <td>Private method to handle the zoom context menu action.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#PixmapDiagram.__zoomIn">__zoomIn</a></td> | |
| 82 <td>Private method to handle the zoom in context menu entry.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#PixmapDiagram.__zoomOut">__zoomOut</a></td> | |
| 85 <td>Private method to handle the zoom out context menu entry.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#PixmapDiagram.__zoomReset">__zoomReset</a></td> | |
| 88 <td>Private method to handle the reset zoom context menu entry.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#PixmapDiagram.getDiagramName">getDiagramName</a></td> | |
| 91 <td>Method to retrieve a name for the diagram.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#PixmapDiagram.getStatus">getStatus</a></td> | |
| 94 <td>Method to retrieve the status of the canvas.</td> | |
| 95 </tr> | |
| 96 </table> | |
| 97 <a NAME="PixmapDiagram.__init__" ID="PixmapDiagram.__init__"></a> | |
| 98 <h4>PixmapDiagram (Constructor)</h4> | |
| 99 <b>PixmapDiagram</b>(<i>pixmap, parent = None, name = None</i>) | |
| 100 <p> | |
| 101 Constructor | |
| 102 </p><dl> | |
| 103 <dt><i>pixmap</i></dt> | |
| 104 <dd> | |
| 105 filename of a graphics file to show (string) | |
| 106 </dd><dt><i>parent</i></dt> | |
| 107 <dd> | |
| 108 parent widget of the view (QWidget) | |
| 109 </dd><dt><i>name</i></dt> | |
| 110 <dd> | |
| 111 name of the view widget (string) | |
| 112 </dd> | |
| 113 </dl><a NAME="PixmapDiagram.__adjustScrollBar" ID="PixmapDiagram.__adjustScrollBar"></a> | |
| 114 <h4>PixmapDiagram.__adjustScrollBar</h4> | |
| 115 <b>__adjustScrollBar</b>(<i>scrollBar, factor</i>) | |
| 116 <p> | |
| 117 Private method to adjust a scrollbar by a certain factor. | |
| 118 </p><dl> | |
| 119 <dt><i>scrollBar</i></dt> | |
| 120 <dd> | |
| 121 reference to the scrollbar object (QScrollBar) | |
| 122 </dd><dt><i>factor</i></dt> | |
| 123 <dd> | |
| 124 factor to adjust by (float) | |
| 125 </dd> | |
| 126 </dl><a NAME="PixmapDiagram.__doZoom" ID="PixmapDiagram.__doZoom"></a> | |
| 127 <h4>PixmapDiagram.__doZoom</h4> | |
| 128 <b>__doZoom</b>(<i>factor</i>) | |
| 129 <p> | |
| 130 Private method to perform the zooming. | |
| 131 </p><dl> | |
| 132 <dt><i>factor</i></dt> | |
| 133 <dd> | |
| 134 zoom factor (float) | |
| 135 </dd> | |
| 136 </dl><a NAME="PixmapDiagram.__initActions" ID="PixmapDiagram.__initActions"></a> | |
| 137 <h4>PixmapDiagram.__initActions</h4> | |
| 138 <b>__initActions</b>(<i></i>) | |
| 139 <p> | |
| 140 Private method to initialize the view actions. | |
| 141 </p><a NAME="PixmapDiagram.__initContextMenu" ID="PixmapDiagram.__initContextMenu"></a> | |
| 142 <h4>PixmapDiagram.__initContextMenu</h4> | |
| 143 <b>__initContextMenu</b>(<i></i>) | |
| 144 <p> | |
| 145 Private method to initialize the context menu. | |
| 146 </p><a NAME="PixmapDiagram.__initToolBars" ID="PixmapDiagram.__initToolBars"></a> | |
| 147 <h4>PixmapDiagram.__initToolBars</h4> | |
| 148 <b>__initToolBars</b>(<i></i>) | |
| 149 <p> | |
| 150 Private method to populate the toolbars with our actions. | |
| 151 </p><a NAME="PixmapDiagram.__print" ID="PixmapDiagram.__print"></a> | |
| 152 <h4>PixmapDiagram.__print</h4> | |
| 153 <b>__print</b>(<i>printer</i>) | |
| 154 <p> | |
| 155 Private slot to the actual printing. | |
| 156 </p><dl> | |
| 157 <dt><i>printer</i></dt> | |
| 158 <dd> | |
| 159 reference to the printer object (QPrinter) | |
| 160 </dd> | |
| 161 </dl><a NAME="PixmapDiagram.__printDiagram" ID="PixmapDiagram.__printDiagram"></a> | |
| 162 <h4>PixmapDiagram.__printDiagram</h4> | |
| 163 <b>__printDiagram</b>(<i></i>) | |
| 164 <p> | |
| 165 Private slot called to print the diagram. | |
| 166 </p><a NAME="PixmapDiagram.__printPreviewDiagram" ID="PixmapDiagram.__printPreviewDiagram"></a> | |
| 167 <h4>PixmapDiagram.__printPreviewDiagram</h4> | |
| 168 <b>__printPreviewDiagram</b>(<i></i>) | |
| 169 <p> | |
| 170 Private slot called to show a print preview of the diagram. | |
| 171 </p><a NAME="PixmapDiagram.__showContextMenu" ID="PixmapDiagram.__showContextMenu"></a> | |
| 172 <h4>PixmapDiagram.__showContextMenu</h4> | |
| 173 <b>__showContextMenu</b>(<i>coord</i>) | |
| 174 <p> | |
| 175 Private slot to show the context menu of the listview. | |
| 176 </p><dl> | |
| 177 <dt><i>coord</i></dt> | |
| 178 <dd> | |
| 179 the position of the mouse pointer (QPoint) | |
| 180 </dd> | |
| 181 </dl><a NAME="PixmapDiagram.__showPixmap" ID="PixmapDiagram.__showPixmap"></a> | |
| 182 <h4>PixmapDiagram.__showPixmap</h4> | |
| 183 <b>__showPixmap</b>(<i>filename</i>) | |
| 184 <p> | |
| 185 Private method to show a file. | |
| 186 </p><dl> | |
| 187 <dt><i>filename</i></dt> | |
| 188 <dd> | |
| 189 name of the file to be shown (string) | |
| 190 </dd> | |
| 191 </dl><dl> | |
| 192 <dt>Returns:</dt> | |
| 193 <dd> | |
| 194 flag indicating success (boolean) | |
| 195 </dd> | |
| 196 </dl><a NAME="PixmapDiagram.__zoom" ID="PixmapDiagram.__zoom"></a> | |
| 197 <h4>PixmapDiagram.__zoom</h4> | |
| 198 <b>__zoom</b>(<i></i>) | |
| 199 <p> | |
| 200 Private method to handle the zoom context menu action. | |
| 201 </p><a NAME="PixmapDiagram.__zoomIn" ID="PixmapDiagram.__zoomIn"></a> | |
| 202 <h4>PixmapDiagram.__zoomIn</h4> | |
| 203 <b>__zoomIn</b>(<i></i>) | |
| 204 <p> | |
| 205 Private method to handle the zoom in context menu entry. | |
| 206 </p><a NAME="PixmapDiagram.__zoomOut" ID="PixmapDiagram.__zoomOut"></a> | |
| 207 <h4>PixmapDiagram.__zoomOut</h4> | |
| 208 <b>__zoomOut</b>(<i></i>) | |
| 209 <p> | |
| 210 Private method to handle the zoom out context menu entry. | |
| 211 </p><a NAME="PixmapDiagram.__zoomReset" ID="PixmapDiagram.__zoomReset"></a> | |
| 212 <h4>PixmapDiagram.__zoomReset</h4> | |
| 213 <b>__zoomReset</b>(<i></i>) | |
| 214 <p> | |
| 215 Private method to handle the reset zoom context menu entry. | |
| 216 </p><a NAME="PixmapDiagram.getDiagramName" ID="PixmapDiagram.getDiagramName"></a> | |
| 217 <h4>PixmapDiagram.getDiagramName</h4> | |
| 218 <b>getDiagramName</b>(<i></i>) | |
| 219 <p> | |
| 220 Method to retrieve a name for the diagram. | |
| 221 </p><dl> | |
| 222 <dt>Returns:</dt> | |
| 223 <dd> | |
| 224 name for the diagram | |
| 225 </dd> | |
| 226 </dl><a NAME="PixmapDiagram.getStatus" ID="PixmapDiagram.getStatus"></a> | |
| 227 <h4>PixmapDiagram.getStatus</h4> | |
| 228 <b>getStatus</b>(<i></i>) | |
| 229 <p> | |
| 230 Method to retrieve the status of the canvas. | |
| 231 </p><dl> | |
| 232 <dt>Returns:</dt> | |
| 233 <dd> | |
| 234 flag indicating a successful pixmap loading (boolean) | |
| 235 </dd> | |
| 236 </dl> | |
| 237 <div align="right"><a href="#top">Up</a></div> | |
| 238 <hr /> | |
| 239 </body></html> |
