Documentation/Source/eric5.Graphics.SvgDiagram.html

changeset 2334
fc69ad77e18a
parent 2101
5bac7dee9e1a
child 2367
78f6c8193d37
--- a/Documentation/Source/eric5.Graphics.SvgDiagram.html	Thu Jan 10 19:15:10 2013 +0100
+++ b/Documentation/Source/eric5.Graphics.SvgDiagram.html	Sat Jan 12 18:44:39 2013 +0100
@@ -49,7 +49,7 @@
 E5MainWindow
 <h3>Class Attributes</h3>
 <table>
-<tr><td>None</td></tr>
+<tr><td>ZoomLevelDefault</td></tr><tr><td>ZoomLevels</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
@@ -65,7 +65,7 @@
 <td>Private method to adjust a scrollbar by a certain factor.</td>
 </tr><tr>
 <td><a href="#SvgDiagram.__doZoom">__doZoom</a></td>
-<td>Private method to perform the zooming.</td>
+<td>Public method to set the zoom value in percent.</td>
 </tr><tr>
 <td><a href="#SvgDiagram.__initActions">__initActions</a></td>
 <td>Private method to initialize the view actions.</td>
@@ -76,6 +76,9 @@
 <td><a href="#SvgDiagram.__initToolBars">__initToolBars</a></td>
 <td>Private method to populate the toolbars with our actions.</td>
 </tr><tr>
+<td><a href="#SvgDiagram.__levelForZoom">__levelForZoom</a></td>
+<td>Private method determining the zoom level index given a zoom factor.</td>
+</tr><tr>
 <td><a href="#SvgDiagram.__print">__print</a></td>
 <td>Private slot to the actual printing.</td>
 </tr><tr>
@@ -89,16 +92,16 @@
 <td>Private slot to show the context menu of the listview.</td>
 </tr><tr>
 <td><a href="#SvgDiagram.__zoom">__zoom</a></td>
-<td>Private method to handle the zoom context menu action.</td>
+<td>Public method to get the current zoom factor in percent.</td>
 </tr><tr>
 <td><a href="#SvgDiagram.__zoomIn">__zoomIn</a></td>
-<td>Private method to handle the zoom in context menu entry.</td>
+<td>Private method to zoom into the SVG.</td>
 </tr><tr>
 <td><a href="#SvgDiagram.__zoomOut">__zoomOut</a></td>
-<td>Private method to handle the zoom out context menu entry.</td>
+<td>Private method to zoom out of the SVG.</td>
 </tr><tr>
 <td><a href="#SvgDiagram.__zoomReset">__zoomReset</a></td>
-<td>Private method to handle the reset zoom context menu entry.</td>
+<td>Private method to reset the zoom value.</td>
 </tr><tr>
 <td><a href="#SvgDiagram.event">event</a></td>
 <td>Protected method handling events.</td>
@@ -148,13 +151,13 @@
 </dd>
 </dl><a NAME="SvgDiagram.__doZoom" ID="SvgDiagram.__doZoom"></a>
 <h4>SvgDiagram.__doZoom</h4>
-<b>__doZoom</b>(<i>factor</i>)
+<b>__doZoom</b>(<i>value</i>)
 <p>
-        Private method to perform the zooming.
+        Public method to set the zoom value in percent.
 </p><dl>
-<dt><i>factor</i></dt>
+<dt><i>value</i></dt>
 <dd>
-zoom factor (float)
+zoom value in percent (integer)
 </dd>
 </dl><a NAME="SvgDiagram.__initActions" ID="SvgDiagram.__initActions"></a>
 <h4>SvgDiagram.__initActions</h4>
@@ -171,7 +174,22 @@
 <b>__initToolBars</b>(<i></i>)
 <p>
         Private method to populate the toolbars with our actions.
-</p><a NAME="SvgDiagram.__print" ID="SvgDiagram.__print"></a>
+</p><a NAME="SvgDiagram.__levelForZoom" ID="SvgDiagram.__levelForZoom"></a>
+<h4>SvgDiagram.__levelForZoom</h4>
+<b>__levelForZoom</b>(<i>zoom</i>)
+<p>
+        Private method determining the zoom level index given a zoom factor.
+</p><dl>
+<dt><i>zoom</i></dt>
+<dd>
+zoom factor (integer)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+index of zoom factor (integer)
+</dd>
+</dl><a NAME="SvgDiagram.__print" ID="SvgDiagram.__print"></a>
 <h4>SvgDiagram.__print</h4>
 <b>__print</b>(<i>printer</i>)
 <p>
@@ -205,22 +223,27 @@
 <h4>SvgDiagram.__zoom</h4>
 <b>__zoom</b>(<i></i>)
 <p>
-        Private method to handle the zoom context menu action.
-</p><a NAME="SvgDiagram.__zoomIn" ID="SvgDiagram.__zoomIn"></a>
+        Public method to get the current zoom factor in percent.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+current zoom factor in percent (integer)
+</dd>
+</dl><a NAME="SvgDiagram.__zoomIn" ID="SvgDiagram.__zoomIn"></a>
 <h4>SvgDiagram.__zoomIn</h4>
 <b>__zoomIn</b>(<i></i>)
 <p>
-        Private method to handle the zoom in context menu entry.
+        Private method to zoom into the SVG.
 </p><a NAME="SvgDiagram.__zoomOut" ID="SvgDiagram.__zoomOut"></a>
 <h4>SvgDiagram.__zoomOut</h4>
 <b>__zoomOut</b>(<i></i>)
 <p>
-        Private method to handle the zoom out context menu entry.
+        Private method to zoom out of the SVG.
 </p><a NAME="SvgDiagram.__zoomReset" ID="SvgDiagram.__zoomReset"></a>
 <h4>SvgDiagram.__zoomReset</h4>
 <b>__zoomReset</b>(<i></i>)
 <p>
-        Private method to handle the reset zoom context menu entry.
+        Private method to reset the zoom value.
 </p><a NAME="SvgDiagram.event" ID="SvgDiagram.event"></a>
 <h4>SvgDiagram.event</h4>
 <b>event</b>(<i>evt</i>)

eric ide

mercurial