diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Graphics.GraphicsUtilities.html --- a/eric6/Documentation/Source/eric6.Graphics.GraphicsUtilities.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.GraphicsUtilities.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,106 +18,137 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.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> +</tr> +<tr> <td><a href="#sort">sort</a></td> <td>Function to sort widgets topographically.</td> </tr> </table> -<hr /><hr /> +<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 /> +<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> +</p> +<p> Taken from Boa Constructor. -</p><dl> +</p> +<dl> + <dt><i>routes</i></dt> <dd> list of routes between nodes </dd> -</dl><dl> +</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 /> +<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> +</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> +</p> +<p> The algorithm was taken from Boa Constructor. -</p><dl> +</p> +<dl> + <dt><i>nodes</i></dt> <dd> list of nodes to be sorted -</dd><dt><i>routes</i></dt> +</dd> +<dt><i>routes</i></dt> <dd> list of routes between the nodes -</dd><dt><i>noRecursion</i></dt> +</dd> +<dt><i>noRecursion</i></dt> <dd> flag indicating, if recursion errors should be raised </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> list of stages </dd> -</dl><dl> +</dl> +<dl> + <dt>Raises <b>RecursionError</b>:</dt> <dd> a recursion error was detected