blob: 47be10f8cdbffac2cd803ca378aec5898f6d5f22 (
plain)
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
438
439
440
441
442
443
444
|
<?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-gtktexttagtable">
<refnamediv>
<refname>gtk.TextTagTable</refname>
<refpurpose>A collection of <link
linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> objects
that can be used together</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.TextTagTable</classname></ooclass>
<ooclass><classname><link
linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link
linkend="constructor-gtktexttagtable">gtk.TextTagTable</link></methodname>
<methodparam></methodparam> </constructorsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtktexttagtable--add">add</link></methodname>
<methodparam><parameter role="keyword">tag</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtktexttagtable--remove">remove</link></methodname>
<methodparam><parameter role="keyword">tag</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtktexttagtable--lookup">lookup</link></methodname>
<methodparam><parameter
role="keyword">name</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtktexttagtable--foreach">foreach</link></methodname>
<methodparam><parameter role="keyword">func</parameter></methodparam>
<methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtktexttagtable--get-size">get_size</link></methodname>
<methodparam></methodparam> </methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtktexttagtable">gtk.TextTagTable</link>
</synopsis>
</refsect1>
<refsect1 id="signal-prototypes-gtktexttagtable">
<title>gtk.TextTagTable Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<variablelist>
<varlistentry>
<term>"<link
linkend="signal-gtktexttagtable--tag-added">tag-added</link>"</term>
<listitem>
<methodsynopsis
language="python"><methodname>callback</methodname>
<methodparam><parameter>texttagtable</parameter></methodparam>
<methodparam><parameter>texttag</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link
linkend="signal-gtktexttagtable--tag-changed">tag-changed</link>"</term>
<listitem>
<methodsynopsis
language="python"><methodname>callback</methodname>
<methodparam><parameter>texttagtable</parameter></methodparam>
<methodparam><parameter>texttag</parameter></methodparam>
<methodparam><parameter>size_changed</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link
linkend="signal-gtktexttagtable--tag-removed">tag-removed</link>"</term>
<listitem>
<methodsynopsis
language="python"><methodname>callback</methodname>
<methodparam><parameter>texttagtable</parameter></methodparam>
<methodparam><parameter>texttag</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<para>A <link
linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
object holds a set of <link
linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> objects
for use with a <link
linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>.
Usually a <link
linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
is created automatically when a <link
linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
is created but a standalone <link
linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
can be created using the <link
linkend="constructor-gtktexttagtable">gtk.TextTagTable</link>() constructor.
A <link
linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
can be passed as an argument to the <link
linkend="constructor-gtktextbuffer">gtk.TextBuffer</link>() constructor to
associate an existing <link
linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>
rather than creating a new one. This is useful when several textbuffers need
to use the same texttags.</para>
</refsect1>
<refsect1 id="constructor-gtktexttagtable">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.TextTagTable</methodname>
<methodparam></methodparam> </constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>Creates a new <link
linkend="class-gtktexttagtable"><classname>gtk.TextTagTable</classname></link>.
The table contains no tags by default.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtktexttagtable--add">
<title>gtk.TextTagTable.add</title>
<programlisting><methodsynopsis language="python">
<methodname>add</methodname>
<methodparam><parameter
role="keyword">tag</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">tag</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>add</methodname>() method adds a texttag to the
texttagtable. The texttag is assigned the highest priority in the
texttagtable. A <literal>ValueError</literal> exception is raised if
<parameter>tag</parameter> is in a texttag table already, or has the same
name as another texttag in the texttagtable.</para>
</refsect2>
<refsect2 id="method-gtktexttagtable--remove">
<title>gtk.TextTagTable.remove</title>
<programlisting><methodsynopsis language="python">
<methodname>remove</methodname>
<methodparam><parameter
role="keyword">tag</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">tag</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>remove</methodname>() method removes a texttag
from the texttagtable.</para>
</refsect2>
<refsect2 id="method-gtktexttagtable--lookup">
<title>gtk.TextTagTable.lookup</title>
<programlisting><methodsynopsis language="python">
<methodname>lookup</methodname>
<methodparam><parameter
role="keyword">name</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">name</parameter> :</term>
<listitem><simpara>the name of a texttag</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The texttag, or <literal>None</literal> if none
by that name is in the texttagtable.</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>lookup</methodname>() method looks in the
texttagtable for a <link
linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> with
the name specified by <parameter>name</parameter> and returns it if found.
This method returns <literal>None</literal> if <parameter>name</parameter>
does not identify a <link
linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> in the
texttagtable.</para>
</refsect2>
<refsect2 id="method-gtktexttagtable--foreach">
<title>gtk.TextTagTable.foreach</title>
<programlisting><methodsynopsis language="python">
<methodname>foreach</methodname>
<methodparam><parameter role="keyword">func</parameter></methodparam>
<methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">func</parameter> :</term>
<listitem><simpara>a function to call on each texttag</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">data</parameter> :</term>
<listitem><simpara>user data to pass to
<parameter>func</parameter> or
<literal>None</literal></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>foreach</methodname>() method calls the function
specified by <parameter>func</parameter> on each texttag in the text tag
table passing the user data specified by <parameter>data</parameter>. The
signature of <parameter>func</parameter> is:</para>
<programlisting>
def func(texttag, user_data):
</programlisting>
<para>where <parameter>texttag</parameter> is a <link
linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link> in the
text tag table and <parameter>user_data</parameter> is
<parameter>data</parameter>.
Note that the table may not be modified while iterating over it (you can't add/remove tags).</para>
</refsect2>
<refsect2 id="method-gtktexttagtable--get-size">
<title>gtk.TextTagTable.get_size</title>
<programlisting><methodsynopsis language="python">
<methodname>get_size</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the number of texttags in the
texttagtable</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_size</methodname>() method returns the size
of the texttagtable (number of texttags).</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gtktexttagtable--tag-added">
<title>The "tag-added" gtk.TextTagTable Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>texttagtable</parameter></methodparam>
<methodparam><parameter>texttag</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>texttagtable</parameter> :</term>
<listitem><simpara>the texttagtable that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>texttag</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
</variablelist>
<para>The "tag-added" signal is emitted when the <link
linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>
specified by <parameter>texttag</parameter> is added to
<parameter>texttagtable</parameter>.</para>
</refsect2>
<refsect2 id="signal-gtktexttagtable--tag-changed">
<title>The "tag-changed" gtk.TextTagTable Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>texttagtable</parameter></methodparam>
<methodparam><parameter>texttag</parameter></methodparam>
<methodparam><parameter>size_changed</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>texttagtable</parameter> :</term>
<listitem><simpara>the texttagtable that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>texttag</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>size_changed</parameter> :</term>
<listitem><simpara>if <literal>True</literal> a
<parameter>texttag</parameter> property has changed that may affect the size
of the text enclosed by the texttag</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
</variablelist>
<para>The "tag-changed" signal is emitted when a property of the <link
linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>
specified by <parameter>texttag</parameter> is changed. If
<parameter>size_changed</parameter> is <literal>True</literal> the text
enclosed by <parameter>texttag</parameter> will change size.</para>
</refsect2>
<refsect2 id="signal-gtktexttagtable--tag-removed">
<title>The "tag-removed" gtk.TextTagTable Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>texttagtable</parameter></methodparam>
<methodparam><parameter>texttag</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>texttagtable</parameter> :</term>
<listitem><simpara>the texttagtable that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>texttag</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
</variablelist>
<para>The "tag-removed" signal is emitted when the <link
linkend="class-gtktexttag"><classname>gtk.TextTag</classname></link>
specified by <parameter>texttag</parameter> is removed from
<parameter>texttagtable</parameter></para>
</refsect2>
</refsect1>
</refentry>
|
