Fri, 22 Jan 2021 16:48:43 +0100
Editor
- added functionality to insert docstring templates via the context menu (cursor placed on first line of function definition) or after entering the docstring start string (e.g. """ for Python)
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | <!DOCTYPE html> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <html><head> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | <title>eric6.Utilities.uic</title> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | <meta charset="UTF-8"> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
5 | <style> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | body { |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | background: #EDECE6; |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | margin: 0em 1em 10em 1em; |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | color: black; |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | h1 { color: white; background: #85774A; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | h2 { color: white; background: #85774A; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | h3 { color: white; background: #9D936E; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | h4 { color: white; background: #9D936E; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | a { color: #BA6D36; } |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | </style> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | </head> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
21 | <body> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
22 | <a NAME="top" ID="top"></a> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | <h1>eric6.Utilities.uic</h1> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
24 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | <p> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | Module implementing a function to compile all user interface files of a |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | directory or directory tree. |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | </p> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | <h3>Global Attributes</h3> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
30 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | <table> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | <tr><td>None</td></tr> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | </table> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
34 | <h3>Classes</h3> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
35 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | <table> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | <tr><td>None</td></tr> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | </table> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | <h3>Functions</h3> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
40 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | <table> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
42 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | <tr> |
4435
9f6555d3c3c0
Fixed some code style issues and removed code no longer needed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
44 | <td><a href="#__pyName">__pyName</a></td> |
9f6555d3c3c0
Fixed some code style issues and removed code no longer needed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
45 | <td>Local function to create the Python source file name for the compiled .ui file.</td> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
46 | </tr> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
47 | <tr> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48 | <td><a href="#compileUiFiles">compileUiFiles</a></td> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49 | <td>Module function to compile the .ui files of a directory tree to Python sources.</td> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50 | </tr> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51 | </table> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
52 | <hr /> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
53 | <hr /> |
4435
9f6555d3c3c0
Fixed some code style issues and removed code no longer needed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
54 | <a NAME="__pyName" ID="__pyName"></a> |
9f6555d3c3c0
Fixed some code style issues and removed code no longer needed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
55 | <h2>__pyName</h2> |
9f6555d3c3c0
Fixed some code style issues and removed code no longer needed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
56 | <b>__pyName</b>(<i>py_dir, py_file</i>) |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
57 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | <p> |
4435
9f6555d3c3c0
Fixed some code style issues and removed code no longer needed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
59 | Local function to create the Python source file name for the compiled |
9f6555d3c3c0
Fixed some code style issues and removed code no longer needed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
60 | .ui file. |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
61 | </p> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
62 | <dl> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
63 | |
4435
9f6555d3c3c0
Fixed some code style issues and removed code no longer needed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
64 | <dt><i>py_dir</i></dt> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | <dd> |
4435
9f6555d3c3c0
Fixed some code style issues and removed code no longer needed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
66 | suggested name of the directory (string) |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
67 | </dd> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
68 | <dt><i>py_file</i></dt> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
69 | <dd> |
4435
9f6555d3c3c0
Fixed some code style issues and removed code no longer needed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
70 | suggested name for the compile source file (string) |
9f6555d3c3c0
Fixed some code style issues and removed code no longer needed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
71 | </dd> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
72 | </dl> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
73 | <dl> |
7989
a21d673a8f99
Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7273
diff
changeset
|
74 | <dt>Return:</dt> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
75 | <dd> |
4435
9f6555d3c3c0
Fixed some code style issues and removed code no longer needed.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3673
diff
changeset
|
76 | tuple of directory name (string) and source file name (string) |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
77 | </dd> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
78 | </dl> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
79 | <div align="right"><a href="#top">Up</a></div> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
80 | <hr /> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
81 | <hr /> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
82 | <a NAME="compileUiFiles" ID="compileUiFiles"></a> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
83 | <h2>compileUiFiles</h2> |
5606
da305d172769
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4435
diff
changeset
|
84 | <b>compileUiFiles</b>(<i>directory, recurse=False</i>) |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
85 | |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
86 | <p> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
87 | Module function to compile the .ui files of a directory tree to Python |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
88 | sources. |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
89 | </p> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
90 | <dl> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
91 | |
5606
da305d172769
Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4435
diff
changeset
|
92 | <dt><i>directory</i></dt> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
93 | <dd> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
94 | name of a directory to scan for .ui files (string) |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
95 | </dd> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
96 | <dt><i>recurse</i></dt> |
3673
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
97 | <dd> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
98 | flag indicating to recurse into subdirectories (boolean) |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
99 | </dd> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
100 | </dl> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
101 | <div align="right"><a href="#top">Up</a></div> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
102 | <hr /> |
e26d7d0c1088
Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
103 | </body></html> |