gtkentry.sgml 6.05 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
1 2 3 4
<!-- ##### SECTION Title ##### -->
GtkEntry

<!-- ##### SECTION Short_Description ##### -->
5
A single line text entry field
Owen Taylor's avatar
Owen Taylor committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkEntry widget is a single line text entry
widget. A fairly large set of key bindings are supported
by default. If the entered text is longer than the allocation
of the widget, the widget will scroll so that the cursor
position is visible. 
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>

<varlistentry>
21
<term>#GtkTextView</term>
Owen Taylor's avatar
Owen Taylor committed
22 23 24 25 26 27
<listitem><para>a widget for handling multi-line text entry.</para></listitem>
</varlistentry>

</variablelist>
</para>

Matthias Clasen's avatar
2.7.0  
Matthias Clasen committed
28 29 30
<!-- ##### SECTION Stability_Level ##### -->


Owen Taylor's avatar
Owen Taylor committed
31 32 33 34 35 36
<!-- ##### STRUCT GtkEntry ##### -->
<para>
The #GtkEntry-struct struct contains only private data.
</para>


Soeren Sandmann's avatar
Soeren Sandmann committed
37 38 39 40 41 42 43
<!-- ##### SIGNAL GtkEntry::activate ##### -->
<para>

</para>

@entry: the object which received the signal.

Matthias Clasen's avatar
2.5.2  
Matthias Clasen committed
44 45 46 47 48 49 50
<!-- ##### SIGNAL GtkEntry::backspace ##### -->
<para>

</para>

@entry: the object which received the signal.

Soeren Sandmann's avatar
Soeren Sandmann committed
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
<!-- ##### SIGNAL GtkEntry::copy-clipboard ##### -->
<para>

</para>

@entry: the object which received the signal.

<!-- ##### SIGNAL GtkEntry::cut-clipboard ##### -->
<para>

</para>

@entry: the object which received the signal.

<!-- ##### SIGNAL GtkEntry::delete-from-cursor ##### -->
<para>

</para>

@entry: the object which received the signal.
@arg1: 
@arg2: 

<!-- ##### SIGNAL GtkEntry::insert-at-cursor ##### -->
<para>

</para>

@entry: the object which received the signal.
@arg1: 

<!-- ##### SIGNAL GtkEntry::move-cursor ##### -->
<para>

</para>

@entry: the object which received the signal.
@arg1: 
@arg2: 
@arg3: 

<!-- ##### SIGNAL GtkEntry::paste-clipboard ##### -->
<para>

</para>

@entry: the object which received the signal.

<!-- ##### SIGNAL GtkEntry::populate-popup ##### -->
<para>

</para>

@entry: the object which received the signal.
@arg1: 

<!-- ##### SIGNAL GtkEntry::toggle-overwrite ##### -->
<para>

</para>

@entry: the object which received the signal.

<!-- ##### ARG GtkEntry:activates-default ##### -->
<para>

</para>

<!-- ##### ARG GtkEntry:cursor-position ##### -->
<para>

</para>

<!-- ##### ARG GtkEntry:editable ##### -->
<para>

</para>

<!-- ##### ARG GtkEntry:has-frame ##### -->
<para>

</para>

Matthias Clasen's avatar
Matthias Clasen committed
134 135 136 137 138
<!-- ##### ARG GtkEntry:inner-border ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
<!-- ##### ARG GtkEntry:invisible-char ##### -->
<para>

</para>

<!-- ##### ARG GtkEntry:max-length ##### -->
<para>

</para>

<!-- ##### ARG GtkEntry:scroll-offset ##### -->
<para>

</para>

<!-- ##### ARG GtkEntry:selection-bound ##### -->
<para>

</para>

Matthias Clasen's avatar
2.11.0  
Matthias Clasen committed
159 160 161 162 163
<!-- ##### ARG GtkEntry:shadow-type ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
164 165 166 167 168
<!-- ##### ARG GtkEntry:text ##### -->
<para>

</para>

Matthias Clasen's avatar
Matthias Clasen committed
169 170 171 172 173
<!-- ##### ARG GtkEntry:truncate-multiline ##### -->
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
<!-- ##### ARG GtkEntry:visibility ##### -->
<para>

