gtk2/docs/reference/gtk/tmpl/gtkentry.sgml

492 lines
6.1 KiB
Plaintext
Raw Normal View History

1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Title ##### -->
GtkEntry
<!-- ##### SECTION Short_Description ##### -->
A single line text entry field
1999-08-16 18:51:52 +00:00
<!-- ##### 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>#GtkTextView</term>
1999-08-16 18:51:52 +00:00
<listitem><para>a widget for handling multi-line text entry.</para></listitem>
</varlistentry>
</variablelist>
</para>
2005-06-20 22:06:27 +00:00
<!-- ##### SECTION Stability_Level ##### -->
1999-08-16 18:51:52 +00:00
<!-- ##### STRUCT GtkEntry ##### -->
<para>
The #GtkEntry-struct struct contains only private data.
</para>
<!-- ##### SIGNAL GtkEntry::activate ##### -->
<para>
</para>
@entry: the object which received the signal.
2004-08-25 16:21:15 +00:00
<!-- ##### SIGNAL GtkEntry::backspace ##### -->
<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:activates-default ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:cursor-position ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:editable ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:has-frame ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:inner-border ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:invisible-char ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:max-length ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:scroll-offset ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:selection-bound ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:shadow-type ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:text ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:truncate-multiline ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:visibility ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:width-chars ##### -->
<para>
</para>
<!-- ##### ARG GtkEntry:xalign ##### -->
<para>
</para>
2006-05-05 16:21:19 +00:00
<!-- ##### ARG GtkEntry:inner-border ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_entry_new ##### -->
<para>
</para>
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_entry_new_with_max_length ##### -->
<para>
</para>
@max:
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_entry_set_text ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
@entry:
@text:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_entry_append_text ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
@entry:
@text:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_entry_prepend_text ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
@entry:
@text:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_entry_set_position ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
@entry:
@position:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_entry_get_text ##### -->
<para>
Minor documentation fixes 2002-08-10 Soren Sandmann <sandmann@daimi.au.dk> * docs/reference/gtk/tree_widget.sgml, docs/reference/gtk/tmpl/gtkdialog.sgml, docs/reference/gtk/tmpl/gtkentry.sgml, docs/reference/gtk/tmpl/gtkfilesel.sgml, docs/reference/gtk/tmpl/gtkfontsel.sgml, docs/reference/gtk/tmpl/gtkfontseldlg.sgml, docs/reference/gtk/tmpl/gtktreemodel.sgml, docs/reference/gtk/tmpl/gtkwidget.sgml, gdk/x11/gdkdisplay-x11.c, gtk/gtkbbox.c, gtk/gtkbox.c, gtk/gtkbutton.c, gtk/gtkcellrenderer.c, gtk/gtkcellrendererpixbuf.c, gtk/gtkcellrenderertext.c, gtk/gtkcheckmenuitem.c, gtk/gtkcontainer.c, gtk/gtkcurve.c, gtk/gtkdialog.h, gtk/gtkentry.c, gtk/gtkfilesel.c, gtk/gtkfontsel.c, gtk/gtkframe.c, gtk/gtkhandlebox.c, gtk/gtkiconfactory.c, gtk/gtkimage.c, gtk/gtkinvisible.c, gtk/gtkitemfactory.c, gtk/gtklabel.c, gtk/gtklayout.c, gtk/gtkmenu.c, gtk/gtkprogress.c, gtk/gtkprogressbar.c, gtk/gtkscrolledwindow.c, gtk/gtksizegroup.c, gtk/gtktable.c, gtk/gtktextiter.c, gtk/gtktexttag.c, gtk/gtktexttag.h, gtk/gtktextview.c, gtk/gtktogglebutton.c, gtk/gtktoolbar.c, gtk/gtktreemodel.c, gtk/gtktreeselection.c, gtk/gtktreestore.c, gtk/gtktreeview.c, gtk/gtktreeviewcolumn.c, gtk/gtkviewport.c, gtk/gtkwidget.c, gtk/gtkwidget.h, gtk/gtkwindow.c: Minor documentation fixes (#89254, patch from Brett Nash; #85809, patch from daten@dnetc.org; #76391, patch from Ross Burton; #74559, Manuel Clos; #73569, #72005, Alexey A. Malyshev; #70061, patch from Dennis Bj"orklund; #64566, #63388, #58328, #57499, #81007, #77349, Vitaly Tishkov; #78932, Vitaly Tishkov, patch from Ross Burton; #73306)
2002-08-10 09:55:41 +00:00
1999-08-16 18:51:52 +00:00
</para>
Minor documentation fixes 2002-08-10 Soren Sandmann <sandmann@daimi.au.dk> * docs/reference/gtk/tree_widget.sgml, docs/reference/gtk/tmpl/gtkdialog.sgml, docs/reference/gtk/tmpl/gtkentry.sgml, docs/reference/gtk/tmpl/gtkfilesel.sgml, docs/reference/gtk/tmpl/gtkfontsel.sgml, docs/reference/gtk/tmpl/gtkfontseldlg.sgml, docs/reference/gtk/tmpl/gtktreemodel.sgml, docs/reference/gtk/tmpl/gtkwidget.sgml, gdk/x11/gdkdisplay-x11.c, gtk/gtkbbox.c, gtk/gtkbox.c, gtk/gtkbutton.c, gtk/gtkcellrenderer.c, gtk/gtkcellrendererpixbuf.c, gtk/gtkcellrenderertext.c, gtk/gtkcheckmenuitem.c, gtk/gtkcontainer.c, gtk/gtkcurve.c, gtk/gtkdialog.h, gtk/gtkentry.c, gtk/gtkfilesel.c, gtk/gtkfontsel.c, gtk/gtkframe.c, gtk/gtkhandlebox.c, gtk/gtkiconfactory.c, gtk/gtkimage.c, gtk/gtkinvisible.c, gtk/gtkitemfactory.c, gtk/gtklabel.c, gtk/gtklayout.c, gtk/gtkmenu.c, gtk/gtkprogress.c, gtk/gtkprogressbar.c, gtk/gtkscrolledwindow.c, gtk/gtksizegroup.c, gtk/gtktable.c, gtk/gtktextiter.c, gtk/gtktexttag.c, gtk/gtktexttag.h, gtk/gtktextview.c, gtk/gtktogglebutton.c, gtk/gtktoolbar.c, gtk/gtktreemodel.c, gtk/gtktreeselection.c, gtk/gtktreestore.c, gtk/gtktreeview.c, gtk/gtktreeviewcolumn.c, gtk/gtkviewport.c, gtk/gtkwidget.c, gtk/gtkwidget.h, gtk/gtkwindow.c: Minor documentation fixes (#89254, patch from Brett Nash; #85809, patch from daten@dnetc.org; #76391, patch from Ross Burton; #74559, Manuel Clos; #73569, #72005, Alexey A. Malyshev; #70061, patch from Dennis Bj"orklund; #64566, #63388, #58328, #57499, #81007, #77349, Vitaly Tishkov; #78932, Vitaly Tishkov, patch from Ross Burton; #73306)
2002-08-10 09:55:41 +00:00
@entry:
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_entry_select_region ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
@entry:
@start:
@end:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_entry_set_visibility ##### -->
<para>
</para>
1999-08-16 18:51:52 +00:00
@entry:
@visible:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_entry_set_invisible_char ##### -->
<para>
</para>
@entry:
@ch:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_entry_set_editable ##### -->
<para>
1999-08-16 18:51:52 +00:00
</para>
@entry:
@editable:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_entry_set_max_length ##### -->
<para>
</para>
@entry:
@max:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_entry_get_activates_default ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gtk_entry_get_has_frame ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gtk_entry_get_inner_border ##### -->
<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_inner_border ##### -->
<para>
</para>
@entry:
@border:
<!-- ##### FUNCTION gtk_entry_set_width_chars ##### -->
<para>
</para>
@entry:
@n_chars:
<!-- ##### FUNCTION gtk_entry_get_invisible_char ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gtk_entry_set_alignment ##### -->
<para>
</para>
@entry:
@xalign:
<!-- ##### FUNCTION gtk_entry_get_alignment ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gtk_entry_get_layout ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gtk_entry_get_layout_offsets ##### -->
<para>
</para>
@entry:
@x:
@y:
2004-08-25 16:21:15 +00:00
<!-- ##### 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:
<!-- ##### FUNCTION gtk_entry_get_max_length ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gtk_entry_get_visibility ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gtk_entry_set_completion ##### -->
<para>
</para>
@entry:
@completion:
<!-- ##### FUNCTION gtk_entry_get_completion ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gtk_entry_set_cursor_hadjustment ##### -->
<para>
</para>
@entry:
@adjustment:
<!-- ##### FUNCTION gtk_entry_get_cursor_hadjustment ##### -->
<para>
</para>
@entry:
@Returns: