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)
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | <!DOCTYPE html> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <html><head> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | <title>eric6.Preferences.ConfigurationPages.EditorDocViewerPage</title> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | <meta charset="UTF-8"> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
5 | <style> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | body { |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | background: #EDECE6; |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | margin: 0em 1em 10em 1em; |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | color: black; |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | } |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | h1 { color: white; background: #85774A; } |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | h2 { color: white; background: #85774A; } |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | h3 { color: white; background: #9D936E; } |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | h4 { color: white; background: #9D936E; } |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | a { color: #BA6D36; } |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | </style> |
69482290dbdd
Updated source documentation.
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> |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | <h1>eric6.Preferences.ConfigurationPages.EditorDocViewerPage</h1> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
24 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | <p> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | Module implementing the Editor Documentation Viewer configuration page. |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | </p> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | <h3>Global Attributes</h3> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
29 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | <table> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | <tr><td>None</td></tr> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | </table> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | <h3>Classes</h3> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
34 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35 | <table> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
36 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | <tr> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | <td><a href="#EditorDocViewerPage">EditorDocViewerPage</a></td> |
6047
39586a2de99d
Fixed some forgotten source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
5926
diff
changeset
|
39 | <td>Class implementing the Editor Documentation Viewer configuration page.</td> |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | </tr> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | </table> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | <h3>Functions</h3> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
43 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | <table> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
45 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46 | <tr> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
47 | <td><a href="#create">create</a></td> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48 | <td>Module function to create the configuration page.</td> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49 | </tr> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50 | </table> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
51 | <hr /> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
52 | <hr /> |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
53 | <a NAME="EditorDocViewerPage" ID="EditorDocViewerPage"></a> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
54 | <h2>EditorDocViewerPage</h2> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
55 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
56 | <p> |
6047
39586a2de99d
Fixed some forgotten source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
5926
diff
changeset
|
57 | Class implementing the Editor Documentation Viewer configuration page. |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | </p> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
59 | <h3>Derived from</h3> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
60 | ConfigurationPageBase, Ui_EditorDocViewerPage |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
61 | <h3>Class Attributes</h3> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
62 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63 | <table> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
64 | <tr><td>None</td></tr> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | </table> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | <h3>Class Methods</h3> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
67 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
68 | <table> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
69 | <tr><td>None</td></tr> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
70 | </table> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
71 | <h3>Methods</h3> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
72 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
73 | <table> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
74 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
75 | <tr> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
76 | <td><a href="#EditorDocViewerPage.__init__">EditorDocViewerPage</a></td> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
77 | <td>Constructor</td> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
78 | </tr> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
79 | <tr> |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
80 | <td><a href="#EditorDocViewerPage.save">save</a></td> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
81 | <td>Public slot to save the Editor Typing configuration.</td> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
82 | </tr> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
83 | </table> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
84 | <h3>Static Methods</h3> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
85 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
86 | <table> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
87 | <tr><td>None</td></tr> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
88 | </table> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
89 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
90 | <a NAME="EditorDocViewerPage.__init__" ID="EditorDocViewerPage.__init__"></a> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
91 | <h4>EditorDocViewerPage (Constructor)</h4> |
6382
4d6e43200bc7
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6047
diff
changeset
|
92 | <b>EditorDocViewerPage</b>(<i></i>) |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
93 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
94 | <p> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
95 | Constructor |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
96 | </p> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
97 | <a NAME="EditorDocViewerPage.save" ID="EditorDocViewerPage.save"></a> |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
98 | <h4>EditorDocViewerPage.save</h4> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
99 | <b>save</b>(<i></i>) |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
100 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
101 | <p> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
102 | Public slot to save the Editor Typing configuration. |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
103 | </p> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
104 | <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
|
105 | <hr /> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
106 | <hr /> |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
107 | <a NAME="create" ID="create"></a> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
108 | <h2>create</h2> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
109 | <b>create</b>(<i>dlg</i>) |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
110 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
111 | <p> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
112 | Module function to create the configuration page. |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
113 | </p> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
114 | <dl> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
115 | |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
116 | <dt><i>dlg</i></dt> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
117 | <dd> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
118 | reference to the configuration dialog |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
119 | </dd> |
7273
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
120 | </dl> |
391d6b7b1eff
Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6942
diff
changeset
|
121 | <dl> |
7989
a21d673a8f99
Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7273
diff
changeset
|
122 | <dt>Return:</dt> |
5926
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
123 | <dd> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
124 | reference to the instantiated page (ConfigurationPageBase) |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
125 | </dd> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
126 | </dl> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
127 | <div align="right"><a href="#top">Up</a></div> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
128 | <hr /> |
69482290dbdd
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
129 | </body></html> |