<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<!--ENTITY index-Objects-Grouped SYSTEM "objects_grouped.sgml"-->
<refentry id="GtkEntry">
<refmeta>
<refentrytitle role="top_of_page" id="GtkEntry.top_of_page">GtkEntry</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GtkEntry</refname>
<refpurpose>A single line text entry field</refpurpose>
</refnamediv>

<refsynopsisdiv id="GtkEntry.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

#include &lt;gtk/gtk.h&gt;

                    <link linkend="GtkEntry-struct">GtkEntry</link>;
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-entry-new">gtk_entry_new</link>                       (void);
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-entry-new-with-buffer">gtk_entry_new_with_buffer</link>           (<link linkend="GtkEntryBuffer">GtkEntryBuffer</link> *buffer);
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-entry-new-with-max-length">gtk_entry_new_with_max_length</link>       (<link linkend="gint">gint</link> max);
<link linkend="GtkEntryBuffer">GtkEntryBuffer</link>*     <link linkend="gtk-entry-get-buffer">gtk_entry_get_buffer</link>                (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-buffer">gtk_entry_set_buffer</link>                (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryBuffer">GtkEntryBuffer</link> *buffer);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-text">gtk_entry_set_text</link>                  (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         const <link linkend="gchar">gchar</link> *text);
<link linkend="void">void</link>                <link linkend="gtk-entry-append-text">gtk_entry_append_text</link>               (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         const <link linkend="gchar">gchar</link> *text);
<link linkend="void">void</link>                <link linkend="gtk-entry-prepend-text">gtk_entry_prepend_text</link>              (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         const <link linkend="gchar">gchar</link> *text);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-position">gtk_entry_set_position</link>              (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> position);
const <link linkend="gchar">gchar</link>*        <link linkend="gtk-entry-get-text">gtk_entry_get_text</link>                  (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="guint16">guint16</link>             <link linkend="gtk-entry-get-text-length">gtk_entry_get_text_length</link>           (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="void">void</link>                <link linkend="gtk-entry-select-region">gtk_entry_select_region</link>             (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> start,
                                                         <link linkend="gint">gint</link> end);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-visibility">gtk_entry_set_visibility</link>            (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gboolean">gboolean</link> visible);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-invisible-char">gtk_entry_set_invisible_char</link>        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gunichar">gunichar</link> ch);
<link linkend="void">void</link>                <link linkend="gtk-entry-unset-invisible-char">gtk_entry_unset_invisible_char</link>      (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-editable">gtk_entry_set_editable</link>              (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gboolean">gboolean</link> editable);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-max-length">gtk_entry_set_max_length</link>            (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> max);
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-entry-get-activates-default">gtk_entry_get_activates_default</link>     (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-entry-get-has-frame">gtk_entry_get_has_frame</link>             (<link linkend="GtkEntry">GtkEntry</link> *entry);
const <link linkend="GtkBorder">GtkBorder</link>*    <link linkend="gtk-entry-get-inner-border">gtk_entry_get_inner_border</link>          (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="gint">gint</link>                <link linkend="gtk-entry-get-width-chars">gtk_entry_get_width_chars</link>           (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-activates-default">gtk_entry_set_activates_default</link>     (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gboolean">gboolean</link> setting);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-has-frame">gtk_entry_set_has_frame</link>             (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gboolean">gboolean</link> setting);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-inner-border">gtk_entry_set_inner_border</link>          (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         const <link linkend="GtkBorder">GtkBorder</link> *border);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-width-chars">gtk_entry_set_width_chars</link>           (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> n_chars);
<link linkend="gunichar">gunichar</link>            <link linkend="gtk-entry-get-invisible-char">gtk_entry_get_invisible_char</link>        (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-alignment">gtk_entry_set_alignment</link>             (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gfloat">gfloat</link> xalign);
<link linkend="gfloat">gfloat</link>              <link linkend="gtk-entry-get-alignment">gtk_entry_get_alignment</link>             (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-overwrite-mode">gtk_entry_set_overwrite_mode</link>        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gboolean">gboolean</link> overwrite);
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-entry-get-overwrite-mode">gtk_entry_get_overwrite_mode</link>        (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="PangoLayout">PangoLayout</link>*        <link linkend="gtk-entry-get-layout">gtk_entry_get_layout</link>                (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="void">void</link>                <link linkend="gtk-entry-get-layout-offsets">gtk_entry_get_layout_offsets</link>        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y);
<link linkend="gint">gint</link>                <link linkend="gtk-entry-layout-index-to-text-index">gtk_entry_layout_index_to_text_index</link>
                                                        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> layout_index);
<link linkend="gint">gint</link>                <link linkend="gtk-entry-text-index-to-layout-index">gtk_entry_text_index_to_layout_index</link>
                                                        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> text_index);
