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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
|
<?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-gtkeditable">
<refnamediv>
<refname>gtk.Editable</refname>
<refpurpose>an interface for text-editing widgets.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.Editable</classname></ooclass>
<ooclass><classname>gobject.GInterface</classname></ooclass>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkeditable--select-region">select_region</link></methodname>
<methodparam><parameter
role="keyword">start</parameter></methodparam>
<methodparam><parameter role="keyword">end</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkeditable--get-selection-bounds">get_selection_bounds</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkeditable--insert-text">insert_text</link></methodname>
<methodparam><parameter
role="keyword">text</parameter></methodparam>
<methodparam><parameter
role="keyword">position</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkeditable--delete-text">delete_text</link></methodname>
<methodparam><parameter
role="keyword">start_pos</parameter></methodparam>
<methodparam><parameter
role="keyword">end_pos</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkeditable--get-chars">get_chars</link></methodname>
<methodparam><parameter
role="keyword">start_pos</parameter></methodparam>
<methodparam><parameter
role="keyword">end_pos</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkeditable--cut-clipboard">cut_clipboard</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkeditable--copy-clipboard">copy_clipboard</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkeditable--paste-clipboard">paste_clipboard</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkeditable--delete-selection">delete_selection</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkeditable--set-position">set_position</link></methodname>
<methodparam><parameter
role="keyword">position</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkeditable--get-position">get_position</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkeditable--set-editable">set_editable</link></methodname>
<methodparam><parameter
role="keyword">is_editable</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkeditable--get-editable">get_editable</link></methodname>
<methodparam></methodparam> </methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1 id="signal-prototypes-gtkeditable">
<title>gtk.Editable Signal Prototypes</title>
<variablelist>
<varlistentry>
<term>"<link
linkend="signal-gtkeditable--changed">changed</link>"</term>
<listitem>
<methodsynopsis
language="python"><methodname>callback</methodname>
<methodparam><parameter>editable</parameter>
</methodparam>
<methodparam><parameter>user_param1</parameter>
</methodparam>
<methodparam><parameter>...</parameter>
</methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link
linkend="signal-gtkeditable--delete-text">delete-text</link>"</term>
<listitem>
<methodsynopsis
language="python"><methodname>callback</methodname>
<methodparam><parameter>editable</parameter>
</methodparam>
<methodparam><parameter>start</parameter>
</methodparam>
<methodparam><parameter>end</parameter>
</methodparam>
<methodparam><parameter>user_param1</parameter>
</methodparam>
<methodparam><parameter>...</parameter>
</methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link
linkend="signal-gtkeditable--insert-text">insert-text</link>"</term>
<listitem>
<methodsynopsis
language="python"><methodname>callback</methodname>
<methodparam><parameter>editable</parameter>
</methodparam>
<methodparam><parameter>new_text</parameter>
</methodparam>
<methodparam><parameter>new_text_length</parameter>
</methodparam>
<methodparam><parameter>position</parameter>
</methodparam>
<methodparam><parameter>user_param1</parameter>
</methodparam>
<methodparam><parameter>...</parameter>
</methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<para><link
linkend="class-gtkeditable"><classname>gtk.Editable</classname></link>
is an interface for text editing widgets, such as <link
linkend="class-gtkentry"><classname>gtk.Entry</classname></link>. The
editable class contains methods for generically manipulating an editable
widget, a large number of action signals used for key bindings, and
several signals that an application can connect to to modify the
behavior of a widget.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkeditable--select-region">
<title>gtk.Editable.select_region</title>
<programlisting><methodsynopsis language="python">
<methodname>select_region</methodname>
<methodparam><parameter
role="keyword">start</parameter></methodparam>
<methodparam><parameter
role="keyword">end</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">start</parameter> :</term>
<listitem><simpara>the new start position of the
selection</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">end</parameter> :</term>
<listitem><simpara>the new end position of the
selection</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>select_region</methodname>() method selects a
region of text from <parameter>start</parameter> up to, but not including
<parameter>end</parameter>. If <parameter>end</parameter> is negative, then
the selection will run from <parameter>start</parameter> to the end of the
text.</para>
</refsect2>
<refsect2 id="method-gtkeditable--get-selection-bounds">
<title>gtk.Editable.get_selection_bounds</title>
<programlisting><methodsynopsis language="python">
<methodname>get_selection_bounds</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a tuple containing the start and end positions
of the selection or an empty tuple if there is no
selection</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_selection_bounds</methodname>() method
returns a tuple that contains the start and end positions of the selection
if any or an empty tuple if there is no selection.</para>
</refsect2>
<refsect2 id="method-gtkeditable--insert-text">
<title>gtk.Editable.insert_text</title>
<programlisting><methodsynopsis language="python">
<methodname>insert_text</methodname>
<methodparam><parameter
role="keyword">text</parameter></methodparam>
<methodparam><parameter
role="keyword">position</parameter><initializer>0</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">text</parameter> :</term>
<listitem><simpara>the text to be inserted</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">position</parameter> :</term>
<listitem><simpara>the position where the text should be
inserted</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>insert_text</methodname>() method inserts the
string specified by <parameter>text</parameter> at the location specified by
<parameter>position</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkeditable--delete-text">
<title>gtk.Editable.delete_text</title>
<programlisting><methodsynopsis language="python">
<methodname>delete_text</methodname>
<methodparam><parameter
role="keyword">start_pos</parameter></methodparam>
<methodparam><parameter
role="keyword">end_pos</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">start_pos</parameter> :</term>
<listitem><simpara>the start position of the text to
delete</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">end_pos</parameter> :</term>
<listitem><simpara>the end position of the text to
delete</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>delete_text</methodname>() method deletes a
sequence of characters starting from <parameter>start_pos</parameter> up to,
but not including <parameter>end_pos</parameter>. If
<parameter>end_pos</parameter> is negative, then the characters deleted will
be those characters from <parameter>start_pos</parameter> to the end of the
text.</para>
</refsect2>
<refsect2 id="method-gtkeditable--get-chars">
<title>gtk.Editable.get_chars</title>
<programlisting><methodsynopsis language="python">
<methodname>get_chars</methodname>
<methodparam><parameter
role="keyword">start_pos</parameter></methodparam>
<methodparam><parameter
role="keyword">end_pos</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">start_pos</parameter> :</term>
<listitem><simpara>the start position</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">end_pos</parameter> :</term>
<listitem><simpara>the end position</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a string containing the characters from start
to end</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_chars</methodname>() method retrieves a
string of characters starting from <parameter>start_pos</parameter> up to,
but not including <parameter>end_pos</parameter>. If
<parameter>end_pos</parameter> is negative, then all the characters from
<parameter>start_pos</parameter> to the end of the text are
retrieved.</para>
</refsect2>
<refsect2 id="method-gtkeditable--cut-clipboard">
<title>gtk.Editable.cut_clipboard</title>
<programlisting><methodsynopsis language="python">
<methodname>cut_clipboard</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<para>The <methodname>cut_clipboard</methodname>() method copies the
characters in the current selection to the clipboard and then deletes them
from the widget.</para>
</refsect2>
<refsect2 id="method-gtkeditable--copy-clipboard">
<title>gtk.Editable.copy_clipboard</title>
<programlisting><methodsynopsis language="python">
<methodname>copy_clipboard</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<para>The <methodname>copy_clipboard</methodname>() method copies the
characters in the current selection to the clipboard</para>
</refsect2>
<refsect2 id="method-gtkeditable--paste-clipboard">
<title>gtk.Editable.paste_clipboard</title>
<programlisting><methodsynopsis language="python">
<methodname>paste_clipboard</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<para>The <methodname>paste_clipboard</methodname>() method copies the
contents of the clipboard to the widget at the cursor position.</para>
</refsect2>
<refsect2 id="method-gtkeditable--delete-selection">
<title>gtk.Editable.delete_selection</title>
<programlisting><methodsynopsis language="python">
<methodname>delete_selection</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<para>The <methodname>delete_selection</methodname>() method deletes
the characters in the selection and releases the selection ownership</para>
</refsect2>
<refsect2 id="method-gtkeditable--set-position">
<title>gtk.Editable.set_position</title>
<programlisting><methodsynopsis language="python">
<methodname>set_position</methodname>
<methodparam><parameter
role="keyword">position</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">position</parameter> :</term>
<listitem><simpara>the new cursor position</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_position</methodname>() method sets the
cursor position to be just before the character at the location specified by
<parameter>position</parameter>. If <parameter>position</parameter> is less
than 0 or greater than the number of characters in the widget the cursor is
positioned after the last character in the widget. Note
<parameter>position</parameter> is in characters not bytes.</para>
</refsect2>
<refsect2 id="method-gtkeditable--get-position">
<title>gtk.Editable.get_position</title>
<programlisting><methodsynopsis language="python">
<methodname>get_position</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the cursor position</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_position</methodname>() method retrieves the
cursor position as a character index starting from 0. If the cursor is after
the last character the position will equal the number of characters in the
widget. Note <parameter>position</parameter> is in characters not
bytes.</para>
</refsect2>
<refsect2 id="method-gtkeditable--set-editable">
<title>gtk.Editable.set_editable</title>
<programlisting><methodsynopsis language="python">
<methodname>set_editable</methodname>
<methodparam><parameter
role="keyword">is_editable</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">is_editable</parameter> :</term>
<listitem><simpara>if True the text can be
edited</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_editable</methodname>() method sets the
widget "editable" attribute of the widget to the value specified by
<parameter>is_editable</parameter>. If <parameter>is_editable</parameter> is
<literal>True</literal> the text can be edited; if <literal>False</literal>,
the text cannot be edited.</para>
</refsect2>
<refsect2 id="method-gtkeditable--get-editable">
<title>gtk.Editable.get_editable</title>
<programlisting><methodsynopsis language="python">
<methodname>get_editable</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the text is
editable.</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_editable</methodname>() method retrieves the
value of the widget "editable" attribute that specifies whether the text is
editable. See <link
linkend="method-gtkeditable--set-editable"><methodname>set_editable()</methodname></link>.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gtkeditable--changed">
<title>The "changed" gtk.Editable Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>editable</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>editable</parameter> :</term>
<listitem><simpara>the editable that received the
signal</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 "changed" signal is emitted when the contents of the widget
have changed.</para>
</refsect2>
<refsect2 id="signal-gtkeditable--delete-text">
<title>The "delete-text" gtk.Editable Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>editable</parameter></methodparam>
<methodparam><parameter>start</parameter></methodparam>
<methodparam><parameter>end</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>editable</parameter> :</term>
<listitem><simpara>the editable that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>start</parameter> :</term>
<listitem><simpara>the start position</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>end</parameter> :</term>
<listitem><simpara>the end position</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 "delete-text" signal is emitted when text is deleted from
the widget by the user. The default handler for this signal will normally be
responsible for deleting the text, so by connecting to this signal and then
stopping the signal with the <link
linkend="method-gobject--stop-emission"><methodname>gobject.stop_emission</methodname>()</link>
method, it is possible to prevent it from being deleted. The
<parameter>start</parameter> and <parameter>end</parameter> parameters are
interpreted as for <link
linkend="method-gtkeditable--delete-text"><methodname>delete_text</methodname>()</link></para>
</refsect2>
<refsect2 id="signal-gtkeditable--insert-text">
<title>The "insert-text" gtk.Editable Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>editable</parameter></methodparam>
<methodparam><parameter>new_text</parameter></methodparam>
<methodparam><parameter>new_text_length</parameter></methodparam>
<methodparam><parameter>position</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>editable</parameter> :</term>
<listitem><simpara>the editable that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>new_text</parameter> :</term>
<listitem><simpara>the string that is being
inserted</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>new_text_length</parameter> :</term>
<listitem><simpara>the length of the new text</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>position</parameter> :</term>
<listitem><simpara>a pointer to the location at which the new text
will be inserted</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 "insert-text" signal is emitted when text is inserted into
the widget by the user. The default handler for this signal will normally be
responsible for inserting the text, so by connecting to this signal and then
stopping the signal with the <link
linkend="method-gobject--stop-emission"><methodname>gobject.stop_emission</methodname>()</link>
method, it is possible to prevent it from being inserted entirely. The
<parameter>position</parameter> parameter is a <link
linkend="class-gobjectgpointer"><classname>gobject.GPointer</classname></link>
object containing a pointer to the insertion position - there is no way to
access the position value from <literal>PyGTK</literal>.</para>
</refsect2>
</refsect1>
</refentry>
|
