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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtkspell">
<refnamediv>
<refname>gtkspell.Spell</refname>
<refpurpose>Spell object for <link linkend="class-gtktextview">gtk.TextView</link></refpurpose>
</refnamediv>
<!-- ************************** -->
<!-- BEGIN OF GTKSPELL SYNOPSIS -->
<!-- ************************** -->
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtkspell.Spell</classname></ooclass>
<ooclass><classname></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gtkspell">gtkspell.Spell</link></methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
<methodparam><parameter role="keyword">language</parameter><initializer>None</initializer></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkspell--set-language">set_language</link></methodname>
<methodparam><parameter role="keyword">lang</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkspell--recheck-all">recheck_all</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkspell--detach">detach</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
<programlisting>
<emphasis role="bold">Functions</emphasis>
<methodsynopsis language="python">
<methodname><link linkend="function-gtkspell--get-from-text-view">gtkspell.get_from_text_view</link></methodname>
<methodparam><parameter role="keyword">view</parameter></methodparam>
</methodsynopsis></programlisting>
</refsect1>
<!-- ************************** -->
<!-- BEGIN OF GTKSPELL ANCESTRY -->
<!-- ************************** -->
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gtkspell">gtkspell</link>
</synopsis>
</refsect1>
<!-- ***************************** -->
<!-- BEGIN OF GTKSPELL DESCRIPTION -->
<!-- ***************************** -->
<refsect1 id="description-gtkspell">
<title>Description</title>
<para>
The <link linkend="class-gtkspell"><classname>gtkspell.Spell</classname></link>
used in concert with <link linkend="class-gtktextview"><classname>gtk.TextView</classname></link>
provides mis-spelled word highlighting in red and offers a right click pop-up menu with suggested corrections.
</para>
</refsect1>
<!-- ***************************** -->
<!-- BEGIN OF GTKSPELL CONSTRUCTOR -->
<!-- ***************************** -->
<refsect1 id="constructor-gtkspell">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtkspell.Spell</methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
<methodparam><parameter role="keyword">lang</parameter><initializer>None</initializer></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">text</parameter> :</term>
<listitem><simpara>a <link linkend="class-gtktextview"><classname>gtk.TextView</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">lang</parameter> :</term>
<listitem><simpara>the language to use, in a form like "en_US"
or <literal>None</literal></simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link linkend="class-gtkspell"><classname>gtkspell.Spell</classname></link>.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
Creates a new <link linkend="class-gtkspell"><classname>gtkspell.Spell</classname></link> object.
</para>
<note>
If <parameter>lang</parameter> is <literal>None</literal> then $LANG will be used, if also $LANG is <literal>None</literal>
or not valid then English will be used as default.
</note>
</refsect1>
<!-- ************************* -->
<!-- BEGIN OF GTKSPELL METHODS -->
<!-- ************************* -->
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkspell--set-language">
<title>gtkspell.Spell.set_language</title>
<programlisting><methodsynopsis language="python">
<methodname>set_language</methodname>
<methodparam><parameter role="keyword">lang</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">lang</parameter> :</term>
<listitem><simpara>the language to use in the form "en_US".</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>set_language</methodname>() method set the language that have to be used while checking for mispelled words.
</para>
</refsect2>
<refsect2 id="method-gtkspell--recheck-all">
<title>gtkspell.Spell.recheck_all</title>
<programlisting><methodsynopsis language="python">
<methodname>recheck_all</methodname>
<methodparam></methodparam></methodsynopsis></programlisting>
<para>
The <methodname>recheck_all</methodname>() method recheck the spelling in the entire buffer.
</para>
</refsect2>
<refsect2 id="method-gtkspell--detach">
<title>gtkspell.Spell.detach</title>
<programlisting><methodsynopsis language="python">
<methodname>detach</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<para>
The <methodname>detach</methodname>() method detaches this
<link linkend="class-gtkspell"><classname>gtkspell.Spell</classname></link>
from its <link linkend="class-gtktextview"><classname>gtk.TextView</classname></link>, use the function
<methodname><link linkend="function-gtkspell--get-from-text-view">gtkspell.get_from_text_view</link></methodname>
to retrieve a <link linkend="class-gtkspell"><classname>gtkspell.Spell</classname></link> from a
<link linkend="class-gtktextview"><classname>gtk.TextView</classname></link>.
</para>
</refsect2>
</refsect1>
<!-- *************************** -->
<!-- BEGIN OF GTKSPELL FUNCTIONS -->
<!-- *************************** -->
<refsect1>
<title>Functions</title>
<refsect2 id="function-gtkspell--get-from-text-view">
<title>gtkspell.get_from_text_view</title>
<programlisting><methodsynopsis language="python">
<methodname>gtkspell.get_from_text_view</methodname>
<methodparam><parameter role="keyword">view</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">view</parameter> :</term>
<listitem><simpara> a <link linkend="class-gtktextview"><classname>gtk.TextView</classname></link>.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> the <link linkend="class-gtkspell"><classname>gtkspell.Spell</classname></link> object
or <literal>None</literal> if there is no <link linkend="class-gtkspell"><classname>gtkspell.Spell</classname></link>
attached to <parameter>view</parameter>.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
Retrieves the <link linkend="class-gtkspell"><classname>gtkspell.Spell</classname></link> object attached to a text view.
</para>
</refsect2>
</refsect1>
</refentry>
|
