src/eric7/Documentation/Source/eric7.WebBrowser.SpellCheck.ManageDictionariesDialog.html

branch
eric7
changeset 10479
856476537696
parent 10436
f6881d10e995
child 10692
9becf9ca115c
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.SpellCheck.ManageDictionariesDialog</h1> 9 <h1>eric7.WebBrowser.SpellCheck.ManageDictionariesDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to install spell checking dictionaries. 11 Module implementing a dialog to install spell checking dictionaries.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#ManageDictionariesDialog">ManageDictionariesDialog</a></td> 22 <td><a href="#ManageDictionariesDialog">ManageDictionariesDialog</a></td>
25 <td>Class implementing a dialog to install spell checking dictionaries.</td> 23 <td>Class implementing a dialog to install spell checking dictionaries.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="ManageDictionariesDialog" ID="ManageDictionariesDialog"></a> 34 <a NAME="ManageDictionariesDialog" ID="ManageDictionariesDialog"></a>
36 <h2>ManageDictionariesDialog</h2> 35 <h2>ManageDictionariesDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to install spell checking dictionaries. 37 Class implementing a dialog to install spell checking dictionaries.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_ManageDictionariesDialog 41 QDialog, Ui_ManageDictionariesDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>DocumentationDirRole</td></tr>
46 <tr><td>DocumentationDirRole</td></tr><tr><td>FilenameRole</td></tr><tr><td>LocalesRole</td></tr><tr><td>UrlRole</td></tr> 45 <tr><td>FilenameRole</td></tr>
47 </table> 46 <tr><td>LocalesRole</td></tr>
47 <tr><td>UrlRole</td></tr>
48 </table>
49
48 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
49
50 <table> 51 <table>
51 <tr><td>None</td></tr> 52 <tr><td>None</td></tr>
52 </table> 53 </table>
54
53 <h3>Methods</h3> 55 <h3>Methods</h3>
54 56 <table>
55 <table>
56
57 <tr> 57 <tr>
58 <td><a href="#ManageDictionariesDialog.__init__">ManageDictionariesDialog</a></td> 58 <td><a href="#ManageDictionariesDialog.__init__">ManageDictionariesDialog</a></td>
59 <td>Constructor</td> 59 <td>Constructor</td>
60 </tr> 60 </tr>
61 <tr> 61 <tr>
121 <tr> 121 <tr>
122 <td><a href="#ManageDictionariesDialog.on_locationComboBox_currentTextChanged">on_locationComboBox_currentTextChanged</a></td> 122 <td><a href="#ManageDictionariesDialog.on_locationComboBox_currentTextChanged">on_locationComboBox_currentTextChanged</a></td>
123 <td>Private slot to handle a change of the installation location.</td> 123 <td>Private slot to handle a change of the installation location.</td>
124 </tr> 124 </tr>
125 </table> 125 </table>
126
126 <h3>Static Methods</h3> 127 <h3>Static Methods</h3>
127
128 <table> 128 <table>
129 <tr><td>None</td></tr> 129 <tr><td>None</td></tr>
130 </table> 130 </table>
131
131 132
132 <a NAME="ManageDictionariesDialog.__init__" ID="ManageDictionariesDialog.__init__"></a> 133 <a NAME="ManageDictionariesDialog.__init__" ID="ManageDictionariesDialog.__init__"></a>
133 <h4>ManageDictionariesDialog (Constructor)</h4> 134 <h4>ManageDictionariesDialog (Constructor)</h4>
134 <b>ManageDictionariesDialog</b>(<i>writeableDirectories, enforceUnencryptedDownloads=False, parent=None, </i>) 135 <b>ManageDictionariesDialog</b>(<i>writeableDirectories, enforceUnencryptedDownloads=False, parent=None, </i>)
135
136 <p> 136 <p>
137 Constructor 137 Constructor
138 </p> 138 </p>
139
139 <dl> 140 <dl>
140 141
141 <dt><i>writeableDirectories</i> (list of str)</dt> 142 <dt><i>writeableDirectories</i> (list of str)</dt>
142 <dd> 143 <dd>
143 list of writable directories 144 list of writable directories
153 </dd> 154 </dd>
154 </dl> 155 </dl>
155 <a NAME="ManageDictionariesDialog.__checkInstalledDictionaries" ID="ManageDictionariesDialog.__checkInstalledDictionaries"></a> 156 <a NAME="ManageDictionariesDialog.__checkInstalledDictionaries" ID="ManageDictionariesDialog.__checkInstalledDictionaries"></a>
156 <h4>ManageDictionariesDialog.__checkInstalledDictionaries</h4> 157 <h4>ManageDictionariesDialog.__checkInstalledDictionaries</h4>
157 <b>__checkInstalledDictionaries</b>(<i></i>) 158 <b>__checkInstalledDictionaries</b>(<i></i>)
158
159 <p> 159 <p>
160 Private method to check all installed dictionaries. 160 Private method to check all installed dictionaries.
161 </p> 161 </p>
162 <p> 162 <p>
163 Note: A dictionary is assumed to be installed, if at least one of its 163 Note: A dictionary is assumed to be installed, if at least one of its
164 binary dictionaries (*.bdic) is found in the selected dictionaries 164 binary dictionaries (*.bdic) is found in the selected dictionaries
165 location. 165 location.
166 </p> 166 </p>
167
167 <a NAME="ManageDictionariesDialog.__downloadCancel" ID="ManageDictionariesDialog.__downloadCancel"></a> 168 <a NAME="ManageDictionariesDialog.__downloadCancel" ID="ManageDictionariesDialog.__downloadCancel"></a>
168 <h4>ManageDictionariesDialog.__downloadCancel</h4> 169 <h4>ManageDictionariesDialog.__downloadCancel</h4>
169 <b>__downloadCancel</b>(<i></i>) 170 <b>__downloadCancel</b>(<i></i>)
170
171 <p> 171 <p>
172 Private slot to cancel the current download. 172 Private slot to cancel the current download.
173 </p> 173 </p>
174
174 <a NAME="ManageDictionariesDialog.__downloadDictionary" ID="ManageDictionariesDialog.__downloadDictionary"></a> 175 <a NAME="ManageDictionariesDialog.__downloadDictionary" ID="ManageDictionariesDialog.__downloadDictionary"></a>
175 <h4>ManageDictionariesDialog.__downloadDictionary</h4> 176 <h4>ManageDictionariesDialog.__downloadDictionary</h4>
176 <b>__downloadDictionary</b>(<i></i>) 177 <b>__downloadDictionary</b>(<i></i>)
177
178 <p> 178 <p>
179 Private slot to download a dictionary. 179 Private slot to download a dictionary.
180 </p> 180 </p>
181
181 <a NAME="ManageDictionariesDialog.__downloadProgress" ID="ManageDictionariesDialog.__downloadProgress"></a> 182 <a NAME="ManageDictionariesDialog.__downloadProgress" ID="ManageDictionariesDialog.__downloadProgress"></a>
182 <h4>ManageDictionariesDialog.__downloadProgress</h4> 183 <h4>ManageDictionariesDialog.__downloadProgress</h4>
183 <b>__downloadProgress</b>(<i>done, total</i>) 184 <b>__downloadProgress</b>(<i>done, total</i>)
184
185 <p> 185 <p>
186 Private slot to show the download progress. 186 Private slot to show the download progress.
187 </p> 187 </p>
188
188 <dl> 189 <dl>
189 190
190 <dt><i>done</i> (int)</dt> 191 <dt><i>done</i> (int)</dt>
191 <dd> 192 <dd>
192 number of bytes downloaded so far 193 number of bytes downloaded so far
197 </dd> 198 </dd>
198 </dl> 199 </dl>
199 <a NAME="ManageDictionariesDialog.__installDictionary" ID="ManageDictionariesDialog.__installDictionary"></a> 200 <a NAME="ManageDictionariesDialog.__installDictionary" ID="ManageDictionariesDialog.__installDictionary"></a>
200 <h4>ManageDictionariesDialog.__installDictionary</h4> 201 <h4>ManageDictionariesDialog.__installDictionary</h4>
201 <b>__installDictionary</b>(<i>reply</i>) 202 <b>__installDictionary</b>(<i>reply</i>)
202
203 <p> 203 <p>
204 Private slot to install the downloaded dictionary. 204 Private slot to install the downloaded dictionary.
205 </p> 205 </p>
206
206 <dl> 207 <dl>
207 208
208 <dt><i>reply</i> (QNetworkReply)</dt> 209 <dt><i>reply</i> (QNetworkReply)</dt>
209 <dd> 210 <dd>
210 reference to the network reply 211 reference to the network reply
211 </dd> 212 </dd>
212 </dl> 213 </dl>
213 <a NAME="ManageDictionariesDialog.__installSelected" ID="ManageDictionariesDialog.__installSelected"></a> 214 <a NAME="ManageDictionariesDialog.__installSelected" ID="ManageDictionariesDialog.__installSelected"></a>
214 <h4>ManageDictionariesDialog.__installSelected</h4> 215 <h4>ManageDictionariesDialog.__installSelected</h4>
215 <b>__installSelected</b>(<i></i>) 216 <b>__installSelected</b>(<i></i>)
216
217 <p> 217 <p>
218 Private method to install the selected dictionaries. 218 Private method to install the selected dictionaries.
219 </p> 219 </p>
220
220 <a NAME="ManageDictionariesDialog.__installationFinished" ID="ManageDictionariesDialog.__installationFinished"></a> 221 <a NAME="ManageDictionariesDialog.__installationFinished" ID="ManageDictionariesDialog.__installationFinished"></a>
221 <h4>ManageDictionariesDialog.__installationFinished</h4> 222 <h4>ManageDictionariesDialog.__installationFinished</h4>
222 <b>__installationFinished</b>(<i></i>) 223 <b>__installationFinished</b>(<i></i>)
223
224 <p> 224 <p>
225 Private method called after all selected dictionaries have been 225 Private method called after all selected dictionaries have been
226 installed. 226 installed.
227 </p> 227 </p>
228
228 <a NAME="ManageDictionariesDialog.__listFileDownloaded" ID="ManageDictionariesDialog.__listFileDownloaded"></a> 229 <a NAME="ManageDictionariesDialog.__listFileDownloaded" ID="ManageDictionariesDialog.__listFileDownloaded"></a>
229 <h4>ManageDictionariesDialog.__listFileDownloaded</h4> 230 <h4>ManageDictionariesDialog.__listFileDownloaded</h4>
230 <b>__listFileDownloaded</b>(<i>reply</i>) 231 <b>__listFileDownloaded</b>(<i>reply</i>)
231
232 <p> 232 <p>
233 Private method called, after the dictionaries list file has been 233 Private method called, after the dictionaries list file has been
234 downloaded from the Internet. 234 downloaded from the Internet.
235 </p> 235 </p>
236
236 <dl> 237 <dl>
237 238
238 <dt><i>reply</i> (QNetworkReply)</dt> 239 <dt><i>reply</i> (QNetworkReply)</dt>
239 <dd> 240 <dd>
240 reference to the network reply 241 reference to the network reply
241 </dd> 242 </dd>
242 </dl> 243 </dl>
243 <a NAME="ManageDictionariesDialog.__populateList" ID="ManageDictionariesDialog.__populateList"></a> 244 <a NAME="ManageDictionariesDialog.__populateList" ID="ManageDictionariesDialog.__populateList"></a>
244 <h4>ManageDictionariesDialog.__populateList</h4> 245 <h4>ManageDictionariesDialog.__populateList</h4>
245 <b>__populateList</b>(<i></i>) 246 <b>__populateList</b>(<i></i>)
246
247 <p> 247 <p>
248 Private method to populate the list of available plugins. 248 Private method to populate the list of available plugins.
249 </p> 249 </p>
250
250 <a NAME="ManageDictionariesDialog.__reachabilityChanged" ID="ManageDictionariesDialog.__reachabilityChanged"></a> 251 <a NAME="ManageDictionariesDialog.__reachabilityChanged" ID="ManageDictionariesDialog.__reachabilityChanged"></a>
251 <h4>ManageDictionariesDialog.__reachabilityChanged</h4> 252 <h4>ManageDictionariesDialog.__reachabilityChanged</h4>
252 <b>__reachabilityChanged</b>(<i>reachability</i>) 253 <b>__reachabilityChanged</b>(<i>reachability</i>)
253
254 <p> 254 <p>
255 Private slot handling reachability state changes. 255 Private slot handling reachability state changes.
256 </p> 256 </p>
257
257 <dl> 258 <dl>
258 259
259 <dt><i>reachability</i> (QNetworkInformation.Reachability)</dt> 260 <dt><i>reachability</i> (QNetworkInformation.Reachability)</dt>
260 <dd> 261 <dd>
261 new reachability state 262 new reachability state
262 </dd> 263 </dd>
263 </dl> 264 </dl>
264 <a NAME="ManageDictionariesDialog.__uninstallSelected" ID="ManageDictionariesDialog.__uninstallSelected"></a> 265 <a NAME="ManageDictionariesDialog.__uninstallSelected" ID="ManageDictionariesDialog.__uninstallSelected"></a>
265 <h4>ManageDictionariesDialog.__uninstallSelected</h4> 266 <h4>ManageDictionariesDialog.__uninstallSelected</h4>
266 <b>__uninstallSelected</b>(<i></i>) 267 <b>__uninstallSelected</b>(<i></i>)
267
268 <p> 268 <p>
269 Private method to uninstall the selected dictionaries. 269 Private method to uninstall the selected dictionaries.
270 </p> 270 </p>
271
271 <a NAME="ManageDictionariesDialog.addEntry" ID="ManageDictionariesDialog.addEntry"></a> 272 <a NAME="ManageDictionariesDialog.addEntry" ID="ManageDictionariesDialog.addEntry"></a>
272 <h4>ManageDictionariesDialog.addEntry</h4> 273 <h4>ManageDictionariesDialog.addEntry</h4>
273 <b>addEntry</b>(<i>short, filename, url, documentationDir, locales</i>) 274 <b>addEntry</b>(<i>short, filename, url, documentationDir, locales</i>)
274
275 <p> 275 <p>
276 Public method to add an entry to the list. 276 Public method to add an entry to the list.
277 </p> 277 </p>
278
278 <dl> 279 <dl>
279 280
280 <dt><i>short</i> (str)</dt> 281 <dt><i>short</i> (str)</dt>
281 <dd> 282 <dd>
282 data for the description field 283 data for the description field
300 </dd> 301 </dd>
301 </dl> 302 </dl>
302 <a NAME="ManageDictionariesDialog.on_buttonBox_clicked" ID="ManageDictionariesDialog.on_buttonBox_clicked"></a> 303 <a NAME="ManageDictionariesDialog.on_buttonBox_clicked" ID="ManageDictionariesDialog.on_buttonBox_clicked"></a>
303 <h4>ManageDictionariesDialog.on_buttonBox_clicked</h4> 304 <h4>ManageDictionariesDialog.on_buttonBox_clicked</h4>
304 <b>on_buttonBox_clicked</b>(<i>button</i>) 305 <b>on_buttonBox_clicked</b>(<i>button</i>)
305
306 <p> 306 <p>
307 Private slot to handle the click of a button of the button box. 307 Private slot to handle the click of a button of the button box.
308 </p> 308 </p>
309
309 <dl> 310 <dl>
310 311
311 <dt><i>button</i> (QAbstractButton)</dt> 312 <dt><i>button</i> (QAbstractButton)</dt>
312 <dd> 313 <dd>
313 reference to the button pressed 314 reference to the button pressed
314 </dd> 315 </dd>
315 </dl> 316 </dl>
316 <a NAME="ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged" ID="ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged"></a> 317 <a NAME="ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged" ID="ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged"></a>
317 <h4>ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged</h4> 318 <h4>ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged</h4>
318 <b>on_dictionariesList_itemSelectionChanged</b>(<i></i>) 319 <b>on_dictionariesList_itemSelectionChanged</b>(<i></i>)
319
320 <p> 320 <p>
321 Private slot to handle a change of the selection. 321 Private slot to handle a change of the selection.
322 </p> 322 </p>
323
323 <a NAME="ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled" ID="ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled"></a> 324 <a NAME="ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled" ID="ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled"></a>
324 <h4>ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled</h4> 325 <h4>ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled</h4>
325 <b>on_dictionariesUrlEditButton_toggled</b>(<i>checked</i>) 326 <b>on_dictionariesUrlEditButton_toggled</b>(<i>checked</i>)
326
327 <p> 327 <p>
328 Private slot to set the read only status of the dictionaries URL line 328 Private slot to set the read only status of the dictionaries URL line
329 edit. 329 edit.
330 </p> 330 </p>
331
331 <dl> 332 <dl>
332 333
333 <dt><i>checked</i> (bool)</dt> 334 <dt><i>checked</i> (bool)</dt>
334 <dd> 335 <dd>
335 state of the push button 336 state of the push button
336 </dd> 337 </dd>
337 </dl> 338 </dl>
338 <a NAME="ManageDictionariesDialog.on_locationComboBox_currentTextChanged" ID="ManageDictionariesDialog.on_locationComboBox_currentTextChanged"></a> 339 <a NAME="ManageDictionariesDialog.on_locationComboBox_currentTextChanged" ID="ManageDictionariesDialog.on_locationComboBox_currentTextChanged"></a>
339 <h4>ManageDictionariesDialog.on_locationComboBox_currentTextChanged</h4> 340 <h4>ManageDictionariesDialog.on_locationComboBox_currentTextChanged</h4>
340 <b>on_locationComboBox_currentTextChanged</b>(<i>txt</i>) 341 <b>on_locationComboBox_currentTextChanged</b>(<i>txt</i>)
341
342 <p> 342 <p>
343 Private slot to handle a change of the installation location. 343 Private slot to handle a change of the installation location.
344 </p> 344 </p>
345
345 <dl> 346 <dl>
346 347
347 <dt><i>txt</i> (str)</dt> 348 <dt><i>txt</i> (str)</dt>
348 <dd> 349 <dd>
349 installation location 350 installation location

eric ide

mercurial