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