/usr/share/gtk-doc/html/pygtkspell/class-gtkspell.html is in python-gtkspell 2.25.3-11.
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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtkspell.Spell</title><link rel="stylesheet" type="text/css" href="style.css"><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html" title="Python GtkSpell Reference Manual"><link rel="up" href="gtkspell-class-reference.html" title="The PyGtkSpell Class Reference"><link rel="prev" href="gtkspell-class-reference.html" title="The PyGtkSpell Class Reference"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtkspell.Spell</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gtkspell-class-reference.html">Prev</a> </td><th width="60%" align="center">The PyGtkSpell Class Reference</th><td width="20%" align="right"> </td></tr></table><hr></div><div class="refentry" title="gtkspell.Spell"><a name="class-gtkspell"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtkspell.Spell</h2><p>gtkspell.Spell — Spell object for <a
href="../pygtk/class-gtktextview.html"
>gtk.TextView</a></p></div><div class="refsect1" title="Synopsis"><a name="idp6583472"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtkspell.Spell</span></span>(<span class="ooclass"><span class="classname"></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkspell.html#constructor-gtkspell" title="Constructor">gtkspell.Spell</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>language</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspell.html#method-gtkspell--set-language" title="gtkspell.Spell.set_language">set_language</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>lang</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspell.html#method-gtkspell--recheck-all" title="gtkspell.Spell.recheck_all">recheck_all</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspell.html#method-gtkspell--detach" title="gtkspell.Spell.detach">detach</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table><pre class="programlisting">
<span class="bold"><strong>Functions</strong></span>
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspell.html#function-gtkspell--get-from-text-view" title="gtkspell.get_from_text_view">gtkspell.get_from_text_view</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>view</code></strong></span></span>)</code></pre></div><div class="refsect1" title="Ancestry"><a name="idp67792"></a><h2>Ancestry</h2><pre class="synopsis">+-- <a class="link" href="class-gtkspell.html" title="gtkspell.Spell">gtkspell</a>
</pre></div><div class="refsect1" title="Description"><a name="description-gtkspell"></a><h2>Description</h2><p>
The <a class="link" href="class-gtkspell.html" title="gtkspell.Spell"><code class="classname">gtkspell.Spell</code></a>
used in concert with <a
href="../pygtk/class-gtktextview.html"
><code class="classname">gtk.TextView</code></a>
provides mis-spelled word highlighting in red and offers a right click pop-up menu with suggested corrections.
</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkspell"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtkspell.Spell</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>lang</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>text</code></strong> :</span></p></td><td>a <a
href="../pygtk/class-gtktextview.html"
><code class="classname">gtk.TextView</code></a></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>lang</code></strong> :</span></p></td><td>the language to use, in a form like "en_US"
or <code class="literal">None</code></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtkspell.html" title="gtkspell.Spell"><code class="classname">gtkspell.Spell</code></a>.
</td></tr></tbody></table><p>
Creates a new <a class="link" href="class-gtkspell.html" title="gtkspell.Spell"><code class="classname">gtkspell.Spell</code></a> object.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3>
If <em class="parameter"><code>lang</code></em> is <code class="literal">None</code> then $LANG will be used, if also $LANG is <code class="literal">None</code>
or not valid then English will be used as default.
</div></div><div class="refsect1" title="Methods"><a name="idp6870640"></a><h2>Methods</h2><div class="refsect2" title="gtkspell.Spell.set_language"><a name="method-gtkspell--set-language"></a><h3>gtkspell.Spell.set_language</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_language</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>lang</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>lang</code></strong> :</span></p></td><td>the language to use in the form "en_US".</td></tr></tbody></table><p>
The <code class="methodname">set_language</code>() method set the language that have to be used while checking for mispelled words.
</p></div><div class="refsect2" title="gtkspell.Spell.recheck_all"><a name="method-gtkspell--recheck-all"></a><h3>gtkspell.Spell.recheck_all</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">recheck_all</span>(<span class="methodparam"></span>)</code></pre><p>
The <code class="methodname">recheck_all</code>() method recheck the spelling in the entire buffer.
</p></div><div class="refsect2" title="gtkspell.Spell.detach"><a name="method-gtkspell--detach"></a><h3>gtkspell.Spell.detach</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">detach</span>(<span class="methodparam"></span>)</code></pre><p>
The <code class="methodname">detach</code>() method detaches this
<a class="link" href="class-gtkspell.html" title="gtkspell.Spell"><code class="classname">gtkspell.Spell</code></a>
from its <a
href="../pygtk/class-gtktextview.html"
><code class="classname">gtk.TextView</code></a>, use the function
<code class="methodname"><a class="link" href="class-gtkspell.html#function-gtkspell--get-from-text-view" title="gtkspell.get_from_text_view">gtkspell.get_from_text_view</a></code>
to retrieve a <a class="link" href="class-gtkspell.html" title="gtkspell.Spell"><code class="classname">gtkspell.Spell</code></a> from a
<a
href="../pygtk/class-gtktextview.html"
><code class="classname">gtk.TextView</code></a>.
</p></div></div><div class="refsect1" title="Functions"><a name="idp6893760"></a><h2>Functions</h2><div class="refsect2" title="gtkspell.get_from_text_view"><a name="function-gtkspell--get-from-text-view"></a><h3>gtkspell.get_from_text_view</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtkspell.get_from_text_view</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>view</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>view</code></strong> :</span></p></td><td> a <a
href="../pygtk/class-gtktextview.html"
><code class="classname">gtk.TextView</code></a>.
</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> the <a class="link" href="class-gtkspell.html" title="gtkspell.Spell"><code class="classname">gtkspell.Spell</code></a> object
or <code class="literal">None</code> if there is no <a class="link" href="class-gtkspell.html" title="gtkspell.Spell"><code class="classname">gtkspell.Spell</code></a>
attached to <em class="parameter"><code>view</code></em>.</td></tr></tbody></table><p>
Retrieves the <a class="link" href="class-gtkspell.html" title="gtkspell.Spell"><code class="classname">gtkspell.Spell</code></a> object attached to a text view.
</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gtkspell-class-reference.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtkspell-class-reference.html">Up</a></td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">The PyGtkSpell Class Reference </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
|