src/eric7/Documentation/Source/eric7.Graphics.GraphicsUtilities.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.Graphics.GraphicsUtilities.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Graphics.GraphicsUtilities.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,157 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Graphics.GraphicsUtilities</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.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> (list of tuple of (str, str))</dt>
+<dd>
+list of routes between nodes
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary of child and dictionary of parent relationships
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (dict, dict)
+</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> (str)</dt>
+<dd>
+list of nodes to be sorted
+</dd>
+<dt><i>routes</i> (list of tuple of (str, str))</dt>
+<dd>
+list of routes between the nodes
+</dd>
+<dt><i>noRecursion</i> (bool)</dt>
+<dd>
+flag indicating, if recursion errors should be raised
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of stages
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of lists of str
+</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