Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.SpellCheck.ManageDictionariesDialog.html

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

branch
eric7
changeset 8372
e0227a7c850e
child 8580
e91b276e0771
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.SpellCheck.ManageDictionariesDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.WebBrowser.SpellCheck.ManageDictionariesDialog</h1>
24
25 <p>
26 Module implementing a dialog to install spell checking dictionaries.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#ManageDictionariesDialog">ManageDictionariesDialog</a></td>
39 <td>Class implementing a dialog to install spell checking dictionaries.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="ManageDictionariesDialog" ID="ManageDictionariesDialog"></a>
50 <h2>ManageDictionariesDialog</h2>
51
52 <p>
53 Class implementing a dialog to install spell checking dictionaries.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_ManageDictionariesDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>DocumentationDirRole</td></tr><tr><td>FilenameRole</td></tr><tr><td>LocalesRole</td></tr><tr><td>UrlRole</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#ManageDictionariesDialog.__init__">ManageDictionariesDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#ManageDictionariesDialog.__checkInstalledDictionaries">__checkInstalledDictionaries</a></td>
77 <td>Private method to check all installed dictionaries.</td>
78 </tr>
79 <tr>
80 <td><a href="#ManageDictionariesDialog.__downloadCancel">__downloadCancel</a></td>
81 <td>Private slot to cancel the current download.</td>
82 </tr>
83 <tr>
84 <td><a href="#ManageDictionariesDialog.__downloadDictionary">__downloadDictionary</a></td>
85 <td>Private slot to download a dictionary.</td>
86 </tr>
87 <tr>
88 <td><a href="#ManageDictionariesDialog.__downloadProgress">__downloadProgress</a></td>
89 <td>Private slot to show the download progress.</td>
90 </tr>
91 <tr>
92 <td><a href="#ManageDictionariesDialog.__installDictionary">__installDictionary</a></td>
93 <td>Private slot to install the downloaded dictionary.</td>
94 </tr>
95 <tr>
96 <td><a href="#ManageDictionariesDialog.__installSelected">__installSelected</a></td>
97 <td>Private method to install the selected dictionaries.</td>
98 </tr>
99 <tr>
100 <td><a href="#ManageDictionariesDialog.__installationFinished">__installationFinished</a></td>
101 <td>Private method called after all selected dictionaries have been installed.</td>
102 </tr>
103 <tr>
104 <td><a href="#ManageDictionariesDialog.__listFileDownloaded">__listFileDownloaded</a></td>
105 <td>Private method called, after the dictionaries list file has been downloaded from the Internet.</td>
106 </tr>
107 <tr>
108 <td><a href="#ManageDictionariesDialog.__populateList">__populateList</a></td>
109 <td>Private method to populate the list of available plugins.</td>
110 </tr>
111 <tr>
112 <td><a href="#ManageDictionariesDialog.__uninstallSelected">__uninstallSelected</a></td>
113 <td>Private method to uninstall the selected dictionaries.</td>
114 </tr>
115 <tr>
116 <td><a href="#ManageDictionariesDialog.addEntry">addEntry</a></td>
117 <td>Public method to add an entry to the list.</td>
118 </tr>
119 <tr>
120 <td><a href="#ManageDictionariesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
121 <td>Private slot to handle the click of a button of the button box.</td>
122 </tr>
123 <tr>
124 <td><a href="#ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged">on_dictionariesList_itemSelectionChanged</a></td>
125 <td>Private slot to handle a change of the selection.</td>
126 </tr>
127 <tr>
128 <td><a href="#ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled">on_dictionariesUrlEditButton_toggled</a></td>
129 <td>Private slot to set the read only status of the dictionaries URL line edit.</td>
130 </tr>
131 <tr>
132 <td><a href="#ManageDictionariesDialog.on_locationComboBox_currentTextChanged">on_locationComboBox_currentTextChanged</a></td>
133 <td>Private slot to handle a change of the installation location.</td>
134 </tr>
135 </table>
136 <h3>Static Methods</h3>
137
138 <table>
139 <tr><td>None</td></tr>
140 </table>
141
142 <a NAME="ManageDictionariesDialog.__init__" ID="ManageDictionariesDialog.__init__"></a>
143 <h4>ManageDictionariesDialog (Constructor)</h4>
144 <b>ManageDictionariesDialog</b>(<i>writeableDirectories, parent=None</i>)
145
146 <p>
147 Constructor
148 </p>
149 <dl>
150
151 <dt><i>writeableDirectories</i> (list of str)</dt>
152 <dd>
153 list of writable directories
154 </dd>
155 <dt><i>parent</i> (QWidget)</dt>
156 <dd>
157 reference to the parent widget
158 </dd>
159 </dl>
160 <a NAME="ManageDictionariesDialog.__checkInstalledDictionaries" ID="ManageDictionariesDialog.__checkInstalledDictionaries"></a>
161 <h4>ManageDictionariesDialog.__checkInstalledDictionaries</h4>
162 <b>__checkInstalledDictionaries</b>(<i></i>)
163
164 <p>
165 Private method to check all installed dictionaries.
166 </p>
167 <p>
168 Note: A dictionary is assumed to be installed, if at least one of its
169 binary dictionaries (*.bdic) is found in the selected dictionaries
170 location.
171 </p>
172 <a NAME="ManageDictionariesDialog.__downloadCancel" ID="ManageDictionariesDialog.__downloadCancel"></a>
173 <h4>ManageDictionariesDialog.__downloadCancel</h4>
174 <b>__downloadCancel</b>(<i></i>)
175
176 <p>
177 Private slot to cancel the current download.
178 </p>
179 <a NAME="ManageDictionariesDialog.__downloadDictionary" ID="ManageDictionariesDialog.__downloadDictionary"></a>
180 <h4>ManageDictionariesDialog.__downloadDictionary</h4>
181 <b>__downloadDictionary</b>(<i></i>)
182
183 <p>
184 Private slot to download a dictionary.
185 </p>
186 <a NAME="ManageDictionariesDialog.__downloadProgress" ID="ManageDictionariesDialog.__downloadProgress"></a>
187 <h4>ManageDictionariesDialog.__downloadProgress</h4>
188 <b>__downloadProgress</b>(<i>done, total</i>)
189
190 <p>
191 Private slot to show the download progress.
192 </p>
193 <dl>
194
195 <dt><i>done</i> (int)</dt>
196 <dd>
197 number of bytes downloaded so far
198 </dd>
199 <dt><i>total</i> (int)</dt>
200 <dd>
201 total bytes to be downloaded
202 </dd>
203 </dl>
204 <a NAME="ManageDictionariesDialog.__installDictionary" ID="ManageDictionariesDialog.__installDictionary"></a>
205 <h4>ManageDictionariesDialog.__installDictionary</h4>
206 <b>__installDictionary</b>(<i>reply</i>)
207
208 <p>
209 Private slot to install the downloaded dictionary.
210 </p>
211 <dl>
212
213 <dt><i>reply</i> (QNetworkReply)</dt>
214 <dd>
215 reference to the network reply
216 </dd>
217 </dl>
218 <a NAME="ManageDictionariesDialog.__installSelected" ID="ManageDictionariesDialog.__installSelected"></a>
219 <h4>ManageDictionariesDialog.__installSelected</h4>
220 <b>__installSelected</b>(<i></i>)
221
222 <p>
223 Private method to install the selected dictionaries.
224 </p>
225 <a NAME="ManageDictionariesDialog.__installationFinished" ID="ManageDictionariesDialog.__installationFinished"></a>
226 <h4>ManageDictionariesDialog.__installationFinished</h4>
227 <b>__installationFinished</b>(<i></i>)
228
229 <p>
230 Private method called after all selected dictionaries have been
231 installed.
232 </p>
233 <a NAME="ManageDictionariesDialog.__listFileDownloaded" ID="ManageDictionariesDialog.__listFileDownloaded"></a>
234 <h4>ManageDictionariesDialog.__listFileDownloaded</h4>
235 <b>__listFileDownloaded</b>(<i>reply</i>)
236
237 <p>
238 Private method called, after the dictionaries list file has been
239 downloaded from the Internet.
240 </p>
241 <dl>
242
243 <dt><i>reply</i> (QNetworkReply)</dt>
244 <dd>
245 reference to the network reply
246 </dd>
247 </dl>
248 <a NAME="ManageDictionariesDialog.__populateList" ID="ManageDictionariesDialog.__populateList"></a>
249 <h4>ManageDictionariesDialog.__populateList</h4>
250 <b>__populateList</b>(<i></i>)
251
252 <p>
253 Private method to populate the list of available plugins.
254 </p>
255 <a NAME="ManageDictionariesDialog.__uninstallSelected" ID="ManageDictionariesDialog.__uninstallSelected"></a>
256 <h4>ManageDictionariesDialog.__uninstallSelected</h4>
257 <b>__uninstallSelected</b>(<i></i>)
258
259 <p>
260 Private method to uninstall the selected dictionaries.
261 </p>
262 <a NAME="ManageDictionariesDialog.addEntry" ID="ManageDictionariesDialog.addEntry"></a>
263 <h4>ManageDictionariesDialog.addEntry</h4>
264 <b>addEntry</b>(<i>short, filename, url, documentationDir, locales</i>)
265
266 <p>
267 Public method to add an entry to the list.
268 </p>
269 <dl>
270
271 <dt><i>short</i> (str)</dt>
272 <dd>
273 data for the description field
274 </dd>
275 <dt><i>filename</i> (str)</dt>
276 <dd>
277 data for the filename field
278 </dd>
279 <dt><i>url</i> (str)</dt>
280 <dd>
281 download URL for the dictionary entry
282 </dd>
283 <dt><i>documentationDir</i> (str)</dt>
284 <dd>
285 name of the directory containing the
286 dictionary documentation
287 </dd>
288 <dt><i>locales</i> (list of str)</dt>
289 <dd>
290 list of locales
291 </dd>
292 </dl>
293 <a NAME="ManageDictionariesDialog.on_buttonBox_clicked" ID="ManageDictionariesDialog.on_buttonBox_clicked"></a>
294 <h4>ManageDictionariesDialog.on_buttonBox_clicked</h4>
295 <b>on_buttonBox_clicked</b>(<i>button</i>)
296
297 <p>
298 Private slot to handle the click of a button of the button box.
299 </p>
300 <dl>
301
302 <dt><i>button</i> (QAbstractButton)</dt>
303 <dd>
304 reference to the button pressed
305 </dd>
306 </dl>
307 <a NAME="ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged" ID="ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged"></a>
308 <h4>ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged</h4>
309 <b>on_dictionariesList_itemSelectionChanged</b>(<i></i>)
310
311 <p>
312 Private slot to handle a change of the selection.
313 </p>
314 <a NAME="ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled" ID="ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled"></a>
315 <h4>ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled</h4>
316 <b>on_dictionariesUrlEditButton_toggled</b>(<i>checked</i>)
317
318 <p>
319 Private slot to set the read only status of the dictionaries URL line
320 edit.
321 </p>
322 <dl>
323
324 <dt><i>checked</i></dt>
325 <dd>
326 state of the push button (boolean)
327 </dd>
328 </dl>
329 <a NAME="ManageDictionariesDialog.on_locationComboBox_currentTextChanged" ID="ManageDictionariesDialog.on_locationComboBox_currentTextChanged"></a>
330 <h4>ManageDictionariesDialog.on_locationComboBox_currentTextChanged</h4>
331 <b>on_locationComboBox_currentTextChanged</b>(<i>txt</i>)
332
333 <p>
334 Private slot to handle a change of the installation location.
335 </p>
336 <dl>
337
338 <dt><i>txt</i> (str)</dt>
339 <dd>
340 installation location
341 </dd>
342 </dl>
343 <div align="right"><a href="#top">Up</a></div>
344 <hr />
345 </body></html>

Mercurial Repository: eric

eric ide

mercurial