Documentation/Source/eric4.Graphics.GraphicsUtilities.html

changeset 3
0d9daebf5b8c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.Graphics.GraphicsUtilities.html	Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,121 @@
+<?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.GraphicsUtilities</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.GraphicsUtilities</h1>
+<p>
+Module implementing some graphical utility functions.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#RecursionError">RecursionError</a></td>
+<td>Unable to calculate result because of recursive structure.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#_buildChildrenLists">_buildChildrenLists</a></td>
+<td>Function to build up parent - child relationships.</td>
+</tr><tr>
+<td><a href="#sort">sort</a></td>
+<td>Function to sort widgets topographically.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="RecursionError" ID="RecursionError"></a>
+<h2>RecursionError</h2>
+<p>
+    Unable to calculate result because of recursive structure.
+</p>
+<h3>Derived from</h3>
+OverflowError, ValueError
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="_buildChildrenLists" ID="_buildChildrenLists"></a>
+<h2>_buildChildrenLists</h2>
+<b>_buildChildrenLists</b>(<i>routes</i>)
+<p>
+    Function to build up parent - child relationships.
+</p><p>
+    Taken from Boa Constructor.
+</p><dl>
+<dt><i>routes</i></dt>
+<dd>
+list of routes between nodes
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+dictionary of child and dictionary of parent relationships
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="sort" ID="sort"></a>
+<h2>sort</h2>
+<b>sort</b>(<i>nodes, routes, noRecursion = False</i>)
+<p>
+    Function to sort widgets topographically.
+</p><p>
+    Passed a list of nodes and a list of source, dest routes, it attempts
+    to create a list of stages, where each sub list is one stage in a process.
+</p><p>
+    The algorithm was taken from Boa Constructor.
+</p><dl>
+<dt><i>nodes</i></dt>
+<dd>
+list of nodes to be sorted
+</dd><dt><i>routes</i></dt>
+<dd>
+list of routes between the nodes
+</dd><dt><i>noRecursion</i></dt>
+<dd>
+flag indicating, if recursion errors should be raised
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+list of stages
+</dd>
+</dl><dl>
+<dt>Raises <b>RecursionError</b>:</dt>
+<dd>
+a recursion error was detected
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial