diff -r 892c1787d666 -r edde1fe80b3e Documentation/Source/eric5.Graphics.PixmapDiagram.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Graphics.PixmapDiagram.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,239 @@ +<?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>eric5.Graphics.PixmapDiagram</title> +<style> +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' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.Graphics.PixmapDiagram</h1> +<p> +Module implementing a dialog showing a pixmap. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PixmapDiagram">PixmapDiagram</a></td> +<td>Class implementing a dialog showing a pixmap.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="PixmapDiagram" ID="PixmapDiagram"></a> +<h2>PixmapDiagram</h2> +<p> + Class implementing a dialog showing a pixmap. +</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="#PixmapDiagram.__init__">PixmapDiagram</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PixmapDiagram.__adjustScrollBar">__adjustScrollBar</a></td> +<td>Private method to adjust a scrollbar by a certain factor.</td> +</tr><tr> +<td><a href="#PixmapDiagram.__doZoom">__doZoom</a></td> +<td>Private method to perform the zooming.</td> +</tr><tr> +<td><a href="#PixmapDiagram.__initActions">__initActions</a></td> +<td>Private method to initialize the view actions.</td> +</tr><tr> +<td><a href="#PixmapDiagram.__initContextMenu">__initContextMenu</a></td> +<td>Private method to initialize the context menu.</td> +</tr><tr> +<td><a href="#PixmapDiagram.__initToolBars">__initToolBars</a></td> +<td>Private method to populate the toolbars with our actions.</td> +</tr><tr> +<td><a href="#PixmapDiagram.__print">__print</a></td> +<td>Private slot to the actual printing.</td> +</tr><tr> +<td><a href="#PixmapDiagram.__printDiagram">__printDiagram</a></td> +<td>Private slot called to print the diagram.</td> +</tr><tr> +<td><a href="#PixmapDiagram.__printPreviewDiagram">__printPreviewDiagram</a></td> +<td>Private slot called to show a print preview of the diagram.</td> +</tr><tr> +<td><a href="#PixmapDiagram.__showContextMenu">__showContextMenu</a></td> +<td>Private slot to show the context menu of the listview.</td> +</tr><tr> +<td><a href="#PixmapDiagram.__showPixmap">__showPixmap</a></td> +<td>Private method to show a file.</td> +</tr><tr> +<td><a href="#PixmapDiagram.__zoom">__zoom</a></td> +<td>Private method to handle the zoom context menu action.</td> +</tr><tr> +<td><a href="#PixmapDiagram.__zoomIn">__zoomIn</a></td> +<td>Private method to handle the zoom in context menu entry.</td> +</tr><tr> +<td><a href="#PixmapDiagram.__zoomOut">__zoomOut</a></td> +<td>Private method to handle the zoom out context menu entry.</td> +</tr><tr> +<td><a href="#PixmapDiagram.__zoomReset">__zoomReset</a></td> +<td>Private method to handle the reset zoom context menu entry.</td> +</tr><tr> +<td><a href="#PixmapDiagram.getDiagramName">getDiagramName</a></td> +<td>Method to retrieve a name for the diagram.</td> +</tr><tr> +<td><a href="#PixmapDiagram.getStatus">getStatus</a></td> +<td>Method to retrieve the status of the canvas.</td> +</tr> +</table> +<a NAME="PixmapDiagram.__init__" ID="PixmapDiagram.__init__"></a> +<h4>PixmapDiagram (Constructor)</h4> +<b>PixmapDiagram</b>(<i>pixmap, parent = None, name = None</i>) +<p> + Constructor +</p><dl> +<dt><i>pixmap</i></dt> +<dd> +filename of a 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="PixmapDiagram.__adjustScrollBar" ID="PixmapDiagram.__adjustScrollBar"></a> +<h4>PixmapDiagram.__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="PixmapDiagram.__doZoom" ID="PixmapDiagram.__doZoom"></a> +<h4>PixmapDiagram.__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="PixmapDiagram.__initActions" ID="PixmapDiagram.__initActions"></a> +<h4>PixmapDiagram.__initActions</h4> +<b>__initActions</b>(<i></i>) +<p> + Private method to initialize the view actions. +</p><a NAME="PixmapDiagram.__initContextMenu" ID="PixmapDiagram.__initContextMenu"></a> +<h4>PixmapDiagram.__initContextMenu</h4> +<b>__initContextMenu</b>(<i></i>) +<p> + Private method to initialize the context menu. +</p><a NAME="PixmapDiagram.__initToolBars" ID="PixmapDiagram.__initToolBars"></a> +<h4>PixmapDiagram.__initToolBars</h4> +<b>__initToolBars</b>(<i></i>) +<p> + Private method to populate the toolbars with our actions. +</p><a NAME="PixmapDiagram.__print" ID="PixmapDiagram.__print"></a> +<h4>PixmapDiagram.__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="PixmapDiagram.__printDiagram" ID="PixmapDiagram.__printDiagram"></a> +<h4>PixmapDiagram.__printDiagram</h4> +<b>__printDiagram</b>(<i></i>) +<p> + Private slot called to print the diagram. +</p><a NAME="PixmapDiagram.__printPreviewDiagram" ID="PixmapDiagram.__printPreviewDiagram"></a> +<h4>PixmapDiagram.__printPreviewDiagram</h4> +<b>__printPreviewDiagram</b>(<i></i>) +<p> + Private slot called to show a print preview of the diagram. +</p><a NAME="PixmapDiagram.__showContextMenu" ID="PixmapDiagram.__showContextMenu"></a> +<h4>PixmapDiagram.__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="PixmapDiagram.__showPixmap" ID="PixmapDiagram.__showPixmap"></a> +<h4>PixmapDiagram.__showPixmap</h4> +<b>__showPixmap</b>(<i>filename</i>) +<p> + Private method to show a file. +</p><dl> +<dt><i>filename</i></dt> +<dd> +name of the file to be shown (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> +</dl><a NAME="PixmapDiagram.__zoom" ID="PixmapDiagram.__zoom"></a> +<h4>PixmapDiagram.__zoom</h4> +<b>__zoom</b>(<i></i>) +<p> + Private method to handle the zoom context menu action. +</p><a NAME="PixmapDiagram.__zoomIn" ID="PixmapDiagram.__zoomIn"></a> +<h4>PixmapDiagram.__zoomIn</h4> +<b>__zoomIn</b>(<i></i>) +<p> + Private method to handle the zoom in context menu entry. +</p><a NAME="PixmapDiagram.__zoomOut" ID="PixmapDiagram.__zoomOut"></a> +<h4>PixmapDiagram.__zoomOut</h4> +<b>__zoomOut</b>(<i></i>) +<p> + Private method to handle the zoom out context menu entry. +</p><a NAME="PixmapDiagram.__zoomReset" ID="PixmapDiagram.__zoomReset"></a> +<h4>PixmapDiagram.__zoomReset</h4> +<b>__zoomReset</b>(<i></i>) +<p> + Private method to handle the reset zoom context menu entry. +</p><a NAME="PixmapDiagram.getDiagramName" ID="PixmapDiagram.getDiagramName"></a> +<h4>PixmapDiagram.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><a NAME="PixmapDiagram.getStatus" ID="PixmapDiagram.getStatus"></a> +<h4>PixmapDiagram.getStatus</h4> +<b>getStatus</b>(<i></i>) +<p> + Method to retrieve the status of the canvas. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating a successful pixmap loading (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file