eric6/Documentation/Source/eric6.E5XML.SpellCheckDictionariesReader.html

Fri, 22 Jan 2021 16:48:43 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 22 Jan 2021 16:48:43 +0100
changeset 7998
cd41c844862f
parent 7273
391d6b7b1eff
permissions
-rw-r--r--

Editor
- added functionality to insert docstring templates via the context menu (cursor placed on first line of function definition) or after entering the docstring start string (e.g. """ for Python)

5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric6.E5XML.SpellCheckDictionariesReader</title>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
21 <body>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
22 <a NAME="top" ID="top"></a>
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>eric6.E5XML.SpellCheckDictionariesReader</h1>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
24
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 <p>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 Module to read the web browser spell check dictionaries list file.
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 </p>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <h3>Global Attributes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
29
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <table>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <tr><td>None</td></tr>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 </table>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <h3>Classes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
34
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
36
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <tr>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <td><a href="#SpellCheckDictionariesReader">SpellCheckDictionariesReader</a></td>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <td>Class to read the web browser spell check dictionaries list file.</td>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </tr>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </table>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <h3>Functions</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
43
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <table>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <tr><td>None</td></tr>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 </table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
47 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
48 <hr />
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <a NAME="SpellCheckDictionariesReader" ID="SpellCheckDictionariesReader"></a>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <h2>SpellCheckDictionariesReader</h2>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
51
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <p>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 Class to read the web browser spell check dictionaries list file.
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 </p>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <h3>Derived from</h3>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 XMLStreamReaderBase
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <h3>Class Attributes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
58
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <table>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <tr><td>supportedVersions</td></tr>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 </table>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <h3>Class Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
63
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <table>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 <tr><td>None</td></tr>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 </table>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <h3>Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
68
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
70
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <tr>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <td><a href="#SpellCheckDictionariesReader.__init__">SpellCheckDictionariesReader</a></td>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <td>Constructor</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
74 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
75 <tr>
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <td><a href="#SpellCheckDictionariesReader.__readDictionary">__readDictionary</a></td>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <td>Private method to read the plug-in info.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
78 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
79 <tr>
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <td><a href="#SpellCheckDictionariesReader.readXML">readXML</a></td>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 <td>Public method to read and parse the XML document.</td>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 </tr>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 </table>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <h3>Static Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
85
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 <table>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <tr><td>None</td></tr>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 </table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
89
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <a NAME="SpellCheckDictionariesReader.__init__" ID="SpellCheckDictionariesReader.__init__"></a>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <h4>SpellCheckDictionariesReader (Constructor)</h4>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 <b>SpellCheckDictionariesReader</b>(<i>data, entryCallback</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
93
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 <p>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 Constructor
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
96 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
97 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
98
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 <dt><i>data</i></dt>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <dd>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 reference to the data array to read XML from (QByteArray)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
102 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
103 <dt><i>entryCallback</i></dt>
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <dd>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 reference to a function to be called once the
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 data for a dictionary has been read (function)
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
108 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
109 <a NAME="SpellCheckDictionariesReader.__readDictionary" ID="SpellCheckDictionariesReader.__readDictionary"></a>
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 <h4>SpellCheckDictionariesReader.__readDictionary</h4>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <b>__readDictionary</b>(<i></i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
112
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 <p>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 Private method to read the plug-in info.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
115 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
116 <a NAME="SpellCheckDictionariesReader.readXML" ID="SpellCheckDictionariesReader.readXML"></a>
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 <h4>SpellCheckDictionariesReader.readXML</h4>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 <b>readXML</b>(<i></i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
119
5871
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 <p>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 Public method to read and parse the XML document.
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 </p>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 <div align="right"><a href="#top">Up</a></div>
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 <hr />
6dccd8542cd1 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
125 </body></html>

eric ide

mercurial