Mercurial Repositories > eric / file comparison

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

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

changeset 5871
6dccd8542cd1
child 6123
39cd368143db
equal deleted inserted replaced
5870:82e04c70f969 5871:6dccd8542cd1
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.SpellCheck.ManageDictionariesDialog</h1>
23 <p>
24 Module implementing a dialog to install spell checking dictionaries.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#ManageDictionariesDialog">ManageDictionariesDialog</a></td>
34 <td>Class implementing a dialog to install spell checking dictionaries.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="ManageDictionariesDialog" ID="ManageDictionariesDialog"></a>
43 <h2>ManageDictionariesDialog</h2>
44 <p>
45 Class implementing a dialog to install spell checking dictionaries.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_ManageDictionariesDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>DocumentationDirRole</td></tr><tr><td>FilenameRole</td></tr><tr><td>LocalesRole</td></tr><tr><td>UrlRole</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#ManageDictionariesDialog.__init__">ManageDictionariesDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#ManageDictionariesDialog.__checkInstalledDictionaries">__checkInstalledDictionaries</a></td>
64 <td>Private method to check all installed dictionaries.</td>
65 </tr><tr>
66 <td><a href="#ManageDictionariesDialog.__downloadCancel">__downloadCancel</a></td>
67 <td>Private slot to cancel the current download.</td>
68 </tr><tr>
69 <td><a href="#ManageDictionariesDialog.__downloadDictionary">__downloadDictionary</a></td>
70 <td>Private slot to download a dictionary.</td>
71 </tr><tr>
72 <td><a href="#ManageDictionariesDialog.__downloadProgress">__downloadProgress</a></td>
73 <td>Private slot to show the download progress.</td>
74 </tr><tr>
75 <td><a href="#ManageDictionariesDialog.__installDictionary">__installDictionary</a></td>
76 <td>Private slot to install the downloaded dictionary.</td>
77 </tr><tr>
78 <td><a href="#ManageDictionariesDialog.__installSelected">__installSelected</a></td>
79 <td>Private method to install the selected dictionaries.</td>
80 </tr><tr>
81 <td><a href="#ManageDictionariesDialog.__installationFinished">__installationFinished</a></td>
82 <td>Private method called after all selected dictionaries have been installed.</td>
83 </tr><tr>
84 <td><a href="#ManageDictionariesDialog.__isOnline">__isOnline</a></td>
85 <td>Private method to check the online status.</td>
86 </tr><tr>
87 <td><a href="#ManageDictionariesDialog.__listFileDownloaded">__listFileDownloaded</a></td>
88 <td>Private method called, after the dictionaries list file has been downloaded from the Internet.</td>
89 </tr><tr>
90 <td><a href="#ManageDictionariesDialog.__onlineStateChanged">__onlineStateChanged</a></td>
91 <td>Private slot handling online state changes.</td>
92 </tr><tr>
93 <td><a href="#ManageDictionariesDialog.__populateList">__populateList</a></td>
94 <td>Private method to populate the list of available plugins.</td>
95 </tr><tr>
96 <td><a href="#ManageDictionariesDialog.__uninstallSelected">__uninstallSelected</a></td>
97 <td>Private method to uninstall the selected dictionaries.</td>
98 </tr><tr>
99 <td><a href="#ManageDictionariesDialog.addEntry">addEntry</a></td>
100 <td>Public method to add an entry to the list.</td>
101 </tr><tr>
102 <td><a href="#ManageDictionariesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
103 <td>Private slot to handle the click of a button of the button box.</td>
104 </tr><tr>
105 <td><a href="#ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged">on_dictionariesList_itemSelectionChanged</a></td>
106 <td>Private slot to handle a change of the selection.</td>
107 </tr><tr>
108 <td><a href="#ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled">on_dictionariesUrlEditButton_toggled</a></td>
109 <td>Private slot to set the read only status of the dictionaries URL line edit.</td>
110 </tr><tr>
111 <td><a href="#ManageDictionariesDialog.on_locationComboBox_currentTextChanged">on_locationComboBox_currentTextChanged</a></td>
112 <td>Private slot to handle a change of the installation location.</td>
113 </tr>
114 </table>
115 <h3>Static Methods</h3>
116 <table>
117 <tr><td>None</td></tr>
118 </table>
119 <a NAME="ManageDictionariesDialog.__init__" ID="ManageDictionariesDialog.__init__"></a>
120 <h4>ManageDictionariesDialog (Constructor)</h4>
121 <b>ManageDictionariesDialog</b>(<i>writeableDirectories, parent=None</i>)
122 <p>
123 Constructor
124 </p><dl>
125 <dt><i>writeableDirectories</i> (list of str)</dt>
126 <dd>
127 list of writable directories
128 </dd><dt><i>parent</i> (QWidget)</dt>
129 <dd>
130 reference to the parent widget
131 </dd>
132 </dl><a NAME="ManageDictionariesDialog.__checkInstalledDictionaries" ID="ManageDictionariesDialog.__checkInstalledDictionaries"></a>
133 <h4>ManageDictionariesDialog.__checkInstalledDictionaries</h4>
134 <b>__checkInstalledDictionaries</b>(<i></i>)
135 <p>
136 Private method to check all installed dictionaries.
137 </p><p>
138 Note: A dictionary is assumed to be installed, if at least one of its
139 binary dictionaries (*.bdic) is found in the selected dictionaries
140 location.
141 </p><a NAME="ManageDictionariesDialog.__downloadCancel" ID="ManageDictionariesDialog.__downloadCancel"></a>
142 <h4>ManageDictionariesDialog.__downloadCancel</h4>
143 <b>__downloadCancel</b>(<i></i>)
144 <p>
145 Private slot to cancel the current download.
146 </p><a NAME="ManageDictionariesDialog.__downloadDictionary" ID="ManageDictionariesDialog.__downloadDictionary"></a>
147 <h4>ManageDictionariesDialog.__downloadDictionary</h4>
148 <b>__downloadDictionary</b>(<i></i>)
149 <p>
150 Private slot to download a dictionary.
151 </p><a NAME="ManageDictionariesDialog.__downloadProgress" ID="ManageDictionariesDialog.__downloadProgress"></a>
152 <h4>ManageDictionariesDialog.__downloadProgress</h4>
153 <b>__downloadProgress</b>(<i>done, total</i>)
154 <p>
155 Private slot to show the download progress.
156 </p><dl>
157 <dt><i>done</i> (int)</dt>
158 <dd>
159 number of bytes downloaded so far
160 </dd><dt><i>total</i> (int)</dt>
161 <dd>
162 total bytes to be downloaded
163 </dd>
164 </dl><a NAME="ManageDictionariesDialog.__installDictionary" ID="ManageDictionariesDialog.__installDictionary"></a>
165 <h4>ManageDictionariesDialog.__installDictionary</h4>
166 <b>__installDictionary</b>(<i></i>)
167 <p>
168 Private slot to install the downloaded dictionary.
169 </p><a NAME="ManageDictionariesDialog.__installSelected" ID="ManageDictionariesDialog.__installSelected"></a>
170 <h4>ManageDictionariesDialog.__installSelected</h4>
171 <b>__installSelected</b>(<i></i>)
172 <p>
173 Private method to install the selected dictionaries.
174 </p><a NAME="ManageDictionariesDialog.__installationFinished" ID="ManageDictionariesDialog.__installationFinished"></a>
175 <h4>ManageDictionariesDialog.__installationFinished</h4>
176 <b>__installationFinished</b>(<i></i>)
177 <p>
178 Private method called after all selected dictionaries have been
179 installed.
180 </p><a NAME="ManageDictionariesDialog.__isOnline" ID="ManageDictionariesDialog.__isOnline"></a>
181 <h4>ManageDictionariesDialog.__isOnline</h4>
182 <b>__isOnline</b>(<i></i>)
183 <p>
184 Private method to check the online status.
185 </p><dl>
186 <dt>Returns:</dt>
187 <dd>
188 flag indicating the online status
189 </dd>
190 </dl><dl>
191 <dt>Return Type:</dt>
192 <dd>
193 bool
194 </dd>
195 </dl><a NAME="ManageDictionariesDialog.__listFileDownloaded" ID="ManageDictionariesDialog.__listFileDownloaded"></a>
196 <h4>ManageDictionariesDialog.__listFileDownloaded</h4>
197 <b>__listFileDownloaded</b>(<i></i>)
198 <p>
199 Private method called, after the dictionaries list file has been
200 downloaded from the Internet.
201 </p><a NAME="ManageDictionariesDialog.__onlineStateChanged" ID="ManageDictionariesDialog.__onlineStateChanged"></a>
202 <h4>ManageDictionariesDialog.__onlineStateChanged</h4>
203 <b>__onlineStateChanged</b>(<i>online</i>)
204 <p>
205 Private slot handling online state changes.
206 </p><dl>
207 <dt><i>online</i> (bool)</dt>
208 <dd>
209 flag indicating the online status
210 </dd>
211 </dl><a NAME="ManageDictionariesDialog.__populateList" ID="ManageDictionariesDialog.__populateList"></a>
212 <h4>ManageDictionariesDialog.__populateList</h4>
213 <b>__populateList</b>(<i></i>)
214 <p>
215 Private method to populate the list of available plugins.
216 </p><a NAME="ManageDictionariesDialog.__uninstallSelected" ID="ManageDictionariesDialog.__uninstallSelected"></a>
217 <h4>ManageDictionariesDialog.__uninstallSelected</h4>
218 <b>__uninstallSelected</b>(<i></i>)
219 <p>
220 Private method to uninstall the selected dictionaries.
221 </p><a NAME="ManageDictionariesDialog.addEntry" ID="ManageDictionariesDialog.addEntry"></a>
222 <h4>ManageDictionariesDialog.addEntry</h4>
223 <b>addEntry</b>(<i>short, filename, url, documentationDir, locales</i>)
224 <p>
225 Public method to add an entry to the list.
226 </p><dl>
227 <dt><i>short</i> (str)</dt>
228 <dd>
229 data for the description field
230 </dd><dt><i>filename</i> (str)</dt>
231 <dd>
232 data for the filename field
233 </dd><dt><i>url</i> (str)</dt>
234 <dd>
235 download URL for the dictionary entry
236 </dd><dt><i>documentationDir</i> (str)</dt>
237 <dd>
238 name of the directory containing the
239 dictionary documentation
240 </dd><dt><i>locales</i> (list of str)</dt>
241 <dd>
242 list of locales
243 </dd>
244 </dl><a NAME="ManageDictionariesDialog.on_buttonBox_clicked" ID="ManageDictionariesDialog.on_buttonBox_clicked"></a>
245 <h4>ManageDictionariesDialog.on_buttonBox_clicked</h4>
246 <b>on_buttonBox_clicked</b>(<i>button</i>)
247 <p>
248 Private slot to handle the click of a button of the button box.
249 </p><dl>
250 <dt><i>button</i> (QAbstractButton)</dt>
251 <dd>
252 reference to the button pressed
253 </dd>
254 </dl><a NAME="ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged" ID="ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged"></a>
255 <h4>ManageDictionariesDialog.on_dictionariesList_itemSelectionChanged</h4>
256 <b>on_dictionariesList_itemSelectionChanged</b>(<i></i>)
257 <p>
258 Private slot to handle a change of the selection.
259 </p><a NAME="ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled" ID="ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled"></a>
260 <h4>ManageDictionariesDialog.on_dictionariesUrlEditButton_toggled</h4>
261 <b>on_dictionariesUrlEditButton_toggled</b>(<i>checked</i>)
262 <p>
263 Private slot to set the read only status of the dictionaries URL line
264 edit.
265 </p><dl>
266 <dt><i>checked</i></dt>
267 <dd>
268 state of the push button (boolean)
269 </dd>
270 </dl><a NAME="ManageDictionariesDialog.on_locationComboBox_currentTextChanged" ID="ManageDictionariesDialog.on_locationComboBox_currentTextChanged"></a>
271 <h4>ManageDictionariesDialog.on_locationComboBox_currentTextChanged</h4>
272 <b>on_locationComboBox_currentTextChanged</b>(<i>txt</i>)
273 <p>
274 Private slot to handle a change of the installation location.
275 </p><dl>
276 <dt><i>txt</i> (str)</dt>
277 <dd>
278 installation location
279 </dd>
280 </dl>
281 <div align="right"><a href="#top">Up</a></div>
282 <hr />
283 </body></html>

Mercurial Repository: eric

eric ide

mercurial