<link linkend="gint">gint</link>                <link linkend="gtk-entry-get-max-length">gtk_entry_get_max_length</link>            (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-entry-get-visibility">gtk_entry_get_visibility</link>            (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-completion">gtk_entry_set_completion</link>            (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryCompletion">GtkEntryCompletion</link> *completion);
<link linkend="GtkEntryCompletion">GtkEntryCompletion</link> * <link linkend="gtk-entry-get-completion">gtk_entry_get_completion</link>           (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-cursor-hadjustment">gtk_entry_set_cursor_hadjustment</link>    (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkAdjustment">GtkAdjustment</link> *adjustment);
<link linkend="GtkAdjustment">GtkAdjustment</link>*      <link linkend="gtk-entry-get-cursor-hadjustment">gtk_entry_get_cursor_hadjustment</link>    (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-progress-fraction">gtk_entry_set_progress_fraction</link>     (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gdouble">gdouble</link> fraction);
<link linkend="gdouble">gdouble</link>             <link linkend="gtk-entry-get-progress-fraction">gtk_entry_get_progress_fraction</link>     (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-progress-pulse-step">gtk_entry_set_progress_pulse_step</link>   (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gdouble">gdouble</link> fraction);
<link linkend="gdouble">gdouble</link>             <link linkend="gtk-entry-get-progress-pulse-step">gtk_entry_get_progress_pulse_step</link>   (<link linkend="GtkEntry">GtkEntry</link> *entry);
<link linkend="void">void</link>                <link linkend="gtk-entry-progress-pulse">gtk_entry_progress_pulse</link>            (<link linkend="GtkEntry">GtkEntry</link> *entry);
enum                <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link>;
<link linkend="void">void</link>                <link linkend="gtk-entry-set-icon-from-pixbuf">gtk_entry_set_icon_from_pixbuf</link>      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         <link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-icon-from-stock">gtk_entry_set_icon_from_stock</link>       (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         const <link linkend="gchar">gchar</link> *stock_id);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-icon-from-icon-name">gtk_entry_set_icon_from_icon_name</link>   (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         const <link linkend="gchar">gchar</link> *icon_name);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-icon-from-gicon">gtk_entry_set_icon_from_gicon</link>       (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         <link linkend="GIcon">GIcon</link> *icon);
<link linkend="GtkImageType">GtkImageType</link>        <link linkend="gtk-entry-get-icon-storage-type">gtk_entry_get_icon_storage_type</link>     (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);
<link linkend="GdkPixbuf">GdkPixbuf</link>*          <link linkend="gtk-entry-get-icon-pixbuf">gtk_entry_get_icon_pixbuf</link>           (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);
const <link linkend="gchar">gchar</link>*        <link linkend="gtk-entry-get-icon-stock">gtk_entry_get_icon_stock</link>            (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);
const <link linkend="gchar">gchar</link>*        <link linkend="gtk-entry-get-icon-name">gtk_entry_get_icon_name</link>             (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);
<link linkend="GIcon">GIcon</link>*              <link linkend="gtk-entry-get-icon-gicon">gtk_entry_get_icon_gicon</link>            (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-icon-activatable">gtk_entry_set_icon_activatable</link>      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         <link linkend="gboolean">gboolean</link> activatable);
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-entry-get-icon-activatable">gtk_entry_get_icon_activatable</link>      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-icon-sensitive">gtk_entry_set_icon_sensitive</link>        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         <link linkend="gboolean">gboolean</link> sensitive);
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-entry-get-icon-sensitive">gtk_entry_get_icon_sensitive</link>        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);
<link linkend="gint">gint</link>                <link linkend="gtk-entry-get-icon-at-pos">gtk_entry_get_icon_at_pos</link>           (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-icon-tooltip-text">gtk_entry_set_icon_tooltip_text</link>     (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         const <link linkend="gchar">gchar</link> *tooltip);
<link linkend="gchar">gchar</link> *             <link linkend="gtk-entry-get-icon-tooltip-text">gtk_entry_get_icon_tooltip_text</link>     (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-icon-tooltip-markup">gtk_entry_set_icon_tooltip_markup</link>   (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         const <link linkend="gchar">gchar</link> *tooltip);
<link linkend="gchar">gchar</link> *             <link linkend="gtk-entry-get-icon-tooltip-markup">gtk_entry_get_icon_tooltip_markup</link>   (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);
<link linkend="void">void</link>                <link linkend="gtk-entry-set-icon-drag-source">gtk_entry_set_icon_drag_source</link>      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         <link linkend="GtkTargetList">GtkTargetList</link> *target_list,
                                                         <link linkend="GdkDragAction">GdkDragAction</link> actions);
<link linkend="gint">gint</link>                <link linkend="gtk-entry-get-current-icon-drag-source">gtk_entry_get_current_icon_drag_source</link>
                                                        (<link linkend="GtkEntry">GtkEntry</link> *entry);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GtkEntry.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----GtkEntry
                           +----<link linkend="GtkSpinButton">GtkSpinButton</link>
</synopsis>
</refsect1>



<refsect1 id="GtkEntry.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkEntry implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="GtkCellEditable">GtkCellEditable</link> and  <link linkend="GtkEditable">GtkEditable</link>.</para>
</refsect1>


<refsect1 id="GtkEntry.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GtkEntry--activates-default">activates-default</link>&quot;        <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkEntry--buffer">buffer</link>&quot;                   <link linkend="GtkEntryBuffer">GtkEntryBuffer</link>*       : Read / Write / Construct
  &quot;<link linkend="GtkEntry--caps-lock-warning">caps-lock-warning</link>&quot;        <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkEntry--cursor-position">cursor-position</link>&quot;          <link linkend="gint">gint</link>                  : Read
  &quot;<link linkend="GtkEntry--editable">editable</link>&quot;                 <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkEntry--has-frame">has-frame</link>&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkEntry--im-module">im-module</link>&quot;                <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="GtkEntry--inner-border">inner-border</link>&quot;             <link linkend="GtkBorder">GtkBorder</link>*            : Read / Write
  &quot;<link linkend="GtkEntry--invisible-char">invisible-char</link>&quot;           <link linkend="guint">guint</link>                 : Read / Write
  &quot;<link linkend="GtkEntry--invisible-char-set">invisible-char-set</link>&quot;       <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkEntry--max-length">max-length</link>&quot;               <link linkend="gint">gint</link>                  : Read / Write
  &quot;<link linkend="GtkEntry--overwrite-mode">overwrite-mode</link>&quot;           <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkEntry--primary-icon-activatable">primary-icon-activatable</link>&quot; <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkEntry--primary-icon-gicon">primary-icon-gicon</link>&quot;       <link linkend="GIcon">GIcon</link>*                : Read / Write
  &quot;<link linkend="GtkEntry--primary-icon-name">primary-icon-name</link>&quot;        <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="GtkEntry--primary-icon-pixbuf">primary-icon-pixbuf</link>&quot;      <link linkend="GdkPixbuf">GdkPixbuf</link>*            : Read / Write
  &quot;<link linkend="GtkEntry--primary-icon-sensitive">primary-icon-sensitive</link>&quot;   <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkEntry--primary-icon-stock">primary-icon-stock</link>&quot;       <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="GtkEntry--primary-icon-storage-type">primary-icon-storage-type</link>&quot; <link linkend="GtkImageType">GtkImageType</link>          : Read
  &quot;<link linkend="GtkEntry--primary-icon-tooltip-markup">primary-icon-tooltip-markup</link>&quot; <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="GtkEntry--primary-icon-tooltip-text">primary-icon-tooltip-text</link>&quot; <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="GtkEntry--progress-fraction">progress-fraction</link>&quot;        <link linkend="gdouble">gdouble</link>               : Read / Write
  &quot;<link linkend="GtkEntry--progress-pulse-step">progress-pulse-step</link>&quot;      <link linkend="gdouble">gdouble</link>               : Read / Write
  &quot;<link linkend="GtkEntry--scroll-offset">scroll-offset</link>&quot;            <link linkend="gint">gint</link>                  : Read
  &quot;<link linkend="GtkEntry--secondary-icon-activatable">secondary-icon-activatable</link>&quot; <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkEntry--secondary-icon-gicon">secondary-icon-gicon</link>&quot;     <link linkend="GIcon">GIcon</link>*                : Read / Write
  &quot;<link linkend="GtkEntry--secondary-icon-name">secondary-icon-name</link>&quot;      <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="GtkEntry--secondary-icon-pixbuf">secondary-icon-pixbuf</link>&quot;    <link linkend="GdkPixbuf">GdkPixbuf</link>*            : Read / Write
  &quot;<link linkend="GtkEntry--secondary-icon-sensitive">secondary-icon-sensitive</link>&quot; <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkEntry--secondary-icon-stock">secondary-icon-stock</link>&quot;     <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="GtkEntry--secondary-icon-storage-type">secondary-icon-storage-type</link>&quot; <link linkend="GtkImageType">GtkImageType</link>          : Read
  &quot;<link linkend="GtkEntry--secondary-icon-tooltip-markup">secondary-icon-tooltip-markup</link>&quot; <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="GtkEntry--secondary-icon-tooltip-text">secondary-icon-tooltip-text</link>&quot; <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="GtkEntry--selection-bound">selection-bound</link>&quot;          <link linkend="gint">gint</link>                  : Read
  &quot;<link linkend="GtkEntry--shadow-type">shadow-type</link>&quot;              <link linkend="GtkShadowType">GtkShadowType</link>         : Read / Write
  &quot;<link linkend="GtkEntry--text">text</link>&quot;                     <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="GtkEntry--text-length">text-length</link>&quot;              <link linkend="guint">guint</link>                 : Read
  &quot;<link linkend="GtkEntry--truncate-multiline">truncate-multiline</link>&quot;       <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkEntry--visibility">visibility</link>&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkEntry--width-chars">width-chars</link>&quot;              <link linkend="gint">gint</link>                  : Read / Write
  &quot;<link linkend="GtkEntry--xalign">xalign</link>&quot;                   <link linkend="gfloat">gfloat</link>                : Read / Write
</synopsis>
</refsect1>
<refsect1 id="GtkEntry.style-properties" role="style_properties">
<title role="style_properties.title">Style Properties</title>
<synopsis>
  &quot;<link linkend="GtkEntry--s-icon-prelight">icon-prelight</link>&quot;            <link linkend="gboolean">gboolean</link>              : Read
  &quot;<link linkend="GtkEntry--s-inner-border">inner-border</link>&quot;             <link linkend="GtkBorder">GtkBorder</link>*            : Read
  &quot;<link linkend="GtkEntry--s-invisible-char">invisible-char</link>&quot;           <link linkend="guint">guint</link>                 : Read
  &quot;<link linkend="GtkEntry--s-progress-border">progress-border</link>&quot;          <link linkend="GtkBorder">GtkBorder</link>*            : Read
  &quot;<link linkend="GtkEntry--s-state-hint">state-hint</link>&quot;               <link linkend="gboolean">gboolean</link>              : Read
</synopsis>
</refsect1>

<refsect1 id="GtkEntry.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="GtkEntry-activate">activate</link>&quot;                                       : Run Last / Action
  &quot;<link linkend="GtkEntry-backspace">backspace</link>&quot;                                      : Run Last / Action
  &quot;<link linkend="GtkEntry-copy-clipboard">copy-clipboard</link>&quot;                                 : Run Last / Action
  &quot;<link linkend="GtkEntry-cut-clipboard">cut-clipboard</link>&quot;                                  : Run Last / Action
  &quot;<link linkend="GtkEntry-delete-from-cursor">delete-from-cursor</link>&quot;                             : Run Last / Action
  &quot;<link linkend="GtkEntry-icon-press">icon-press</link>&quot;                                     : Run Last
  &quot;<link linkend="GtkEntry-icon-release">icon-release</link>&quot;                                   : Run Last
  &quot;<link linkend="GtkEntry-insert-at-cursor">insert-at-cursor</link>&quot;                               : Run Last / Action
  &quot;<link linkend="GtkEntry-move-cursor">move-cursor</link>&quot;                                    : Run Last / Action
  &quot;<link linkend="GtkEntry-paste-clipboard">paste-clipboard</link>&quot;                                : Run Last / Action
  &quot;<link linkend="GtkEntry-populate-popup">populate-popup</link>&quot;                                 : Run Last
  &quot;<link linkend="GtkEntry-toggle-overwrite">toggle-overwrite</link>&quot;                               : Run Last / Action
</synopsis>
</refsect1>


<refsect1 id="GtkEntry.description" role="desc">
<title role="desc.title">Description</title>
<para>
The <link linkend="GtkEntry"><type>GtkEntry</type></link> 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>
<para>
When using an entry for passwords and other sensitive information,
it can be put into "password mode" using <link linkend="gtk-entry-set-visibility"><function>gtk_entry_set_visibility()</function></link>.
In this mode, entered text is displayed using a 'invisible' character.
By default, GTK+ picks the best invisible character that is available
in the current font, but it can be changed with
<link linkend="gtk-entry-set-invisible-char"><function>gtk_entry_set_invisible_char()</function></link>. Since 2.16, GTK+ displays a warning
when Caps Lock or input methods might interfere with entering text in
a password entry. The warning can be turned off with the
<link linkend="GtkEntry-caps-lock-warning"><type>"caps-lock-warning"</type></link> property.
</para>
<para>
Since 2.16, GtkEntry has the ability to display progress or activity
information behind the text. To make an entry display such information,
use <link linkend="gtk-entry-set-progress-fraction"><function>gtk_entry_set_progress_fraction()</function></link> or <link linkend="gtk-entry-set-progress-pulse-step"><function>gtk_entry_set_progress_pulse_step()</function></link>.
</para>
<para>
Additionally, GtkEntry can show icons at either side of the entry. These
icons can be activatable by clicking, can be set up as drag source and
can have tooltips. To add an icon, use <link linkend="gtk-entry-set-icon-from-gicon"><function>gtk_entry_set_icon_from_gicon()</function></link> or
one of the various other functions that set an icon from a stock id, an
icon name or a pixbuf. To trigger an action when the user clicks an icon,
connect to the <link linkend="GtkEntry-icon-press"><type>"icon-press"</type></link> signal. To allow DND operations
from an icon, use <link linkend="gtk-entry-set-icon-drag-source"><function>gtk_entry_set_icon_drag_source()</function></link>. To set a tooltip on
an icon, use <link linkend="gtk-entry-set-icon-tooltip-text"><function>gtk_entry_set_icon_tooltip_text()</function></link> or the corresponding function
for markup.
</para>
<para>
Note that functionality or information that is only available by clicking
on an icon in an entry may not be accessible at all to users which are not
able to use a mouse or other pointing device. It is therefore recommended
that any such functionality should also be available by other means, e.g.
via the context menu of the entry.
</para>
</refsect1>

<refsect1 id="GtkEntry.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GtkEntry-struct" role="struct">
<title>GtkEntry</title>
<indexterm zone="GtkEntry-struct"><primary sortas="Entry">GtkEntry</primary></indexterm><programlisting>typedef struct _GtkEntry GtkEntry;</programlisting>
<para>
The <link linkend="GtkEntry-struct"><type>GtkEntry</type></link> struct contains only private data.
</para></refsect2>
<refsect2 id="gtk-entry-new" role="function">
<title>gtk_entry_new ()</title>
<indexterm zone="gtk-entry-new"><primary sortas="entry_new">gtk_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_entry_new                       (void);</programlisting>
<para>
Creates a new entry.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GtkEntry"><type>GtkEntry</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-new-with-buffer" role="function" condition="since:2.18">
<title>gtk_entry_new_with_buffer ()</title>
<indexterm zone="gtk-entry-new-with-buffer" role="2.18"><primary sortas="entry_new_with_buffer">gtk_entry_new_with_buffer</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_entry_new_with_buffer           (<link linkend="GtkEntryBuffer">GtkEntryBuffer</link> *buffer);</programlisting>
<para>
Creates a new entry with the specified text buffer.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter>&#160;:</term>
<listitem><simpara> The buffer to use for the new <link linkend="GtkEntry"><type>GtkEntry</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GtkEntry"><type>GtkEntry</type></link>

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.18</para></refsect2>
<refsect2 id="gtk-entry-new-with-max-length" role="function" condition="deprecated:Use gtk_entry_set_max_length() instead.">
<title>gtk_entry_new_with_max_length ()</title>
<indexterm zone="gtk-entry-new-with-max-length" role="deprecated"><primary sortas="entry_new_with_max_length">gtk_entry_new_with_max_length</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_entry_new_with_max_length       (<link linkend="gint">gint</link> max);</programlisting>
<warning><para><literal>gtk_entry_new_with_max_length</literal> is deprecated and should not be used in newly-written code. Use <link linkend="gtk-entry-set-max-length"><function>gtk_entry_set_max_length()</function></link> instead.</para></warning>
<para>
Creates a new <link linkend="GtkEntry"><type>GtkEntry</type></link> widget with the given maximum length.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>max</parameter>&#160;:</term>
<listitem><simpara> the maximum length of the entry, or 0 for no maximum.
  (other than the maximum length of entries.) The value passed in will
  be clamped to the range 0-65536.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GtkEntry"><type>GtkEntry</type></link>

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-get-buffer" role="function" condition="since:2.18">
<title>gtk_entry_get_buffer ()</title>
<indexterm zone="gtk-entry-get-buffer" role="2.18"><primary sortas="entry_get_buffer">gtk_entry_get_buffer</primary></indexterm><programlisting><link linkend="GtkEntryBuffer">GtkEntryBuffer</link>*     gtk_entry_get_buffer                (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Get the <link linkend="GtkEntryBuffer"><type>GtkEntryBuffer</type></link> object which holds the text for
this widget.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GtkEntryBuffer"><type>GtkEntryBuffer</type></link> object.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.18</para></refsect2>
<refsect2 id="gtk-entry-set-buffer" role="function" condition="since:2.18">
<title>gtk_entry_set_buffer ()</title>
<indexterm zone="gtk-entry-set-buffer" role="2.18"><primary sortas="entry_set_buffer">gtk_entry_set_buffer</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_buffer                (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryBuffer">GtkEntryBuffer</link> *buffer);</programlisting>
<para>
Set the <link linkend="GtkEntryBuffer"><type>GtkEntryBuffer</type></link> object which holds the text for
this widget.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buffer</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntryBuffer"><type>GtkEntryBuffer</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.18</para></refsect2>
<refsect2 id="gtk-entry-set-text" role="function">
<title>gtk_entry_set_text ()</title>
<indexterm zone="gtk-entry-set-text"><primary sortas="entry_set_text">gtk_entry_set_text</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_text                  (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         const <link linkend="gchar">gchar</link> *text);</programlisting>
<para>
Sets the text in the widget to the given
value, replacing the current contents.
</para>
<para>
See <link linkend="gtk-entry-buffer-set-text"><function>gtk_entry_buffer_set_text()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter>&#160;:</term>
<listitem><simpara> the new text
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-append-text" role="function" condition="deprecated:2.0: Use gtk_editable_insert_text() instead.">
<title>gtk_entry_append_text ()</title>
<indexterm zone="gtk-entry-append-text" role="deprecated"><primary sortas="entry_append_text">gtk_entry_append_text</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_append_text               (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         const <link linkend="gchar">gchar</link> *text);</programlisting>
<warning><para><literal>gtk_entry_append_text</literal> has been deprecated since version 2.0 and should not be used in newly-written code. Use <link linkend="gtk-editable-insert-text"><function>gtk_editable_insert_text()</function></link> instead.</para></warning>
<para>
Appends the given text to the contents of the widget.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter>&#160;:</term>
<listitem><simpara> the text to append
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-prepend-text" role="function" condition="deprecated:2.0: Use gtk_editable_insert_text() instead.">
<title>gtk_entry_prepend_text ()</title>
<indexterm zone="gtk-entry-prepend-text" role="deprecated"><primary sortas="entry_prepend_text">gtk_entry_prepend_text</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_prepend_text              (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         const <link linkend="gchar">gchar</link> *text);</programlisting>
<warning><para><literal>gtk_entry_prepend_text</literal> has been deprecated since version 2.0 and should not be used in newly-written code. Use <link linkend="gtk-editable-insert-text"><function>gtk_editable_insert_text()</function></link> instead.</para></warning>
<para>
Prepends the given text to the contents of the widget.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter>&#160;:</term>
<listitem><simpara> the text to prepend
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-set-position" role="function" condition="deprecated:2.0: Use gtk_editable_set_position() instead.">
<title>gtk_entry_set_position ()</title>
<indexterm zone="gtk-entry-set-position" role="deprecated"><primary sortas="entry_set_position">gtk_entry_set_position</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_position              (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> position);</programlisting>
<warning><para><literal>gtk_entry_set_position</literal> has been deprecated since version 2.0 and should not be used in newly-written code. Use <link linkend="gtk-editable-set-position"><function>gtk_editable_set_position()</function></link> instead.</para></warning>
<para>
Sets the cursor position in an entry to the given value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>position</parameter>&#160;:</term>
<listitem><simpara> 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.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-get-text" role="function">
<title>gtk_entry_get_text ()</title>
<indexterm zone="gtk-entry-get-text"><primary sortas="entry_get_text">gtk_entry_get_text</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gtk_entry_get_text                  (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Retrieves the contents of the entry widget.
See also <link linkend="gtk-editable-get-chars"><function>gtk_editable_get_chars()</function></link>.
</para>
<para>
This is equivalent to:
</para>
<para>
<informalexample><programlisting>
gtk_entry_buffer_get_text (gtk_entry_get_buffer (entry));
</programlisting></informalexample></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a pointer to the contents of the widget as a
     string. This string points to internally allocated
     storage in the widget and must not be freed, modified or
     stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-get-text-length" role="function" condition="since:2.14">
<title>gtk_entry_get_text_length ()</title>
<indexterm zone="gtk-entry-get-text-length" role="2.14"><primary sortas="entry_get_text_length">gtk_entry_get_text_length</primary></indexterm><programlisting><link linkend="guint16">guint16</link>             gtk_entry_get_text_length           (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Retrieves the current length of the text in
<parameter>entry</parameter>. 
</para>
<para>
This is equivalent to:
</para>
<para>
<informalexample><programlisting>
gtk_entry_buffer_get_length (gtk_entry_get_buffer (entry));
</programlisting></informalexample></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the current number of characters
              in <link linkend="GtkEntry"><type>GtkEntry</type></link>, or 0 if there are none.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.14</para></refsect2>
<refsect2 id="gtk-entry-select-region" role="function" condition="deprecated:2.0: Use gtk_editable_select_region() instead.">
<title>gtk_entry_select_region ()</title>
<indexterm zone="gtk-entry-select-region" role="deprecated"><primary sortas="entry_select_region">gtk_entry_select_region</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_select_region             (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> start,
                                                         <link linkend="gint">gint</link> end);</programlisting>
<warning><para><literal>gtk_entry_select_region</literal> has been deprecated since version 2.0 and should not be used in newly-written code. Use <link linkend="gtk-editable-select-region"><function>gtk_editable_select_region()</function></link> instead.</para></warning>
<para>
Selects a region of text. The characters that are selected are 
those characters at positions from <parameter>start_pos</parameter> up to, but not 
including <parameter>end_pos</parameter>. If <parameter>end_pos</parameter> is negative, then the the characters 
selected will be those characters from <parameter>start_pos</parameter> to the end of 
the text.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start</parameter>&#160;:</term>
<listitem><simpara> the starting position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end</parameter>&#160;:</term>
<listitem><simpara> the end position
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-set-visibility" role="function">
<title>gtk_entry_set_visibility ()</title>
<indexterm zone="gtk-entry-set-visibility"><primary sortas="entry_set_visibility">gtk_entry_set_visibility</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_visibility            (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gboolean">gboolean</link> visible);</programlisting>
<para>
Sets whether the contents of the entry are visible or not. 
When visibility is set to <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>, 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>
By default, GTK+ picks the best invisible character available
in the current font, but it can be changed with
<link linkend="gtk-entry-set-invisible-char"><function>gtk_entry_set_invisible_char()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>visible</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the contents of the entry are displayed
          as plaintext
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-set-invisible-char" role="function">
<title>gtk_entry_set_invisible_char ()</title>
<indexterm zone="gtk-entry-set-invisible-char"><primary sortas="entry_set_invisible_char">gtk_entry_set_invisible_char</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_invisible_char        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gunichar">gunichar</link> ch);</programlisting>
<para>
Sets the character to use in place of the actual text when
<link linkend="gtk-entry-set-visibility"><function>gtk_entry_set_visibility()</function></link> has been called to set text visibility
to <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>. i.e. this is the character used in "password mode" to
show the user how many characters have been typed. By default, GTK+
picks the best invisible char available in the current font. If you
set the invisible char to 0, then the user will get no feedback
at all; there will be no text on the screen as they type.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ch</parameter>&#160;:</term>
<listitem><simpara> a Unicode character
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-unset-invisible-char" role="function" condition="since:2.16">
<title>gtk_entry_unset_invisible_char ()</title>
<indexterm zone="gtk-entry-unset-invisible-char" role="2.16"><primary sortas="entry_unset_invisible_char">gtk_entry_unset_invisible_char</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_unset_invisible_char      (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Unsets the invisible char previously set with
<link linkend="gtk-entry-set-invisible-char"><function>gtk_entry_set_invisible_char()</function></link>. So that the
default invisible char is used again.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-set-editable" role="function" condition="deprecated:2.0: Use gtk_editable_set_editable() instead.">
<title>gtk_entry_set_editable ()</title>
<indexterm zone="gtk-entry-set-editable" role="deprecated"><primary sortas="entry_set_editable">gtk_entry_set_editable</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_editable              (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gboolean">gboolean</link> editable);</programlisting>
<warning><para><literal>gtk_entry_set_editable</literal> has been deprecated since version 2.0 and should not be used in newly-written code. Use <link linkend="gtk-editable-set-editable"><function>gtk_editable_set_editable()</function></link> instead.</para></warning>
<para>
Determines if the user can edit the text in the editable
widget or not.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>editable</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the user is allowed to edit the text
  in the widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-set-max-length" role="function">
<title>gtk_entry_set_max_length ()</title>
<indexterm zone="gtk-entry-set-max-length"><primary sortas="entry_set_max_length">gtk_entry_set_max_length</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_max_length            (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> max);</programlisting>
<para>
Sets the maximum allowed length of the contents of the widget. If
the current contents are longer than the given length, then they
will be truncated to fit.
</para>
<para>
This is equivalent to:
</para>
<para>
<informalexample><programlisting>
gtk_entry_buffer_set_max_length (gtk_entry_get_buffer (entry), max);
</programlisting></informalexample></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>max</parameter>&#160;:</term>
<listitem><simpara> the maximum length of the entry, or 0 for no maximum.
  (other than the maximum length of entries.) The value passed in will
  be clamped to the range 0-65536.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-get-activates-default" role="function">
<title>gtk_entry_get_activates_default ()</title>
<indexterm zone="gtk-entry-get-activates-default"><primary sortas="entry_get_activates_default">gtk_entry_get_activates_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_entry_get_activates_default     (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Retrieves the value set by <link linkend="gtk-entry-set-activates-default"><function>gtk_entry_set_activates_default()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the entry will activate the default widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-get-has-frame" role="function">
<title>gtk_entry_get_has_frame ()</title>
<indexterm zone="gtk-entry-get-has-frame"><primary sortas="entry_get_has_frame">gtk_entry_get_has_frame</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_entry_get_has_frame             (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Gets the value set by <link linkend="gtk-entry-set-has-frame"><function>gtk_entry_set_has_frame()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> whether the entry has a beveled frame
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-get-inner-border" role="function" condition="since:2.10">
<title>gtk_entry_get_inner_border ()</title>
<indexterm zone="gtk-entry-get-inner-border" role="2.10"><primary sortas="entry_get_inner_border">gtk_entry_get_inner_border</primary></indexterm><programlisting>const <link linkend="GtkBorder">GtkBorder</link>*    gtk_entry_get_inner_border          (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
This function returns the entry's <link linkend="GtkEntry--inner-border"><type>"inner-border"</type></link> property. See
<link linkend="gtk-entry-set-inner-border"><function>gtk_entry_set_inner_border()</function></link> for more information.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the entry's <link linkend="GtkBorder"><type>GtkBorder</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if none was set.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.10</para></refsect2>
<refsect2 id="gtk-entry-get-width-chars" role="function">
<title>gtk_entry_get_width_chars ()</title>
<indexterm zone="gtk-entry-get-width-chars"><primary sortas="entry_get_width_chars">gtk_entry_get_width_chars</primary></indexterm><programlisting><link linkend="gint">gint</link>                gtk_entry_get_width_chars           (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Gets the value set by <link linkend="gtk-entry-set-width-chars"><function>gtk_entry_set_width_chars()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> number of chars to request space for, or negative if unset
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-set-activates-default" role="function">
<title>gtk_entry_set_activates_default ()</title>
<indexterm zone="gtk-entry-set-activates-default"><primary sortas="entry_set_activates_default">gtk_entry_set_activates_default</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_activates_default     (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gboolean">gboolean</link> setting);</programlisting>
<para>
If <parameter>setting</parameter> is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, pressing Enter in the <parameter>entry</parameter> will activate the default
widget for the window containing the entry. This usually means that
the dialog box containing the entry will be closed, since the default
widget is usually one of the dialog buttons.
</para>
<para>
(For experts: if <parameter>setting</parameter> is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, the entry calls
<link linkend="gtk-window-activate-default"><function>gtk_window_activate_default()</function></link> on the window containing the entry, in
the default handler for the <link linkend="GtkWidget-activate"><type>"activate"</type></link> signal.)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>setting</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to activate window's default widget on Enter keypress
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-set-has-frame" role="function">
<title>gtk_entry_set_has_frame ()</title>
<indexterm zone="gtk-entry-set-has-frame"><primary sortas="entry_set_has_frame">gtk_entry_set_has_frame</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_has_frame             (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gboolean">gboolean</link> setting);</programlisting>
<para>
Sets whether the entry has a beveled frame around it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>setting</parameter>&#160;:</term>
<listitem><simpara> new value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-set-inner-border" role="function" condition="since:2.10">
<title>gtk_entry_set_inner_border ()</title>
<indexterm zone="gtk-entry-set-inner-border" role="2.10"><primary sortas="entry_set_inner_border">gtk_entry_set_inner_border</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_inner_border          (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         const <link linkend="GtkBorder">GtkBorder</link> *border);</programlisting>
<para>
Sets <link linkend="entry"><literal>entry</literal></link>'s inner-border property to <link linkend="border"><literal>border</literal></link>, or clears it if <link linkend="NULL--CAPS"><literal>NULL</literal></link>
is passed. The inner-border is the area around the entry's text, but
inside its frame.
</para>
<para>
If set, this property overrides the inner-border style property.
Overriding the style-provided border is useful when you want to do
in-place editing of some text in a canvas or list widget, where
pixel-exact positioning of the entry is important.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>border</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkBorder"><type>GtkBorder</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.10</para></refsect2>
<refsect2 id="gtk-entry-set-width-chars" role="function">
<title>gtk_entry_set_width_chars ()</title>
<indexterm zone="gtk-entry-set-width-chars"><primary sortas="entry_set_width_chars">gtk_entry_set_width_chars</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_width_chars           (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> n_chars);</programlisting>
<para>
Changes the size request of the entry to be about the right size
for <parameter>n_chars</parameter> characters. Note that it changes the size
<emphasis>request</emphasis>, the size can still be affected by
how you pack the widget into containers. If <parameter>n_chars</parameter> is -1, the
size reverts to the default entry size.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n_chars</parameter>&#160;:</term>
<listitem><simpara> width in chars
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-get-invisible-char" role="function">
<title>gtk_entry_get_invisible_char ()</title>
<indexterm zone="gtk-entry-get-invisible-char"><primary sortas="entry_get_invisible_char">gtk_entry_get_invisible_char</primary></indexterm><programlisting><link linkend="gunichar">gunichar</link>            gtk_entry_get_invisible_char        (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Retrieves the character displayed in place of the real characters
for entries with visibility set to false. See <link linkend="gtk-entry-set-invisible-char"><function>gtk_entry_set_invisible_char()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the current invisible char, or 0, if the entry does not
              show invisible text at all. 
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-set-alignment" role="function" condition="since:2.4">
<title>gtk_entry_set_alignment ()</title>
<indexterm zone="gtk-entry-set-alignment" role="2.4"><primary sortas="entry_set_alignment">gtk_entry_set_alignment</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_alignment             (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gfloat">gfloat</link> xalign);</programlisting>
<para>
Sets the alignment for the contents of the entry. This controls
the horizontal positioning of the contents when the displayed
text is shorter than the width of the entry.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>xalign</parameter>&#160;:</term>
<listitem><simpara> The horizontal alignment, from 0 (left) to 1 (right).
         Reversed for RTL layouts
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-entry-get-alignment" role="function" condition="since:2.4">
<title>gtk_entry_get_alignment ()</title>
<indexterm zone="gtk-entry-get-alignment" role="2.4"><primary sortas="entry_get_alignment">gtk_entry_get_alignment</primary></indexterm><programlisting><link linkend="gfloat">gfloat</link>              gtk_entry_get_alignment             (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Gets the value set by <link linkend="gtk-entry-set-alignment"><function>gtk_entry_set_alignment()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the alignment

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-entry-set-overwrite-mode" role="function" condition="since:2.14">
<title>gtk_entry_set_overwrite_mode ()</title>
<indexterm zone="gtk-entry-set-overwrite-mode" role="2.14"><primary sortas="entry_set_overwrite_mode">gtk_entry_set_overwrite_mode</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_overwrite_mode        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gboolean">gboolean</link> overwrite);</programlisting>
<para>
Sets whether the text is overwritten when typing in the <link linkend="GtkEntry"><type>GtkEntry</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>overwrite</parameter>&#160;:</term>
<listitem><simpara> new value
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.14</para></refsect2>
<refsect2 id="gtk-entry-get-overwrite-mode" role="function" condition="since:2.14">
<title>gtk_entry_get_overwrite_mode ()</title>
<indexterm zone="gtk-entry-get-overwrite-mode" role="2.14"><primary sortas="entry_get_overwrite_mode">gtk_entry_get_overwrite_mode</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_entry_get_overwrite_mode        (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Gets the value set by <link linkend="gtk-entry-set-overwrite-mode"><function>gtk_entry_set_overwrite_mode()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> whether the text is overwritten when typing.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.14</para></refsect2>
<refsect2 id="gtk-entry-get-layout" role="function">
<title>gtk_entry_get_layout ()</title>
<indexterm zone="gtk-entry-get-layout"><primary sortas="entry_get_layout">gtk_entry_get_layout</primary></indexterm><programlisting><link linkend="PangoLayout">PangoLayout</link>*        gtk_entry_get_layout                (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Gets the <link linkend="PangoLayout"><type>PangoLayout</type></link> used to display the entry.
The layout is useful to e.g. convert text positions to
pixel positions, in combination with <link linkend="gtk-entry-get-layout-offsets"><function>gtk_entry_get_layout_offsets()</function></link>.
The returned layout is owned by the entry and must not be 
modified or freed by the caller.
</para>
<para>
Keep in mind that the layout text may contain a preedit string, so
<link linkend="gtk-entry-layout-index-to-text-index"><function>gtk_entry_layout_index_to_text_index()</function></link> and
<link linkend="gtk-entry-text-index-to-layout-index"><function>gtk_entry_text_index_to_layout_index()</function></link> are needed to convert byte
indices in the layout to byte indices in the entry contents.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="PangoLayout"><type>PangoLayout</type></link> for this entry
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-get-layout-offsets" role="function">
<title>gtk_entry_get_layout_offsets ()</title>
<indexterm zone="gtk-entry-get-layout-offsets"><primary sortas="entry_get_layout_offsets">gtk_entry_get_layout_offsets</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_get_layout_offsets        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y);</programlisting>
<para>
Obtains the position of the <link linkend="PangoLayout"><type>PangoLayout</type></link> used to render text
in the entry, in widget coordinates. Useful if you want to line
up the text in an entry with some other text, e.g. when using the
entry to implement editable cells in a sheet widget.
</para>
<para>
Also useful to convert mouse events into coordinates inside the
<link linkend="PangoLayout"><type>PangoLayout</type></link>, e.g. to take some action if some part of the entry text
is clicked.
</para>
<para>
Note that as the user scrolls around in the entry the offsets will
change; you'll need to connect to the "notify::scroll-offset"
signal to track this. Remember when using the <link linkend="PangoLayout"><type>PangoLayout</type></link>
functions you need to convert to and from pixels using
<link linkend="PANGO-PIXELS--CAPS"><function>PANGO_PIXELS()</function></link> or <link linkend="PANGO-SCALE--CAPS"><type>PANGO_SCALE</type></link>.
</para>
<para>
Keep in mind that the layout text may contain a preedit string, so
<link linkend="gtk-entry-layout-index-to-text-index"><function>gtk_entry_layout_index_to_text_index()</function></link> and
<link linkend="gtk-entry-text-index-to-layout-index"><function>gtk_entry_text_index_to_layout_index()</function></link> are needed to convert byte
indices in the layout to byte indices in the entry contents.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> location to store X offset of layout, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> location to store Y offset of layout, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-layout-index-to-text-index" role="function">
<title>gtk_entry_layout_index_to_text_index ()</title>
<indexterm zone="gtk-entry-layout-index-to-text-index"><primary sortas="entry_layout_index_to_text_index">gtk_entry_layout_index_to_text_index</primary></indexterm><programlisting><link linkend="gint">gint</link>                gtk_entry_layout_index_to_text_index
                                                        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> layout_index);</programlisting>
<para>
Converts from a position in the entry contents (returned
by <link linkend="gtk-entry-get-text"><function>gtk_entry_get_text()</function></link>) to a position in the
entry's <link linkend="PangoLayout"><type>PangoLayout</type></link> (returned by <link linkend="gtk-entry-get-layout"><function>gtk_entry_get_layout()</function></link>,
with text retrieved via <link linkend="pango-layout-get-text"><function>pango_layout_get_text()</function></link>).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>layout_index</parameter>&#160;:</term>
<listitem><simpara> byte index into the entry layout text
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> byte index into the entry contents
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-text-index-to-layout-index" role="function">
<title>gtk_entry_text_index_to_layout_index ()</title>
<indexterm zone="gtk-entry-text-index-to-layout-index"><primary sortas="entry_text_index_to_layout_index">gtk_entry_text_index_to_layout_index</primary></indexterm><programlisting><link linkend="gint">gint</link>                gtk_entry_text_index_to_layout_index
                                                        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> text_index);</programlisting>
<para>
Converts from a position in the entry's <link linkend="PangoLayout"><type>PangoLayout</type></link> (returned by
<link linkend="gtk-entry-get-layout"><function>gtk_entry_get_layout()</function></link>) to a position in the entry contents
(returned by <link linkend="gtk-entry-get-text"><function>gtk_entry_get_text()</function></link>).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text_index</parameter>&#160;:</term>
<listitem><simpara> byte index into the entry contents
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> byte index into the entry layout text
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-get-max-length" role="function">
<title>gtk_entry_get_max_length ()</title>
<indexterm zone="gtk-entry-get-max-length"><primary sortas="entry_get_max_length">gtk_entry_get_max_length</primary></indexterm><programlisting><link linkend="gint">gint</link>                gtk_entry_get_max_length            (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Retrieves the maximum allowed length of the text in
<parameter>entry</parameter>. See <link linkend="gtk-entry-set-max-length"><function>gtk_entry_set_max_length()</function></link>.
</para>
<para>
This is equivalent to:
</para>
<para>
<informalexample><programlisting>
gtk_entry_buffer_get_max_length (gtk_entry_get_buffer (entry));
</programlisting></informalexample></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the maximum allowed number of characters
              in <link linkend="GtkEntry"><type>GtkEntry</type></link>, or 0 if there is no maximum.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-get-visibility" role="function">
<title>gtk_entry_get_visibility ()</title>
<indexterm zone="gtk-entry-get-visibility"><primary sortas="entry_get_visibility">gtk_entry_get_visibility</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_entry_get_visibility            (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Retrieves whether the text in <parameter>entry</parameter> is visible. See
<link linkend="gtk-entry-set-visibility"><function>gtk_entry_set_visibility()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the text is currently visible
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-set-completion" role="function" condition="since:2.4">
<title>gtk_entry_set_completion ()</title>
<indexterm zone="gtk-entry-set-completion" role="2.4"><primary sortas="entry_set_completion">gtk_entry_set_completion</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_completion            (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryCompletion">GtkEntryCompletion</link> *completion);</programlisting>
<para>
Sets <parameter>completion</parameter> to be the auxiliary completion object to use with <parameter>entry</parameter>.
All further configuration of the completion mechanism is done on
<parameter>completion</parameter> using the <link linkend="GtkEntryCompletion"><type>GtkEntryCompletion</type></link> API. Completion is disabled if
<parameter>completion</parameter> is set to <link linkend="NULL--CAPS"><literal>NULL</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>completion</parameter>&#160;:</term>
<listitem><simpara> The <link linkend="GtkEntryCompletion"><type>GtkEntryCompletion</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-entry-get-completion" role="function" condition="since:2.4">
<title>gtk_entry_get_completion ()</title>
<indexterm zone="gtk-entry-get-completion" role="2.4"><primary sortas="entry_get_completion">gtk_entry_get_completion</primary></indexterm><programlisting><link linkend="GtkEntryCompletion">GtkEntryCompletion</link> * gtk_entry_get_completion           (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Returns the auxiliary completion object currently in use by <parameter>entry</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The auxiliary completion object currently in use by <parameter>entry</parameter>.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-entry-set-cursor-hadjustment" role="function" condition="since:2.12">
<title>gtk_entry_set_cursor_hadjustment ()</title>
<indexterm zone="gtk-entry-set-cursor-hadjustment" role="2.12"><primary sortas="entry_set_cursor_hadjustment">gtk_entry_set_cursor_hadjustment</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_cursor_hadjustment    (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkAdjustment">GtkAdjustment</link> *adjustment);</programlisting>
<para>
Hooks up an adjustment to the cursor position in an entry, so that when 
the cursor is moved, the adjustment is scrolled to show that position. 
See <link linkend="gtk-scrolled-window-get-hadjustment"><function>gtk_scrolled_window_get_hadjustment()</function></link> for a typical way of obtaining 
the adjustment.
</para>
<para>
The adjustment has to be in pixel units and in the same coordinate system 
as the entry.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>adjustment</parameter>&#160;:</term>
<listitem><simpara> an adjustment which should be adjusted when the cursor 
             is moved, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.12</para></refsect2>
<refsect2 id="gtk-entry-get-cursor-hadjustment" role="function" condition="since:2.12">
<title>gtk_entry_get_cursor_hadjustment ()</title>
<indexterm zone="gtk-entry-get-cursor-hadjustment" role="2.12"><primary sortas="entry_get_cursor_hadjustment">gtk_entry_get_cursor_hadjustment</primary></indexterm><programlisting><link linkend="GtkAdjustment">GtkAdjustment</link>*      gtk_entry_get_cursor_hadjustment    (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Retrieves the horizontal cursor adjustment for the entry. 
See <link linkend="gtk-entry-set-cursor-hadjustment"><function>gtk_entry_set_cursor_hadjustment()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the horizontal cursor adjustment, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> 
  if none has been set.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.12</para></refsect2>
<refsect2 id="gtk-entry-set-progress-fraction" role="function" condition="since:2.16">
<title>gtk_entry_set_progress_fraction ()</title>
<indexterm zone="gtk-entry-set-progress-fraction" role="2.16"><primary sortas="entry_set_progress_fraction">gtk_entry_set_progress_fraction</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_progress_fraction     (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gdouble">gdouble</link> fraction);</programlisting>
<para>
Causes the entry's progress indicator to "fill in" the given
fraction of the bar. The fraction should be between 0.0 and 1.0,
inclusive.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fraction</parameter>&#160;:</term>
<listitem><simpara> fraction of the task that's been completed
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-get-progress-fraction" role="function" condition="since:2.16">
<title>gtk_entry_get_progress_fraction ()</title>
<indexterm zone="gtk-entry-get-progress-fraction" role="2.16"><primary sortas="entry_get_progress_fraction">gtk_entry_get_progress_fraction</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gtk_entry_get_progress_fraction     (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Returns the current fraction of the task that's been completed.
See <link linkend="gtk-entry-set-progress-fraction"><function>gtk_entry_set_progress_fraction()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a fraction from 0.0 to 1.0

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-set-progress-pulse-step" role="function" condition="since:2.16">
<title>gtk_entry_set_progress_pulse_step ()</title>
<indexterm zone="gtk-entry-set-progress-pulse-step" role="2.16"><primary sortas="entry_set_progress_pulse_step">gtk_entry_set_progress_pulse_step</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_progress_pulse_step   (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gdouble">gdouble</link> fraction);</programlisting>
<para>
Sets the fraction of total entry width to move the progress
bouncing block for each call to <link linkend="gtk-entry-progress-pulse"><function>gtk_entry_progress_pulse()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fraction</parameter>&#160;:</term>
<listitem><simpara> fraction between 0.0 and 1.0
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-get-progress-pulse-step" role="function" condition="since:2.16">
<title>gtk_entry_get_progress_pulse_step ()</title>
<indexterm zone="gtk-entry-get-progress-pulse-step" role="2.16"><primary sortas="entry_get_progress_pulse_step">gtk_entry_get_progress_pulse_step</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gtk_entry_get_progress_pulse_step   (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Retrieves the pulse step set with <link linkend="gtk-entry-set-progress-pulse-step"><function>gtk_entry_set_progress_pulse_step()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a fraction from 0.0 to 1.0

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-progress-pulse" role="function" condition="since:2.16">
<title>gtk_entry_progress_pulse ()</title>
<indexterm zone="gtk-entry-progress-pulse" role="2.16"><primary sortas="entry_progress_pulse">gtk_entry_progress_pulse</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_progress_pulse            (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Indicates that some progress is made, but you don't know how much.
Causes the entry's progress indicator to enter "activity mode,"
where a block bounces back and forth. Each call to
<link linkend="gtk-entry-progress-pulse"><function>gtk_entry_progress_pulse()</function></link> causes the block to move by a little bit
(the amount of movement per pulse is determined by
<link linkend="gtk-entry-set-progress-pulse-step"><function>gtk_entry_set_progress_pulse_step()</function></link>).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="GtkEntryIconPosition" role="enum">
<title>enum GtkEntryIconPosition</title>
<indexterm zone="GtkEntryIconPosition"><primary sortas="EntryIconPosition">GtkEntryIconPosition</primary></indexterm><programlisting>typedef enum
{
  GTK_ENTRY_ICON_PRIMARY,
  GTK_ENTRY_ICON_SECONDARY
} GtkEntryIconPosition;
</programlisting>
<para>
Specifies the side of the entry at which an icon is placed.
</para><variablelist role="enum">
<varlistentry id="GTK-ENTRY-ICON-PRIMARY--CAPS" role="constant">
<term><literal>GTK_ENTRY_ICON_PRIMARY</literal></term>
<listitem><simpara>At the beginning of the entry (depending on the text direction).
</simpara></listitem>
</varlistentry>
<varlistentry id="GTK-ENTRY-ICON-SECONDARY--CAPS" role="constant">
<term><literal>GTK_ENTRY_ICON_SECONDARY</literal></term>
<listitem><simpara>At the end of the entry (depending on the text direction).
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-set-icon-from-pixbuf" role="function" condition="since:2.16">
<title>gtk_entry_set_icon_from_pixbuf ()</title>
<indexterm zone="gtk-entry-set-icon-from-pixbuf" role="2.16"><primary sortas="entry_set_icon_from_pixbuf">gtk_entry_set_icon_from_pixbuf</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_icon_from_pixbuf      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         <link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);</programlisting>
<para>
Sets the icon shown in the specified position using a pixbuf.
</para>
<para>
If <parameter>pixbuf</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, no icon will be shown in the specified position.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> Icon position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixbuf</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-set-icon-from-stock" role="function" condition="since:2.16">
<title>gtk_entry_set_icon_from_stock ()</title>
<indexterm zone="gtk-entry-set-icon-from-stock" role="2.16"><primary sortas="entry_set_icon_from_stock">gtk_entry_set_icon_from_stock</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_icon_from_stock       (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         const <link linkend="gchar">gchar</link> *stock_id);</programlisting>
<para>
Sets the icon shown in the entry at the specified position from
a stock image.
</para>
<para>
If <parameter>stock_id</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, no icon will be shown in the specified position.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> Icon position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stock_id</parameter>&#160;:</term>
<listitem><simpara> The name of the stock item, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-set-icon-from-icon-name" role="function" condition="since:2.16">
<title>gtk_entry_set_icon_from_icon_name ()</title>
<indexterm zone="gtk-entry-set-icon-from-icon-name" role="2.16"><primary sortas="entry_set_icon_from_icon_name">gtk_entry_set_icon_from_icon_name</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_icon_from_icon_name   (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         const <link linkend="gchar">gchar</link> *icon_name);</programlisting>
<para>
Sets the icon shown in the entry at the specified position
from the current icon theme.
</para>
<para>
If the icon name isn't known, a "broken image" icon will be displayed
instead.
</para>
<para>
If <parameter>icon_name</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, no icon will be shown in the specified position.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> The position at which to set the icon
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_name</parameter>&#160;:</term>
<listitem><simpara> An icon name, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-set-icon-from-gicon" role="function" condition="since:2.16">
<title>gtk_entry_set_icon_from_gicon ()</title>
<indexterm zone="gtk-entry-set-icon-from-gicon" role="2.16"><primary sortas="entry_set_icon_from_gicon">gtk_entry_set_icon_from_gicon</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_icon_from_gicon       (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         <link linkend="GIcon">GIcon</link> *icon);</programlisting>
<para>
Sets the icon shown in the entry at the specified position
from the current icon theme.
If the icon isn't known, a "broken image" icon will be displayed
instead.
</para>
<para>
If <parameter>icon</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, no icon will be shown in the specified position.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> The position at which to set the icon
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon</parameter>&#160;:</term>
<listitem><simpara> The icon to set, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-get-icon-storage-type" role="function" condition="since:2.16">
<title>gtk_entry_get_icon_storage_type ()</title>
<indexterm zone="gtk-entry-get-icon-storage-type" role="2.16"><primary sortas="entry_get_icon_storage_type">gtk_entry_get_icon_storage_type</primary></indexterm><programlisting><link linkend="GtkImageType">GtkImageType</link>        gtk_entry_get_icon_storage_type     (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);</programlisting>
<para>
Gets the type of representation being used by the icon
to store image data. If the icon has no image data,
the return value will be <link linkend="GTK-IMAGE-EMPTY--CAPS"><literal>GTK_IMAGE_EMPTY</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> Icon position
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> image representation being used

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-get-icon-pixbuf" role="function" condition="since:2.16">
<title>gtk_entry_get_icon_pixbuf ()</title>
<indexterm zone="gtk-entry-get-icon-pixbuf" role="2.16"><primary sortas="entry_get_icon_pixbuf">gtk_entry_get_icon_pixbuf</primary></indexterm><programlisting><link linkend="GdkPixbuf">GdkPixbuf</link>*          gtk_entry_get_icon_pixbuf           (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);</programlisting>
<para>
Retrieves the image used for the icon.
</para>
<para>
Unlike the other methods of setting and getting icon data, this
method will work regardless of whether the icon was set using a
<link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>, a <link linkend="GIcon"><type>GIcon</type></link>, a stock item, or an icon name.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> Icon position
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if no icon is set for this position.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-get-icon-stock" role="function" condition="since:2.16">
<title>gtk_entry_get_icon_stock ()</title>
<indexterm zone="gtk-entry-get-icon-stock" role="2.16"><primary sortas="entry_get_icon_stock">gtk_entry_get_icon_stock</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gtk_entry_get_icon_stock            (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);</programlisting>
<para>
Retrieves the stock id used for the icon, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if there is
no icon or if the icon was set by some other method (e.g., by
pixbuf, icon name or gicon).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> Icon position
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A stock id, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if no icon is set or if the icon
         wasn't set from a stock id

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-get-icon-name" role="function" condition="since:2.16">
<title>gtk_entry_get_icon_name ()</title>
<indexterm zone="gtk-entry-get-icon-name" role="2.16"><primary sortas="entry_get_icon_name">gtk_entry_get_icon_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gtk_entry_get_icon_name             (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);</programlisting>
<para>
Retrieves the icon name used for the icon, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if there is
no icon or if the icon was set by some other method (e.g., by
pixbuf, stock or gicon).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> Icon position
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An icon name, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if no icon is set or if the icon
         wasn't set from an icon name

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-get-icon-gicon" role="function" condition="since:2.16">
<title>gtk_entry_get_icon_gicon ()</title>
<indexterm zone="gtk-entry-get-icon-gicon" role="2.16"><primary sortas="entry_get_icon_gicon">gtk_entry_get_icon_gicon</primary></indexterm><programlisting><link linkend="GIcon">GIcon</link>*              gtk_entry_get_icon_gicon            (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);</programlisting>
<para>
Retrieves the <link linkend="GIcon"><type>GIcon</type></link> used for the icon, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if there is
no icon or if the icon was set by some other method (e.g., by
stock, pixbuf, or icon name).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> Icon position
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GIcon"><type>GIcon</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if no icon is set or if the icon
         is not a <link linkend="GIcon"><type>GIcon</type></link>

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-set-icon-activatable" role="function" condition="since:2.16">
<title>gtk_entry_set_icon_activatable ()</title>
<indexterm zone="gtk-entry-set-icon-activatable" role="2.16"><primary sortas="entry_set_icon_activatable">gtk_entry_set_icon_activatable</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_icon_activatable      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         <link linkend="gboolean">gboolean</link> activatable);</programlisting>
<para>
Sets whether the icon is activatable.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> Icon position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>activatable</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the icon should be activatable
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-get-icon-activatable" role="function" condition="since:2.16">
<title>gtk_entry_get_icon_activatable ()</title>
<indexterm zone="gtk-entry-get-icon-activatable" role="2.16"><primary sortas="entry_get_icon_activatable">gtk_entry_get_icon_activatable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_entry_get_icon_activatable      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);</programlisting>
<para>
Returns whether the icon is activatable.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> Icon position
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the icon is activatable.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-set-icon-sensitive" role="function" condition="since:2.16">
<title>gtk_entry_set_icon_sensitive ()</title>
<indexterm zone="gtk-entry-set-icon-sensitive" role="2.16"><primary sortas="entry_set_icon_sensitive">gtk_entry_set_icon_sensitive</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_icon_sensitive        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         <link linkend="gboolean">gboolean</link> sensitive);</programlisting>
<para>
Sets the sensitivity for the specified icon.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> Icon position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sensitive</parameter>&#160;:</term>
<listitem><simpara> Specifies whether the icon should appear
            sensitive or insensitive
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-get-icon-sensitive" role="function" condition="since:2.16">
<title>gtk_entry_get_icon_sensitive ()</title>
<indexterm zone="gtk-entry-get-icon-sensitive" role="2.16"><primary sortas="entry_get_icon_sensitive">gtk_entry_get_icon_sensitive</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_entry_get_icon_sensitive        (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);</programlisting>
<para>
Returns whether the icon appears sensitive or insensitive.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> Icon position
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the icon is sensitive.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-get-icon-at-pos" role="function" condition="since:2.16">
<title>gtk_entry_get_icon_at_pos ()</title>
<indexterm zone="gtk-entry-get-icon-at-pos" role="2.16"><primary sortas="entry_get_icon_at_pos">gtk_entry_get_icon_at_pos</primary></indexterm><programlisting><link linkend="gint">gint</link>                gtk_entry_get_icon_at_pos           (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y);</programlisting>
<para>
Finds the icon at the given position and return its index.
If <parameter>x</parameter>, <parameter>y</parameter> doesn't lie inside an icon, -1 is returned.
This function is intended for use in a <link linkend="GtkWidget-query-tooltip"><type>"query-tooltip"</type></link>
signal handler.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&#160;:</term>
<listitem><simpara> the x coordinate of the position to find
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&#160;:</term>
<listitem><simpara> the y coordinate of the position to find
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the index of the icon at the given position, or -1

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-set-icon-tooltip-text" role="function" condition="since:2.16">
<title>gtk_entry_set_icon_tooltip_text ()</title>
<indexterm zone="gtk-entry-set-icon-tooltip-text" role="2.16"><primary sortas="entry_set_icon_tooltip_text">gtk_entry_set_icon_tooltip_text</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_icon_tooltip_text     (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         const <link linkend="gchar">gchar</link> *tooltip);</programlisting>
<para>
Sets <parameter>tooltip</parameter> as the contents of the tooltip for the icon
at the specified position.
</para>
<para>
Use <link linkend="NULL--CAPS"><literal>NULL</literal></link> for <parameter>tooltip</parameter> to remove an existing tooltip.
</para>
<para>
See also <link linkend="gtk-widget-set-tooltip-text"><function>gtk_widget_set_tooltip_text()</function></link> and 
<link linkend="gtk-entry-set-icon-tooltip-markup"><function>gtk_entry_set_icon_tooltip_markup()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> the icon position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tooltip</parameter>&#160;:</term>
<listitem><simpara> the contents of the tooltip for the icon, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-get-icon-tooltip-text" role="function" condition="since:2.16">
<title>gtk_entry_get_icon_tooltip_text ()</title>
<indexterm zone="gtk-entry-get-icon-tooltip-text" role="2.16"><primary sortas="entry_get_icon_tooltip_text">gtk_entry_get_icon_tooltip_text</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             gtk_entry_get_icon_tooltip_text     (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);</programlisting>
<para>
Gets the contents of the tooltip on the icon at the specified 
position in <parameter>entry</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> the icon position
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tooltip text, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>. Free the returned string
    with <link linkend="g-free"><function>g_free()</function></link> when done.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-set-icon-tooltip-markup" role="function" condition="since:2.16">
<title>gtk_entry_set_icon_tooltip_markup ()</title>
<indexterm zone="gtk-entry-set-icon-tooltip-markup" role="2.16"><primary sortas="entry_set_icon_tooltip_markup">gtk_entry_set_icon_tooltip_markup</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_icon_tooltip_markup   (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         const <link linkend="gchar">gchar</link> *tooltip);</programlisting>
<para>
Sets <parameter>tooltip</parameter> as the contents of the tooltip for the icon at
the specified position. <parameter>tooltip</parameter> is assumed to be marked up with
the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
</para>
<para>
Use <link linkend="NULL--CAPS"><literal>NULL</literal></link> for <parameter>tooltip</parameter> to remove an existing tooltip.
</para>
<para>
See also <link linkend="gtk-widget-set-tooltip-markup"><function>gtk_widget_set_tooltip_markup()</function></link> and 
<link linkend="gtk-enty-set-icon-tooltip-text"><function>gtk_enty_set_icon_tooltip_text()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> the icon position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tooltip</parameter>&#160;:</term>
<listitem><simpara> the contents of the tooltip for the icon, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-get-icon-tooltip-markup" role="function" condition="since:2.16">
<title>gtk_entry_get_icon_tooltip_markup ()</title>
<indexterm zone="gtk-entry-get-icon-tooltip-markup" role="2.16"><primary sortas="entry_get_icon_tooltip_markup">gtk_entry_get_icon_tooltip_markup</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             gtk_entry_get_icon_tooltip_markup   (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos);</programlisting>
<para>
Gets the contents of the tooltip on the icon at the specified 
position in <parameter>entry</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkEntry"><type>GtkEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> the icon position
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the tooltip text, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>. Free the returned string
    with <link linkend="g-free"><function>g_free()</function></link> when done.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.16</para></refsect2>
<refsect2 id="gtk-entry-set-icon-drag-source" role="function">
<title>gtk_entry_set_icon_drag_source ()</title>
<indexterm zone="gtk-entry-set-icon-drag-source"><primary sortas="entry_set_icon_drag_source">gtk_entry_set_icon_drag_source</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_entry_set_icon_drag_source      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                         <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                         <link linkend="GtkTargetList">GtkTargetList</link> *target_list,
                                                         <link linkend="GdkDragAction">GdkDragAction</link> actions);</programlisting>
<para>
Sets up the icon at the given position so that GTK+ will start a drag
operation when the user clicks and drags the icon.
</para>
<para>
To handle the drag operation, you need to connect to the usual
<link linkend="GtkWidget-drag-data-get"><type>"drag-data-get"</type></link> (or possibly <link linkend="GtkWidget-drag-data-delete"><type>"drag-data-delete"</type></link>)
signal, and use <link linkend="gtk-entry-get-current-icon-drag-source"><function>gtk_entry_get_current_icon_drag_source()</function></link> in
your signal handler to find out if the drag was started from
an icon.
</para>
<para>
By default, GTK+ uses the icon as the drag icon. You can use the 
<link linkend="GtkWidget-drag-begin"><type>"drag-begin"</type></link> signal to set a different icon. Note that you 
have to use <link linkend="g-signal-connect-after"><function>g_signal_connect_after()</function></link> to ensure that your signal handler
gets executed after the default handler.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkIconEntry"><type>GtkIconEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> icon position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>target_list</parameter>&#160;:</term>
<listitem><simpara> the targets (data formats) in which the data can be provided
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>actions</parameter>&#160;:</term>
<listitem><simpara> a bitmask of the allowed drag actions
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-entry-get-current-icon-drag-source" role="function">
<title>gtk_entry_get_current_icon_drag_source ()</title>
<indexterm zone="gtk-entry-get-current-icon-drag-source"><primary sortas="entry_get_current_icon_drag_source">gtk_entry_get_current_icon_drag_source</primary></indexterm><programlisting><link linkend="gint">gint</link>                gtk_entry_get_current_icon_drag_source
                                                        (<link linkend="GtkEntry">GtkEntry</link> *entry);</programlisting>
<para>
Returns the index of the icon which is the source of the current
DND operation, or -1.
</para>
<para>
This function is meant to be used in a <link linkend="GtkWidget-drag-data-get"><type>"drag-data-get"</type></link>
callback.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkIconEntry"><type>GtkIconEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> index of the icon which is the source of the current
         DND operation, or -1.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="GtkEntry.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkEntry--activates-default" role="property"><title>The <literal>&quot;activates-default&quot;</literal> property</title>
<indexterm zone="GtkEntry--activates-default"><primary sortas="Entry:activates-default">GtkEntry:activates-default</primary></indexterm><programlisting>  &quot;activates-default&quot;        <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="GtkEntry--buffer" role="property"><title>The <literal>&quot;buffer&quot;</literal> property</title>
<indexterm zone="GtkEntry--buffer"><primary sortas="Entry:buffer">GtkEntry:buffer</primary></indexterm><programlisting>  &quot;buffer&quot;                   <link linkend="GtkEntryBuffer">GtkEntryBuffer</link>*       : Read / Write / Construct</programlisting>
<para>Text buffer object which actually stores entry text.</para></refsect2>
<refsect2 id="GtkEntry--caps-lock-warning" role="property"><title>The <literal>&quot;caps-lock-warning&quot;</literal> property</title>
<indexterm zone="GtkEntry--caps-lock-warning" role="2.16"><primary sortas="Entry:caps-lock-warning">GtkEntry:caps-lock-warning</primary></indexterm><programlisting>  &quot;caps-lock-warning&quot;        <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>
Whether password entries will show a warning when Caps Lock is on.
</para>
<para>
Note that the warning is shown using a secondary icon, and thus
does not work if you are using the secondary icon position for some
other purpose.</para>
<para>
</para><para>Default value: TRUE</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--cursor-position" role="property"><title>The <literal>&quot;cursor-position&quot;</literal> property</title>
<indexterm zone="GtkEntry--cursor-position"><primary sortas="Entry:cursor-position">GtkEntry:cursor-position</primary></indexterm><programlisting>  &quot;cursor-position&quot;          <link linkend="gint">gint</link>                  : Read</programlisting>
<para>The current position of the insertion cursor in chars.</para><para>Allowed values: [0,65535]</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="GtkEntry--editable" role="property"><title>The <literal>&quot;editable&quot;</literal> property</title>
<indexterm zone="GtkEntry--editable"><primary sortas="Entry:editable">GtkEntry:editable</primary></indexterm><programlisting>  &quot;editable&quot;                 <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>Whether the entry contents can be edited.</para><para>Default value: TRUE</para>
</refsect2>
<refsect2 id="GtkEntry--has-frame" role="property"><title>The <literal>&quot;has-frame&quot;</literal> property</title>
<indexterm zone="GtkEntry--has-frame"><primary sortas="Entry:has-frame">GtkEntry:has-frame</primary></indexterm><programlisting>  &quot;has-frame&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>FALSE removes outside bevel from entry.</para><para>Default value: TRUE</para>
</refsect2>
<refsect2 id="GtkEntry--im-module" role="property"><title>The <literal>&quot;im-module&quot;</literal> property</title>
<indexterm zone="GtkEntry--im-module" role="2.16"><primary sortas="Entry:im-module">GtkEntry:im-module</primary></indexterm><programlisting>  &quot;im-module&quot;                <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
<para>
Which IM (input method) module should be used for this entry. 
See <link linkend="GtkIMContext"><type>GtkIMContext</type></link>.
</para>
<para>
Setting this to a non-<link linkend="NULL--CAPS"><literal>NULL</literal></link> value overrides the
system-wide IM module setting. See the GtkSettings 
<link linkend="GtkSettings--gtk-im-module"><type>"gtk-im-module"</type></link> property.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--inner-border" role="property"><title>The <literal>&quot;inner-border&quot;</literal> property</title>
<indexterm zone="GtkEntry--inner-border" role="2.10"><primary sortas="Entry:inner-border">GtkEntry:inner-border</primary></indexterm><programlisting>  &quot;inner-border&quot;             <link linkend="GtkBorder">GtkBorder</link>*            : Read / Write</programlisting>
<para>
Sets the text area's border between the text and the frame.</para>
<para>
</para><para>Since 2.10</para>
</refsect2>
<refsect2 id="GtkEntry--invisible-char" role="property"><title>The <literal>&quot;invisible-char&quot;</literal> property</title>
<indexterm zone="GtkEntry--invisible-char"><primary sortas="Entry:invisible-char">GtkEntry:invisible-char</primary></indexterm><programlisting>  &quot;invisible-char&quot;           <link linkend="guint">guint</link>                 : Read / Write</programlisting>
<para>The character to use when masking entry contents (in "password mode").</para><para>Default value: '*'</para>
</refsect2>
<refsect2 id="GtkEntry--invisible-char-set" role="property"><title>The <literal>&quot;invisible-char-set&quot;</literal> property</title>
<indexterm zone="GtkEntry--invisible-char-set" role="2.16"><primary sortas="Entry:invisible-char-set">GtkEntry:invisible-char-set</primary></indexterm><programlisting>  &quot;invisible-char-set&quot;       <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>
Whether the invisible char has been set for the <link linkend="GtkEntry"><type>GtkEntry</type></link>.</para>
<para>
</para><para>Default value: FALSE</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--max-length" role="property"><title>The <literal>&quot;max-length&quot;</literal> property</title>
<indexterm zone="GtkEntry--max-length"><primary sortas="Entry:max-length">GtkEntry:max-length</primary></indexterm><programlisting>  &quot;max-length&quot;               <link linkend="gint">gint</link>                  : Read / Write</programlisting>
<para>Maximum number of characters for this entry. Zero if no maximum.</para><para>Allowed values: [0,65535]</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="GtkEntry--overwrite-mode" role="property"><title>The <literal>&quot;overwrite-mode&quot;</literal> property</title>
<indexterm zone="GtkEntry--overwrite-mode" role="2.14"><primary sortas="Entry:overwrite-mode">GtkEntry:overwrite-mode</primary></indexterm><programlisting>  &quot;overwrite-mode&quot;           <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>
If text is overwritten when typing in the <link linkend="GtkEntry"><type>GtkEntry</type></link>.</para>
<para>
</para><para>Default value: FALSE</para>
<para>Since 2.14</para>
</refsect2>
<refsect2 id="GtkEntry--primary-icon-activatable" role="property"><title>The <literal>&quot;primary-icon-activatable&quot;</literal> property</title>
<indexterm zone="GtkEntry--primary-icon-activatable" role="2.16"><primary sortas="Entry:primary-icon-activatable">GtkEntry:primary-icon-activatable</primary></indexterm><programlisting>  &quot;primary-icon-activatable&quot; <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>
Whether the primary icon is activatable.
</para>
<para>
GTK+ emits the <link linkend="GtkEntry-icon-press"><type>"icon-press"</type></link> and <link linkend="GtkEntry-icon-release"><type>"icon-release"</type></link> 
signals only on sensitive, activatable icons. 
</para>
<para>
Sensitive, but non-activatable icons can be used for purely 
informational purposes.</para>
<para>
</para><para>Default value: FALSE</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--primary-icon-gicon" role="property"><title>The <literal>&quot;primary-icon-gicon&quot;</literal> property</title>
<indexterm zone="GtkEntry--primary-icon-gicon" role="2.16"><primary sortas="Entry:primary-icon-gicon">GtkEntry:primary-icon-gicon</primary></indexterm><programlisting>  &quot;primary-icon-gicon&quot;       <link linkend="GIcon">GIcon</link>*                : Read / Write</programlisting>
<para>
The <link linkend="GIcon"><type>GIcon</type></link> to use for the primary icon for the entry.</para>
<para>
</para><para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--primary-icon-name" role="property"><title>The <literal>&quot;primary-icon-name&quot;</literal> property</title>
<indexterm zone="GtkEntry--primary-icon-name" role="2.16"><primary sortas="Entry:primary-icon-name">GtkEntry:primary-icon-name</primary></indexterm><programlisting>  &quot;primary-icon-name&quot;        <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
<para>
The icon name to use for the primary icon for the entry.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--primary-icon-pixbuf" role="property"><title>The <literal>&quot;primary-icon-pixbuf&quot;</literal> property</title>
<indexterm zone="GtkEntry--primary-icon-pixbuf" role="2.16"><primary sortas="Entry:primary-icon-pixbuf">GtkEntry:primary-icon-pixbuf</primary></indexterm><programlisting>  &quot;primary-icon-pixbuf&quot;      <link linkend="GdkPixbuf">GdkPixbuf</link>*            : Read / Write</programlisting>
<para>
A pixbuf to use as the primary icon for the entry.</para>
<para>
</para><para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--primary-icon-sensitive" role="property"><title>The <literal>&quot;primary-icon-sensitive&quot;</literal> property</title>
<indexterm zone="GtkEntry--primary-icon-sensitive" role="2.16"><primary sortas="Entry:primary-icon-sensitive">GtkEntry:primary-icon-sensitive</primary></indexterm><programlisting>  &quot;primary-icon-sensitive&quot;   <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>
Whether the primary icon is sensitive.
</para>
<para>
An insensitive icon appears grayed out. GTK+ does not emit the 
<link linkend="GtkEntry-icon-press"><type>"icon-press"</type></link> and <link linkend="GtkEntry-icon-release"><type>"icon-release"</type></link> signals and 
does not allow DND from insensitive icons.
</para>
<para>
An icon should be set insensitive if the action that would trigger
when clicked is currently not available.</para>
<para>
</para><para>Default value: TRUE</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--primary-icon-stock" role="property"><title>The <literal>&quot;primary-icon-stock&quot;</literal> property</title>
<indexterm zone="GtkEntry--primary-icon-stock" role="2.16"><primary sortas="Entry:primary-icon-stock">GtkEntry:primary-icon-stock</primary></indexterm><programlisting>  &quot;primary-icon-stock&quot;       <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
<para>
The stock id to use for the primary icon for the entry.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--primary-icon-storage-type" role="property"><title>The <literal>&quot;primary-icon-storage-type&quot;</literal> property</title>
<indexterm zone="GtkEntry--primary-icon-storage-type" role="2.16"><primary sortas="Entry:primary-icon-storage-type">GtkEntry:primary-icon-storage-type</primary></indexterm><programlisting>  &quot;primary-icon-storage-type&quot; <link linkend="GtkImageType">GtkImageType</link>          : Read</programlisting>
<para>
The representation which is used for the primary icon of the entry.</para>
<para>
</para><para>Default value: GTK_IMAGE_EMPTY</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--primary-icon-tooltip-markup" role="property"><title>The <literal>&quot;primary-icon-tooltip-markup&quot;</literal> property</title>
<indexterm zone="GtkEntry--primary-icon-tooltip-markup" role="2.16"><primary sortas="Entry:primary-icon-tooltip-markup">GtkEntry:primary-icon-tooltip-markup</primary></indexterm><programlisting>  &quot;primary-icon-tooltip-markup&quot; <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
<para>
The contents of the tooltip on the primary icon, which is marked up
with the <link linkend="PangoMarkupFormat">Pango text markup 
language</link>.
</para>
<para>
Also see <link linkend="gtk-entry-set-icon-tooltip-markup"><function>gtk_entry_set_icon_tooltip_markup()</function></link>.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--primary-icon-tooltip-text" role="property"><title>The <literal>&quot;primary-icon-tooltip-text&quot;</literal> property</title>
<indexterm zone="GtkEntry--primary-icon-tooltip-text" role="2.16"><primary sortas="Entry:primary-icon-tooltip-text">GtkEntry:primary-icon-tooltip-text</primary></indexterm><programlisting>  &quot;primary-icon-tooltip-text&quot; <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
<para>
The contents of the tooltip on the primary icon.
</para>
<para>
Also see <link linkend="gtk-entry-set-icon-tooltip-text"><function>gtk_entry_set_icon_tooltip_text()</function></link>.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--progress-fraction" role="property"><title>The <literal>&quot;progress-fraction&quot;</literal> property</title>
<indexterm zone="GtkEntry--progress-fraction" role="2.16"><primary sortas="Entry:progress-fraction">GtkEntry:progress-fraction</primary></indexterm><programlisting>  &quot;progress-fraction&quot;        <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
<para>
The current fraction of the task that's been completed.</para>
<para>
</para><para>Allowed values: [0,1]</para>
<para>Default value: 0</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--progress-pulse-step" role="property"><title>The <literal>&quot;progress-pulse-step&quot;</literal> property</title>
<indexterm zone="GtkEntry--progress-pulse-step" role="2.16"><primary sortas="Entry:progress-pulse-step">GtkEntry:progress-pulse-step</primary></indexterm><programlisting>  &quot;progress-pulse-step&quot;      <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
<para>
The fraction of total entry width to move the progress
bouncing block for each call to <link linkend="gtk-entry-progress-pulse"><function>gtk_entry_progress_pulse()</function></link>.</para>
<para>
</para><para>Allowed values: [0,1]</para>
<para>Default value: 0.1</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--scroll-offset" role="property"><title>The <literal>&quot;scroll-offset&quot;</literal> property</title>
<indexterm zone="GtkEntry--scroll-offset"><primary sortas="Entry:scroll-offset">GtkEntry:scroll-offset</primary></indexterm><programlisting>  &quot;scroll-offset&quot;            <link linkend="gint">gint</link>                  : Read</programlisting>
<para>Number of pixels of the entry scrolled off the screen to the left.</para><para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="GtkEntry--secondary-icon-activatable" role="property"><title>The <literal>&quot;secondary-icon-activatable&quot;</literal> property</title>
<indexterm zone="GtkEntry--secondary-icon-activatable" role="2.16"><primary sortas="Entry:secondary-icon-activatable">GtkEntry:secondary-icon-activatable</primary></indexterm><programlisting>  &quot;secondary-icon-activatable&quot; <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>
Whether the secondary icon is activatable.
</para>
<para>
GTK+ emits the <link linkend="GtkEntry-icon-press"><type>"icon-press"</type></link> and <link linkend="GtkEntry-icon-release"><type>"icon-release"</type></link> 
signals only on sensitive, activatable icons.
</para>
<para>
Sensitive, but non-activatable icons can be used for purely 
informational purposes.</para>
<para>
</para><para>Default value: FALSE</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--secondary-icon-gicon" role="property"><title>The <literal>&quot;secondary-icon-gicon&quot;</literal> property</title>
<indexterm zone="GtkEntry--secondary-icon-gicon" role="2.16"><primary sortas="Entry:secondary-icon-gicon">GtkEntry:secondary-icon-gicon</primary></indexterm><programlisting>  &quot;secondary-icon-gicon&quot;     <link linkend="GIcon">GIcon</link>*                : Read / Write</programlisting>
<para>
The <link linkend="GIcon"><type>GIcon</type></link> to use for the secondary icon for the entry.</para>
<para>
</para><para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--secondary-icon-name" role="property"><title>The <literal>&quot;secondary-icon-name&quot;</literal> property</title>
<indexterm zone="GtkEntry--secondary-icon-name" role="2.16"><primary sortas="Entry:secondary-icon-name">GtkEntry:secondary-icon-name</primary></indexterm><programlisting>  &quot;secondary-icon-name&quot;      <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
<para>
The icon name to use for the secondary icon for the entry.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--secondary-icon-pixbuf" role="property"><title>The <literal>&quot;secondary-icon-pixbuf&quot;</literal> property</title>
<indexterm zone="GtkEntry--secondary-icon-pixbuf" role="2.16"><primary sortas="Entry:secondary-icon-pixbuf">GtkEntry:secondary-icon-pixbuf</primary></indexterm><programlisting>  &quot;secondary-icon-pixbuf&quot;    <link linkend="GdkPixbuf">GdkPixbuf</link>*            : Read / Write</programlisting>
<para>
An pixbuf to use as the secondary icon for the entry.</para>
<para>
</para><para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--secondary-icon-sensitive" role="property"><title>The <literal>&quot;secondary-icon-sensitive&quot;</literal> property</title>
<indexterm zone="GtkEntry--secondary-icon-sensitive" role="2.16"><primary sortas="Entry:secondary-icon-sensitive">GtkEntry:secondary-icon-sensitive</primary></indexterm><programlisting>  &quot;secondary-icon-sensitive&quot; <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>
Whether the secondary icon is sensitive.
</para>
<para>
An insensitive icon appears grayed out. GTK+ does not emit the 
<link linkend="GtkEntry-icon-press"><type>"icon-press"</type></link> and <link linkend="GtkEntry-icon-release"><type>"icon-release"</type></link> signals and 
does not allow DND from insensitive icons.
</para>
<para>
An icon should be set insensitive if the action that would trigger
when clicked is currently not available.</para>
<para>
</para><para>Default value: TRUE</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--secondary-icon-stock" role="property"><title>The <literal>&quot;secondary-icon-stock&quot;</literal> property</title>
<indexterm zone="GtkEntry--secondary-icon-stock" role="2.16"><primary sortas="Entry:secondary-icon-stock">GtkEntry:secondary-icon-stock</primary></indexterm><programlisting>  &quot;secondary-icon-stock&quot;     <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
<para>
The stock id to use for the secondary icon for the entry.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--secondary-icon-storage-type" role="property"><title>The <literal>&quot;secondary-icon-storage-type&quot;</literal> property</title>
<indexterm zone="GtkEntry--secondary-icon-storage-type" role="2.16"><primary sortas="Entry:secondary-icon-storage-type">GtkEntry:secondary-icon-storage-type</primary></indexterm><programlisting>  &quot;secondary-icon-storage-type&quot; <link linkend="GtkImageType">GtkImageType</link>          : Read</programlisting>
<para>
The representation which is used for the secondary icon of the entry.</para>
<para>
</para><para>Default value: GTK_IMAGE_EMPTY</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--secondary-icon-tooltip-markup" role="property"><title>The <literal>&quot;secondary-icon-tooltip-markup&quot;</literal> property</title>
<indexterm zone="GtkEntry--secondary-icon-tooltip-markup" role="2.16"><primary sortas="Entry:secondary-icon-tooltip-markup">GtkEntry:secondary-icon-tooltip-markup</primary></indexterm><programlisting>  &quot;secondary-icon-tooltip-markup&quot; <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
<para>
The contents of the tooltip on the secondary icon, which is marked up
with the <link linkend="PangoMarkupFormat">Pango text markup 
language</link>.
</para>
<para>
Also see <link linkend="gtk-entry-set-icon-tooltip-markup"><function>gtk_entry_set_icon_tooltip_markup()</function></link>.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--secondary-icon-tooltip-text" role="property"><title>The <literal>&quot;secondary-icon-tooltip-text&quot;</literal> property</title>
<indexterm zone="GtkEntry--secondary-icon-tooltip-text" role="2.16"><primary sortas="Entry:secondary-icon-tooltip-text">GtkEntry:secondary-icon-tooltip-text</primary></indexterm><programlisting>  &quot;secondary-icon-tooltip-text&quot; <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
<para>
The contents of the tooltip on the secondary icon.
</para>
<para>
Also see <link linkend="gtk-entry-set-icon-tooltip-text"><function>gtk_entry_set_icon_tooltip_text()</function></link>.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--selection-bound" role="property"><title>The <literal>&quot;selection-bound&quot;</literal> property</title>
<indexterm zone="GtkEntry--selection-bound"><primary sortas="Entry:selection-bound">GtkEntry:selection-bound</primary></indexterm><programlisting>  &quot;selection-bound&quot;          <link linkend="gint">gint</link>                  : Read</programlisting>
<para>The position of the opposite end of the selection from the cursor in chars.</para><para>Allowed values: [0,65535]</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="GtkEntry--shadow-type" role="property"><title>The <literal>&quot;shadow-type&quot;</literal> property</title>
<indexterm zone="GtkEntry--shadow-type" role="2.12"><primary sortas="Entry:shadow-type">GtkEntry:shadow-type</primary></indexterm><programlisting>  &quot;shadow-type&quot;              <link linkend="GtkShadowType">GtkShadowType</link>         : Read / Write</programlisting>
<para>
Which kind of shadow to draw around the entry when 
<link linkend="GtkEntry--has-frame"><type>"has-frame"</type></link> is set to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>.</para>
<para>
</para><para>Default value: GTK_SHADOW_IN</para>
<para>Since 2.12</para>
</refsect2>
<refsect2 id="GtkEntry--text" role="property"><title>The <literal>&quot;text&quot;</literal> property</title>
<indexterm zone="GtkEntry--text"><primary sortas="Entry:text">GtkEntry:text</primary></indexterm><programlisting>  &quot;text&quot;                     <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
<para>The contents of the entry.</para><para>Default value: ""</para>
</refsect2>
<refsect2 id="GtkEntry--text-length" role="property"><title>The <literal>&quot;text-length&quot;</literal> property</title>
<indexterm zone="GtkEntry--text-length" role="2.14"><primary sortas="Entry:text-length">GtkEntry:text-length</primary></indexterm><programlisting>  &quot;text-length&quot;              <link linkend="guint">guint</link>                 : Read</programlisting>
<para>
The length of the text in the <link linkend="GtkEntry"><type>GtkEntry</type></link>.</para>
<para>
</para><para>Allowed values: &lt;= 65535</para>
<para>Default value: 0</para>
<para>Since 2.14</para>
</refsect2>
<refsect2 id="GtkEntry--truncate-multiline" role="property"><title>The <literal>&quot;truncate-multiline&quot;</literal> property</title>
<indexterm zone="GtkEntry--truncate-multiline" role="2.10"><primary sortas="Entry:truncate-multiline">GtkEntry:truncate-multiline</primary></indexterm><programlisting>  &quot;truncate-multiline&quot;       <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>
When <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, pasted multi-line text is truncated to the first line.</para>
<para>
</para><para>Default value: FALSE</para>
<para>Since 2.10</para>
</refsect2>
<refsect2 id="GtkEntry--visibility" role="property"><title>The <literal>&quot;visibility&quot;</literal> property</title>
<indexterm zone="GtkEntry--visibility"><primary sortas="Entry:visibility">GtkEntry:visibility</primary></indexterm><programlisting>  &quot;visibility&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>FALSE displays the "invisible char" instead of the actual text (password mode).</para><para>Default value: TRUE</para>
</refsect2>
<refsect2 id="GtkEntry--width-chars" role="property"><title>The <literal>&quot;width-chars&quot;</literal> property</title>
<indexterm zone="GtkEntry--width-chars"><primary sortas="Entry:width-chars">GtkEntry:width-chars</primary></indexterm><programlisting>  &quot;width-chars&quot;              <link linkend="gint">gint</link>                  : Read / Write</programlisting>
<para>Number of characters to leave space for in the entry.</para><para>Allowed values: &gt;= G_MAXULONG</para>
<para>Default value: -1</para>
</refsect2>
<refsect2 id="GtkEntry--xalign" role="property"><title>The <literal>&quot;xalign&quot;</literal> property</title>
<indexterm zone="GtkEntry--xalign" role="2.4"><primary sortas="Entry:xalign">GtkEntry:xalign</primary></indexterm><programlisting>  &quot;xalign&quot;                   <link linkend="gfloat">gfloat</link>                : Read / Write</programlisting>
<para>
The horizontal alignment, from 0 (left) to 1 (right). 
Reversed for RTL layouts.</para>
<para>
</para><para>Allowed values: [0,1]</para>
<para>Default value: 0</para>
<para>Since 2.4</para>
</refsect2>

</refsect1>
<refsect1 id="GtkEntry.style-property-details" role="style_properties_details">
<title role="style_properties_details.title">Style Property Details</title>
<refsect2 id="GtkEntry--s-icon-prelight" role="property"><title>The <literal>&quot;icon-prelight&quot;</literal> style property</title>
<indexterm zone="GtkEntry--s-icon-prelight" role="2.16"><primary sortas="Entry:icon-prelight">GtkEntry:icon-prelight</primary></indexterm><programlisting>  &quot;icon-prelight&quot;            <link linkend="gboolean">gboolean</link>              : Read</programlisting>
<para>
The prelight style property determines whether activatable
icons prelight on mouseover.</para>
<para>
</para><para>Default value: TRUE</para>
<para>Since 2.16</para>
</refsect2>
<refsect2 id="GtkEntry--s-inner-border" role="property"><title>The <literal>&quot;inner-border&quot;</literal> style property</title>
<indexterm zone="GtkEntry--s-inner-border" role="2.10"><primary sortas="Entry:inner-border">GtkEntry:inner-border</primary></indexterm><programlisting>  &quot;inner-border&quot;             <link linkend="GtkBorder">GtkBorder</link>*            : Read</programlisting>
<para>
Sets the text area's border between the text and the frame.</para>
<para>
</para><para>Since 2.10</para>
</refsect2>
<refsect2 id="GtkEntry--s-invisible-char" role="property"><title>The <literal>&quot;invisible-char&quot;</literal> style property</title>
<indexterm zone="GtkEntry--s-invisible-char"><primary sortas="Entry:invisible-char">GtkEntry:invisible-char</primary></indexterm><programlisting>  &quot;invisible-char&quot;           <link linkend="guint">guint</link>                 : Read</programlisting>
<para>The character to use when masking entry contents (in "password mode").</para><para>Default value: 0</para>
</refsect2>
<refsect2 id="GtkEntry--s-progress-border" role="property"><title>The <literal>&quot;progress-border&quot;</literal> style property</title>
<indexterm zone="GtkEntry--s-progress-border"><primary sortas="Entry:progress-border">GtkEntry:progress-border</primary></indexterm><programlisting>  &quot;progress-border&quot;          <link linkend="GtkBorder">GtkBorder</link>*            : Read</programlisting>
<para>Border around the progress bar.</para></refsect2>
<refsect2 id="GtkEntry--s-state-hint" role="property"><title>The <literal>&quot;state-hint&quot;</literal> style property</title>
<indexterm zone="GtkEntry--s-state-hint" role="2.16"><primary sortas="Entry:state-hint">GtkEntry:state-hint</primary></indexterm><programlisting>  &quot;state-hint&quot;               <link linkend="gboolean">gboolean</link>              : Read</programlisting>
<para>
Indicates whether to pass a proper widget state when
drawing the shadow and the widget background.</para>
<para>
</para><para>Default value: FALSE</para>
<para>Since 2.16</para>
</refsect2>
</refsect1>

<refsect1 id="GtkEntry.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GtkEntry-activate" role="signal"><title>The <literal>&quot;activate&quot;</literal> signal</title>
<indexterm zone="GtkEntry-activate"><primary sortas="Entry::activate">GtkEntry::activate</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                        <link linkend="gpointer">gpointer</link>  user_data)      : Run Last / Action</programlisting>
<para>
A  <link linkend="keybinding-signals">keybinding signal</link>
which gets emitted when the user activates the entry.
</para>
<para>
Applications should not connect to it, but may emit it with
<link linkend="g-signal-emit-by-name"><function>g_signal_emit_by_name()</function></link> if they need to control activation
programmatically.
</para>
<para>
The default bindings for this signal are all forms of the Enter key.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> The entry on which the signal is emitted
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkEntry-backspace" role="signal"><title>The <literal>&quot;backspace&quot;</literal> signal</title>
<indexterm zone="GtkEntry-backspace"><primary sortas="Entry::backspace">GtkEntry::backspace</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                        <link linkend="gpointer">gpointer</link>  user_data)      : Run Last / Action</programlisting>
<para>
The ::backspace signal is a
<link linkend="keybinding-signals">keybinding signal</link>
which gets emitted when the user asks for it.
</para>
<para>
The default bindings for this signal are
Backspace and Shift-Backspace.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> the object which received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkEntry-copy-clipboard" role="signal"><title>The <literal>&quot;copy-clipboard&quot;</literal> signal</title>
<indexterm zone="GtkEntry-copy-clipboard"><primary sortas="Entry::copy-clipboard">GtkEntry::copy-clipboard</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                        <link linkend="gpointer">gpointer</link>  user_data)      : Run Last / Action</programlisting>
<para>
The ::copy-clipboard signal is a
<link linkend="keybinding-signals">keybinding signal</link>
which gets emitted to copy the selection to the clipboard.
</para>
<para>
The default bindings for this signal are
Ctrl-c and Ctrl-Insert.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> the object which received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkEntry-cut-clipboard" role="signal"><title>The <literal>&quot;cut-clipboard&quot;</literal> signal</title>
<indexterm zone="GtkEntry-cut-clipboard"><primary sortas="Entry::cut-clipboard">GtkEntry::cut-clipboard</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                        <link linkend="gpointer">gpointer</link>  user_data)      : Run Last / Action</programlisting>
<para>
The ::cut-clipboard signal is a
<link linkend="keybinding-signals">keybinding signal</link>
which gets emitted to cut the selection to the clipboard.
</para>
<para>
The default bindings for this signal are
Ctrl-x and Shift-Delete.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> the object which received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkEntry-delete-from-cursor" role="signal"><title>The <literal>&quot;delete-from-cursor&quot;</literal> signal</title>
<indexterm zone="GtkEntry-delete-from-cursor"><primary sortas="Entry::delete-from-cursor">GtkEntry::delete-from-cursor</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkEntry">GtkEntry</link>     *entry,
                                                        <link linkend="GtkDeleteType">GtkDeleteType</link> type,
                                                        <link linkend="gint">gint</link>          count,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last / Action</programlisting>
<para>
The ::delete-from-cursor signal is a
<link linkend="keybinding-signals">keybinding signal</link>
which gets emitted when the user initiates a text deletion.
</para>
<para>
If the <parameter>type</parameter> is <link linkend="GTK-DELETE-CHARS--CAPS"><literal>GTK_DELETE_CHARS</literal></link>, GTK+ deletes the selection
if there is one, otherwise it deletes the requested number
of characters.
</para>
<para>
The default bindings for this signal are
Delete for deleting a character and Ctrl-Delete for
deleting a word.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> the object which received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&#160;:</term>
<listitem><simpara> the granularity of the deletion, as a <link linkend="GtkDeleteType"><type>GtkDeleteType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>count</parameter>&#160;:</term>
<listitem><simpara> the number of <parameter>type</parameter> units to delete
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkEntry-icon-press" role="signal"><title>The <literal>&quot;icon-press&quot;</literal> signal</title>
<indexterm zone="GtkEntry-icon-press" role="2.16"><primary sortas="Entry::icon-press">GtkEntry::icon-press</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkEntry">GtkEntry</link>            *entry,
                                                        <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                        <link linkend="GdkEvent">GdkEvent</link>            *event,
                                                        <link linkend="gpointer">gpointer</link>             user_data)      : Run Last</programlisting>
<para>
The ::icon-press signal is emitted when an activatable icon
is clicked.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> The entry on which the signal is emitted
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> The position of the clicked icon
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>event</parameter>&#160;:</term>
<listitem><simpara> the button press event
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist><para>Since 2.16</para></refsect2><refsect2 id="GtkEntry-icon-release" role="signal"><title>The <literal>&quot;icon-release&quot;</literal> signal</title>
<indexterm zone="GtkEntry-icon-release" role="2.16"><primary sortas="Entry::icon-release">GtkEntry::icon-release</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkEntry">GtkEntry</link>            *entry,
                                                        <link linkend="GtkEntryIconPosition">GtkEntryIconPosition</link> icon_pos,
                                                        <link linkend="GdkEvent">GdkEvent</link>            *event,
                                                        <link linkend="gpointer">gpointer</link>             user_data)      : Run Last</programlisting>
<para>
The ::icon-release signal is emitted on the button release from a
mouse click over an activatable icon.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> The entry on which the signal is emitted
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_pos</parameter>&#160;:</term>
<listitem><simpara> The position of the clicked icon
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>event</parameter>&#160;:</term>
<listitem><simpara> the button release event
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist><para>Since 2.16</para></refsect2><refsect2 id="GtkEntry-insert-at-cursor" role="signal"><title>The <literal>&quot;insert-at-cursor&quot;</literal> signal</title>
<indexterm zone="GtkEntry-insert-at-cursor"><primary sortas="Entry::insert-at-cursor">GtkEntry::insert-at-cursor</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                        <link linkend="gchar">gchar</link>    *string,
                                                        <link linkend="gpointer">gpointer</link>  user_data)      : Run Last / Action</programlisting>
<para>
The ::insert-at-cursor signal is a
<link linkend="keybinding-signals">keybinding signal</link>
which gets emitted when the user initiates the insertion of a
fixed string at the cursor.
</para>
<para>
This signal has no default bindings.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> the object which received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>string</parameter>&#160;:</term>
<listitem><simpara> the string to insert
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkEntry-move-cursor" role="signal"><title>The <literal>&quot;move-cursor&quot;</literal> signal</title>
<indexterm zone="GtkEntry-move-cursor"><primary sortas="Entry::move-cursor">GtkEntry::move-cursor</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkEntry">GtkEntry</link>       *entry,
                                                        <link linkend="GtkMovementStep">GtkMovementStep</link> step,
                                                        <link linkend="gint">gint</link>            count,
                                                        <link linkend="gboolean">gboolean</link>        extend_selection,
                                                        <link linkend="gpointer">gpointer</link>        user_data)             : Run Last / Action</programlisting>
<para>
The ::move-cursor signal is a
<link linkend="keybinding-signals">keybinding signal</link>
which gets emitted when the user initiates a cursor movement.
If the cursor is not visible in <parameter>entry</parameter>, this signal causes
the viewport to be moved instead.
</para>
<para>
Applications should not connect to it, but may emit it with
<link linkend="g-signal-emit-by-name"><function>g_signal_emit_by_name()</function></link> if they need to control the cursor
programmatically.
</para>
<para>
The default bindings for this signal come in two variants,
the variant with the Shift modifier extends the selection,
the variant without the Shift modifer does not.
There are too many key combinations to list them all here.
<itemizedlist>
<listitem>Arrow keys move by individual characters/lines</listitem>
<listitem>Ctrl-arrow key combinations move by words/paragraphs</listitem>
<listitem>Home/End keys move to the ends of the buffer</listitem>
</itemizedlist></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> the object which received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>step</parameter>&#160;:</term>
<listitem><simpara> the granularity of the move, as a <link linkend="GtkMovementStep"><type>GtkMovementStep</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>count</parameter>&#160;:</term>
<listitem><simpara> the number of <parameter>step</parameter> units to move
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>extend_selection</parameter>&#160;:</term>
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the move should extend the selection
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkEntry-paste-clipboard" role="signal"><title>The <literal>&quot;paste-clipboard&quot;</literal> signal</title>
<indexterm zone="GtkEntry-paste-clipboard"><primary sortas="Entry::paste-clipboard">GtkEntry::paste-clipboard</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                        <link linkend="gpointer">gpointer</link>  user_data)      : Run Last / Action</programlisting>
<para>
The ::paste-clipboard signal is a
<link linkend="keybinding-signals">keybinding signal</link>
which gets emitted to paste the contents of the clipboard
into the text view.
</para>
<para>
The default bindings for this signal are
Ctrl-v and Shift-Insert.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> the object which received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkEntry-populate-popup" role="signal"><title>The <literal>&quot;populate-popup&quot;</literal> signal</title>
<indexterm zone="GtkEntry-populate-popup"><primary sortas="Entry::populate-popup">GtkEntry::populate-popup</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                        <link linkend="GtkMenu">GtkMenu</link>  *menu,
                                                        <link linkend="gpointer">gpointer</link>  user_data)      : Run Last</programlisting>
<para>
The ::populate-popup signal gets emitted before showing the 
context menu of the entry. 
</para>
<para>
If you need to add items to the context menu, connect
to this signal and append your menuitems to the <parameter>menu</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> The entry on which the signal is emitted
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>menu</parameter>&#160;:</term>
<listitem><simpara> the menu that is being populated
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkEntry-toggle-overwrite" role="signal"><title>The <literal>&quot;toggle-overwrite&quot;</literal> signal</title>
<indexterm zone="GtkEntry-toggle-overwrite"><primary sortas="Entry::toggle-overwrite">GtkEntry::toggle-overwrite</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkEntry">GtkEntry</link> *entry,
                                                        <link linkend="gpointer">gpointer</link>  user_data)      : Run Last / Action</programlisting>
<para>
The ::toggle-overwrite signal is a
<link linkend="keybinding-signals">keybinding signal</link>
which gets emitted to toggle the overwrite mode of the entry.
</para>
<para>
The default bindings for this signal is Insert.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
<listitem><simpara> the object which received the signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>


<refsect1 id="GtkEntry.see-also">
<title>See Also</title>
<para>
<variablelist>
<varlistentry>
<term><link linkend="GtkTextView"><type>GtkTextView</type></link></term>
<listitem><para>a widget for handling multi-line text entry.</para></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GtkEntryCompletion"><type>GtkEntryCompletion</type></link></term>
<listitem><para>adds completion functionality to GtkEntry.</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>

</refentry>
