Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkentry.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkEntry
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A single line text entry field
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GtkEntry widget is a single line text entry
  10 widget. A fairly large set of key bindings are supported
  11 by default. If the entered text is longer than the allocation
  12 of the widget, the widget will scroll so that the cursor
  13 position is visible.
  14 </para>
  15
  16 <!-- ##### SECTION See_Also ##### -->
  17 <para>
  18 <variablelist>
  19
  20 <varlistentry>
  21 <term>#GtkTextView</term>
  22 <listitem><para>a widget for handling multi-line text entry.</para></listitem>
  23 </varlistentry>
  24
  25 </variablelist>
  26 </para>
  27
  28 <!-- ##### SECTION Stability_Level ##### -->
  29
  30
  31 <!-- ##### STRUCT GtkEntry ##### -->
  32 <para>
  33 The #GtkEntry-struct struct contains only private data.
  34 </para>
  35
  36
  37 <!-- ##### SIGNAL GtkEntry::activate ##### -->
  38 <para>
  39
  40 </para>
  41
  42 @entry: the object which received the signal.
  43
  44 <!-- ##### SIGNAL GtkEntry::backspace ##### -->
  45 <para>
  46
  47 </para>
  48
  49 @entry: the object which received the signal.
  50
  51 <!-- ##### SIGNAL GtkEntry::copy-clipboard ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @entry: the object which received the signal.
  57
  58 <!-- ##### SIGNAL GtkEntry::cut-clipboard ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @entry: the object which received the signal.
  64
  65 <!-- ##### SIGNAL GtkEntry::delete-from-cursor ##### -->
  66 <para>
  67
  68 </para>
  69
  70 @entry: the object which received the signal.
  71 @arg1:
  72 @arg2:
  73
  74 <!-- ##### SIGNAL GtkEntry::insert-at-cursor ##### -->
  75 <para>
  76
  77 </para>
  78
  79 @entry: the object which received the signal.
  80 @arg1:
  81
  82 <!-- ##### SIGNAL GtkEntry::move-cursor ##### -->
  83 <para>
  84
  85 </para>
  86
  87 @entry: the object which received the signal.
  88 @arg1:
  89 @arg2:
  90 @arg3:
  91
  92 <!-- ##### SIGNAL GtkEntry::paste-clipboard ##### -->
  93 <para>
  94
  95 </para>
  96
  97 @entry: the object which received the signal.
  98
  99 <!-- ##### SIGNAL GtkEntry::populate-popup ##### -->
 100 <para>
 101
 102 </para>
 103
 104 @entry: the object which received the signal.
 105 @arg1:
 106
 107 <!-- ##### SIGNAL GtkEntry::toggle-overwrite ##### -->
 108 <para>
 109
 110 </para>
 111
 112 @entry: the object which received the signal.
 113
 114 <!-- ##### ARG GtkEntry:activates-default ##### -->
 115 <para>
 116
 117 </para>
 118
 119 <!-- ##### ARG GtkEntry:cursor-position ##### -->
 120 <para>
 121
 122 </para>
 123
 124 <!-- ##### ARG GtkEntry:editable ##### -->
 125 <para>
 126
 127 </para>
 128
 129 <!-- ##### ARG GtkEntry:has-frame ##### -->
 130 <para>
 131
 132 </para>
 133
 134 <!-- ##### ARG GtkEntry:inner-border ##### -->
 135 <para>
 136
 137 </para>
 138
 139 <!-- ##### ARG GtkEntry:invisible-char ##### -->
 140 <para>
 141
 142 </para>
 143
 144 <!-- ##### ARG GtkEntry:max-length ##### -->
 145 <para>
 146
 147 </para>
 148
 149 <!-- ##### ARG GtkEntry:scroll-offset ##### -->
 150 <para>
 151
 152 </para>
 153
 154 <!-- ##### ARG GtkEntry:selection-bound ##### -->
 155 <para>
 156
 157 </para>
 158
 159 <!-- ##### ARG GtkEntry:shadow-type ##### -->
 160 <para>
 161
 162 </para>
 163
 164 <!-- ##### ARG GtkEntry:text ##### -->
 165 <para>
 166
 167 </para>
 168
 169 <!-- ##### ARG GtkEntry:truncate-multiline ##### -->
 170 <para>
 171
 172 </para>
 173
 174 <!-- ##### ARG GtkEntry:visibility ##### -->
 175 <para>
 176
 177 </para>
 178
 179 <!-- ##### ARG GtkEntry:width-chars ##### -->
 180 <para>
 181
 182 </para>
 183
 184 <!-- ##### ARG GtkEntry:xalign ##### -->
 185 <para>
 186
 187 </para>
 188
 189 <!-- ##### ARG GtkEntry:inner-border ##### -->
 190 <para>
 191
 192 </para>
 193
 194 <!-- ##### FUNCTION gtk_entry_new ##### -->
 195 <para>
 196
 197 </para>
 198
 199 @Returns:
 200
 201
 202 <!-- ##### FUNCTION gtk_entry_new_with_max_length ##### -->
 203 <para>
 204 </para>
 205
 206 @max:
 207 @Returns:
 208
 209
 210 <!-- ##### FUNCTION gtk_entry_set_text ##### -->
 211 <para>
 212
 213 </para>
 214
 215 @entry:
 216 @text:
 217
 218
 219 <!-- ##### FUNCTION gtk_entry_append_text ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @entry:
 225 @text:
 226
 227
 228 <!-- ##### FUNCTION gtk_entry_prepend_text ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @entry:
 234 @text:
 235
 236
 237 <!-- ##### FUNCTION gtk_entry_set_position ##### -->
 238 <para>
 239
 240 </para>
 241
 242 @entry:
 243 @position:
 244
 245
 246 <!-- ##### FUNCTION gtk_entry_get_text ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @entry:
 252 @Returns:
 253
 254
 255 <!-- ##### FUNCTION gtk_entry_select_region ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @entry:
 261 @start:
 262 @end:
 263
 264
 265 <!-- ##### FUNCTION gtk_entry_set_visibility ##### -->
 266 <para>
 267
 268 </para>
 269
 270 @entry:
 271 @visible:
 272
 273
 274 <!-- ##### FUNCTION gtk_entry_set_invisible_char ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @entry:
 280 @ch:
 281
 282
 283 <!-- ##### FUNCTION gtk_entry_set_editable ##### -->
 284 <para>
 285
 286 </para>
 287
 288 @entry:
 289 @editable:
 290
 291
 292 <!-- ##### FUNCTION gtk_entry_set_max_length ##### -->
 293 <para>
 294 </para>
 295
 296 @entry:
 297 @max:
 298
 299
 300 <!-- ##### FUNCTION gtk_entry_get_activates_default ##### -->
 301 <para>
 302
 303 </para>
 304
 305 @entry:
 306 @Returns:
 307
 308
 309 <!-- ##### FUNCTION gtk_entry_get_has_frame ##### -->
 310 <para>
 311
 312 </para>
 313
 314 @entry:
 315 @Returns:
 316
 317
 318 <!-- ##### FUNCTION gtk_entry_get_inner_border ##### -->
 319 <para>
 320
 321 </para>
 322
 323 @entry:
 324 @Returns:
 325
 326
 327 <!-- ##### FUNCTION gtk_entry_get_width_chars ##### -->
 328 <para>
 329
 330 </para>
 331
 332 @entry:
 333 @Returns:
 334
 335
 336 <!-- ##### FUNCTION gtk_entry_set_activates_default ##### -->
 337 <para>
 338
 339 </para>
 340
 341 @entry:
 342 @setting:
 343
 344
 345 <!-- ##### FUNCTION gtk_entry_set_has_frame ##### -->
 346 <para>
 347
 348 </para>
 349
 350 @entry:
 351 @setting:
 352
 353
 354 <!-- ##### FUNCTION gtk_entry_set_inner_border ##### -->
 355 <para>
 356
 357 </para>
 358
 359 @entry:
 360 @border:
 361
 362
 363 <!-- ##### FUNCTION gtk_entry_set_width_chars ##### -->
 364 <para>
 365
 366 </para>
 367
 368 @entry:
 369 @n_chars:
 370
 371
 372 <!-- ##### FUNCTION gtk_entry_get_invisible_char ##### -->
 373 <para>
 374
 375 </para>
 376
 377 @entry:
 378 @Returns:
 379
 380
 381 <!-- ##### FUNCTION gtk_entry_set_alignment ##### -->
 382 <para>
 383
 384 </para>
 385
 386 @entry:
 387 @xalign:
 388
 389
 390 <!-- ##### FUNCTION gtk_entry_get_alignment ##### -->
 391 <para>
 392
 393 </para>
 394
 395 @entry:
 396 @Returns:
 397
 398
 399 <!-- ##### FUNCTION gtk_entry_get_layout ##### -->
 400 <para>
 401
 402 </para>
 403
 404 @entry:
 405 @Returns:
 406
 407
 408 <!-- ##### FUNCTION gtk_entry_get_layout_offsets ##### -->
 409 <para>
 410
 411 </para>
 412
 413 @entry:
 414 @x:
 415 @y:
 416
 417
 418 <!-- ##### FUNCTION gtk_entry_layout_index_to_text_index ##### -->
 419 <para>
 420
 421 </para>
 422
 423 @entry:
 424 @layout_index:
 425 @Returns:
 426
 427
 428 <!-- ##### FUNCTION gtk_entry_text_index_to_layout_index ##### -->
 429 <para>
 430
 431 </para>
 432
 433 @entry:
 434 @text_index:
 435 @Returns:
 436
 437
 438 <!-- ##### FUNCTION gtk_entry_get_max_length ##### -->
 439 <para>
 440
 441 </para>
 442
 443 @entry:
 444 @Returns:
 445
 446
 447 <!-- ##### FUNCTION gtk_entry_get_visibility ##### -->
 448 <para>
 449
 450 </para>
 451
 452 @entry:
 453 @Returns:
 454
 455
 456 <!-- ##### FUNCTION gtk_entry_set_completion ##### -->
 457 <para>
 458
 459 </para>
 460
 461 @entry:
 462 @completion:
 463
 464
 465 <!-- ##### FUNCTION gtk_entry_get_completion ##### -->
 466 <para>
 467
 468 </para>
 469
 470 @entry:
 471 @Returns:
 472
 473
 474 <!-- ##### FUNCTION gtk_entry_set_cursor_hadjustment ##### -->
 475 <para>
 476
 477 </para>
 478
 479 @entry:
 480 @adjustment:
 481
 482
 483 <!-- ##### FUNCTION gtk_entry_get_cursor_hadjustment ##### -->
 484 <para>
 485
 486 </para>
 487
 488 @entry:
 489 @Returns:
 490
 491