forked from AuroraMiddleware/gtk
2aaf3c0e19
* gtk/gtkwindow.c (gtk_window_move): Markup fixes * gtk/gtkrc.c (gtk_rc_get_module_dir): Markup fixes. * gdk/x11/gdkcursor-x11.c (gdk_cursor_new_for_screen): Update docs for Docbook XML. * gtk/*, gdk/*, gdk-pixbuf/*: Create XML, not SGML. * gtk/tmpl/*: Remove property documentation which comes from the source now. * gtk/building.sgml: Remove traces of gxi.
397 lines
6.8 KiB
Plaintext
397 lines
6.8 KiB
Plaintext
<!-- ##### 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>
|
|
|
|
@max:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### 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>
|
|
Retrieve the contents of the entry widget. The returned
|
|
pointer points to internally allocated storage in the
|
|
widget and must not be freed, modified or stored.
|
|
See also gtk_editable_get_chars().
|
|
</para>
|
|
|
|
@entry: a #GtkEntry.
|
|
@Returns: the pointer the the contents of the text widget as a
|
|
string.
|
|
|
|
|
|
<!-- ##### 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
|
|
are displayed as the invisible char, and will also appear
|
|
that way when the text in the entry widget is copied
|
|
elsewhere.
|
|
</para>
|
|
<para>
|
|
The default invisible char is the asterisk '*', but it can
|
|
be changed with gtk_entry_set_invisible_char().
|
|
</para>
|
|
|
|
@entry: a #GtkEntry.
|
|
@visible: %TRUE if the contents of the entry are displayed
|
|
as plaintext.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_entry_set_invisible_char ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@entry:
|
|
@ch:
|
|
|
|
|
|
<!-- ##### 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>
|
|
|
|
@entry:
|
|
@max:
|
|
|
|
|
|
<!-- ##### 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:
|
|
|
|
|
|
<!-- ##### 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:
|
|
|
|
|
|
<!-- ##### 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.
|
|
|
|
<!-- ##### 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:cursor-position ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkEntry:selection-bound ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkEntry:editable ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkEntry:max-length ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkEntry:visibility ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkEntry:has-frame ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkEntry:invisible-char ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkEntry:activates-default ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkEntry:width-chars ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkEntry:scroll-offset ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkEntry:text ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|