gtkentry.sgml 6.49 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
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
<!-- ##### SECTION Title ##### -->
GtkEntry

<!-- ##### SECTION Short_Description ##### -->
a single line text entry field.

<!-- ##### 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>
<term>#GtkText</term>
<listitem><para>a widget for handling multi-line text entry.</para></listitem>
</varlistentry>

</variablelist>
</para>

<!-- ##### STRUCT GtkEntry ##### -->
<para>
The #GtkEntry-struct struct contains only private data.
</para>


<!-- ##### FUNCTION gtk_entry_new ##### -->
<para>
Creates a new #GtkEntry widget.
</para>

@Returns: a new #GtkEntry.


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

Owen Taylor's avatar
Owen Taylor committed
46
@max: 
47
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
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


<!-- ##### FUNCTION gtk_entry_set_text ##### -->
<para>
Sets the text in the widget to the given
value, replacing the current contents.
</para>

@entry: a #GtkEntry.
@text: the new text.


<!-- ##### FUNCTION gtk_entry_append_text ##### -->
<para>
Appends the given text to the contents of the widget.
</para>

@entry: a #GtkEntry.
@text: the text to append.


<!-- ##### FUNCTION gtk_entry_prepend_text ##### -->
<para>
Prepends the given text to the contents of th ewidget.
</para>

@entry: a #GtkEntry.
@text: the text to prepend.


<!-- ##### FUNCTION gtk_entry_set_position ##### -->
<para>
Sets the cursor position in an entry to the given 
value. This function is obsolete. You should use
gtk_editable_set_position() instead.
</para>

@entry: a #GtkEntry.
@position: the position of the cursor. The cursor is displayed
           before the character with the given (base 0) index
           in the widget. The value must be less than or
           equal to the number of characters in the widget.
           A value of -1 indicates that the position should
           be set after the last character in the entry.
           Note that this position is in characters, not in
           bytes.


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

Owen Taylor's avatar
Owen Taylor committed
99 100
</para>

Soren Sandmann's avatar
Soren Sandmann committed
101 102
@entry: 
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124


<!-- ##### FUNCTION gtk_entry_select_region ##### -->
<para>
Selects a region of text. The characters that
are selected are those characters at positions from
@start_pos up to, but not including @end_pos. If 
@end_pos is negative, then the the characters selected
will be those characters from @start_pos to the end
of the text. This function is obsolete. You should
use gtk_editable_select_region() instead.
</para>

@entry: a #GtkEntry.
@start: the starting position.
@end: the end position.


<!-- ##### FUNCTION gtk_entry_set_visibility ##### -->
<para>
Sets whether the contents of the entry are visible or
not. When visibility is set to %FALSE, characters
125
are displayed as the invisible char, and will also appear
Owen Taylor's avatar
Owen Taylor committed
126 127 128
that way when the text in the entry widget is copied
elsewhere.
</para>
129 130 131 132
<para>
The default invisible char is the asterisk '*', but it can
be changed with gtk_entry_set_invisible_char().
</para>
Owen Taylor's avatar
Owen Taylor committed
133 134

@entry: a #GtkEntry.
135
@visible: %TRUE if the contents of the entry are displayed
Owen Taylor's avatar
Owen Taylor committed
136 137 138
          as plaintext.


139 140 141 142 143 144 145 146 147
<!-- ##### FUNCTION gtk_entry_set_invisible_char ##### -->
<para>

</para>

@entry: 
@ch: 


Owen Taylor's avatar
Owen Taylor committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
<!-- ##### FUNCTION gtk_entry_set_editable ##### -->
<para>
Determines if the user can edit the text in the editable
widget or not. This function is obsolete. You should
use gtk_editable_set_editable() instead.
</para>

@entry: a #GtkEntry.
@editable: %TRUE if the user is allowed to edit the text
  in the widget.


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

Owen Taylor's avatar
Owen Taylor committed
164 165
@entry: 
@max: 
Owen Taylor's avatar
Owen Taylor committed
166 167


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

</para>

@entry: 
@Returns: 


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

</para>

@entry: 
@Returns: 


<!-- ##### 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: 


<!-- ##### FUNCTION gtk_entry_set_width_chars ##### -->
<para>

</para>

@entry: 
@n_chars: 


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
<!-- ##### FUNCTION gtk_entry_get_invisible_char ##### -->
<para>

</para>

@entry: 
@Returns: 


<!-- ##### FUNCTION gtk_entry_get_layout ##### -->
<para>

</para>

@entry: 
@Returns: 


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

</para>

@entry: 
@x: 
@y: 


<!-- ##### FUNCTION gtk_entry_get_max_length ##### -->
<para>

</para>

@entry: 
@Returns: 


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

</para>

@entry: 
@Returns: 


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
<!-- ##### SIGNAL GtkEntry::activate ##### -->
<para>

</para>

@entry: the object which received the signal.

<!-- ##### 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.

Owen Taylor's avatar
Owen Taylor committed
323 324 325 326 327 328 329 330
<!-- ##### SIGNAL GtkEntry::populate-popup ##### -->
<para>

</para>

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

331 332 333 334 335 336 337
<!-- ##### SIGNAL GtkEntry::toggle-overwrite ##### -->
<para>

</para>

@entry: the object which received the signal.

338
<!-- ##### ARG GtkEntry:activates-default ##### -->
339 340 341 342
<para>

</para>

343
<!-- ##### ARG GtkEntry:cursor-position ##### -->
344 345 346 347 348 349 350 351 352
<para>

</para>

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

</para>

353
<!-- ##### ARG GtkEntry:has-frame ##### -->
Owen Taylor's avatar
Owen Taylor committed
354
<para>
Matthias Clasen's avatar
Matthias Clasen committed
355

Owen Taylor's avatar
Owen Taylor committed
356 357
</para>

358
<!-- ##### ARG GtkEntry:invisible-char ##### -->
Owen Taylor's avatar
Owen Taylor committed
359
<para>
Matthias Clasen's avatar
Matthias Clasen committed
360

Owen Taylor's avatar
Owen Taylor committed
361 362
</para>

363
<!-- ##### ARG GtkEntry:max-length ##### -->
364 365 366 367
<para>

</para>

368
<!-- ##### ARG GtkEntry:scroll-offset ##### -->
369 370 371 372
<para>

</para>

373
<!-- ##### ARG GtkEntry:selection-bound ##### -->
374 375 376 377
<para>

</para>

378
<!-- ##### ARG GtkEntry:text ##### -->
379 380 381 382
<para>

</para>

383
<!-- ##### ARG GtkEntry:visibility ##### -->
384 385 386 387
<para>

</para>

388
<!-- ##### ARG GtkEntry:width-chars ##### -->
389 390 391 392
<para>

</para>