Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Graphics.SvgDiagram.html

eric6/Documentation/Source/eric6.Graphics.SvgDiagram.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Graphics.SvgDiagram</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Graphics.SvgDiagram</h1>
23 <p>
24 Module implementing a dialog showing a SVG graphic.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#SvgDiagram">SvgDiagram</a></td>
34 <td>Class implementing a dialog showing a SVG graphic.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="SvgDiagram" ID="SvgDiagram"></a>
43 <h2>SvgDiagram</h2>
44 <p>
45 Class implementing a dialog showing a SVG graphic.
46 </p>
47 <h3>Derived from</h3>
48 E5MainWindow
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>ZoomLevelDefault</td></tr><tr><td>ZoomLevels</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#SvgDiagram.__init__">SvgDiagram</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#SvgDiagram.__adjustScrollBar">__adjustScrollBar</a></td>
64 <td>Private method to adjust a scrollbar by a certain factor.</td>
65 </tr><tr>
66 <td><a href="#SvgDiagram.__doZoom">__doZoom</a></td>
67 <td>Private method to set the zoom value in percent.</td>
68 </tr><tr>
69 <td><a href="#SvgDiagram.__initActions">__initActions</a></td>
70 <td>Private method to initialize the view actions.</td>
71 </tr><tr>
72 <td><a href="#SvgDiagram.__initContextMenu">__initContextMenu</a></td>
73 <td>Private method to initialize the context menu.</td>
74 </tr><tr>
75 <td><a href="#SvgDiagram.__initToolBars">__initToolBars</a></td>
76 <td>Private method to populate the toolbars with our actions.</td>
77 </tr><tr>
78 <td><a href="#SvgDiagram.__levelForZoom">__levelForZoom</a></td>
79 <td>Private method determining the zoom level index given a zoom factor.</td>
80 </tr><tr>
81 <td><a href="#SvgDiagram.__print">__print</a></td>
82 <td>Private slot to the actual printing.</td>
83 </tr><tr>
84 <td><a href="#SvgDiagram.__printDiagram">__printDiagram</a></td>
85 <td>Private slot called to print the diagram.</td>
86 </tr><tr>
87 <td><a href="#SvgDiagram.__printPreviewDiagram">__printPreviewDiagram</a></td>
88 <td>Private slot called to show a print preview of the diagram.</td>
89 </tr><tr>
90 <td><a href="#SvgDiagram.__showContextMenu">__showContextMenu</a></td>
91 <td>Private slot to show the context menu of the listview.</td>
92 </tr><tr>
93 <td><a href="#SvgDiagram.__zoom">__zoom</a></td>
94 <td>Private method to get the current zoom factor in percent.</td>
95 </tr><tr>
96 <td><a href="#SvgDiagram.__zoomIn">__zoomIn</a></td>
97 <td>Private method to zoom into the SVG.</td>
98 </tr><tr>
99 <td><a href="#SvgDiagram.__zoomOut">__zoomOut</a></td>
100 <td>Private method to zoom out of the SVG.</td>
101 </tr><tr>
102 <td><a href="#SvgDiagram.__zoomReset">__zoomReset</a></td>
103 <td>Private method to reset the zoom value.</td>
104 </tr><tr>
105 <td><a href="#SvgDiagram.event">event</a></td>
106 <td>Public method handling events.</td>
107 </tr><tr>
108 <td><a href="#SvgDiagram.gestureEvent">gestureEvent</a></td>
109 <td>Protected method handling gesture events.</td>
110 </tr><tr>
111 <td><a href="#SvgDiagram.getDiagramName">getDiagramName</a></td>
112 <td>Public method to retrieve a name for the diagram.</td>
113 </tr><tr>
114 <td><a href="#SvgDiagram.wheelEvent">wheelEvent</a></td>
115 <td>Protected method to handle wheel events.</td>
116 </tr>
117 </table>
118 <h3>Static Methods</h3>
119 <table>
120 <tr><td>None</td></tr>
121 </table>
122 <a NAME="SvgDiagram.__init__" ID="SvgDiagram.__init__"></a>
123 <h4>SvgDiagram (Constructor)</h4>
124 <b>SvgDiagram</b>(<i>svgFile, parent=None, name=None</i>)
125 <p>
126 Constructor
127 </p><dl>
128 <dt><i>svgFile</i></dt>
129 <dd>
130 filename of a SVG graphics file to show (string)
131 </dd><dt><i>parent</i></dt>
132 <dd>
133 parent widget of the view (QWidget)
134 </dd><dt><i>name</i></dt>
135 <dd>
136 name of the view widget (string)
137 </dd>
138 </dl><a NAME="SvgDiagram.__adjustScrollBar" ID="SvgDiagram.__adjustScrollBar"></a>
139 <h4>SvgDiagram.__adjustScrollBar</h4>
140 <b>__adjustScrollBar</b>(<i>scrollBar, factor</i>)
141 <p>
142 Private method to adjust a scrollbar by a certain factor.
143 </p><dl>
144 <dt><i>scrollBar</i></dt>
145 <dd>
146 reference to the scrollbar object (QScrollBar)
147 </dd><dt><i>factor</i></dt>
148 <dd>
149 factor to adjust by (float)
150 </dd>
151 </dl><a NAME="SvgDiagram.__doZoom" ID="SvgDiagram.__doZoom"></a>
152 <h4>SvgDiagram.__doZoom</h4>
153 <b>__doZoom</b>(<i>value</i>)
154 <p>
155 Private method to set the zoom value in percent.
156 </p><dl>
157 <dt><i>value</i></dt>
158 <dd>
159 zoom value in percent (integer)
160 </dd>
161 </dl><a NAME="SvgDiagram.__initActions" ID="SvgDiagram.__initActions"></a>
162 <h4>SvgDiagram.__initActions</h4>
163 <b>__initActions</b>(<i></i>)
164 <p>
165 Private method to initialize the view actions.
166 </p><a NAME="SvgDiagram.__initContextMenu" ID="SvgDiagram.__initContextMenu"></a>
167 <h4>SvgDiagram.__initContextMenu</h4>
168 <b>__initContextMenu</b>(<i></i>)
169 <p>
170 Private method to initialize the context menu.
171 </p><a NAME="SvgDiagram.__initToolBars" ID="SvgDiagram.__initToolBars"></a>
172 <h4>SvgDiagram.__initToolBars</h4>
173 <b>__initToolBars</b>(<i></i>)
174 <p>
175 Private method to populate the toolbars with our actions.
176 </p><a NAME="SvgDiagram.__levelForZoom" ID="SvgDiagram.__levelForZoom"></a>
177 <h4>SvgDiagram.__levelForZoom</h4>
178 <b>__levelForZoom</b>(<i>zoom</i>)
179 <p>
180 Private method determining the zoom level index given a zoom factor.
181 </p><dl>
182 <dt><i>zoom</i></dt>
183 <dd>
184 zoom factor (integer)
185 </dd>
186 </dl><dl>
187 <dt>Returns:</dt>
188 <dd>
189 index of zoom factor (integer)
190 </dd>
191 </dl><a NAME="SvgDiagram.__print" ID="SvgDiagram.__print"></a>
192 <h4>SvgDiagram.__print</h4>
193 <b>__print</b>(<i>printer</i>)
194 <p>
195 Private slot to the actual printing.
196 </p><dl>
197 <dt><i>printer</i></dt>
198 <dd>
199 reference to the printer object (QPrinter)
200 </dd>
201 </dl><a NAME="SvgDiagram.__printDiagram" ID="SvgDiagram.__printDiagram"></a>
202 <h4>SvgDiagram.__printDiagram</h4>
203 <b>__printDiagram</b>(<i></i>)
204 <p>
205 Private slot called to print the diagram.
206 </p><a NAME="SvgDiagram.__printPreviewDiagram" ID="SvgDiagram.__printPreviewDiagram"></a>
207 <h4>SvgDiagram.__printPreviewDiagram</h4>
208 <b>__printPreviewDiagram</b>(<i></i>)
209 <p>
210 Private slot called to show a print preview of the diagram.
211 </p><a NAME="SvgDiagram.__showContextMenu" ID="SvgDiagram.__showContextMenu"></a>
212 <h4>SvgDiagram.__showContextMenu</h4>
213 <b>__showContextMenu</b>(<i>coord</i>)
214 <p>
215 Private slot to show the context menu of the listview.
216 </p><dl>
217 <dt><i>coord</i></dt>
218 <dd>
219 the position of the mouse pointer (QPoint)
220 </dd>
221 </dl><a NAME="SvgDiagram.__zoom" ID="SvgDiagram.__zoom"></a>
222 <h4>SvgDiagram.__zoom</h4>
223 <b>__zoom</b>(<i></i>)
224 <p>
225 Private method to get the current zoom factor in percent.
226 </p><dl>
227 <dt>Returns:</dt>
228 <dd>
229 current zoom factor in percent (integer)
230 </dd>
231 </dl><a NAME="SvgDiagram.__zoomIn" ID="SvgDiagram.__zoomIn"></a>
232 <h4>SvgDiagram.__zoomIn</h4>
233 <b>__zoomIn</b>(<i></i>)
234 <p>
235 Private method to zoom into the SVG.
236 </p><a NAME="SvgDiagram.__zoomOut" ID="SvgDiagram.__zoomOut"></a>
237 <h4>SvgDiagram.__zoomOut</h4>
238 <b>__zoomOut</b>(<i></i>)
239 <p>
240 Private method to zoom out of the SVG.
241 </p><a NAME="SvgDiagram.__zoomReset" ID="SvgDiagram.__zoomReset"></a>
242 <h4>SvgDiagram.__zoomReset</h4>
243 <b>__zoomReset</b>(<i></i>)
244 <p>
245 Private method to reset the zoom value.
246 </p><a NAME="SvgDiagram.event" ID="SvgDiagram.event"></a>
247 <h4>SvgDiagram.event</h4>
248 <b>event</b>(<i>evt</i>)
249 <p>
250 Public method handling events.
251 </p><dl>
252 <dt><i>evt</i></dt>
253 <dd>
254 reference to the event (QEvent)
255 </dd>
256 </dl><dl>
257 <dt>Returns:</dt>
258 <dd>
259 flag indicating, if the event was handled (boolean)
260 </dd>
261 </dl><a NAME="SvgDiagram.gestureEvent" ID="SvgDiagram.gestureEvent"></a>
262 <h4>SvgDiagram.gestureEvent</h4>
263 <b>gestureEvent</b>(<i>evt</i>)
264 <p>
265 Protected method handling gesture events.
266 </p><dl>
267 <dt><i>evt</i></dt>
268 <dd>
269 reference to the gesture event (QGestureEvent
270 </dd>
271 </dl><a NAME="SvgDiagram.getDiagramName" ID="SvgDiagram.getDiagramName"></a>
272 <h4>SvgDiagram.getDiagramName</h4>
273 <b>getDiagramName</b>(<i></i>)
274 <p>
275 Public method to retrieve a name for the diagram.
276 </p><dl>
277 <dt>Returns:</dt>
278 <dd>
279 name for the diagram
280 </dd>
281 </dl><a NAME="SvgDiagram.wheelEvent" ID="SvgDiagram.wheelEvent"></a>
282 <h4>SvgDiagram.wheelEvent</h4>
283 <b>wheelEvent</b>(<i>evt</i>)
284 <p>
285 Protected method to handle wheel events.
286 </p><dl>
287 <dt><i>evt</i></dt>
288 <dd>
289 reference to the wheel event (QWheelEvent)
290 </dd>
291 </dl>
292 <div align="right"><a href="#top">Up</a></div>
293 <hr />
294 </body></html>

Mercurial Repository: eric

eric ide

mercurial