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
|
<?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-gtkentrybuffer">
<refnamediv>
<refname>gtk.EntryBuffer</refname>
<refpurpose>stores text for display in a <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link> (new in PyGTK 2.22)</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.EntryBuffer</classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gtkentrybuffer">gtk.EntryBuffer</link></methodname>
<methodparam><parameter role="keyword">initial_chars</parameter></methodparam>
<methodparam><parameter role="keyword">n_initial_chars</parameter></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkentrybuffer--get-bytes">get_bytes</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkentrybuffer--get-length">get_length</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkentrybuffer--set-text">set_text</link></methodname>
<methodparam><parameter role="keyword">chars</parameter></methodparam>
<methodparam><parameter role="keyword">n_chars</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkentrybuffer--get-text">get_text</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkentrybuffer--set-max-length">set_max_length</link></methodname>
<methodparam><parameter role="keyword">max_length</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkentrybuffer--get-max-length">get_max_length</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkentrybuffer--insert-text">insert_text</link></methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">chars</parameter></methodparam>
<methodparam><parameter role="keyword">n_chars</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkentrybuffer--delete-text">delete_text</link></methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">n_chars</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkentrybuffer--emit-inserted-text">emit_inserted_text</link></methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">chars</parameter></methodparam>
<methodparam><parameter role="keyword">n_chars</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkentrybuffer--emit-deleted-text">emit_deleted_text</link></methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">n_chars</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkentrybuffer">gtk.EntryBuffer</link>
</synopsis>
</refsect1>
<refsect1 id="properties-gtkentrybuffer">
<title>gtk.EntryBuffer Properties</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="3.5in"/>
<tbody>
<row valign="top">
<entry>"length"</entry>
<entry>Read</entry>
<entry>The length (in characters) of the text in buffer. Allowed values: <=65535. Default value: 0.</entry>
</row>
<row valign="top">
<entry>"max-length"</entry>
<entry>Read/Write</entry>
<entry>The maximum length (in characters) of the text in the buffer. Allowed values: <=65535. Default value: 0.</entry>
</row>
<row valign="top">
<entry>"text"</entry>
<entry>Read/Write</entry>
<entry>The contents of the buffer. Default value: "".</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="signal-prototypes-gtkentrybuffer">
<title>gtk.EntryBuffer Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<variablelist>
<varlistentry>
<term>"<link linkend="signal-gtkentrybuffer--deleted-text">deleted-text</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>buffer</parameter></methodparam>
<methodparam><parameter>position</parameter></methodparam>
<methodparam><parameter>n_chars</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkentrybuffer--inserted-text">inserted-text</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>buffer</parameter></methodparam>
<methodparam><parameter>position</parameter></methodparam>
<methodparam><parameter>chars</parameter></methodparam>
<methodparam><parameter>n_chars</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<para>The <link linkend="class-gtkentrybuffer"><classname>gtk.EntryBuffer</classname></link> class contains the actual text displayed in a
<link linkend="class-gtkentry"><classname>gtk.Entry</classname></link> widget.</para>
<para>A single <link linkend="class-gtkentrybuffer"><classname>gtk.EntryBuffer</classname></link> object can be shared by multiple
<link linkend="class-gtkentry"><classname>gtk.Entry</classname></link> widgets which will then share the same text content, but not the cursor
position, visibility attributes, icon etc.</para>
<para><link linkend="class-gtkentrybuffer"><classname>gtk.EntryBuffer</classname></link> may be derived from. Such a derived class might allow
text to be stored in an alternate location, such as non-pageable memory, useful in the case of important passwords. Or a derived class could
integrate with an application's concept of undo/redo.</para>
</refsect1>
<refsect1 id="constructor-gtkentrybuffer">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.EntryBuffer</methodname>
<methodparam><parameter role="keyword">initial_chars</parameter></methodparam>
<methodparam><parameter role="keyword">n_initial_chars</parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">initial_chars</parameter> :</term>
<listitem><simpara>initial buffer text, or <literal>None</literal>.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">n_initial_chars</parameter> :</term>
<listitem><simpara>number of characters in <parameter>initial_chars</parameter>, or -1.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link linkend="class-gtkentrybuffer"><classname>gtk.EntryBuffer</classname></link>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This constructor is available in PyGTK 2.22 and above.</para>
</note>
<para>Creates a new <link linkend="class-gtkentrybuffer"><classname>gtk.EntryBuffer</classname></link> object.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkentrybuffer--get-bytes">
<title>gtk.EntryBuffer.get_bytes</title>
<programlisting><methodsynopsis language="python">
<methodname>get_bytes</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the byte length of the buffer.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>get_bytes</methodname>() method retrieves the length in bytes of the buffer.
See <link linkend="method-gtkentrybuffer--get-length"><methodname>gtk.EntryBuffer.get_length</methodname></link>().</para>
</refsect2>
<refsect2 id="method-gtkentrybuffer--get-length">
<title>gtk.EntryBuffer.get_length</title>
<programlisting><methodsynopsis language="python">
<methodname>get_length</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the number of characters in the buffer.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>get_length</methodname>() method retrieves the length in characters of the buffer.</para>
</refsect2>
<refsect2 id="method-gtkentrybuffer--set-text">
<title>gtk.EntryBuffer.set_text</title>
<programlisting><methodsynopsis language="python">
<methodname>set_text</methodname>
<methodparam><parameter role="keyword">chars</parameter></methodparam>
<methodparam><parameter role="keyword">n_chars</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">chars</parameter> :</term>
<listitem><simpara>the new text</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">n_chars</parameter> :</term>
<listitem><simpara>the number of characters, or -1</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>set_text</methodname>() method sets the text in the buffer.</para>
</refsect2>
<refsect2 id="method-gtkentrybuffer--get-text">
<title>gtk.EntryBuffer.get_text</title>
<programlisting><methodsynopsis language="python">
<methodname>get_text</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the contents of the buffer.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>get_text</methodname>() method retrieves the contents of the buffer.</para>
</refsect2>
<refsect2 id="method-gtkentrybuffer--get-max-length">
<title>gtk.EntryBuffer.set_max_length</title>
<programlisting><methodsynopsis language="python">
<methodname>set_max_length</methodname>
<methodparam><parameter role="keyword">max_length</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">max_length</parameter> :</term>
<listitem><simpara>the maximum length of the entry buffer, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>set_max_length</methodname>() sets the maximum allowed length of the contents of the buffer.
If the current contents are longer than the given length, then they will be truncated to fit.</para>
</refsect2>
<refsect2 id="method-gtkentrybuffer--set-max-length">
<title>gtk.EntryBuffer.get_max_length</title>
<programlisting><methodsynopsis language="python">
<methodname>get_max_length</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the maximum allowed number of characters in the entry buffer, or 0 if there is no maximum.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>get_max_length</methodname>() method retrieves the maximum allowed length of the text in buffer.
See <link linkend="method-gtkentrybuffer--set-max-length"><methodname>gtk.EntryBuffer.set_max_length</methodname></link>().</para>
</refsect2>
<refsect2 id="method-gtkentrybuffer--insert-text">
<title>gtk.EntryBuffer.insert_text</title>
<programlisting><methodsynopsis language="python">
<methodname>insert_text</methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">chars</parameter></methodparam>
<methodparam><parameter role="keyword">n_chars</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">position</parameter> :</term>
<listitem><simpara>the position at which to insert text.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">chars</parameter> :</term>
<listitem><simpara>the text to insert into the buffer.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">n_chars</parameter> :</term>
<listitem><simpara>the length of the text in characters, or -1.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>insert_text</methodname>() method inserts n_chars characters of chars into the contents of the buffer, at position position.</para>
</refsect2>
<refsect2 id="method-gtkentrybuffer--delete-text">
<title>gtk.EntryBuffer.delete_text</title>
<programlisting><methodsynopsis language="python">
<methodname>delete_text</methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">n_chars</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">position</parameter> :</term>
<listitem><simpara>the position at which to delete text.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">n_chars</parameter> :</term>
<listitem><simpara>the number of characters to delete.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>delete_text</methodname>() method deletes a sequence of characters from the buffer. n_chars characters are deleted starting at position.
If n_chars is negative, then all characters until the end of the text are deleted. .</para>
</refsect2>
<refsect2 id="method-gtkentrybuffer--emit-inserted-text">
<title>gtk.EntryBuffer.emit_inserted_text</title>
<programlisting><methodsynopsis language="python">
<methodname>emit_inserted_text</methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">chars</parameter></methodparam>
<methodparam><parameter role="keyword">n_chars</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">position</parameter> :</term>
<listitem><simpara>the position at which text was inserted.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">chars</parameter> :</term>
<listitem><simpara>the text that was inserted.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">n_chars</parameter> :</term>
<listitem><simpara>the number of characters inserted.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>emit_inserted_text</methodname>() method can be used when subclassing
<link linkend="class-gtkentrybuffer"><classname>gtk.EntryBuffer</classname></link>.</para>
</refsect2>
<refsect2 id="method-gtkentrybuffer--emit-deleted-text">
<title>gtk.EntryBuffer.emit_deleted_text</title>
<programlisting><methodsynopsis language="python">
<methodname>emit_deleted_text</methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">n_chars</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">position</parameter> :</term>
<listitem><simpara>the position at which text was deleted.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">n_chars</parameter> :</term>
<listitem><simpara>the number of characters deleted.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>emit_deleted_text</methodname>() method can be used when subclassing
<link linkend="class-gtkentrybuffer"><classname>gtk.EntryBuffer</classname></link>.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gtkentrybuffer--deleted-text">
<title>The "deleted-text" gtk.EntryBuffer Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>buffer</parameter></methodparam>
<methodparam><parameter>position</parameter></methodparam>
<methodparam><parameter>n_chars</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter> :</term>
<listitem><simpara>the buffer that received the signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>position</parameter> :</term>
<listitem><simpara>the the position the text was deleted at</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>n_chars</parameter> :</term>
<listitem><simpara>the number of characters that were deleted</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 "activate" signal is emitted after text is deleted from the buffer.</para>
</refsect2>
<refsect2 id="signal-gtkentrybuffer--inserted-text">
<title>The "inserted-text" gtk.EntryBuffer Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>buffer</parameter></methodparam>
<methodparam><parameter>position</parameter></methodparam>
<methodparam><parameter>chars</parameter></methodparam>
<methodparam><parameter>n_chars</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter> :</term>
<listitem><simpara>the buffer that received the signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>position</parameter> :</term>
<listitem><simpara>the position the text was inserted at</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>chars</parameter> :</term>
<listitem><simpara>the text that was inserted</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>n_chars</parameter> :</term>
<listitem><simpara>the number of characters that were 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 "activate" signal is emitted after text is inserted into the buffer. </para>
</refsect2>
</refsect1>
</refentry>
|
