python-gtkspellcheck-doc 3.0-1.1 / usr / share / doc / python-gtkspellcheck-doc / html / spellchecker.html

This file is indexed.

/usr/share/doc/python-gtkspellcheck-doc/html/spellchecker.html is in python-gtkspellcheck-doc 3.0-1.1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!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">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>SpellChecker class reference &mdash; Python GTK Spellcheck 3.0 documentation</title>
    
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '3.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="Python GTK Spellcheck 3.0 documentation" href="index.html" />
    <link rel="next" title="oxt_import module reference" href="oxt_import.html" />
    <link rel="prev" title="Python GTK Spellcheck" href="index.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="oxt_import.html" title="oxt_import module reference"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Python GTK Spellcheck"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Python GTK Spellcheck 3.0 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="spellchecker-class-reference">
<h1>SpellChecker class reference<a class="headerlink" href="#spellchecker-class-reference" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="gtkspellcheck.spellcheck.SpellChecker">
<em class="property">class </em><tt class="descclassname">gtkspellcheck.spellcheck.</tt><tt class="descname">SpellChecker</tt><big>(</big><em>view</em>, <em>language='en'</em>, <em>prefix='gtkspellchecker'</em>, <em>collapse=True</em>, <em>params={}</em><big>)</big><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker" title="Permalink to this definition"></a></dt>
<dd><p>Main spellchecking class, everything important happens here.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>view</strong> &#8211; GtkTextView the SpellChecker should be attached to.</li>
<li><strong>language</strong> &#8211; the language which should be used for spellchecking.
Use a combination of two letter lower-case ISO 639 language code with a
two letter upper-case ISO 3166 country code, for example en_US or de_DE.</li>
<li><strong>prefix</strong> &#8211; a prefix for some internal GtkTextMarks.</li>
<li><strong>collapse</strong> &#8211; enclose suggestions in its own menu.</li>
<li><strong>params</strong> &#8211; dictionary with Enchant broker parameters that should be set
e.g. <cite>enchant.myspell.dictionary.path</cite>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="SpellChecker.languages">
<tt class="descname">languages</tt><a class="headerlink" href="#SpellChecker.languages" title="Permalink to this definition"></a></dt>
<dd><p>A list of supported languages.</p>
<dl class="function">
<dt id="SpellChecker.exists">
<tt class="descname">exists</tt><big>(</big><em>language</em><big>)</big><a class="headerlink" href="#SpellChecker.exists" title="Permalink to this definition"></a></dt>
<dd><p>checks if a language exists</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>language</strong> &#8211; language to check</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="method">
<dt id="gtkspellcheck.spellcheck.SpellChecker.add_to_dictionary">
<tt class="descname">add_to_dictionary</tt><big>(</big><em>word</em><big>)</big><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker.add_to_dictionary" title="Permalink to this definition"></a></dt>
<dd><p>Adds a word to user&#8217;s dictionary.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>word</strong> &#8211; the word to add</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="gtkspellcheck.spellcheck.SpellChecker.append_filter">
<tt class="descname">append_filter</tt><big>(</big><em>regex</em>, <em>filter_type</em><big>)</big><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker.append_filter" title="Permalink to this definition"></a></dt>
<dd><p>Append a new filter to the filter list.
Filters are useful to ignore some misspelled words based on regular expressions.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>regex</strong> &#8211; the regex used for filtering</li>
<li><strong>filter_type</strong> &#8211; the type of the filter</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Filter Types:</p>
<p><tt class="xref py py-const docutils literal"><span class="pre">SpellChecker.FILTER_WORD</span></tt>: The regex must match the whole word you want to filter.
The word separation is done by Pango&#8217;s word separation algorythm so, for example, urls won&#8217;t work here because they are split in many words.</p>
<p><tt class="xref py py-const docutils literal"><span class="pre">SpellChecker.FILTER_LINE</span></tt>: If the expression you want to match is a single line expression use this type.
It should not be an open end expression because then the rest of the line with the text you want to filter will become correct.</p>
<p><tt class="xref py py-const docutils literal"><span class="pre">SpellChecker.FILTER_TEXT</span></tt>: Use this if you want to filter multiline expressions.
The regex will be compiled with the <cite>MULTILINE</cite> flag.
Same with open end expressions apply here.</p>
</dd></dl>

