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:overwrite-mode ##### -->
 150 <para>
 151
 152 </para>
 153
 154 <!-- ##### ARG GtkEntry:scroll-offset ##### -->
 155 <para>
 156
 157 </para>
 158
 159 <!-- ##### ARG GtkEntry:selection-bound ##### -->
 160 <para>
 161
 162 </para>
 163
 164 <!-- ##### ARG GtkEntry:shadow-type ##### -->
 165 <para>
 166
 167 </para>
 168
 169 <!-- ##### ARG GtkEntry:text ##### -->
 170 <para>
 171
 172 </para>
 173
 174 <!-- ##### ARG GtkEntry:text-length ##### -->
 175 <para>
 176
 177 </para>
 178
 179 <!-- ##### ARG GtkEntry:truncate-multiline ##### -->
 180 <para>
 181
 182 </para>
 183
 184 <!-- ##### ARG GtkEntry:visibility ##### -->
 185 <para>
 186
 187 </para>
 188
 189 <!-- ##### ARG GtkEntry:width-chars ##### -->
 190 <para>
 191
 192 </para>
 193
 194 <!-- ##### ARG GtkEntry:xalign ##### -->
 195 <para>
 196
 197 </para>
 198
 199 <!-- ##### ARG GtkEntry:inner-border ##### -->
 200 <para>
 201
 202 </para>
 203
 204 <!-- ##### FUNCTION gtk_entry_new ##### -->
 205 <para>
 206
 207 </para>
 208
 209 @Returns:
 210
 211
 212 <!-- ##### FUNCTION gtk_entry_new_with_max_length ##### -->
 213 <para>
 214 </para>
 215
 216 @max:
 217 @Returns:
 218
 219
 220 <!-- ##### FUNCTION gtk_entry_set_text ##### -->
 221 <para>
 222
 223 </para>
 224
 225 @entry:
 226 @text:
 227
 228
 229 <!-- ##### FUNCTION gtk_entry_append_text ##### -->
 230 <para>
 231
 232 </para>
 233
 234 @entry:
 235 @text:
 236
 237
 238 <!-- ##### FUNCTION gtk_entry_prepend_text ##### -->
 239 <para>
 240
 241 </para>
 242
 243 @entry:
 244 @text:
 245
 246
 247 <!-- ##### FUNCTION gtk_entry_set_position ##### -->
 248 <para>
 249
 250 </para>
 251
 252 @entry:
 253 @position:
 254
 255
 256 <!-- ##### FUNCTION gtk_entry_get_text ##### -->
 257 <para>
 258
 259 </para>
 260
 261 @entry:
 262 @Returns:
 263
 264
 265 <!-- ##### FUNCTION gtk_entry_select_region ##### -->
 266 <para>
 267
 268 </para>
 269
 270 @entry:
 271 @start:
 272 @end:
 273
 274
 275 <!-- ##### FUNCTION gtk_entry_set_visibility ##### -->
 276 <para>
 277
 278 </para>
 279
 280 @entry:
 281 @visible:
 282
 283
 284 <!-- ##### FUNCTION gtk_entry_set_invisible_char ##### -->
 285 <para>
 286
 287 </para>
 288
 289 @entry:
 290 @ch:
 291
 292
 293 <!-- ##### FUNCTION gtk_entry_set_editable ##### -->
 294 <para>
 295
 296 </para>
 297
 298 @entry:
 299 @editable:
 300
 301
 302 <!-- ##### FUNCTION gtk_entry_set_max_length ##### -->
 303 <para>
 304 </para>
 305
 306 @entry:
 307 @max:
 308
 309
 310 <!-- ##### FUNCTION gtk_entry_get_activates_default ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @entry:
 316 @Returns:
 317
 318
 319 <!-- ##### FUNCTION gtk_entry_get_has_frame ##### -->
 320 <para>
 321
 322 </para>
 323
 324 @entry:
 325 @Returns:
 326
 327
 328 <!-- ##### FUNCTION gtk_entry_get_inner_border ##### -->
 329 <para>
 330
 331 </para>
 332
 333 @entry:
 334 @Returns:
 335
 336
 337 <!-- ##### FUNCTION gtk_entry_get_width_chars ##### -->
 338 <para>
 339
 340 </para>
 341
 342 @entry:
 343 @Returns:
 344
 345
 346 <!-- ##### FUNCTION gtk_entry_set_activates_default ##### -->
 347 <para>
 348
 349 </para>
 350
 351 @entry:
 352 @setting:
 353
 354
 355 <!-- ##### FUNCTION gtk_entry_set_has_frame ##### -->
 356 <para>
 357
 358 </para>
 359
 360 @entry:
 361 @setting:
 362
 363
 364 <!-- ##### FUNCTION gtk_entry_set_inner_border ##### -->
 365 <para>
 366
 367 </para>
 368
 369 @entry:
 370 @border:
 371
 372
 373 <!-- ##### FUNCTION gtk_entry_set_width_chars ##### -->
 374 <para>
 375
 376 </para>
 377
 378 @entry:
 379 @n_chars:
 380
 381
 382 <!-- ##### FUNCTION gtk_entry_get_invisible_char ##### -->
 383 <para>
 384
 385 </para>
 386
 387 @entry:
 388 @Returns:
 389
 390
 391 <!-- ##### FUNCTION gtk_entry_set_alignment ##### -->
 392 <para>
 393
 394 </para>
 395
 396 @entry:
 397 @xalign:
 398
 399
 400 <!-- ##### FUNCTION gtk_entry_get_alignment ##### -->
 401 <para>
 402
 403 </para>
 404
 405 @entry:
 406 @Returns:
 407
 408
 409 <!-- ##### FUNCTION gtk_entry_get_layout ##### -->
 410 <para>
 411
 412 </para>
 413
 414 @entry:
 415 @Returns:
 416
 417
 418 <!-- ##### FUNCTION gtk_entry_get_layout_offsets ##### -->
 419 <para>
 420
 421 </para>
 422
 423 @entry:
 424 @x:
 425 @y:
 426
 427
 428 <!-- ##### FUNCTION gtk_entry_layout_index_to_text_index ##### -->
 429 <para>
 430
 431 </para>
 432
 433 @entry:
 434 @layout_index:
 435 @Returns:
 436
 437
 438 <!-- ##### FUNCTION gtk_entry_text_index_to_layout_index ##### -->
 439 <para>
 440
 441 </para>
 442
 443 @entry:
 444 @text_index:
 445 @Returns:
 446
 447
 448 <!-- ##### FUNCTION gtk_entry_get_max_length ##### -->
 449 <para>
 450
 451 </para>
 452
 453 @entry:
 454 @Returns:
 455
 456
 457 <!-- ##### FUNCTION gtk_entry_get_visibility ##### -->
 458 <para>
 459
 460 </para>
 461
 462 @entry:
 463 @Returns:
 464
 465
 466 <!-- ##### FUNCTION gtk_entry_set_completion ##### -->
 467 <para>
 468
 469 </para>
 470
 471 @entry:
 472 @completion:
 473
 474
 475 <!-- ##### FUNCTION gtk_entry_get_completion ##### -->
 476 <para>
 477
 478 </para>
 479
 480 @entry:
 481 @Returns:
 482
 483
 484 <!-- ##### FUNCTION gtk_entry_set_cursor_hadjustment ##### -->
 485 <para>
 486
 487 </para>
 488
 489 @entry:
 490 @adjustment:
 491
 492
 493 <!-- ##### FUNCTION gtk_entry_get_cursor_hadjustment ##### -->
 494 <para>
 495
 496 </para>
 497
 498 @entry:
 499 @Returns:
 500
 501