1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KEncodingProber</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>KEncodingProber Class Reference</h1>
<code>from PyKDE4.kdecore import *</code>
<p>
<h2>Detailed Description</h2>
<p>Provides encoding detection(probe) capabilities.
</p>
<p>
Probe the encoding of raw data only.
In the case it can't find it, return the most possible encoding it guessed.
</p>
<p>
Always do Unicode probe regardless the ProberType
</p>
<p>
Feed data to it several times with feed() until ProberState changes to FoundIt/NotMe,
or confidence() returns a value you find acceptable.
</p>
<p>
Intended lifetime of the object: one instance per ProberType.
</p>
<p>
Typical use:
<pre class="fragment">
QByteArray data, moredata;
...
KEncodingProber prober(KEncodingProber.Chinese);
prober.feed(data);
prober.feed(moredata);
if (prober.confidence() > 0.6)
QString out = QTextCodec.codecForName(prober.encoding())->toUnicode(data);
</pre>
</p>
<p>
At least 256 characters are needed to change the ProberState from Probing to FoundIt.
If you don't have so many characters to probe,
decide whether to accept the encoding it guessed so far according to the Confidence by yourself.
</p>
<p>
Guess encoding of char array
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#ProberState">ProberState</a> </td><td class="memItemRight" valign="bottom">{ FoundIt, NotMe, Probing }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#ProberType">ProberType</a> </td><td class="memItemRight" valign="bottom">{ None, Universal, Arabic, Baltic, CentralEuropean, ChineseSimplified, ChineseTraditional, Cyrillic, Greek, Hebrew, Japanese, Korean, NorthernSaami, Other, SouthEasternEurope, Thai, Turkish, Unicode, WesternEuropean }</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KEncodingProber">__init__</a> (self, <a href="../kdecore/KEncodingProber.html#ProberType">KEncodingProber.ProberType</a> proberType=KEncodingProber.Universal)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KEncodingProber">__init__</a> (self, <a href="../kdecore/KEncodingProber.html">KEncodingProber</a> other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#confidence">confidence</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="#encoding">encoding</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#encodingName">encodingName</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KEncodingProber.html#ProberState">KEncodingProber.ProberState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#feed">feed</a> (self, QByteArray data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KEncodingProber.html#ProberState">KEncodingProber.ProberState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#feed">feed</a> (self, QString data, int len)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KEncodingProber.html#ProberType">KEncodingProber.ProberType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#proberType">proberType</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#reset">reset</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setProberType">setProberType</a> (self, <a href="../kdecore/KEncodingProber.html#ProberType">KEncodingProber.ProberType</a> proberType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KEncodingProber.html#ProberState">KEncodingProber.ProberState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#state">state</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#nameForProberType">nameForProberType</a> (<a href="../kdecore/KEncodingProber.html#ProberType">KEncodingProber.ProberType</a> proberType)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KEncodingProber.html#ProberType">KEncodingProber.ProberType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#proberTypeForName">proberTypeForName</a> (QString lang)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KEncodingProber"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KEncodingProber.html#ProberType">KEncodingProber.ProberType</a> </td>
<td class="paramname"><em>proberType=KEncodingProber.Universal</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Default ProberType is Universal(detect all possibe encodings)
</p></div></div><a class="anchor" name="KEncodingProber"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KEncodingProber.html">KEncodingProber</a> </td>
<td class="paramname"><em>other</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="confidence"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">float confidence</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the confidence(sureness) of encoding it guessed so far (0.0 ~ 0.99), not very reliable for single byte encodings
</dd></dl>
</p></div></div><a class="anchor" name="encoding"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QByteArray encoding</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> a QByteArray with the name of the best encoding it has guessed so far
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.2.2
</dd></dl>
</p></div></div><a class="anchor" name="encodingName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString encodingName</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the name of the best encoding it has guessed so far
</dd></dl> <dl class="warning" compact><dt><b>Warning:</b></dt><dd> The returned string is allocated with strdup, so some memory is leaked with every call.
</dd></dl> <dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> Use encoding() instead, which returns a QByteArray.
</dd></dl>
</p></div></div><a class="anchor" name="feed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KEncodingProber.html#ProberState">KEncodingProber.ProberState</a> feed</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QByteArray </td>
<td class="paramname"><em>data</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>The main class method
</p>
<p>
feed data to the prober
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the ProberState after probing the fed data.
</dd></dl>
</p></div></div><a class="anchor" name="feed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KEncodingProber.html#ProberState">KEncodingProber.ProberState</a> feed</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>len</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>The main class method
</p>
<p>
feed data to the prober
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the ProberState after probing the fed data.
</dd></dl>
</p></div></div><a class="anchor" name="proberType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KEncodingProber.html#ProberType">KEncodingProber.ProberType</a> proberType</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="reset"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> reset</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>reset the prober's internal state and data.
</p></div></div><a class="anchor" name="setProberType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setProberType</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KEncodingProber.html#ProberType">KEncodingProber.ProberType</a> </td>
<td class="paramname"><em>proberType</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>change current prober's ProberType and reset the prober
</p></div></div><a class="anchor" name="state"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KEncodingProber.html#ProberState">KEncodingProber.ProberState</a> state</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the prober's current ProberState
</dd></dl>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="nameForProberType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString nameForProberType</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KEncodingProber.html#ProberType">KEncodingProber.ProberType</a> </td>
<td class="paramname"><em>proberType</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>map ProberType to language string
</p></div></div><a class="anchor" name="proberTypeForName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KEncodingProber.html#ProberType">KEncodingProber.ProberType</a> proberTypeForName</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>lang</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the ProberType for lang (eg. proberTypeForName("Chinese Simplified") will return KEncodingProber.ChineseSimplified
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="ProberState"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">ProberState</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>FoundIt</em> </td><td><tr><td valign="top"><em>NotMe</em> </td><td><tr><td valign="top"><em>Probing</em> </td><td></table>
</dl>
</div></div><p><a class="anchor" name="ProberType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">ProberType</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>None</em> </td><td><tr><td valign="top"><em>Universal</em> </td><td><tr><td valign="top"><em>Arabic</em> </td><td><tr><td valign="top"><em>Baltic</em> </td><td><tr><td valign="top"><em>CentralEuropean</em> </td><td><tr><td valign="top"><em>ChineseSimplified</em> </td><td><tr><td valign="top"><em>ChineseTraditional</em> </td><td><tr><td valign="top"><em>Cyrillic</em> </td><td><tr><td valign="top"><em>Greek</em> </td><td><tr><td valign="top"><em>Hebrew</em> </td><td><tr><td valign="top"><em>Japanese</em> </td><td><tr><td valign="top"><em>Korean</em> </td><td><tr><td valign="top"><em>NorthernSaami</em> </td><td><tr><td valign="top"><em>Other</em> </td><td><tr><td valign="top"><em>SouthEasternEurope</em> </td><td><tr><td valign="top"><em>Thai</em> </td><td><tr><td valign="top"><em>Turkish</em> </td><td><tr><td valign="top"><em>Unicode</em> </td><td><tr><td valign="top"><em>WesternEuropean</em> </td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
|
