File: gtkdataentry.xml

package info (click to toggle)
gtkextra 3.3.4-7
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 10,580 kB
  • sloc: ansic: 60,728; xml: 28,485; sh: 4,758; makefile: 476
file content (500 lines) | stat: -rw-r--r-- 30,643 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<!--ENTITY index-Objects-Grouped SYSTEM "objects_grouped.sgml"-->
<refentry id="GtkDataEntry">
<refmeta>
<refentrytitle role="top_of_page" id="GtkDataEntry.top_of_page">GtkDataEntry</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTKEXTRA Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkDataEntry</refname>
<refpurpose>a data entry widget, based on GtkEntry</refpurpose>
</refnamediv>

<refsect1 id="GtkDataEntry.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type"><link linkend="GtkDataEntry"><returnvalue>GtkDataEntry</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-data-entry-new">gtk_data_entry_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-data-entry-get-description">gtk_data_entry_get_description</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-data-entry-set-description">gtk_data_entry_set_description</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-data-entry-get-data-type">gtk_data_entry_get_data_type</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-data-entry-set-data-type">gtk_data_entry_set_data_type</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-data-entry-get-data-format">gtk_data_entry_get_data_format</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-data-entry-set-data-format">gtk_data_entry_set_data_format</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-data-entry-get-text">gtk_data_entry_get_text</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-data-entry-set-text">gtk_data_entry_set_text</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-data-entry-get-max-length-bytes">gtk_data_entry_get_max_length_bytes</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-data-entry-set-max-length-bytes">gtk_data_entry_set_max_length_bytes</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkDataEntry.properties" role="properties">
<title role="properties.title">Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="properties_type" colwidth="150px"/>
<colspec colname="properties_name" colwidth="300px"/>
<colspec colname="properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkDataEntry--dataformat">dataformat</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkDataEntry--datatype">datatype</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkDataEntry--description">description</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gint"><type>gint</type></link></entry><entry role="property_name"><link linkend="GtkDataEntry--max-length-bytes">max-length-bytes</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gchar"><type>gchar</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkDataEntry--text">text</link></entry><entry role="property_flags">Read / Write</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkDataEntry.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="name" colwidth="150px"/>
<colspec colname="description"/>
<tbody>
<row><entry role="datatype_keyword">struct</entry><entry role="function_name"><link linkend="GtkDataEntry-struct">GtkDataEntry</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkDataEntry.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
        <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkObject">GtkObject</link>
            <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkWidget">GtkWidget</link>
                <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkEntry">GtkEntry</link>
                    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkDataEntry
</screen>
</refsect1>
<refsect1 id="GtkDataEntry.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkDataEntry implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="GtkEditable">GtkEditable</link> and  <link linkend="GtkCellEditable">GtkCellEditable</link>.</para>

</refsect1>

<refsect1 id="GtkDataEntry.includes"><title>Includes</title><synopsis>#include &lt;gtkextra.h&gt;
</synopsis></refsect1>

