56 </table> |
56 </table> |
57 <h3>Methods</h3> |
57 <h3>Methods</h3> |
58 <table> |
58 <table> |
59 <tr> |
59 <tr> |
60 <td><a href="#EditorAPIsPage.__init__">EditorAPIsPage</a></td> |
60 <td><a href="#EditorAPIsPage.__init__">EditorAPIsPage</a></td> |
61 <td>Constructor</td> |
61 <td>Constructor</td> |
62 </tr><tr> |
62 </tr><tr> |
63 <td><a href="#EditorAPIsPage.__apiPreparationCancelled">__apiPreparationCancelled</a></td> |
63 <td><a href="#EditorAPIsPage.__apiPreparationCancelled">__apiPreparationCancelled</a></td> |
64 <td>Private slot called after the API preparation has been cancelled.</td> |
64 <td>Private slot called after the API preparation has been cancelled.</td> |
65 </tr><tr> |
65 </tr><tr> |
66 <td><a href="#EditorAPIsPage.__apiPreparationFinished">__apiPreparationFinished</a></td> |
66 <td><a href="#EditorAPIsPage.__apiPreparationFinished">__apiPreparationFinished</a></td> |
67 <td>Private method called after the API preparation has finished.</td> |
67 <td>Private method called after the API preparation has finished.</td> |
68 </tr><tr> |
68 </tr><tr> |
69 <td><a href="#EditorAPIsPage.__apiPreparationStarted">__apiPreparationStarted</a></td> |
69 <td><a href="#EditorAPIsPage.__apiPreparationStarted">__apiPreparationStarted</a></td> |
70 <td>Private method called after the API preparation has started.</td> |
70 <td>Private method called after the API preparation has started.</td> |
71 </tr><tr> |
71 </tr><tr> |
72 <td><a href="#EditorAPIsPage.__editorGetApisFromApiList">__editorGetApisFromApiList</a></td> |
72 <td><a href="#EditorAPIsPage.__editorGetApisFromApiList">__editorGetApisFromApiList</a></td> |
73 <td>Private slot to retrieve the api filenames from the list.</td> |
73 <td>Private slot to retrieve the api filenames from the list.</td> |
74 </tr><tr> |
74 </tr><tr> |
75 <td><a href="#EditorAPIsPage.on_addApiFileButton_clicked">on_addApiFileButton_clicked</a></td> |
75 <td><a href="#EditorAPIsPage.on_addApiFileButton_clicked">on_addApiFileButton_clicked</a></td> |
76 <td>Private slot to add the api file displayed to the listbox.</td> |
76 <td>Private slot to add the api file displayed to the listbox.</td> |
77 </tr><tr> |
77 </tr><tr> |
78 <td><a href="#EditorAPIsPage.on_addInstalledApiFileButton_clicked">on_addInstalledApiFileButton_clicked</a></td> |
78 <td><a href="#EditorAPIsPage.on_addInstalledApiFileButton_clicked">on_addInstalledApiFileButton_clicked</a></td> |
79 <td>Private slot to add an API file from the list of installed API files for the selected lexer language.</td> |
79 <td>Private slot to add an API file from the list of installed API files for the selected lexer language.</td> |
80 </tr><tr> |
80 </tr><tr> |
81 <td><a href="#EditorAPIsPage.on_addPluginApiFileButton_clicked">on_addPluginApiFileButton_clicked</a></td> |
81 <td><a href="#EditorAPIsPage.on_addPluginApiFileButton_clicked">on_addPluginApiFileButton_clicked</a></td> |
82 <td>Private slot to add an API file from the list of API files installed by plugins for the selected lexer language.</td> |
82 <td>Private slot to add an API file from the list of API files installed by plugins for the selected lexer language.</td> |
83 </tr><tr> |
83 </tr><tr> |
84 <td><a href="#EditorAPIsPage.on_apiFileButton_clicked">on_apiFileButton_clicked</a></td> |
84 <td><a href="#EditorAPIsPage.on_apiFileButton_clicked">on_apiFileButton_clicked</a></td> |
85 <td>Private method to select an api file.</td> |
85 <td>Private method to select an api file.</td> |
86 </tr><tr> |
86 </tr><tr> |
87 <td><a href="#EditorAPIsPage.on_apiLanguageComboBox_activated">on_apiLanguageComboBox_activated</a></td> |
87 <td><a href="#EditorAPIsPage.on_apiLanguageComboBox_activated">on_apiLanguageComboBox_activated</a></td> |
88 <td>Private slot to fill the api listbox of the api page.</td> |
88 <td>Private slot to fill the api listbox of the api page.</td> |
89 </tr><tr> |
89 </tr><tr> |
90 <td><a href="#EditorAPIsPage.on_deleteApiFileButton_clicked">on_deleteApiFileButton_clicked</a></td> |
90 <td><a href="#EditorAPIsPage.on_deleteApiFileButton_clicked">on_deleteApiFileButton_clicked</a></td> |
91 <td>Private slot to delete the currently selected file of the listbox.</td> |
91 <td>Private slot to delete the currently selected file of the listbox.</td> |
92 </tr><tr> |
92 </tr><tr> |
93 <td><a href="#EditorAPIsPage.on_prepareApiButton_clicked">on_prepareApiButton_clicked</a></td> |
93 <td><a href="#EditorAPIsPage.on_prepareApiButton_clicked">on_prepareApiButton_clicked</a></td> |
94 <td>Private slot to prepare the API file for the currently selected language.</td> |
94 <td>Private slot to prepare the API file for the currently selected language.</td> |
95 </tr><tr> |
95 </tr><tr> |
96 <td><a href="#EditorAPIsPage.save">save</a></td> |
96 <td><a href="#EditorAPIsPage.save">save</a></td> |
97 <td>Public slot to save the Editor APIs configuration.</td> |
97 <td>Public slot to save the Editor APIs configuration.</td> |
98 </tr><tr> |
98 </tr><tr> |
99 <td><a href="#EditorAPIsPage.saveState">saveState</a></td> |
99 <td><a href="#EditorAPIsPage.saveState">saveState</a></td> |
100 <td>Public method to save the current state of the widget.</td> |
100 <td>Public method to save the current state of the widget.</td> |
101 </tr><tr> |
101 </tr><tr> |
102 <td><a href="#EditorAPIsPage.setState">setState</a></td> |
102 <td><a href="#EditorAPIsPage.setState">setState</a></td> |
103 <td>Public method to set the state of the widget.</td> |
103 <td>Public method to set the state of the widget.</td> |
104 </tr> |
104 </tr> |
105 </table> |
105 </table> |
106 <a NAME="EditorAPIsPage.__init__" ID="EditorAPIsPage.__init__"></a> |
106 <a NAME="EditorAPIsPage.__init__" ID="EditorAPIsPage.__init__"></a> |
107 <h4>EditorAPIsPage (Constructor)</h4> |
107 <h4>EditorAPIsPage (Constructor)</h4> |
108 <b>EditorAPIsPage</b>(<i></i>) |
108 <b>EditorAPIsPage</b>(<i></i>) |
109 <p> |
109 <p> |
110 Constructor |
110 Constructor |
111 </p><a NAME="EditorAPIsPage.__apiPreparationCancelled" ID="EditorAPIsPage.__apiPreparationCancelled"></a> |
111 </p><a NAME="EditorAPIsPage.__apiPreparationCancelled" ID="EditorAPIsPage.__apiPreparationCancelled"></a> |
112 <h4>EditorAPIsPage.__apiPreparationCancelled</h4> |
112 <h4>EditorAPIsPage.__apiPreparationCancelled</h4> |
113 <b>__apiPreparationCancelled</b>(<i></i>) |
113 <b>__apiPreparationCancelled</b>(<i></i>) |
114 <p> |
114 <p> |
115 Private slot called after the API preparation has been cancelled. |
115 Private slot called after the API preparation has been cancelled. |
116 </p><a NAME="EditorAPIsPage.__apiPreparationFinished" ID="EditorAPIsPage.__apiPreparationFinished"></a> |
116 </p><a NAME="EditorAPIsPage.__apiPreparationFinished" ID="EditorAPIsPage.__apiPreparationFinished"></a> |
117 <h4>EditorAPIsPage.__apiPreparationFinished</h4> |
117 <h4>EditorAPIsPage.__apiPreparationFinished</h4> |
118 <b>__apiPreparationFinished</b>(<i></i>) |
118 <b>__apiPreparationFinished</b>(<i></i>) |
119 <p> |
119 <p> |
120 Private method called after the API preparation has finished. |
120 Private method called after the API preparation has finished. |
121 </p><a NAME="EditorAPIsPage.__apiPreparationStarted" ID="EditorAPIsPage.__apiPreparationStarted"></a> |
121 </p><a NAME="EditorAPIsPage.__apiPreparationStarted" ID="EditorAPIsPage.__apiPreparationStarted"></a> |
122 <h4>EditorAPIsPage.__apiPreparationStarted</h4> |
122 <h4>EditorAPIsPage.__apiPreparationStarted</h4> |
123 <b>__apiPreparationStarted</b>(<i></i>) |
123 <b>__apiPreparationStarted</b>(<i></i>) |
124 <p> |
124 <p> |
125 Private method called after the API preparation has started. |
125 Private method called after the API preparation has started. |
126 </p><a NAME="EditorAPIsPage.__editorGetApisFromApiList" ID="EditorAPIsPage.__editorGetApisFromApiList"></a> |
126 </p><a NAME="EditorAPIsPage.__editorGetApisFromApiList" ID="EditorAPIsPage.__editorGetApisFromApiList"></a> |
127 <h4>EditorAPIsPage.__editorGetApisFromApiList</h4> |
127 <h4>EditorAPIsPage.__editorGetApisFromApiList</h4> |
128 <b>__editorGetApisFromApiList</b>(<i></i>) |
128 <b>__editorGetApisFromApiList</b>(<i></i>) |
129 <p> |
129 <p> |
130 Private slot to retrieve the api filenames from the list. |
130 Private slot to retrieve the api filenames from the list. |
131 </p><dl> |
131 </p><dl> |
132 <dt>Returns:</dt> |
132 <dt>Returns:</dt> |
133 <dd> |
133 <dd> |
134 list of api filenames (list of strings) |
134 list of api filenames (list of strings) |
135 </dd> |
135 </dd> |
136 </dl><a NAME="EditorAPIsPage.on_addApiFileButton_clicked" ID="EditorAPIsPage.on_addApiFileButton_clicked"></a> |
136 </dl><a NAME="EditorAPIsPage.on_addApiFileButton_clicked" ID="EditorAPIsPage.on_addApiFileButton_clicked"></a> |
137 <h4>EditorAPIsPage.on_addApiFileButton_clicked</h4> |
137 <h4>EditorAPIsPage.on_addApiFileButton_clicked</h4> |
138 <b>on_addApiFileButton_clicked</b>(<i></i>) |
138 <b>on_addApiFileButton_clicked</b>(<i></i>) |
139 <p> |
139 <p> |
140 Private slot to add the api file displayed to the listbox. |
140 Private slot to add the api file displayed to the listbox. |
141 </p><a NAME="EditorAPIsPage.on_addInstalledApiFileButton_clicked" ID="EditorAPIsPage.on_addInstalledApiFileButton_clicked"></a> |
141 </p><a NAME="EditorAPIsPage.on_addInstalledApiFileButton_clicked" ID="EditorAPIsPage.on_addInstalledApiFileButton_clicked"></a> |
142 <h4>EditorAPIsPage.on_addInstalledApiFileButton_clicked</h4> |
142 <h4>EditorAPIsPage.on_addInstalledApiFileButton_clicked</h4> |
143 <b>on_addInstalledApiFileButton_clicked</b>(<i></i>) |
143 <b>on_addInstalledApiFileButton_clicked</b>(<i></i>) |
144 <p> |
144 <p> |
145 Private slot to add an API file from the list of installed API files |
145 Private slot to add an API file from the list of installed API files |
146 for the selected lexer language. |
146 for the selected lexer language. |
147 </p><a NAME="EditorAPIsPage.on_addPluginApiFileButton_clicked" ID="EditorAPIsPage.on_addPluginApiFileButton_clicked"></a> |
147 </p><a NAME="EditorAPIsPage.on_addPluginApiFileButton_clicked" ID="EditorAPIsPage.on_addPluginApiFileButton_clicked"></a> |
148 <h4>EditorAPIsPage.on_addPluginApiFileButton_clicked</h4> |
148 <h4>EditorAPIsPage.on_addPluginApiFileButton_clicked</h4> |
149 <b>on_addPluginApiFileButton_clicked</b>(<i></i>) |
149 <b>on_addPluginApiFileButton_clicked</b>(<i></i>) |
150 <p> |
150 <p> |
151 Private slot to add an API file from the list of API files installed |
151 Private slot to add an API file from the list of API files installed |
152 by plugins for the selected lexer language. |
152 by plugins for the selected lexer language. |
153 </p><a NAME="EditorAPIsPage.on_apiFileButton_clicked" ID="EditorAPIsPage.on_apiFileButton_clicked"></a> |
153 </p><a NAME="EditorAPIsPage.on_apiFileButton_clicked" ID="EditorAPIsPage.on_apiFileButton_clicked"></a> |
154 <h4>EditorAPIsPage.on_apiFileButton_clicked</h4> |
154 <h4>EditorAPIsPage.on_apiFileButton_clicked</h4> |
155 <b>on_apiFileButton_clicked</b>(<i></i>) |
155 <b>on_apiFileButton_clicked</b>(<i></i>) |
156 <p> |
156 <p> |
157 Private method to select an api file. |
157 Private method to select an api file. |
158 </p><a NAME="EditorAPIsPage.on_apiLanguageComboBox_activated" ID="EditorAPIsPage.on_apiLanguageComboBox_activated"></a> |
158 </p><a NAME="EditorAPIsPage.on_apiLanguageComboBox_activated" ID="EditorAPIsPage.on_apiLanguageComboBox_activated"></a> |
159 <h4>EditorAPIsPage.on_apiLanguageComboBox_activated</h4> |
159 <h4>EditorAPIsPage.on_apiLanguageComboBox_activated</h4> |
160 <b>on_apiLanguageComboBox_activated</b>(<i>language</i>) |
160 <b>on_apiLanguageComboBox_activated</b>(<i>language</i>) |
161 <p> |
161 <p> |
162 Private slot to fill the api listbox of the api page. |
162 Private slot to fill the api listbox of the api page. |
163 </p><dl> |
163 </p><dl> |
164 <dt><i>language</i></dt> |
164 <dt><i>language</i></dt> |
165 <dd> |
165 <dd> |
166 selected API language (string) |
166 selected API language (string) |
167 </dd> |
167 </dd> |
168 </dl><a NAME="EditorAPIsPage.on_deleteApiFileButton_clicked" ID="EditorAPIsPage.on_deleteApiFileButton_clicked"></a> |
168 </dl><a NAME="EditorAPIsPage.on_deleteApiFileButton_clicked" ID="EditorAPIsPage.on_deleteApiFileButton_clicked"></a> |
169 <h4>EditorAPIsPage.on_deleteApiFileButton_clicked</h4> |
169 <h4>EditorAPIsPage.on_deleteApiFileButton_clicked</h4> |
170 <b>on_deleteApiFileButton_clicked</b>(<i></i>) |
170 <b>on_deleteApiFileButton_clicked</b>(<i></i>) |
171 <p> |
171 <p> |
172 Private slot to delete the currently selected file of the listbox. |
172 Private slot to delete the currently selected file of the listbox. |
173 </p><a NAME="EditorAPIsPage.on_prepareApiButton_clicked" ID="EditorAPIsPage.on_prepareApiButton_clicked"></a> |
173 </p><a NAME="EditorAPIsPage.on_prepareApiButton_clicked" ID="EditorAPIsPage.on_prepareApiButton_clicked"></a> |
174 <h4>EditorAPIsPage.on_prepareApiButton_clicked</h4> |
174 <h4>EditorAPIsPage.on_prepareApiButton_clicked</h4> |
175 <b>on_prepareApiButton_clicked</b>(<i></i>) |
175 <b>on_prepareApiButton_clicked</b>(<i></i>) |
176 <p> |
176 <p> |
177 Private slot to prepare the API file for the currently selected language. |
177 Private slot to prepare the API file for the currently selected language. |
178 </p><a NAME="EditorAPIsPage.save" ID="EditorAPIsPage.save"></a> |
178 </p><a NAME="EditorAPIsPage.save" ID="EditorAPIsPage.save"></a> |
179 <h4>EditorAPIsPage.save</h4> |
179 <h4>EditorAPIsPage.save</h4> |
180 <b>save</b>(<i></i>) |
180 <b>save</b>(<i></i>) |
181 <p> |
181 <p> |
182 Public slot to save the Editor APIs configuration. |
182 Public slot to save the Editor APIs configuration. |
183 </p><a NAME="EditorAPIsPage.saveState" ID="EditorAPIsPage.saveState"></a> |
183 </p><a NAME="EditorAPIsPage.saveState" ID="EditorAPIsPage.saveState"></a> |
184 <h4>EditorAPIsPage.saveState</h4> |
184 <h4>EditorAPIsPage.saveState</h4> |
185 <b>saveState</b>(<i></i>) |
185 <b>saveState</b>(<i></i>) |
186 <p> |
186 <p> |
187 Public method to save the current state of the widget. |
187 Public method to save the current state of the widget. |
188 </p><dl> |
188 </p><dl> |
189 <dt>Returns:</dt> |
189 <dt>Returns:</dt> |
190 <dd> |
190 <dd> |
191 index of the selected lexer language (integer) |
191 index of the selected lexer language (integer) |
192 </dd> |
192 </dd> |
193 </dl><a NAME="EditorAPIsPage.setState" ID="EditorAPIsPage.setState"></a> |
193 </dl><a NAME="EditorAPIsPage.setState" ID="EditorAPIsPage.setState"></a> |
194 <h4>EditorAPIsPage.setState</h4> |
194 <h4>EditorAPIsPage.setState</h4> |
195 <b>setState</b>(<i>state</i>) |
195 <b>setState</b>(<i>state</i>) |
196 <p> |
196 <p> |
197 Public method to set the state of the widget. |
197 Public method to set the state of the widget. |
198 </p><dl> |
198 </p><dl> |
199 <dt><i>state</i></dt> |
199 <dt><i>state</i></dt> |
200 <dd> |
200 <dd> |
201 state data generated by saveState |
201 state data generated by saveState |
202 </dd> |
202 </dd> |
203 </dl> |
203 </dl> |
204 <div align="right"><a href="#top">Up</a></div> |
204 <div align="right"><a href="#top">Up</a></div> |
205 <hr /><hr /> |
205 <hr /><hr /> |
206 <a NAME="create" ID="create"></a> |
206 <a NAME="create" ID="create"></a> |
207 <h2>create</h2> |
207 <h2>create</h2> |
208 <b>create</b>(<i>dlg</i>) |
208 <b>create</b>(<i>dlg</i>) |
209 <p> |
209 <p> |
210 Module function to create the configuration page. |
210 Module function to create the configuration page. |
211 </p><dl> |
211 </p><dl> |
212 <dt><i>dlg</i></dt> |
212 <dt><i>dlg</i></dt> |
213 <dd> |
213 <dd> |
214 reference to the configuration dialog |
214 reference to the configuration dialog |
215 </dd> |
215 </dd> |
216 </dl> |
216 </dl> |
217 <div align="right"><a href="#top">Up</a></div> |
217 <div align="right"><a href="#top">Up</a></div> |
218 <hr /> |
218 <hr /> |
219 </body></html> |
219 </body></html> |