</para>

<!-- ##### ARG GtkEntry:width-chars ##### -->
<para>

</para>

<!-- ##### ARG GtkEntry:xalign ##### -->
<para>

</para>

Matthias Clasen's avatar
2.9.0  
Matthias Clasen committed
189 190 191 192 193 194 195 196 197 198 199
<!-- ##### ARG GtkEntry:inner-border ##### -->
<para>

</para>

<!-- ##### FUNCTION gtk_entry_new ##### -->
<para>

</para>

@Returns: 
Owen Taylor's avatar
Owen Taylor committed
200 201 202 203 204 205


<!-- ##### FUNCTION gtk_entry_new_with_max_length ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
206
@max: 
207
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
208 209 210 211


<!-- ##### FUNCTION gtk_entry_set_text ##### -->
<para>
Matthias Clasen's avatar
Matthias Clasen committed
212

Owen Taylor's avatar
Owen Taylor committed
213 214
</para>

Matthias Clasen's avatar
Matthias Clasen committed
215 216
@entry:
@text:
Owen Taylor's avatar
Owen Taylor committed
217 218 219 220


<!-- ##### FUNCTION gtk_entry_append_text ##### -->
<para>
Matthias Clasen's avatar
Matthias Clasen committed
221

Owen Taylor's avatar
Owen Taylor committed
222 223
</para>

Matthias Clasen's avatar
Matthias Clasen committed
224 225
@entry: 
@text: 
Owen Taylor's avatar
Owen Taylor committed
226 227 228 229


<!-- ##### FUNCTION gtk_entry_prepend_text ##### -->
<para>
Matthias Clasen's avatar
Matthias Clasen committed
230

Owen Taylor's avatar
Owen Taylor committed
231 232
</para>

Matthias Clasen's avatar
Matthias Clasen committed
233 234
@entry:
@text:
Matthias Clasen's avatar
updates  
Matthias Clasen committed
235

Owen Taylor's avatar
Owen Taylor committed
236 237 238

<!-- ##### FUNCTION gtk_entry_set_position ##### -->
<para>
Matthias Clasen's avatar
Matthias Clasen committed
239

Owen Taylor's avatar
Owen Taylor committed
240 241
</para>

Matthias Clasen's avatar
Matthias Clasen committed
242 243
@entry: 
@position: 
Owen Taylor's avatar
Owen Taylor committed
244 245 246 247


<!-- ##### FUNCTION gtk_entry_get_text ##### -->
<para>
Soren Sandmann's avatar
Soren Sandmann committed
248

Owen Taylor's avatar
Owen Taylor committed
249 250
</para>

Soren Sandmann's avatar
Soren Sandmann committed
251 252
@entry: 
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
253 254 255 256


<!-- ##### FUNCTION gtk_entry_select_region ##### -->
<para>
Matthias Clasen's avatar
Matthias Clasen committed
257

Owen Taylor's avatar
Owen Taylor committed
258 259
</para>

Matthias Clasen's avatar
Matthias Clasen committed
260 261 262
@entry: 
@start:
@end: 
Owen Taylor's avatar
Owen Taylor committed
263 264 265 266


<!-- ##### FUNCTION gtk_entry_set_visibility ##### -->
<para>
Matthias Clasen's avatar
Matthias Clasen committed
267

268
</para>
Owen Taylor's avatar
Owen Taylor committed
269

Matthias Clasen's avatar
Matthias Clasen committed
270 271
@entry: 
@visible:
Owen Taylor's avatar
Owen Taylor committed
272 273


274 275 276 277 278 279 280 281 282
<!-- ##### FUNCTION gtk_entry_set_invisible_char ##### -->
<para>

</para>

@entry: 
@ch: 


Owen Taylor's avatar
Owen Taylor committed
283 284
<!-- ##### FUNCTION gtk_entry_set_editable ##### -->
<para>
Matthias Clasen's avatar
Matthias Clasen committed
285

Owen Taylor's avatar
Owen Taylor committed
286 287
</para>