<dl class="method">
<dt id="gtkspellcheck.spellcheck.SpellChecker.append_ignore_tag">
<tt class="descname">append_ignore_tag</tt><big>(</big><em>tag</em><big>)</big><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker.append_ignore_tag" title="Permalink to this definition"></a></dt>
<dd><p>Appends a tag to the list of ignored tags.
A string will be automatic resolved into a tag object.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tag</strong> &#8211; tag object or tag name</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="gtkspellcheck.spellcheck.SpellChecker.buffer_initialize">
<tt class="descname">buffer_initialize</tt><big>(</big><big>)</big><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker.buffer_initialize" title="Permalink to this definition"></a></dt>
<dd><p>Initialize the GtkTextBuffer associated with the GtkTextView.
If you associate a new GtkTextBuffer with the GtkTextView call this method.</p>
</dd></dl>

<dl class="method">
<dt id="gtkspellcheck.spellcheck.SpellChecker.check_range">
<tt class="descname">check_range</tt><big>(</big><em>start</em>, <em>end</em>, <em>force_all=False</em><big>)</big><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker.check_range" title="Permalink to this definition"></a></dt>
<dd><p>Checks a specified range between two GtkTextIters.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>start</strong> &#8211; start iter - checking starts here</li>
<li><strong>end</strong> &#8211; end iter - checking ends here</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="gtkspellcheck.spellcheck.SpellChecker.disable">
<tt class="descname">disable</tt><big>(</big><big>)</big><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker.disable" title="Permalink to this definition"></a></dt>
<dd><p>Disable spellchecking.</p>
</dd></dl>

<dl class="method">
<dt id="gtkspellcheck.spellcheck.SpellChecker.enable">
<tt class="descname">enable</tt><big>(</big><big>)</big><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker.enable" title="Permalink to this definition"></a></dt>
<dd><p>Enable spellchecking.</p>
</dd></dl>

<dl class="attribute">
<dt id="gtkspellcheck.spellcheck.SpellChecker.enabled">
<tt class="descname">enabled</tt><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker.enabled" title="Permalink to this definition"></a></dt>
<dd><p>Enable or disable spellchecking</p>
</dd></dl>

<dl class="method">
<dt id="gtkspellcheck.spellcheck.SpellChecker.ignore_all">
<tt class="descname">ignore_all</tt><big>(</big><em>word</em><big>)</big><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker.ignore_all" title="Permalink to this definition"></a></dt>
<dd><p>Ignores a word for the current session.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>word</strong> &#8211; the word to ignore</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="gtkspellcheck.spellcheck.SpellChecker.language">
<tt class="descname">language</tt><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker.language" title="Permalink to this definition"></a></dt>
<dd><p>The language used for spellchecking</p>
</dd></dl>

<dl class="method">
<dt id="gtkspellcheck.spellcheck.SpellChecker.recheck">
<tt class="descname">recheck</tt><big>(</big><big>)</big><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker.recheck" title="Permalink to this definition"></a></dt>
<dd><p>Rechecks the spelling of the whole text.</p>
</dd></dl>

<dl class="method">
<dt id="gtkspellcheck.spellcheck.SpellChecker.remove_filter">
<tt class="descname">remove_filter</tt><big>(</big><em>regex</em>, <em>filter_type</em><big>)</big><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker.remove_filter" title="Permalink to this definition"></a></dt>
<dd><p>Remove a filter from the filter list.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>regex</strong> &#8211; the regex which used for filtering</li>
<li><strong>filter_type</strong> &#8211; the type of the filter</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="gtkspellcheck.spellcheck.SpellChecker.remove_ignore_tag">
<tt class="descname">remove_ignore_tag</tt><big>(</big><em>tag</em><big>)</big><a class="headerlink" href="#gtkspellcheck.spellcheck.SpellChecker.remove_ignore_tag" title="Permalink to this definition"></a></dt>
<dd><p>Removes a tag from the list of ignored tags.
A string will be automatic resolved into a tag object.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tag</strong> &#8211; tag object or tag name</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="index.html"
                        title="previous chapter">Python GTK Spellcheck</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="oxt_import.html"
                        title="next chapter">oxt_import module reference</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/spellchecker.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="oxt_import.html" title="oxt_import module reference"
             >next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Python GTK Spellcheck"
             >previous</a> |</li>
        <li><a href="index.html">Python GTK Spellcheck 3.0 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright Maximilian Köhl &amp; Carlos Jenkins.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.