57 <tr> |
57 <tr> |
58 <td><a href="#SpellChecker._getDict">_getDict</a></td> |
58 <td><a href="#SpellChecker._getDict">_getDict</a></td> |
59 <td>Protected classmethod to get a new dictionary.</td> |
59 <td>Protected classmethod to get a new dictionary.</td> |
60 </tr><tr> |
60 </tr><tr> |
61 <td><a href="#SpellChecker.getAvailableLanguages">getAvailableLanguages</a></td> |
61 <td><a href="#SpellChecker.getAvailableLanguages">getAvailableLanguages</a></td> |
62 <td>Public classmethod to get all available languages.</td> |
62 <td>Class method to get all available languages.</td> |
63 </tr><tr> |
63 </tr><tr> |
64 <td><a href="#SpellChecker.getDefaultPath">getDefaultPath</a></td> |
64 <td><a href="#SpellChecker.getDefaultPath">getDefaultPath</a></td> |
65 <td>Class method to get the default path names of the user dictionaries.</td> |
65 <td>Class method to get the default path names of the user dictionaries.</td> |
66 </tr><tr> |
66 </tr><tr> |
67 <td><a href="#SpellChecker.getUserDictionaryPath">getUserDictionaryPath</a></td> |
67 <td><a href="#SpellChecker.getUserDictionaryPath">getUserDictionaryPath</a></td> |
68 <td>Class method to get the path name of a user dictionary file.</td> |
68 <td>Class method to get the path name of a user dictionary file.</td> |
69 </tr><tr> |
69 </tr><tr> |
70 <td><a href="#SpellChecker.isAvailable">isAvailable</a></td> |
70 <td><a href="#SpellChecker.isAvailable">isAvailable</a></td> |
71 <td>Public classmethod to check, if spellchecking is available.</td> |
71 <td>Class method to check, if spellchecking is available.</td> |
72 </tr><tr> |
72 </tr><tr> |
73 <td><a href="#SpellChecker.setDefaultLanguage">setDefaultLanguage</a></td> |
73 <td><a href="#SpellChecker.setDefaultLanguage">setDefaultLanguage</a></td> |
74 <td>Public classmethod to set the default language.</td> |
74 <td>Class method to set the default language.</td> |
75 </tr> |
75 </tr> |
76 </table> |
76 </table> |
77 <h3>Methods</h3> |
77 <h3>Methods</h3> |
78 <table> |
78 <table> |
79 <tr> |
79 <tr> |
88 </tr><tr> |
88 </tr><tr> |
89 <td><a href="#SpellChecker.__incrementalCheck">__incrementalCheck</a></td> |
89 <td><a href="#SpellChecker.__incrementalCheck">__incrementalCheck</a></td> |
90 <td>Private method to check the document incrementally.</td> |
90 <td>Private method to check the document incrementally.</td> |
91 </tr><tr> |
91 </tr><tr> |
92 <td><a href="#SpellChecker.__iter__">__iter__</a></td> |
92 <td><a href="#SpellChecker.__iter__">__iter__</a></td> |
93 <td>Private method to create an iterator.</td> |
93 <td>Special method to create an iterator.</td> |
94 </tr><tr> |
94 </tr><tr> |
95 <td><a href="#SpellChecker.__next__">__next__</a></td> |
95 <td><a href="#SpellChecker.__next__">__next__</a></td> |
96 <td>Public method to advance to the next error.</td> |
96 <td>Special method to advance to the next error.</td> |
97 </tr><tr> |
97 </tr><tr> |
98 <td><a href="#SpellChecker.add">add</a></td> |
98 <td><a href="#SpellChecker.add">add</a></td> |
99 <td>Public method to add a word to the personal word list.</td> |
99 <td>Public method to add a word to the personal word list.</td> |
100 </tr><tr> |
100 </tr><tr> |
101 <td><a href="#SpellChecker.checkCurrentPage">checkCurrentPage</a></td> |
101 <td><a href="#SpellChecker.checkCurrentPage">checkCurrentPage</a></td> |
102 <td>Private method to check the currently visible page.</td> |
102 <td>Public method to check the currently visible page.</td> |
103 </tr><tr> |
103 </tr><tr> |
104 <td><a href="#SpellChecker.checkDocument">checkDocument</a></td> |
104 <td><a href="#SpellChecker.checkDocument">checkDocument</a></td> |
105 <td>Public method to check the complete document.</td> |
105 <td>Public method to check the complete document.</td> |
106 </tr><tr> |
106 </tr><tr> |
107 <td><a href="#SpellChecker.checkDocumentIncrementally">checkDocumentIncrementally</a></td> |
107 <td><a href="#SpellChecker.checkDocumentIncrementally">checkDocumentIncrementally</a></td> |
109 </tr><tr> |
109 </tr><tr> |
110 <td><a href="#SpellChecker.checkLines">checkLines</a></td> |
110 <td><a href="#SpellChecker.checkLines">checkLines</a></td> |
111 <td>Public method to check some lines of text.</td> |
111 <td>Public method to check some lines of text.</td> |
112 </tr><tr> |
112 </tr><tr> |
113 <td><a href="#SpellChecker.checkSelection">checkSelection</a></td> |
113 <td><a href="#SpellChecker.checkSelection">checkSelection</a></td> |
114 <td>Private method to check the current selection.</td> |
114 <td>Public method to check the current selection.</td> |
115 </tr><tr> |
115 </tr><tr> |
116 <td><a href="#SpellChecker.checkWord">checkWord</a></td> |
116 <td><a href="#SpellChecker.checkWord">checkWord</a></td> |
117 <td>Public method to check the word at position pos.</td> |
117 <td>Public method to check the word at position pos.</td> |
118 </tr><tr> |
118 </tr><tr> |
119 <td><a href="#SpellChecker.clearAll">clearAll</a></td> |
119 <td><a href="#SpellChecker.clearAll">clearAll</a></td> |
184 </dd> |
184 </dd> |
185 </dl><a NAME="SpellChecker.getAvailableLanguages" ID="SpellChecker.getAvailableLanguages"></a> |
185 </dl><a NAME="SpellChecker.getAvailableLanguages" ID="SpellChecker.getAvailableLanguages"></a> |
186 <h4>SpellChecker.getAvailableLanguages (class method)</h4> |
186 <h4>SpellChecker.getAvailableLanguages (class method)</h4> |
187 <b>getAvailableLanguages</b>(<i></i>) |
187 <b>getAvailableLanguages</b>(<i></i>) |
188 <p> |
188 <p> |
189 Public classmethod to get all available languages. |
189 Class method to get all available languages. |
190 </p><dl> |
190 </p><dl> |
191 <dt>Returns:</dt> |
191 <dt>Returns:</dt> |
192 <dd> |
192 <dd> |
193 list of available languages (list of strings) |
193 list of available languages (list of strings) |
194 </dd> |
194 </dd> |
228 </dd> |
228 </dd> |
229 </dl><a NAME="SpellChecker.isAvailable" ID="SpellChecker.isAvailable"></a> |
229 </dl><a NAME="SpellChecker.isAvailable" ID="SpellChecker.isAvailable"></a> |
230 <h4>SpellChecker.isAvailable (class method)</h4> |
230 <h4>SpellChecker.isAvailable (class method)</h4> |
231 <b>isAvailable</b>(<i></i>) |
231 <b>isAvailable</b>(<i></i>) |
232 <p> |
232 <p> |
233 Public classmethod to check, if spellchecking is available. |
233 Class method to check, if spellchecking is available. |
234 </p><dl> |
234 </p><dl> |
235 <dt>Returns:</dt> |
235 <dt>Returns:</dt> |
236 <dd> |
236 <dd> |
237 flag indicating availability (boolean) |
237 flag indicating availability (boolean) |
238 </dd> |
238 </dd> |
239 </dl><a NAME="SpellChecker.setDefaultLanguage" ID="SpellChecker.setDefaultLanguage"></a> |
239 </dl><a NAME="SpellChecker.setDefaultLanguage" ID="SpellChecker.setDefaultLanguage"></a> |
240 <h4>SpellChecker.setDefaultLanguage (class method)</h4> |
240 <h4>SpellChecker.setDefaultLanguage (class method)</h4> |
241 <b>setDefaultLanguage</b>(<i>language</i>) |
241 <b>setDefaultLanguage</b>(<i>language</i>) |
242 <p> |
242 <p> |
243 Public classmethod to set the default language. |
243 Class method to set the default language. |
244 </p><dl> |
244 </p><dl> |
245 <dt><i>language</i></dt> |
245 <dt><i>language</i></dt> |
246 <dd> |
246 <dd> |
247 the language to be used as the default (string). |
247 the language to be used as the default (string). |
248 The string should be in language locale format (e.g. en_US, de). |
248 The string should be in language locale format (e.g. en_US, de). |
309 Private method to check the document incrementally. |
309 Private method to check the document incrementally. |
310 </p><a NAME="SpellChecker.__iter__" ID="SpellChecker.__iter__"></a> |
310 </p><a NAME="SpellChecker.__iter__" ID="SpellChecker.__iter__"></a> |
311 <h4>SpellChecker.__iter__</h4> |
311 <h4>SpellChecker.__iter__</h4> |
312 <b>__iter__</b>(<i></i>) |
312 <b>__iter__</b>(<i></i>) |
313 <p> |
313 <p> |
314 Private method to create an iterator. |
314 Special method to create an iterator. |
315 </p><dl> |
315 </p><dl> |
316 <dt>Returns:</dt> |
316 <dt>Returns:</dt> |
317 <dd> |
317 <dd> |
318 self |
318 self |
319 </dd> |
319 </dd> |
320 </dl><a NAME="SpellChecker.__next__" ID="SpellChecker.__next__"></a> |
320 </dl><a NAME="SpellChecker.__next__" ID="SpellChecker.__next__"></a> |
321 <h4>SpellChecker.__next__</h4> |
321 <h4>SpellChecker.__next__</h4> |
322 <b>__next__</b>(<i></i>) |
322 <b>__next__</b>(<i></i>) |
323 <p> |
323 <p> |
324 Public method to advance to the next error. |
324 Special method to advance to the next error. |
325 </p><dl> |
325 </p><dl> |
326 <dt>Returns:</dt> |
326 <dt>Returns:</dt> |
327 <dd> |
327 <dd> |
328 self |
328 self |
329 </dd> |
329 </dd> |
344 </dd> |
344 </dd> |
345 </dl><a NAME="SpellChecker.checkCurrentPage" ID="SpellChecker.checkCurrentPage"></a> |
345 </dl><a NAME="SpellChecker.checkCurrentPage" ID="SpellChecker.checkCurrentPage"></a> |
346 <h4>SpellChecker.checkCurrentPage</h4> |
346 <h4>SpellChecker.checkCurrentPage</h4> |
347 <b>checkCurrentPage</b>(<i></i>) |
347 <b>checkCurrentPage</b>(<i></i>) |
348 <p> |
348 <p> |
349 Private method to check the currently visible page. |
349 Public method to check the currently visible page. |
350 </p><a NAME="SpellChecker.checkDocument" ID="SpellChecker.checkDocument"></a> |
350 </p><a NAME="SpellChecker.checkDocument" ID="SpellChecker.checkDocument"></a> |
351 <h4>SpellChecker.checkDocument</h4> |
351 <h4>SpellChecker.checkDocument</h4> |
352 <b>checkDocument</b>(<i></i>) |
352 <b>checkDocument</b>(<i></i>) |
353 <p> |
353 <p> |
354 Public method to check the complete document. |
354 Public method to check the complete document. |
372 </dd> |
372 </dd> |
373 </dl><a NAME="SpellChecker.checkSelection" ID="SpellChecker.checkSelection"></a> |
373 </dl><a NAME="SpellChecker.checkSelection" ID="SpellChecker.checkSelection"></a> |
374 <h4>SpellChecker.checkSelection</h4> |
374 <h4>SpellChecker.checkSelection</h4> |
375 <b>checkSelection</b>(<i></i>) |
375 <b>checkSelection</b>(<i></i>) |
376 <p> |
376 <p> |
377 Private method to check the current selection. |
377 Public method to check the current selection. |
378 </p><a NAME="SpellChecker.checkWord" ID="SpellChecker.checkWord"></a> |
378 </p><a NAME="SpellChecker.checkWord" ID="SpellChecker.checkWord"></a> |
379 <h4>SpellChecker.checkWord</h4> |
379 <h4>SpellChecker.checkWord</h4> |
380 <b>checkWord</b>(<i>pos, atEnd=False</i>) |
380 <b>checkWord</b>(<i>pos, atEnd=False</i>) |
381 <p> |
381 <p> |
382 Public method to check the word at position pos. |
382 Public method to check the word at position pos. |