Documentation/Source/eric5.Graphics.GraphicsUtilities.html

<?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.GraphicsUtilities</title>
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.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>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Static 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>