|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Graphics.GraphicsUtilities</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>eric7.Graphics.GraphicsUtilities</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing some graphical utility functions. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#RecursionError">RecursionError</a></td> |
|
39 <td>Unable to calculate result because of recursive structure.</td> |
|
40 </tr> |
|
41 </table> |
|
42 <h3>Functions</h3> |
|
43 |
|
44 <table> |
|
45 |
|
46 <tr> |
|
47 <td><a href="#_buildChildrenLists">_buildChildrenLists</a></td> |
|
48 <td>Function to build up parent - child relationships.</td> |
|
49 </tr> |
|
50 <tr> |
|
51 <td><a href="#sort">sort</a></td> |
|
52 <td>Function to sort widgets topographically.</td> |
|
53 </tr> |
|
54 </table> |
|
55 <hr /> |
|
56 <hr /> |
|
57 <a NAME="RecursionError" ID="RecursionError"></a> |
|
58 <h2>RecursionError</h2> |
|
59 |
|
60 <p> |
|
61 Unable to calculate result because of recursive structure. |
|
62 </p> |
|
63 <h3>Derived from</h3> |
|
64 OverflowError, ValueError |
|
65 <h3>Class Attributes</h3> |
|
66 |
|
67 <table> |
|
68 <tr><td>None</td></tr> |
|
69 </table> |
|
70 <h3>Class Methods</h3> |
|
71 |
|
72 <table> |
|
73 <tr><td>None</td></tr> |
|
74 </table> |
|
75 <h3>Methods</h3> |
|
76 |
|
77 <table> |
|
78 <tr><td>None</td></tr> |
|
79 </table> |
|
80 <h3>Static Methods</h3> |
|
81 |
|
82 <table> |
|
83 <tr><td>None</td></tr> |
|
84 </table> |
|
85 |
|
86 <div align="right"><a href="#top">Up</a></div> |
|
87 <hr /> |
|
88 <hr /> |
|
89 <a NAME="_buildChildrenLists" ID="_buildChildrenLists"></a> |
|
90 <h2>_buildChildrenLists</h2> |
|
91 <b>_buildChildrenLists</b>(<i>routes</i>) |
|
92 |
|
93 <p> |
|
94 Function to build up parent - child relationships. |
|
95 </p> |
|
96 <p> |
|
97 Taken from Boa Constructor. |
|
98 </p> |
|
99 <dl> |
|
100 |
|
101 <dt><i>routes</i> (list of tuple of (str, str))</dt> |
|
102 <dd> |
|
103 list of routes between nodes |
|
104 </dd> |
|
105 </dl> |
|
106 <dl> |
|
107 <dt>Return:</dt> |
|
108 <dd> |
|
109 dictionary of child and dictionary of parent relationships |
|
110 </dd> |
|
111 </dl> |
|
112 <dl> |
|
113 <dt>Return Type:</dt> |
|
114 <dd> |
|
115 tuple of (dict, dict) |
|
116 </dd> |
|
117 </dl> |
|
118 <div align="right"><a href="#top">Up</a></div> |
|
119 <hr /> |
|
120 <hr /> |
|
121 <a NAME="sort" ID="sort"></a> |
|
122 <h2>sort</h2> |
|
123 <b>sort</b>(<i>nodes, routes, noRecursion=False</i>) |
|
124 |
|
125 <p> |
|
126 Function to sort widgets topographically. |
|
127 </p> |
|
128 <p> |
|
129 Passed a list of nodes and a list of source, dest routes, it attempts |
|
130 to create a list of stages, where each sub list is one stage in a process. |
|
131 </p> |
|
132 <p> |
|
133 The algorithm was taken from Boa Constructor. |
|
134 </p> |
|
135 <dl> |
|
136 |
|
137 <dt><i>nodes</i> (str)</dt> |
|
138 <dd> |
|
139 list of nodes to be sorted |
|
140 </dd> |
|
141 <dt><i>routes</i> (list of tuple of (str, str))</dt> |
|
142 <dd> |
|
143 list of routes between the nodes |
|
144 </dd> |
|
145 <dt><i>noRecursion</i> (bool)</dt> |
|
146 <dd> |
|
147 flag indicating, if recursion errors should be raised |
|
148 </dd> |
|
149 </dl> |
|
150 <dl> |
|
151 <dt>Return:</dt> |
|
152 <dd> |
|
153 list of stages |
|
154 </dd> |
|
155 </dl> |
|
156 <dl> |
|
157 <dt>Return Type:</dt> |
|
158 <dd> |
|
159 list of lists of str |
|
160 </dd> |
|
161 </dl> |
|
162 <dl> |
|
163 |
|
164 <dt>Raises <b>RecursionError</b>:</dt> |
|
165 <dd> |
|
166 a recursion error was detected |
|
167 </dd> |
|
168 </dl> |
|
169 <div align="right"><a href="#top">Up</a></div> |
|
170 <hr /> |
|
171 </body></html> |