diff -r bc6196164237 -r 0d9daebf5b8c Documentation/Source/eric4.Graphics.SvgDiagram.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.Graphics.SvgDiagram.html Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,220 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric4.Graphics.SvgDiagram</title>
+<style>
+body {
+ background:white;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric4.Graphics.SvgDiagram</h1>
+<p>
+Module implementing a dialog showing a SVG graphic.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#SvgDiagram">SvgDiagram</a></td>
+<td>Class implementing a dialog showing a SVG graphic.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="SvgDiagram" ID="SvgDiagram"></a>
+<h2>SvgDiagram</h2>
+<p>
+ Class implementing a dialog showing a SVG graphic.
+</p>
+<h3>Derived from</h3>
+QMainWindow
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#SvgDiagram.__init__">SvgDiagram</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#SvgDiagram.__adjustScrollBar">__adjustScrollBar</a></td>
+<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>
+</tr><tr>
+<td><a href="#SvgDiagram.__initActions">__initActions</a></td>
+<td>Private method to initialize the view actions.</td>
+</tr><tr>
+<td><a href="#SvgDiagram.__initContextMenu">__initContextMenu</a></td>
+<td>Private method to initialize the context menu.</td>
+</tr><tr>
+<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.__print">__print</a></td>
+<td>Private slot to the actual printing.</td>
+</tr><tr>
+<td><a href="#SvgDiagram.__printDiagram">__printDiagram</a></td>
+<td>Private slot called to print the diagram.</td>
+</tr><tr>
+<td><a href="#SvgDiagram.__printPreviewDiagram">__printPreviewDiagram</a></td>
+<td>Private slot called to show a print preview of the diagram.</td>
+</tr><tr>
+<td><a href="#SvgDiagram.__showContextMenu">__showContextMenu</a></td>
+<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>
+</tr><tr>
+<td><a href="#SvgDiagram.__zoomIn">__zoomIn</a></td>
+<td>Private method to handle the zoom in context menu entry.</td>
+</tr><tr>
+<td><a href="#SvgDiagram.__zoomOut">__zoomOut</a></td>
+<td>Private method to handle the zoom out context menu entry.</td>
+</tr><tr>
+<td><a href="#SvgDiagram.__zoomReset">__zoomReset</a></td>
+<td>Private method to handle the reset zoom context menu entry.</td>
+</tr><tr>
+<td><a href="#SvgDiagram.getDiagramName">getDiagramName</a></td>
+<td>Method to retrieve a name for the diagram.</td>
+</tr>
+</table>
+<a NAME="SvgDiagram.__init__" ID="SvgDiagram.__init__"></a>
+<h4>SvgDiagram (Constructor)</h4>
+<b>SvgDiagram</b>(<i>svgFile, parent = None, name = None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>svgFile</i></dt>
+<dd>
+filename of a SVG graphics file to show (string)
+</dd><dt><i>parent</i></dt>
+<dd>
+parent widget of the view (QWidget)
+</dd><dt><i>name</i></dt>
+<dd>
+name of the view widget (string)
+</dd>
+</dl><a NAME="SvgDiagram.__adjustScrollBar" ID="SvgDiagram.__adjustScrollBar"></a>
+<h4>SvgDiagram.__adjustScrollBar</h4>
+<b>__adjustScrollBar</b>(<i>scrollBar, factor</i>)
+<p>
+ Private method to adjust a scrollbar by a certain factor.
+</p><dl>
+<dt><i>scrollBar</i></dt>
+<dd>
+reference to the scrollbar object (QScrollBar)
+</dd><dt><i>factor</i></dt>
+<dd>
+factor to adjust by (float)
+</dd>
+</dl><a NAME="SvgDiagram.__doZoom" ID="SvgDiagram.__doZoom"></a>
+<h4>SvgDiagram.__doZoom</h4>
+<b>__doZoom</b>(<i>factor</i>)
+<p>
+ Private method to perform the zooming.
+</p><dl>
+<dt><i>factor</i></dt>
+<dd>
+zoom factor (float)
+</dd>
+</dl><a NAME="SvgDiagram.__initActions" ID="SvgDiagram.__initActions"></a>
+<h4>SvgDiagram.__initActions</h4>
+<b>__initActions</b>(<i></i>)
+<p>
+ Private method to initialize the view actions.
+</p><a NAME="SvgDiagram.__initContextMenu" ID="SvgDiagram.__initContextMenu"></a>
+<h4>SvgDiagram.__initContextMenu</h4>
+<b>__initContextMenu</b>(<i></i>)
+<p>
+ Private method to initialize the context menu.
+</p><a NAME="SvgDiagram.__initToolBars" ID="SvgDiagram.__initToolBars"></a>
+<h4>SvgDiagram.__initToolBars</h4>
+<b>__initToolBars</b>(<i></i>)
+<p>
+ Private method to populate the toolbars with our actions.
+</p><a NAME="SvgDiagram.__print" ID="SvgDiagram.__print"></a>
+<h4>SvgDiagram.__print</h4>
+<b>__print</b>(<i>printer</i>)
+<p>
+ Private slot to the actual printing.
+</p><dl>
+<dt><i>printer</i></dt>
+<dd>
+reference to the printer object (QPrinter)
+</dd>
+</dl><a NAME="SvgDiagram.__printDiagram" ID="SvgDiagram.__printDiagram"></a>
+<h4>SvgDiagram.__printDiagram</h4>
+<b>__printDiagram</b>(<i></i>)
+<p>
+ Private slot called to print the diagram.
+</p><a NAME="SvgDiagram.__printPreviewDiagram" ID="SvgDiagram.__printPreviewDiagram"></a>
+<h4>SvgDiagram.__printPreviewDiagram</h4>
+<b>__printPreviewDiagram</b>(<i></i>)
+<p>
+ Private slot called to show a print preview of the diagram.
+</p><a NAME="SvgDiagram.__showContextMenu" ID="SvgDiagram.__showContextMenu"></a>
+<h4>SvgDiagram.__showContextMenu</h4>
+<b>__showContextMenu</b>(<i>coord</i>)
+<p>
+ Private slot to show the context menu of the listview.
+</p><dl>
+<dt><i>coord</i></dt>
+<dd>
+the position of the mouse pointer (QPoint)
+</dd>
+</dl><a NAME="SvgDiagram.__zoom" ID="SvgDiagram.__zoom"></a>
+<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>
+<h4>SvgDiagram.__zoomIn</h4>
+<b>__zoomIn</b>(<i></i>)
+<p>
+ Private method to handle the zoom in context menu entry.
+</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.
+</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.
+</p><a NAME="SvgDiagram.getDiagramName" ID="SvgDiagram.getDiagramName"></a>
+<h4>SvgDiagram.getDiagramName</h4>
+<b>getDiagramName</b>(<i></i>)
+<p>
+ Method to retrieve a name for the diagram.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+name for the diagram
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