<refsect1 id="GtkDataEntry.description" role="desc">
<title role="desc.title">Description</title>
<para>GtkDataEntry provides additional properties: </para>
<itemizedlist>
<listitem>
<para><link linkend="GtkDataEntry--description"><type>“description”</type></link> - no functionality, a place for 
private information that cannot be put anywhere else</para>
</listitem>
<listitem>
<para><link linkend="GtkDataEntry--datatype"><type>“datatype”</type></link> - no functionality, a datatype hint
for the application because any widget content is text</para>
</listitem>
<listitem>
<para><link linkend="GtkDataEntry--dataformat"><type>“dataformat”</type></link> - a formatting instruction that 
controls what you see when the widget doesn't have input
focus</para>
</listitem>
<listitem>
<para><link linkend="GtkDataEntry--text"><type>“text”</type></link> - set the contents of the widget. if the
widget doesn't have input focus text will be formatted
according to the data_format</para>
</listitem>
<listitem>
<para><link linkend="GtkDataEntry--max-length-bytes"><type>“max-length-bytes”</type></link> - set the maximum byte 
length for the contents of the widget.</para>
</listitem>
</itemizedlist>
<para>The main reason for this widget is to provide a formatting  
entry widget for numeric data like integer, float, money 
which also supports NULL values (GtkSpinButton is nice but 
doesn't support empty field values). Handling of Null values 
is supported by all SQL database systems. The Null values are
represented by empty field contents. </para>
<para>When editing field contents, all data formatting is removed 
before the focus enters the widget. As soon as the focus 
leaves the widget, data will be nicely formatted again. </para>
<para>As an additional feature, the minus sign (negative numbers) 
can be entered at the end of the data. As soon as you leave 
the field it will be placed properly in front of the number. </para>
<para>See also: <link linkend="gtk-data-format"><function>gtk_data_format()</function></link></para>

</refsect1>
<refsect1 id="GtkDataEntry.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-data-entry-new" role="function">
<title>gtk_data_entry_new&#160;()</title>
<indexterm zone="gtk-data-entry-new"><primary>gtk_data_entry_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkDataEntry"><returnvalue>GtkDataEntry</returnvalue></link>&#160;*
gtk_data_entry_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new GtkDataEntry Widget.</para>
<refsect3 id="gtk-data-entry-new.returns" role="returns">
<title>Returns</title>
<para> the new GtkDataEntry Widget </para>
</refsect3></refsect2>
<refsect2 id="gtk-data-entry-get-description" role="function">
<title>gtk_data_entry_get_description&#160;()</title>
<indexterm zone="gtk-data-entry-get-description"><primary>gtk_data_entry_get_description</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_data_entry_get_description (<parameter><link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> *data_entry</parameter>);</programlisting>
<para>Retrieves the <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> description.</para>
<refsect3 id="gtk-data-entry-get-description.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>data_entry</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-data-entry-get-description.returns" role="returns">
<title>Returns</title>
<para> a pointer to the contents of the widget as a
string. This string points to internally allocated
storage in the widget and must not be freed, modified or
stored.</para>
</refsect3></refsect2>
<refsect2 id="gtk-data-entry-set-description" role="function">
<title>gtk_data_entry_set_description&#160;()</title>
<indexterm zone="gtk-data-entry-set-description"><primary>gtk_data_entry_set_description</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_data_entry_set_description (<parameter><link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> *data_entry</parameter>,
                                <parameter>const <link linkend="gchar"><type>gchar</type></link> *description</parameter>);</programlisting>
<para>Sets the GtkDataEntry description. </para>
<para>Basically, you can use the description for your own 
programming purpose. The <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> recognizes the 
keywords below, which have a special meaning. </para>
<itemizedlist>
<listitem>
<para>Ignore(vString) - silently ignore all characters in vString </para>
</listitem>
<listitem>
<para>Map(vString1|vString) - map each character in vString1 to 
the corresponding character in vString2 with the same index</para>
</listitem>
<listitem>
<para>Accept(vString) - accept only characters in vString, sound
bell for invalid characters</para>
</listitem>
<listitem>
<para>Reject(vString) - ignore all characters in vString, sound 
bell for invalid characters</para>
</listitem>
</itemizedlist>
<para>Evaluation order: Ignore, Map, not Accept or Reject </para>
<para>vString's are a literate character lists. They may contain
valid utf-8 character sequences and the following
escape sequences: \a, \b, \f, \n, \r, \t, \v, \. vStrings
are not quoted like a normal C string, they are delimited by 
round brackets or the pipe symbol, see above.</para>
<refsect3 id="gtk-data-entry-set-description.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>data_entry</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>description</para></entry>
<entry role="parameter_description"><para>the description or NULL </para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-data-entry-get-data-type" role="function">
<title>gtk_data_entry_get_data_type&#160;()</title>
<indexterm zone="gtk-data-entry-get-data-type"><primary>gtk_data_entry_get_data_type</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_data_entry_get_data_type (<parameter><link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> *data_entry</parameter>);</programlisting>
<para>Retrieves the <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> data_type.</para>
<refsect3 id="gtk-data-entry-get-data-type.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>data_entry</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-data-entry-get-data-type.returns" role="returns">
<title>Returns</title>
<para> a pointer to the contents of the widget as a
string. This string points to internally allocated
storage in the widget and must not be freed, modified or
stored.</para>
</refsect3></refsect2>
<refsect2 id="gtk-data-entry-set-data-type" role="function">
<title>gtk_data_entry_set_data_type&#160;()</title>
<indexterm zone="gtk-data-entry-set-data-type"><primary>gtk_data_entry_set_data_type</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_data_entry_set_data_type (<parameter><link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> *data_entry</parameter>,
                              <parameter>const <link linkend="gchar"><type>gchar</type></link> *data_type</parameter>);</programlisting>
<para>Sets the GtkDataEntry data type for application use.</para>
<refsect3 id="gtk-data-entry-set-data-type.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>data_entry</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>data_type</para></entry>
<entry role="parameter_description"><para>the data type or NULL </para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-data-entry-get-data-format" role="function">
<title>gtk_data_entry_get_data_format&#160;()</title>
<indexterm zone="gtk-data-entry-get-data-format"><primary>gtk_data_entry_get_data_format</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_data_entry_get_data_format (<parameter><link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> *data_entry</parameter>);</programlisting>
<para>Retrieves the <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> data_format. </para>
<para>See <link linkend="gtk-data-format"><function>gtk_data_format()</function></link> for details.</para>
<refsect3 id="gtk-data-entry-get-data-format.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>data_entry</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-data-entry-get-data-format.returns" role="returns">
<title>Returns</title>
<para> a pointer to the contents of the widget as a
string. This string points to internally allocated
storage in the widget and must not be freed, modified or
stored.</para>
</refsect3></refsect2>
<refsect2 id="gtk-data-entry-set-data-format" role="function">
<title>gtk_data_entry_set_data_format&#160;()</title>
<indexterm zone="gtk-data-entry-set-data-format"><primary>gtk_data_entry_set_data_format</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_data_entry_set_data_format (<parameter><link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> *data_entry</parameter>,
                                <parameter>const <link linkend="gchar"><type>gchar</type></link> *data_format</parameter>);</programlisting>
<para>Sets the GtkDataEntry data type for application use. The 
display will not be refreshed upon change. </para>
<para>See <link linkend="gtk-data-format"><function>gtk_data_format()</function></link> for details.</para>
<refsect3 id="gtk-data-entry-set-data-format.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>data_entry</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>data_format</para></entry>
<entry role="parameter_description"><para>the data type or NULL </para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-data-entry-get-text" role="function">
<title>gtk_data_entry_get_text&#160;()</title>
<indexterm zone="gtk-data-entry-get-text"><primary>gtk_data_entry_get_text</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_data_entry_get_text (<parameter><link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> *data_entry</parameter>);</programlisting>
<para>Retrieves the <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> contents. All formatting will be 
removed.</para>
<refsect3 id="gtk-data-entry-get-text.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>data_entry</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-data-entry-get-text.returns" role="returns">
<title>Returns</title>
<para> a pointer to the contents of the widget as a
string. This string points to internally allocated
storage in the widget and must not be freed, modified or
stored.</para>
</refsect3></refsect2>
<refsect2 id="gtk-data-entry-set-text" role="function">
<title>gtk_data_entry_set_text&#160;()</title>
<indexterm zone="gtk-data-entry-set-text"><primary>gtk_data_entry_set_text</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_data_entry_set_text (<parameter><link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> *data_entry</parameter>,
                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *text</parameter>);</programlisting>
<para>Sets the GtkDataEntry contents. The contents will be 
formatted due to the current data_format.</para>
<refsect3 id="gtk-data-entry-set-text.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>data_entry</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>text</para></entry>
<entry role="parameter_description"><para>the contents to be set</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-data-entry-get-max-length-bytes" role="function" condition="since:3.0.6">
<title>gtk_data_entry_get_max_length_bytes&#160;()</title>
<indexterm zone="gtk-data-entry-get-max-length-bytes" role="3.0.6"><primary>gtk_data_entry_get_max_length_bytes</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_data_entry_get_max_length_bytes (<parameter><link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> *data_entry</parameter>);</programlisting>
<para>Retrieves the maximum byte length for the contents of  
<link linkend="GtkDataEntry"><type>GtkDataEntry</type></link>.</para>
<refsect3 id="gtk-data-entry-get-max-length-bytes.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>data_entry</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-data-entry-get-max-length-bytes.returns" role="returns">
<title>Returns</title>
<para> maximum byte length or 0. </para>
</refsect3><para role="since">Since: <link linkend="api-index-3.0.6">3.0.6</link></para></refsect2>
<refsect2 id="gtk-data-entry-set-max-length-bytes" role="function" condition="since:3.0.6">
<title>gtk_data_entry_set_max_length_bytes&#160;()</title>
<indexterm zone="gtk-data-entry-set-max-length-bytes" role="3.0.6"><primary>gtk_data_entry_set_max_length_bytes</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_data_entry_set_max_length_bytes (<parameter><link linkend="GtkDataEntry"><type>GtkDataEntry</type></link> *data_entry</parameter>,
                                     <parameter><link linkend="gint"><type>gint</type></link> max_length_bytes</parameter>);</programlisting>
<para>Sets the maximum byte length for the contents of the 
<link linkend="GtkDataEntry"><type>GtkDataEntry</type></link>. Existing content will not be truncted.</para>
<refsect3 id="gtk-data-entry-set-max-length-bytes.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>data_entry</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkDataEntry"><type>GtkDataEntry</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>max_length_bytes</para></entry>
<entry role="parameter_description"><para>maximum byte length or 0</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-3.0.6">3.0.6</link></para></refsect2>

</refsect1>
<refsect1 id="GtkDataEntry.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkDataEntry-struct" role="struct">
<title>struct GtkDataEntry</title>
<indexterm zone="GtkDataEntry-struct"><primary>GtkDataEntry</primary></indexterm>
<programlisting language="C">struct GtkDataEntry;</programlisting>
<para>The GtkDataEntry struct contains only private data. It should
only be accessed through the functions described below.</para>
</refsect2>

</refsect1>
<refsect1 id="GtkDataEntry.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkDataEntry--dataformat" role="property"><title>The <literal>“dataformat”</literal> property</title>
<indexterm zone="GtkDataEntry--dataformat"><primary>GtkDataEntry:dataformat</primary></indexterm>
<programlisting>  “dataformat”               <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>a formatting string that controls what you see when the

widget doesn't contain input focus. </para>
<para>See <link linkend="gtk-data-format"><function>gtk_data_format()</function></link> for details.</para>
<para>Flags: Read / Write</para>
<para>Default value: ""</para>
</refsect2>
<refsect2 id="GtkDataEntry--datatype" role="property"><title>The <literal>“datatype”</literal> property</title>
<indexterm zone="GtkDataEntry--datatype"><primary>GtkDataEntry:datatype</primary></indexterm>
<programlisting>  “datatype”                 <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>no functionality, a datatype hint for the application because

any widget content is text.</para>
<para>Flags: Read / Write</para>
<para>Default value: ""</para>
</refsect2>
<refsect2 id="GtkDataEntry--description" role="property"><title>The <literal>“description”</literal> property</title>
<indexterm zone="GtkDataEntry--description"><primary>GtkDataEntry:description</primary></indexterm>
<programlisting>  “description”              <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>Description of the GtkDataEntry, no functionality, a place

for private information that cannot be put anywhere else.</para>
<para>Flags: Read / Write</para>
<para>Default value: ""</para>
</refsect2>
<refsect2 id="GtkDataEntry--max-length-bytes" role="property"><title>The <literal>“max-length-bytes”</literal> property</title>
<indexterm zone="GtkDataEntry--max-length-bytes" role="3.0.6"><primary>GtkDataEntry:max-length-bytes</primary></indexterm>
<programlisting>  “max-length-bytes”         <link linkend="gint"><type>gint</type></link></programlisting>
<para>Set the maximum length in bytes for the GtkDataEntry. For

details see <link linkend="gtk-data-entry-set-max-length-bytes"><type>gtk_data_entry_set_max_length_bytes</type></link>. </para>
<para>Sometimes, systems cannot handle UTF-8 string length
correctly, to overcome this problem, you can use the maximum

string length in bytes. When setting both limits, max-length

 and max-length-bytes, both must be fulfilled.</para>
<para>Flags: Read / Write</para>
<para>Allowed values: [0,65535]</para>
<para>Default value: 0</para>
<para role="since">Since: <link linkend="api-index-3.0.6">3.0.6</link></para></refsect2>
<refsect2 id="GtkDataEntry--text" role="property"><title>The <literal>“text”</literal> property</title>
<indexterm zone="GtkDataEntry--text"><primary>GtkDataEntry:text</primary></indexterm>
<programlisting>  “text”                     <link linkend="gchar"><type>gchar</type></link>&#160;*</programlisting>
<para>Set the contents of the GtkDataEntry. For details see

<link linkend="gtk-data-entry-set-text"><type>gtk_data_entry_set_text</type></link>.</para>
<para>Flags: Read / Write</para>
<para>Default value: ""</para>
</refsect2>

</refsect1>

</refentry>