|
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>eric5.Preferences.ConfigurationPages.EditorAPIsPage</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Preferences.ConfigurationPages.EditorAPIsPage</h1> |
|
12 <p> |
|
13 Module implementing the Editor APIs configuration page. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#EditorAPIsPage">EditorAPIsPage</a></td> |
|
23 <td>Class implementing the Editor APIs configuration page.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr> |
|
29 <td><a href="#create">create</a></td> |
|
30 <td>Module function to create the configuration page.</td> |
|
31 </tr> |
|
32 </table> |
|
33 <hr /><hr /> |
|
34 <a NAME="EditorAPIsPage" ID="EditorAPIsPage"></a> |
|
35 <h2>EditorAPIsPage</h2> |
|
36 <p> |
|
37 Class implementing the Editor APIs configuration page. |
|
38 </p> |
|
39 <h3>Derived from</h3> |
|
40 ConfigurationPageBase, Ui_EditorAPIsPage |
|
41 <h3>Class Attributes</h3> |
|
42 <table> |
|
43 <tr><td>None</td></tr> |
|
44 </table> |
|
45 <h3>Methods</h3> |
|
46 <table> |
|
47 <tr> |
|
48 <td><a href="#EditorAPIsPage.__init__">EditorAPIsPage</a></td> |
|
49 <td>Constructor</td> |
|
50 </tr><tr> |
|
51 <td><a href="#EditorAPIsPage.__apiPreparationCancelled">__apiPreparationCancelled</a></td> |
|
52 <td>Private slot called after the API preparation has been cancelled.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#EditorAPIsPage.__apiPreparationFinished">__apiPreparationFinished</a></td> |
|
55 <td>Private method called after the API preparation has finished.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#EditorAPIsPage.__apiPreparationStarted">__apiPreparationStarted</a></td> |
|
58 <td>Private method called after the API preparation has started.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#EditorAPIsPage.__editorGetApisFromApiList">__editorGetApisFromApiList</a></td> |
|
61 <td>Private slot to retrieve the api filenames from the list.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#EditorAPIsPage.on_addApiFileButton_clicked">on_addApiFileButton_clicked</a></td> |
|
64 <td>Private slot to add the api file displayed to the listbox.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#EditorAPIsPage.on_addInstalledApiFileButton_clicked">on_addInstalledApiFileButton_clicked</a></td> |
|
67 <td>Private slot to add an API file from the list of installed API files for the selected lexer language.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#EditorAPIsPage.on_addPluginApiFileButton_clicked">on_addPluginApiFileButton_clicked</a></td> |
|
70 <td>Private slot to add an API file from the list of API files installed by plugins for the selected lexer language.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#EditorAPIsPage.on_apiFileButton_clicked">on_apiFileButton_clicked</a></td> |
|
73 <td>Private method to select an api file.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#EditorAPIsPage.on_apiLanguageComboBox_activated">on_apiLanguageComboBox_activated</a></td> |
|
76 <td>Private slot to fill the api listbox of the api page.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#EditorAPIsPage.on_deleteApiFileButton_clicked">on_deleteApiFileButton_clicked</a></td> |
|
79 <td>Private slot to delete the currently selected file of the listbox.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#EditorAPIsPage.on_prepareApiButton_clicked">on_prepareApiButton_clicked</a></td> |
|
82 <td>Private slot to prepare the API file for the currently selected language.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#EditorAPIsPage.save">save</a></td> |
|
85 <td>Public slot to save the Editor APIs configuration.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#EditorAPIsPage.saveState">saveState</a></td> |
|
88 <td>Public method to save the current state of the widget.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#EditorAPIsPage.setState">setState</a></td> |
|
91 <td>Public method to set the state of the widget.</td> |
|
92 </tr> |
|
93 </table> |
|
94 <a NAME="EditorAPIsPage.__init__" ID="EditorAPIsPage.__init__"></a> |
|
95 <h4>EditorAPIsPage (Constructor)</h4> |
|
96 <b>EditorAPIsPage</b>(<i></i>) |
|
97 <p> |
|
98 Constructor |
|
99 </p><a NAME="EditorAPIsPage.__apiPreparationCancelled" ID="EditorAPIsPage.__apiPreparationCancelled"></a> |
|
100 <h4>EditorAPIsPage.__apiPreparationCancelled</h4> |
|
101 <b>__apiPreparationCancelled</b>(<i></i>) |
|
102 <p> |
|
103 Private slot called after the API preparation has been cancelled. |
|
104 </p><a NAME="EditorAPIsPage.__apiPreparationFinished" ID="EditorAPIsPage.__apiPreparationFinished"></a> |
|
105 <h4>EditorAPIsPage.__apiPreparationFinished</h4> |
|
106 <b>__apiPreparationFinished</b>(<i></i>) |
|
107 <p> |
|
108 Private method called after the API preparation has finished. |
|
109 </p><a NAME="EditorAPIsPage.__apiPreparationStarted" ID="EditorAPIsPage.__apiPreparationStarted"></a> |
|
110 <h4>EditorAPIsPage.__apiPreparationStarted</h4> |
|
111 <b>__apiPreparationStarted</b>(<i></i>) |
|
112 <p> |
|
113 Private method called after the API preparation has started. |
|
114 </p><a NAME="EditorAPIsPage.__editorGetApisFromApiList" ID="EditorAPIsPage.__editorGetApisFromApiList"></a> |
|
115 <h4>EditorAPIsPage.__editorGetApisFromApiList</h4> |
|
116 <b>__editorGetApisFromApiList</b>(<i></i>) |
|
117 <p> |
|
118 Private slot to retrieve the api filenames from the list. |
|
119 </p><dl> |
|
120 <dt>Returns:</dt> |
|
121 <dd> |
|
122 list of api filenames (list of strings) |
|
123 </dd> |
|
124 </dl><a NAME="EditorAPIsPage.on_addApiFileButton_clicked" ID="EditorAPIsPage.on_addApiFileButton_clicked"></a> |
|
125 <h4>EditorAPIsPage.on_addApiFileButton_clicked</h4> |
|
126 <b>on_addApiFileButton_clicked</b>(<i></i>) |
|
127 <p> |
|
128 Private slot to add the api file displayed to the listbox. |
|
129 </p><a NAME="EditorAPIsPage.on_addInstalledApiFileButton_clicked" ID="EditorAPIsPage.on_addInstalledApiFileButton_clicked"></a> |
|
130 <h4>EditorAPIsPage.on_addInstalledApiFileButton_clicked</h4> |
|
131 <b>on_addInstalledApiFileButton_clicked</b>(<i></i>) |
|
132 <p> |
|
133 Private slot to add an API file from the list of installed API files |
|
134 for the selected lexer language. |
|
135 </p><a NAME="EditorAPIsPage.on_addPluginApiFileButton_clicked" ID="EditorAPIsPage.on_addPluginApiFileButton_clicked"></a> |
|
136 <h4>EditorAPIsPage.on_addPluginApiFileButton_clicked</h4> |
|
137 <b>on_addPluginApiFileButton_clicked</b>(<i></i>) |
|
138 <p> |
|
139 Private slot to add an API file from the list of API files installed |
|
140 by plugins for the selected lexer language. |
|
141 </p><a NAME="EditorAPIsPage.on_apiFileButton_clicked" ID="EditorAPIsPage.on_apiFileButton_clicked"></a> |
|
142 <h4>EditorAPIsPage.on_apiFileButton_clicked</h4> |
|
143 <b>on_apiFileButton_clicked</b>(<i></i>) |
|
144 <p> |
|
145 Private method to select an api file. |
|
146 </p><a NAME="EditorAPIsPage.on_apiLanguageComboBox_activated" ID="EditorAPIsPage.on_apiLanguageComboBox_activated"></a> |
|
147 <h4>EditorAPIsPage.on_apiLanguageComboBox_activated</h4> |
|
148 <b>on_apiLanguageComboBox_activated</b>(<i>language</i>) |
|
149 <p> |
|
150 Private slot to fill the api listbox of the api page. |
|
151 </p><dl> |
|
152 <dt><i>language</i></dt> |
|
153 <dd> |
|
154 selected API language (string) |
|
155 </dd> |
|
156 </dl><a NAME="EditorAPIsPage.on_deleteApiFileButton_clicked" ID="EditorAPIsPage.on_deleteApiFileButton_clicked"></a> |
|
157 <h4>EditorAPIsPage.on_deleteApiFileButton_clicked</h4> |
|
158 <b>on_deleteApiFileButton_clicked</b>(<i></i>) |
|
159 <p> |
|
160 Private slot to delete the currently selected file of the listbox. |
|
161 </p><a NAME="EditorAPIsPage.on_prepareApiButton_clicked" ID="EditorAPIsPage.on_prepareApiButton_clicked"></a> |
|
162 <h4>EditorAPIsPage.on_prepareApiButton_clicked</h4> |
|
163 <b>on_prepareApiButton_clicked</b>(<i></i>) |
|
164 <p> |
|
165 Private slot to prepare the API file for the currently selected language. |
|
166 </p><a NAME="EditorAPIsPage.save" ID="EditorAPIsPage.save"></a> |
|
167 <h4>EditorAPIsPage.save</h4> |
|
168 <b>save</b>(<i></i>) |
|
169 <p> |
|
170 Public slot to save the Editor APIs configuration. |
|
171 </p><a NAME="EditorAPIsPage.saveState" ID="EditorAPIsPage.saveState"></a> |
|
172 <h4>EditorAPIsPage.saveState</h4> |
|
173 <b>saveState</b>(<i></i>) |
|
174 <p> |
|
175 Public method to save the current state of the widget. |
|
176 </p><dl> |
|
177 <dt>Returns:</dt> |
|
178 <dd> |
|
179 index of the selected lexer language (integer) |
|
180 </dd> |
|
181 </dl><a NAME="EditorAPIsPage.setState" ID="EditorAPIsPage.setState"></a> |
|
182 <h4>EditorAPIsPage.setState</h4> |
|
183 <b>setState</b>(<i>state</i>) |
|
184 <p> |
|
185 Public method to set the state of the widget. |
|
186 </p><dl> |
|
187 <dt><i>state</i></dt> |
|
188 <dd> |
|
189 state data generated by saveState |
|
190 </dd> |
|
191 </dl> |
|
192 <div align="right"><a href="#top">Up</a></div> |
|
193 <hr /><hr /> |
|
194 <a NAME="create" ID="create"></a> |
|
195 <h2>create</h2> |
|
196 <b>create</b>(<i>dlg</i>) |
|
197 <p> |
|
198 Module function to create the configuration page. |
|
199 </p><dl> |
|
200 <dt><i>dlg</i></dt> |
|
201 <dd> |
|
202 reference to the configuration dialog |
|
203 </dd> |
|
204 </dl> |
|
205 <div align="right"><a href="#top">Up</a></div> |
|
206 <hr /> |
|
207 </body></html> |