Documentation/Source/eric4.Graphics.GraphicsUtilities.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Graphics.GraphicsUtilities</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Graphics.GraphicsUtilities</h1>
24 <p>
25 Module implementing some graphical utility functions.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#RecursionError">RecursionError</a></td>
35 <td>Unable to calculate result because of recursive structure.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr>
41 <td><a href="#_buildChildrenLists">_buildChildrenLists</a></td>
42 <td>Function to build up parent - child relationships.</td>
43 </tr><tr>
44 <td><a href="#sort">sort</a></td>
45 <td>Function to sort widgets topographically.</td>
46 </tr>
47 </table>
48 <hr /><hr />
49 <a NAME="RecursionError" ID="RecursionError"></a>
50 <h2>RecursionError</h2>
51 <p>
52 Unable to calculate result because of recursive structure.
53 </p>
54 <h3>Derived from</h3>
55 OverflowError, ValueError
56 <h3>Class Attributes</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64
65 <div align="right"><a href="#top">Up</a></div>
66 <hr /><hr />
67 <a NAME="_buildChildrenLists" ID="_buildChildrenLists"></a>
68 <h2>_buildChildrenLists</h2>
69 <b>_buildChildrenLists</b>(<i>routes</i>)
70 <p>
71 Function to build up parent - child relationships.
72 </p><p>
73 Taken from Boa Constructor.
74 </p><dl>
75 <dt><i>routes</i></dt>
76 <dd>
77 list of routes between nodes
78 </dd>
79 </dl><dl>
80 <dt>Returns:</dt>
81 <dd>
82 dictionary of child and dictionary of parent relationships
83 </dd>
84 </dl>
85 <div align="right"><a href="#top">Up</a></div>
86 <hr /><hr />
87 <a NAME="sort" ID="sort"></a>
88 <h2>sort</h2>
89 <b>sort</b>(<i>nodes, routes, noRecursion = False</i>)
90 <p>
91 Function to sort widgets topographically.
92 </p><p>
93 Passed a list of nodes and a list of source, dest routes, it attempts
94 to create a list of stages, where each sub list is one stage in a process.
95 </p><p>
96 The algorithm was taken from Boa Constructor.
97 </p><dl>
98 <dt><i>nodes</i></dt>
99 <dd>
100 list of nodes to be sorted
101 </dd><dt><i>routes</i></dt>
102 <dd>
103 list of routes between the nodes
104 </dd><dt><i>noRecursion</i></dt>
105 <dd>
106 flag indicating, if recursion errors should be raised
107 </dd>
108 </dl><dl>
109 <dt>Returns:</dt>
110 <dd>
111 list of stages
112 </dd>
113 </dl><dl>
114 <dt>Raises <b>RecursionError</b>:</dt>
115 <dd>
116 a recursion error was detected
117 </dd>
118 </dl>
119 <div align="right"><a href="#top">Up</a></div>
120 <hr />
121 </body></html>

eric ide

mercurial