Matthias Clasen's avatar
Matthias Clasen committed
288 289
@entry: 
@editable: 
Owen Taylor's avatar
Owen Taylor committed
290 291 292 293 294 295


<!-- ##### FUNCTION gtk_entry_set_max_length ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
296 297
@entry: 
@max: 
Owen Taylor's avatar
Owen Taylor committed
298 299


Havoc Pennington's avatar
Havoc Pennington committed
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
<!-- ##### FUNCTION gtk_entry_get_activates_default ##### -->
<para>

</para>

@entry: 
@Returns: 


<!-- ##### FUNCTION gtk_entry_get_has_frame ##### -->
<para>

</para>

@entry: 
@Returns: 


Matthias Clasen's avatar
Matthias Clasen committed
318 319 320 321 322 323 324 325 326
<!-- ##### FUNCTION gtk_entry_get_inner_border ##### -->
<para>

</para>

@entry: 
@Returns: 


Havoc Pennington's avatar
Havoc Pennington committed
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
<!-- ##### FUNCTION gtk_entry_get_width_chars ##### -->
<para>

</para>

@entry: 
@Returns: 


<!-- ##### FUNCTION gtk_entry_set_activates_default ##### -->
<para>

</para>

@entry: 
@setting: 


<!-- ##### FUNCTION gtk_entry_set_has_frame ##### -->
<para>

</para>

@entry: 
@setting: 


Matthias Clasen's avatar
Matthias Clasen committed
354 355 356 357 358 359 360 361 362
<!-- ##### FUNCTION gtk_entry_set_inner_border ##### -->
<para>

</para>

@entry: 
@border: 


Havoc Pennington's avatar
Havoc Pennington committed
363 364 365 366 367 368 369 370 371
<!-- ##### FUNCTION gtk_entry_set_width_chars ##### -->
<para>

</para>

@entry: 
@n_chars: 


372 373 374 375 376 377 378 379 380
<!-- ##### FUNCTION gtk_entry_get_invisible_char ##### -->
<para>

</para>

@entry: 
@Returns: 


381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
<!-- ##### FUNCTION gtk_entry_set_alignment ##### -->
<para>

</para>

@entry: 
@xalign: 


<!-- ##### FUNCTION gtk_entry_get_alignment ##### -->
<para>

</para>

@entry: 
@Returns: 


399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
<!-- ##### FUNCTION gtk_entry_get_layout ##### -->
<para>

</para>

@entry: 
@Returns: 


<!-- ##### FUNCTION gtk_entry_get_layout_offsets ##### -->
<para>

</para>

@entry: 
@x: 
@y: 


Matthias Clasen's avatar
2.5.2  
Matthias Clasen committed
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
<!-- ##### FUNCTION gtk_entry_layout_index_to_text_index ##### -->
<para>

</para>

@entry: 
@layout_index: 
@Returns: 


<!-- ##### FUNCTION gtk_entry_text_index_to_layout_index ##### -->
<para>

</para>

@entry: 
@text_index: 
@Returns: 


438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
<!-- ##### FUNCTION gtk_entry_get_max_length ##### -->
<para>

</para>

@entry: 
@Returns: 


<!-- ##### FUNCTION gtk_entry_get_visibility ##### -->
<para>

</para>

@entry: 
@Returns: 


Owen Taylor's avatar
Owen Taylor committed
456
<!-- ##### FUNCTION gtk_entry_set_completion ##### -->
457 458 459 460
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
461 462
@entry: 
@completion: 
463 464


Owen Taylor's avatar
Owen Taylor committed
465
<!-- ##### FUNCTION gtk_entry_get_completion ##### -->
466 467 468 469
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
470 471
@entry: 
@Returns: 
472 473


Matthias Clasen's avatar
2.11.0  
Matthias Clasen committed
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
<!-- ##### FUNCTION gtk_entry_set_cursor_hadjustment ##### -->
<para>

</para>

@entry: 
@adjustment: 


<!-- ##### FUNCTION gtk_entry_get_cursor_hadjustment ##### -->
<para>

</para>

@entry: 
@Returns: