GtkEntry

GtkEntry — A single line text entry field

Functions

GtkWidget * gtk_entry_new ()
GtkWidget * gtk_entry_new_with_buffer ()
GtkEntryBuffer * gtk_entry_get_buffer ()
void gtk_entry_set_buffer ()
void gtk_entry_set_text ()
const gchar * gtk_entry_get_text ()
guint16 gtk_entry_get_text_length ()
void gtk_entry_get_text_area ()
void gtk_entry_set_visibility ()
void gtk_entry_set_invisible_char ()
void gtk_entry_unset_invisible_char ()
void gtk_entry_set_max_length ()
gboolean gtk_entry_get_activates_default ()
gboolean gtk_entry_get_has_frame ()
const GtkBorder * gtk_entry_get_inner_border ()
gint gtk_entry_get_width_chars ()
gint gtk_entry_get_max_width_chars ()
void gtk_entry_set_activates_default ()
void gtk_entry_set_has_frame ()
void gtk_entry_set_inner_border ()
void gtk_entry_set_width_chars ()
void gtk_entry_set_max_width_chars ()
gunichar gtk_entry_get_invisible_char ()
void gtk_entry_set_alignment ()
gfloat gtk_entry_get_alignment ()
void gtk_entry_set_placeholder_text ()
const gchar * gtk_entry_get_placeholder_text ()
void gtk_entry_set_overwrite_mode ()
gboolean gtk_entry_get_overwrite_mode ()
PangoLayout * gtk_entry_get_layout ()
void gtk_entry_get_layout_offsets ()
gint gtk_entry_layout_index_to_text_index ()
gint gtk_entry_text_index_to_layout_index ()
void gtk_entry_set_attributes ()
PangoAttrList * gtk_entry_get_attributes ()
gint gtk_entry_get_max_length ()
gboolean gtk_entry_get_visibility ()
void gtk_entry_set_completion ()
GtkEntryCompletion * gtk_entry_get_completion ()
void gtk_entry_set_cursor_hadjustment ()
GtkAdjustment * gtk_entry_get_cursor_hadjustment ()
void gtk_entry_set_progress_fraction ()
gdouble gtk_entry_get_progress_fraction ()
void gtk_entry_set_progress_pulse_step ()
gdouble gtk_entry_get_progress_pulse_step ()
void gtk_entry_progress_pulse ()
gboolean gtk_entry_im_context_filter_keypress ()
void gtk_entry_reset_im_context ()
PangoTabArray * gtk_entry_get_tabs ()
void gtk_entry_set_tabs ()
void gtk_entry_set_icon_from_pixbuf ()
void gtk_entry_set_icon_from_stock ()
void gtk_entry_set_icon_from_icon_name ()
void gtk_entry_set_icon_from_gicon ()
GtkImageType gtk_entry_get_icon_storage_type ()
GdkPixbuf * gtk_entry_get_icon_pixbuf ()
const gchar * gtk_entry_get_icon_stock ()
const gchar * gtk_entry_get_icon_name ()
GIcon * gtk_entry_get_icon_gicon ()
void gtk_entry_set_icon_activatable ()
gboolean gtk_entry_get_icon_activatable ()
void gtk_entry_set_icon_sensitive ()
gboolean gtk_entry_get_icon_sensitive ()
gint gtk_entry_get_icon_at_pos ()
void gtk_entry_set_icon_tooltip_text ()
gchar * gtk_entry_get_icon_tooltip_text ()
void gtk_entry_set_icon_tooltip_markup ()
gchar * gtk_entry_get_icon_tooltip_markup ()
void gtk_entry_set_icon_drag_source ()
gint gtk_entry_get_current_icon_drag_source ()
void gtk_entry_get_icon_area ()
void gtk_entry_set_input_purpose ()
GtkInputPurpose gtk_entry_get_input_purpose ()
void gtk_entry_set_input_hints ()
GtkInputHints gtk_entry_get_input_hints ()
void gtk_entry_grab_focus_without_selecting ()

Properties

gboolean activates-default Read / Write
PangoAttrList * attributes Read / Write
GtkEntryBuffer * buffer Read / Write / Construct
gboolean caps-lock-warning Read / Write
GtkEntryCompletion * completion Read / Write
gint cursor-position Read
gboolean editable Read / Write
gboolean has-frame Read / Write
gchar * im-module Read / Write
GtkBorder * inner-border Read / Write
GtkInputHints input-hints Read / Write
GtkInputPurpose input-purpose Read / Write
guint invisible-char Read / Write
gboolean invisible-char-set Read / Write
gint max-length Read / Write
gint max-width-chars Read / Write
gboolean overwrite-mode Read / Write
gchar * placeholder-text Read / Write
gboolean populate-all Read / Write
gboolean primary-icon-activatable Read / Write
GIcon * primary-icon-gicon Read / Write
gchar * primary-icon-name Read / Write
GdkPixbuf * primary-icon-pixbuf Read / Write
gboolean primary-icon-sensitive Read / Write
gchar * primary-icon-stock Read / Write
GtkImageType primary-icon-storage-type Read
gchar * primary-icon-tooltip-markup Read / Write
gchar * primary-icon-tooltip-text Read / Write
gdouble progress-fraction Read / Write
gdouble progress-pulse-step Read / Write
gint scroll-offset Read
gboolean secondary-icon-activatable Read / Write
GIcon * secondary-icon-gicon Read / Write
gchar * secondary-icon-name Read / Write
GdkPixbuf * secondary-icon-pixbuf Read / Write
gboolean secondary-icon-sensitive Read / Write
gchar * secondary-icon-stock Read / Write
GtkImageType secondary-icon-storage-type Read
gchar * secondary-icon-tooltip-markup Read / Write
gchar * secondary-icon-tooltip-text Read / Write
gint selection-bound Read
GtkShadowType shadow-type Read / Write
PangoTabArray * tabs Read / Write
gchar * text Read / Write
guint text-length Read
gboolean truncate-multiline Read / Write
gboolean visibility Read / Write
gint width-chars Read / Write
gfloat xalign Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkEntry
                ├── GtkSearchEntry
                ╰── GtkSpinButton

Implemented Interfaces

GtkEntry implements AtkImplementorIface, GtkBuildable, GtkEditable and GtkCellEditable.

Includes

#include <gtk/gtk.h>

Description

The GtkEntry widget is a single line text entry widget. A fairly large set of key bindings are supported by default. If the entered text is longer than the allocation of the widget, the widget will scroll so that the cursor position is visible.

When using an entry for passwords and other sensitive information, it can be put into “password mode” using gtk_entry_set_visibility(). 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 gtk_entry_set_invisible_char(). 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 “caps-lock-warning” property.

Since 2.16, GtkEntry has the ability to display progress or activity information behind the text. To make an entry display such information, use gtk_entry_set_progress_fraction() or gtk_entry_set_progress_pulse_step().

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 gtk_entry_set_icon_from_gicon() 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 “icon-press” signal. To allow DND operations from an icon, use gtk_entry_set_icon_drag_source(). To set a tooltip on an icon, use gtk_entry_set_icon_tooltip_text() or the corresponding function for markup.

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.

CSS nodes

1
2
3
4
5
6
7
8
entry
├── image.left
├── image.right
├── undershoot.left
├── undershoot.right
├── [selection]
├── [progress[.pulse]]
╰── [window.popup]

GtkEntry has a main node with the name entry. Depending on the properties of the entry, the style classes .read-only and .flat may appear. The style classes .warning and .error may also be used with entries.

When the entry shows icons, it adds subnodes with the name image and the style class .left or .right, depending on where the icon appears.

When the entry has a selection, it adds a subnode with the name selection.

When the entry shows progress, it adds a subnode with the name progress. The node has the style class .pulse when the shown progress is pulsing.

The CSS node for a context menu is added as a subnode below entry as well.

The undershoot nodes are used to draw the underflow indication when content is scrolled out of view. These nodes get the .left and .right style classes added depending on where the indication is drawn.

When touch is used and touch selection handles are shown, they are using CSS nodes with name cursor-handle. They get the .top or .bottom style class depending on where they are shown in relation to the selection. If there is just a single handle for the text cursor, it gets the style class .insertion-cursor.

Functions

gtk_entry_new ()

GtkWidget *
gtk_entry_new (void);

Creates a new entry.

Returns

a new GtkEntry.


gtk_entry_new_with_buffer ()

GtkWidget *
gtk_entry_new_with_buffer (GtkEntryBuffer *buffer);

Creates a new entry with the specified text buffer.

Parameters

buffer

The buffer to use for the new GtkEntry.

 

Returns

a new GtkEntry

Since: 2.18


gtk_entry_get_buffer ()

GtkEntryBuffer *
gtk_entry_get_buffer (GtkEntry *entry);

Get the GtkEntryBuffer object which holds the text for this widget.

Parameters

entry

a GtkEntry

 

Returns

A GtkEntryBuffer object.

[transfer none]

Since: 2.18


gtk_entry_set_buffer ()

void
gtk_entry_set_buffer (GtkEntry *entry,
                      GtkEntryBuffer *buffer);

Set the GtkEntryBuffer object which holds the text for this widget.

Parameters

entry

a GtkEntry

 

buffer

a GtkEntryBuffer

 

Since: 2.18


gtk_entry_set_text ()

void
gtk_entry_set_text (GtkEntry *entry,
                    const gchar *text);

Sets the text in the widget to the given value, replacing the current contents.

See gtk_entry_buffer_set_text().

Parameters

entry

a GtkEntry

 

text

the new text

 

gtk_entry_get_text ()

const gchar *
gtk_entry_get_text (GtkEntry *entry);

Retrieves the contents of the entry widget. See also gtk_editable_get_chars().

This is equivalent to:

1
2
3
GtkEntryBuffer *buffer;
buffer = gtk_entry_get_buffer (entry);
gtk_entry_buffer_get_text (buffer);

Parameters

entry

a GtkEntry

 

Returns

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.


gtk_entry_get_text_length ()

guint16
gtk_entry_get_text_length (GtkEntry *entry);

Retrieves the current length of the text in entry .

This is equivalent to:

1
2
3
GtkEntryBuffer *buffer;
buffer = gtk_entry_get_buffer (entry);
gtk_entry_buffer_get_length (buffer);

Parameters

entry

a GtkEntry

 

Returns

the current number of characters in GtkEntry, or 0 if there are none.

Since: 2.14


gtk_entry_get_text_area ()

void
gtk_entry_get_text_area (GtkEntry *entry,
                         GdkRectangle *text_area);

Gets the area where the entry’s text is drawn. This function is useful when drawing something to the entry in a draw callback.

If the entry is not realized, text_area is filled with zeros.

See also gtk_entry_get_icon_area().

Parameters

entry

a GtkEntry

 

text_area

Return location for the text area.

[out]

Since: 3.0


gtk_entry_set_visibility ()

void
gtk_entry_set_visibility (GtkEntry *entry,
                          gboolean visible);

Sets whether the contents of the entry are visible or not. When visibility is set to FALSE, characters are displayed as the invisible char, and will also appear that way when the text in the entry widget is copied elsewhere.

By default, GTK+ picks the best invisible character available in the current font, but it can be changed with gtk_entry_set_invisible_char().

Note that you probably want to set “input-purpose” to GTK_INPUT_PURPOSE_PASSWORD or GTK_INPUT_PURPOSE_PIN to inform input methods about the purpose of this entry, in addition to setting visibility to FALSE.

Parameters

entry

a GtkEntry

 

visible

TRUE if the contents of the entry are displayed as plaintext

 

gtk_entry_set_invisible_char ()

void
gtk_entry_set_invisible_char (GtkEntry *entry,
                              gunichar ch);

Sets the character to use in place of the actual text when gtk_entry_set_visibility() has been called to set text visibility to FALSE. 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.

Parameters

entry

a GtkEntry

 

ch

a Unicode character

 

gtk_entry_unset_invisible_char ()

void
gtk_entry_unset_invisible_char (GtkEntry *entry);

Unsets the invisible char previously set with gtk_entry_set_invisible_char(). So that the default invisible char is used again.

Parameters

entry

a GtkEntry

 

Since: 2.16


gtk_entry_set_max_length ()

void
gtk_entry_set_max_length (GtkEntry *entry,
                          gint max);

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.

This is equivalent to:

1
2
3
GtkEntryBuffer *buffer;
buffer = gtk_entry_get_buffer (entry);
gtk_entry_buffer_set_max_length (buffer, max);

Parameters

entry

a GtkEntry

 

max

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.

 

gtk_entry_get_activates_default ()

gboolean
gtk_entry_get_activates_default (GtkEntry *entry);

Retrieves the value set by gtk_entry_set_activates_default().

Parameters

entry

a GtkEntry

 

Returns

TRUE if the entry will activate the default widget


gtk_entry_get_has_frame ()

gboolean
gtk_entry_get_has_frame (GtkEntry *entry);

Gets the value set by gtk_entry_set_has_frame().

Parameters

entry

a GtkEntry

 

Returns

whether the entry has a beveled frame


gtk_entry_get_inner_border ()

const GtkBorder *
gtk_entry_get_inner_border (GtkEntry *entry);

gtk_entry_get_inner_border has been deprecated since version 3.4 and should not be used in newly-written code.

Use the standard border and padding CSS properties (through objects like GtkStyleContext and GtkCssProvider); the value returned by this function is ignored by GtkEntry.

This function returns the entry’s “inner-border” property. See gtk_entry_set_inner_border() for more information.

Parameters

entry

a GtkEntry

 

Returns

the entry’s GtkBorder, or NULL if none was set.

[nullable][transfer none]

Since: 2.10


gtk_entry_get_width_chars ()

gint
gtk_entry_get_width_chars (GtkEntry *entry);

Gets the value set by gtk_entry_set_width_chars().

Parameters

entry

a GtkEntry

 

Returns

number of chars to request space for, or negative if unset


gtk_entry_get_max_width_chars ()

gint
gtk_entry_get_max_width_chars (GtkEntry *entry);

Retrieves the desired maximum width of entry , in characters. See gtk_entry_set_max_width_chars().

Parameters

entry

a GtkEntry

 

Returns

the maximum width of the entry, in characters

Since: 3.12


gtk_entry_set_activates_default ()

void
gtk_entry_set_activates_default (GtkEntry *entry,
                                 gboolean setting);

If setting is TRUE, pressing Enter in the entry 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.

(For experts: if setting is TRUE, the entry calls gtk_window_activate_default() on the window containing the entry, in the default handler for the “activate” signal.)

Parameters

entry

a GtkEntry

 

setting

TRUE to activate window’s default widget on Enter keypress

 

gtk_entry_set_has_frame ()

void
gtk_entry_set_has_frame (GtkEntry *entry,
                         gboolean setting);

Sets whether the entry has a beveled frame around it.

Parameters

entry

a GtkEntry

 

setting

new value

 

gtk_entry_set_inner_border ()

void
gtk_entry_set_inner_border (GtkEntry *entry,
                            const GtkBorder *border);

gtk_entry_set_inner_border has been deprecated since version 3.4 and should not be used in newly-written code.

Use the standard border and padding CSS properties (through objects like GtkStyleContext and GtkCssProvider); the value set with this function is ignored by GtkEntry.

Sets entry’s inner-border property to border , or clears it if NULL is passed. The inner-border is the area around the entry’s text, but inside its frame.

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.

Parameters

entry

a GtkEntry

 

border

a GtkBorder, or NULL.

[allow-none]

Since: 2.10


gtk_entry_set_width_chars ()

void
gtk_entry_set_width_chars (GtkEntry *entry,
                           gint n_chars);

Changes the size request of the entry to be about the right size for n_chars characters. Note that it changes the size request, the size can still be affected by how you pack the widget into containers. If n_chars is -1, the size reverts to the default entry size.

Parameters

entry

a GtkEntry

 

n_chars

width in chars

 

gtk_entry_set_max_width_chars ()

void
gtk_entry_set_max_width_chars (GtkEntry *entry,
                               gint n_chars);

Sets the desired maximum width in characters of entry .

Parameters

entry

a GtkEntry

 

n_chars

the new desired maximum width, in characters

 

Since: 3.12


gtk_entry_get_invisible_char ()

gunichar
gtk_entry_get_invisible_char (GtkEntry *entry);

Retrieves the character displayed in place of the real characters for entries with visibility set to false. See gtk_entry_set_invisible_char().

Parameters

entry

a GtkEntry

 

Returns

the current invisible char, or 0, if the entry does not show invisible text at all.


gtk_entry_set_alignment ()

void
gtk_entry_set_alignment (GtkEntry *entry,
                         gfloat xalign);

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.

Parameters

entry

a GtkEntry

 

xalign

The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts

 

Since: 2.4


gtk_entry_get_alignment ()

gfloat
gtk_entry_get_alignment (GtkEntry *entry);

Gets the value set by gtk_entry_set_alignment().

Parameters

entry

a GtkEntry

 

Returns

the alignment

Since: 2.4


gtk_entry_set_placeholder_text ()

void
gtk_entry_set_placeholder_text (GtkEntry *entry,
                                const gchar *text);

Sets text to be displayed in entry when it is empty and unfocused. This can be used to give a visual hint of the expected contents of the GtkEntry.

Note that since the placeholder text gets removed when the entry received focus, using this feature is a bit problematic if the entry is given the initial focus in a window. Sometimes this can be worked around by delaying the initial focus setting until the first key event arrives.

Parameters

entry

a GtkEntry

 

text

a string to be displayed when entry is empty and unfocused, or NULL.

[nullable]

Since: 3.2


gtk_entry_get_placeholder_text ()

const gchar *
gtk_entry_get_placeholder_text (GtkEntry *entry);

Retrieves the text that will be displayed when entry is empty and unfocused

Parameters

entry

a GtkEntry

 

Returns

a pointer to the placeholder text as a string. This string points to internally allocated storage in the widget and must not be freed, modified or stored.

Since: 3.2


gtk_entry_set_overwrite_mode ()

void
gtk_entry_set_overwrite_mode (GtkEntry *entry,
                              gboolean overwrite);

Sets whether the text is overwritten when typing in the GtkEntry.

Parameters

entry

a GtkEntry

 

overwrite

new value

 

Since: 2.14


gtk_entry_get_overwrite_mode ()

gboolean
gtk_entry_get_overwrite_mode (GtkEntry *entry);

Gets the value set by gtk_entry_set_overwrite_mode().

Parameters

entry

a GtkEntry

 

Returns

whether the text is overwritten when typing.

Since: 2.14


gtk_entry_get_layout ()

PangoLayout *
gtk_entry_get_layout (GtkEntry *entry);

Gets the PangoLayout used to display the entry. The layout is useful to e.g. convert text positions to pixel positions, in combination with gtk_entry_get_layout_offsets(). The returned layout is owned by the entry and must not be modified or freed by the caller.

Keep in mind that the layout text may contain a preedit string, so gtk_entry_layout_index_to_text_index() and gtk_entry_text_index_to_layout_index() are needed to convert byte indices in the layout to byte indices in the entry contents.

Parameters

entry

a GtkEntry

 

Returns

the PangoLayout for this entry.

[transfer none]


gtk_entry_get_layout_offsets ()

void
gtk_entry_get_layout_offsets (GtkEntry *entry,
                              gint *x,
                              gint *y);

Obtains the position of the PangoLayout 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.

Also useful to convert mouse events into coordinates inside the PangoLayout, e.g. to take some action if some part of the entry text is clicked.

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 PangoLayout functions you need to convert to and from pixels using PANGO_PIXELS() or PANGO_SCALE.

Keep in mind that the layout text may contain a preedit string, so gtk_entry_layout_index_to_text_index() and gtk_entry_text_index_to_layout_index() are needed to convert byte indices in the layout to byte indices in the entry contents.

Parameters

entry

a GtkEntry

 

x

location to store X offset of layout, or NULL.

[out][allow-none]

y

location to store Y offset of layout, or NULL.

[out][allow-none]

gtk_entry_layout_index_to_text_index ()

gint
gtk_entry_layout_index_to_text_index (GtkEntry *entry,
                                      gint layout_index);

Converts from a position in the entry contents (returned by gtk_entry_get_text()) to a position in the entry’s PangoLayout (returned by gtk_entry_get_layout(), with text retrieved via pango_layout_get_text()).

Parameters

entry

a GtkEntry

 

layout_index

byte index into the entry layout text

 

Returns

byte index into the entry contents


gtk_entry_text_index_to_layout_index ()

gint
gtk_entry_text_index_to_layout_index (GtkEntry *entry,
                                      gint text_index);

Converts from a position in the entry’s PangoLayout (returned by gtk_entry_get_layout()) to a position in the entry contents (returned by gtk_entry_get_text()).

Parameters

entry

a GtkEntry

 

text_index

byte index into the entry contents

 

Returns

byte index into the entry layout text


gtk_entry_set_attributes ()

void
gtk_entry_set_attributes (GtkEntry *entry,
                          PangoAttrList *attrs);

Sets a PangoAttrList; the attributes in the list are applied to the entry text.

Parameters

entry

a GtkEntry

 

attrs

a PangoAttrList

 

Since: 3.6


gtk_entry_get_attributes ()

PangoAttrList *
gtk_entry_get_attributes (GtkEntry *entry);

Gets the attribute list that was set on the entry using gtk_entry_set_attributes(), if any.

Parameters

entry

a GtkEntry

 

Returns

the attribute list, or NULL if none was set.

[transfer none][nullable]

Since: 3.6


gtk_entry_get_max_length ()

gint
gtk_entry_get_max_length (GtkEntry *entry);

Retrieves the maximum allowed length of the text in entry . See gtk_entry_set_max_length().

This is equivalent to:

1
2
3
GtkEntryBuffer *buffer;
buffer = gtk_entry_get_buffer (entry);
gtk_entry_buffer_get_max_length (buffer);

Parameters

entry

a GtkEntry

 

Returns

the maximum allowed number of characters in GtkEntry, or 0 if there is no maximum.


gtk_entry_get_visibility ()

gboolean
gtk_entry_get_visibility (GtkEntry *entry);

Retrieves whether the text in entry is visible. See gtk_entry_set_visibility().

Parameters

entry

a GtkEntry

 

Returns

TRUE if the text is currently visible


gtk_entry_set_completion ()

void
gtk_entry_set_completion (GtkEntry *entry,
                          GtkEntryCompletion *completion);

Sets completion to be the auxiliary completion object to use with entry . All further configuration of the completion mechanism is done on completion using the GtkEntryCompletion API. Completion is disabled if completion is set to NULL.

Parameters

entry

A GtkEntry

 

completion

The GtkEntryCompletion or NULL.

[allow-none]

Since: 2.4


gtk_entry_get_completion ()

GtkEntryCompletion *
gtk_entry_get_completion (GtkEntry *entry);

Returns the auxiliary completion object currently in use by entry .

Parameters

entry

A GtkEntry

 

Returns

The auxiliary completion object currently in use by entry .

[transfer none]

Since: 2.4


gtk_entry_set_cursor_hadjustment ()

void
gtk_entry_set_cursor_hadjustment (GtkEntry *entry,
                                  GtkAdjustment *adjustment);

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 gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment.

The adjustment has to be in pixel units and in the same coordinate system as the entry.

Parameters

entry

a GtkEntry

 

adjustment

an adjustment which should be adjusted when the cursor is moved, or NULL.

[nullable]

Since: 2.12


gtk_entry_get_cursor_hadjustment ()

GtkAdjustment *
gtk_entry_get_cursor_hadjustment (GtkEntry *entry);

Retrieves the horizontal cursor adjustment for the entry. See gtk_entry_set_cursor_hadjustment().

Parameters

entry

a GtkEntry

 

Returns

the horizontal cursor adjustment, or NULL if none has been set.

[transfer none][nullable]

Since: 2.12


gtk_entry_set_progress_fraction ()

void
gtk_entry_set_progress_fraction (GtkEntry *entry,
                                 gdouble fraction);

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.

Parameters

entry

a GtkEntry

 

fraction

fraction of the task that’s been completed

 

Since: 2.16


gtk_entry_get_progress_fraction ()

gdouble
gtk_entry_get_progress_fraction (GtkEntry *entry);

Returns the current fraction of the task that’s been completed. See gtk_entry_set_progress_fraction().

Parameters

entry

a GtkEntry

 

Returns

a fraction from 0.0 to 1.0

Since: 2.16


gtk_entry_set_progress_pulse_step ()

void
gtk_entry_set_progress_pulse_step (GtkEntry *entry,
                                   gdouble fraction);

Sets the fraction of total entry width to move the progress bouncing block for each call to gtk_entry_progress_pulse().

Parameters

entry

a GtkEntry

 

fraction

fraction between 0.0 and 1.0

 

Since: 2.16


gtk_entry_get_progress_pulse_step ()

gdouble
gtk_entry_get_progress_pulse_step (GtkEntry *entry);

Retrieves the pulse step set with gtk_entry_set_progress_pulse_step().

Parameters

entry

a GtkEntry

 

Returns

a fraction from 0.0 to 1.0

Since: 2.16


gtk_entry_progress_pulse ()

void
gtk_entry_progress_pulse (GtkEntry *entry);

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 gtk_entry_progress_pulse() causes the block to move by a little bit (the amount of movement per pulse is determined by gtk_entry_set_progress_pulse_step()).

Parameters

entry

a GtkEntry

 

Since: 2.16


gtk_entry_im_context_filter_keypress ()

gboolean
gtk_entry_im_context_filter_keypress (GtkEntry *entry,
                                      GdkEventKey *event);

Allow the GtkEntry input method to internally handle key press and release events. If this function returns TRUE, then no further processing should be done for this key event. See gtk_im_context_filter_keypress().

Note that you are expected to call this function from your handler when overriding key event handling. This is needed in the case when you need to insert your own key handling between the input method and the default key event handling of the GtkEntry. See gtk_text_view_reset_im_context() for an example of use.

Parameters

entry

a GtkEntry

 

event

the key event.

[type Gdk.EventKey]

Returns

TRUE if the input method handled the key event.

Since: 2.22


gtk_entry_reset_im_context ()

void
gtk_entry_reset_im_context (GtkEntry *entry);

Reset the input method context of the entry if needed.

This can be necessary in the case where modifying the buffer would confuse on-going input method behavior.

Parameters

entry

a GtkEntry

 

Since: 2.22


gtk_entry_get_tabs ()

PangoTabArray *
gtk_entry_get_tabs (GtkEntry *entry);

Gets the tabstops that were set on the entry using gtk_entry_set_tabs(), if any.

Parameters

entry

a GtkEntry

 

Returns

the tabstops, or NULL if none was set.

[nullable][transfer none]

Since: 3.10


gtk_entry_set_tabs ()

void
gtk_entry_set_tabs (GtkEntry *entry,
                    PangoTabArray *tabs);

Sets a PangoTabArray; the tabstops in the array are applied to the entry text.

Parameters

entry

a GtkEntry

 

tabs

a PangoTabArray

 

Since: 3.10


gtk_entry_set_icon_from_pixbuf ()

void
gtk_entry_set_icon_from_pixbuf (GtkEntry *entry,
                                GtkEntryIconPosition icon_pos,
                                GdkPixbuf *pixbuf);

Sets the icon shown in the specified position using a pixbuf.

If pixbuf is NULL, no icon will be shown in the specified position.

Parameters

entry

a GtkEntry

 

icon_pos

Icon position

 

pixbuf

A GdkPixbuf, or NULL.

[allow-none]

Since: 2.16


gtk_entry_set_icon_from_stock ()

void
gtk_entry_set_icon_from_stock (GtkEntry *entry,
                               GtkEntryIconPosition icon_pos,
                               const gchar *stock_id);

gtk_entry_set_icon_from_stock has been deprecated since version 3.10 and should not be used in newly-written code.

Use gtk_entry_set_icon_from_icon_name() instead.

Sets the icon shown in the entry at the specified position from a stock image.

If stock_id is NULL, no icon will be shown in the specified position.

Parameters

entry

A GtkEntry

 

icon_pos

Icon position

 

stock_id

The name of the stock item, or NULL.

[allow-none]

Since: 2.16


gtk_entry_set_icon_from_icon_name ()

void
gtk_entry_set_icon_from_icon_name (GtkEntry *entry,
                                   GtkEntryIconPosition icon_pos,
                                   const gchar *icon_name);

Sets the icon shown in the entry at the specified position from the current icon theme.

If the icon name isn’t known, a “broken image” icon will be displayed instead.

If icon_name is NULL, no icon will be shown in the specified position.

Parameters

entry

A GtkEntry

 

icon_pos

The position at which to set the icon

 

icon_name

An icon name, or NULL.

[allow-none]

Since: 2.16


gtk_entry_set_icon_from_gicon ()

void
gtk_entry_set_icon_from_gicon (GtkEntry *entry,
                               GtkEntryIconPosition icon_pos,
                               GIcon *icon);

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.

If icon is NULL, no icon will be shown in the specified position.

Parameters

entry

A GtkEntry

 

icon_pos

The position at which to set the icon

 

icon

The icon to set, or NULL.

[allow-none]

Since: 2.16


gtk_entry_get_icon_storage_type ()

GtkImageType
gtk_entry_get_icon_storage_type (GtkEntry *entry,
                                 GtkEntryIconPosition icon_pos);

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 GTK_IMAGE_EMPTY.

Parameters

entry

a GtkEntry

 

icon_pos

Icon position

 

Returns

image representation being used

Since: 2.16


gtk_entry_get_icon_pixbuf ()

GdkPixbuf *
gtk_entry_get_icon_pixbuf (GtkEntry *entry,
                           GtkEntryIconPosition icon_pos);

Retrieves the image used for the icon.

Unlike the other methods of setting and getting icon data, this method will work regardless of whether the icon was set using a GdkPixbuf, a GIcon, a stock item, or an icon name.

Parameters

entry

A GtkEntry

 

icon_pos

Icon position

 

Returns

A GdkPixbuf, or NULL if no icon is set for this position.

[transfer none][nullable]

Since: 2.16


gtk_entry_get_icon_stock ()

const gchar *
gtk_entry_get_icon_stock (GtkEntry *entry,
                          GtkEntryIconPosition icon_pos);

gtk_entry_get_icon_stock has been deprecated since version 3.10 and should not be used in newly-written code.

Use gtk_entry_get_icon_name() instead.

Retrieves the stock id used for the icon, or NULL if there is no icon or if the icon was set by some other method (e.g., by pixbuf, icon name or gicon).

Parameters

entry

A GtkEntry

 

icon_pos

Icon position

 

Returns

A stock id, or NULL if no icon is set or if the icon wasn’t set from a stock id

Since: 2.16


gtk_entry_get_icon_name ()

const gchar *
gtk_entry_get_icon_name (GtkEntry *entry,
                         GtkEntryIconPosition icon_pos);

Retrieves the icon name used for the icon, or NULL if there is no icon or if the icon was set by some other method (e.g., by pixbuf, stock or gicon).

Parameters

entry

A GtkEntry

 

icon_pos

Icon position

 

Returns

An icon name, or NULL if no icon is set or if the icon wasn’t set from an icon name.

[nullable]

Since: 2.16


gtk_entry_get_icon_gicon ()

GIcon *
gtk_entry_get_icon_gicon (GtkEntry *entry,
                          GtkEntryIconPosition icon_pos);

Retrieves the GIcon used for the icon, or NULL if there is no icon or if the icon was set by some other method (e.g., by stock, pixbuf, or icon name).

Parameters

entry

A GtkEntry

 

icon_pos

Icon position

 

Returns

A GIcon, or NULL if no icon is set or if the icon is not a GIcon.

[transfer none][nullable]

Since: 2.16


gtk_entry_set_icon_activatable ()

void
gtk_entry_set_icon_activatable (GtkEntry *entry,
                                GtkEntryIconPosition icon_pos,
                                gboolean activatable);

Sets whether the icon is activatable.

Parameters

entry

A GtkEntry

 

icon_pos

Icon position

 

activatable

TRUE if the icon should be activatable

 

Since: 2.16


gtk_entry_get_icon_activatable ()

gboolean
gtk_entry_get_icon_activatable (GtkEntry *entry,
                                GtkEntryIconPosition icon_pos);

Returns whether the icon is activatable.

Parameters

entry

a GtkEntry

 

icon_pos

Icon position

 

Returns

TRUE if the icon is activatable.

Since: 2.16


gtk_entry_set_icon_sensitive ()

void
gtk_entry_set_icon_sensitive (GtkEntry *entry,
                              GtkEntryIconPosition icon_pos,
                              gboolean sensitive);

Sets the sensitivity for the specified icon.

Parameters

entry

A GtkEntry

 

icon_pos

Icon position

 

sensitive

Specifies whether the icon should appear sensitive or insensitive

 

Since: 2.16


gtk_entry_get_icon_sensitive ()

gboolean
gtk_entry_get_icon_sensitive (GtkEntry *entry,
                              GtkEntryIconPosition icon_pos);

Returns whether the icon appears sensitive or insensitive.

Parameters

entry

a GtkEntry

 

icon_pos

Icon position

 

Returns

TRUE if the icon is sensitive.

Since: 2.16


gtk_entry_get_icon_at_pos ()

gint
gtk_entry_get_icon_at_pos (GtkEntry *entry,
                           gint x,
                           gint y);

Finds the icon at the given position and return its index. The position’s coordinates are relative to the entry ’s top left corner. If x , y doesn’t lie inside an icon, -1 is returned. This function is intended for use in a “query-tooltip” signal handler.

Parameters

entry

a GtkEntry

 

x

the x coordinate of the position to find

 

y

the y coordinate of the position to find

 

Returns

the index of the icon at the given position, or -1

Since: 2.16


gtk_entry_set_icon_tooltip_text ()

void
gtk_entry_set_icon_tooltip_text (GtkEntry *entry,
                                 GtkEntryIconPosition icon_pos,
                                 const gchar *tooltip);

Sets tooltip as the contents of the tooltip for the icon at the specified position.

Use NULL for tooltip to remove an existing tooltip.

See also gtk_widget_set_tooltip_text() and gtk_entry_set_icon_tooltip_markup().

Parameters

entry

a GtkEntry

 

icon_pos

the icon position

 

tooltip

the contents of the tooltip for the icon, or NULL.

[allow-none]

Since: 2.16


gtk_entry_get_icon_tooltip_text ()

gchar *
gtk_entry_get_icon_tooltip_text (GtkEntry *entry,
                                 GtkEntryIconPosition icon_pos);

Gets the contents of the tooltip on the icon at the specified position in entry .

Parameters

entry

a GtkEntry

 

icon_pos

the icon position

 

Returns

the tooltip text, or NULL. Free the returned string with g_free() when done.

[nullable]

Since: 2.16


gtk_entry_set_icon_tooltip_markup ()

void
gtk_entry_set_icon_tooltip_markup (GtkEntry *entry,
                                   GtkEntryIconPosition icon_pos,
                                   const gchar *tooltip);

Sets tooltip as the contents of the tooltip for the icon at the specified position. tooltip is assumed to be marked up with the Pango text markup language.

Use NULL for tooltip to remove an existing tooltip.

See also gtk_widget_set_tooltip_markup() and gtk_entry_set_icon_tooltip_text().

Parameters

entry

a GtkEntry

 

icon_pos

the icon position

 

tooltip

the contents of the tooltip for the icon, or NULL.

[allow-none]

Since: 2.16


gtk_entry_get_icon_tooltip_markup ()

gchar *
gtk_entry_get_icon_tooltip_markup (GtkEntry *entry,
                                   GtkEntryIconPosition icon_pos);

Gets the contents of the tooltip on the icon at the specified position in entry .

Parameters

entry

a GtkEntry

 

icon_pos

the icon position

 

Returns

the tooltip text, or NULL. Free the returned string with g_free() when done.

[nullable]

Since: 2.16


gtk_entry_set_icon_drag_source ()

void
gtk_entry_set_icon_drag_source (GtkEntry *entry,
                                GtkEntryIconPosition icon_pos,
                                GtkTargetList *target_list,
                                GdkDragAction actions);

Sets up the icon at the given position so that GTK+ will start a drag operation when the user clicks and drags the icon.

To handle the drag operation, you need to connect to the usual “drag-data-get” (or possibly “drag-data-delete”) signal, and use gtk_entry_get_current_icon_drag_source() in your signal handler to find out if the drag was started from an icon.

By default, GTK+ uses the icon as the drag icon. You can use the “drag-begin” signal to set a different icon. Note that you have to use g_signal_connect_after() to ensure that your signal handler gets executed after the default handler.

Parameters

entry

a GtkEntry

 

icon_pos

icon position

 

target_list

the targets (data formats) in which the data can be provided

 

actions

a bitmask of the allowed drag actions

 

Since: 2.16


gtk_entry_get_current_icon_drag_source ()

gint
gtk_entry_get_current_icon_drag_source
                               (GtkEntry *entry);

Returns the index of the icon which is the source of the current DND operation, or -1.

This function is meant to be used in a “drag-data-get” callback.

Parameters

entry

a GtkEntry

 

Returns

index of the icon which is the source of the current DND operation, or -1.

Since: 2.16


gtk_entry_get_icon_area ()

void
gtk_entry_get_icon_area (GtkEntry *entry,
                         GtkEntryIconPosition icon_pos,
                         GdkRectangle *icon_area);

Gets the area where entry’s icon at icon_pos is drawn. This function is useful when drawing something to the entry in a draw callback.

If the entry is not realized or has no icon at the given position, icon_area is filled with zeros.

See also gtk_entry_get_text_area()

Parameters

entry

A GtkEntry

 

icon_pos

Icon position

 

icon_area

Return location for the icon’s area.

[out]

Since: 3.0


gtk_entry_set_input_purpose ()

void
gtk_entry_set_input_purpose (GtkEntry *entry,
                             GtkInputPurpose purpose);

Sets the “input-purpose” property which can be used by on-screen keyboards and other input methods to adjust their behaviour.

Parameters

entry

a GtkEntry

 

purpose

the purpose

 

Since: 3.6


gtk_entry_get_input_purpose ()

GtkInputPurpose
gtk_entry_get_input_purpose (GtkEntry *entry);

Gets the value of the “input-purpose” property.

Parameters

entry

a GtkEntry

 

Since: 3.6


gtk_entry_set_input_hints ()

void
gtk_entry_set_input_hints (GtkEntry *entry,
                           GtkInputHints hints);

Sets the “input-hints” property, which allows input methods to fine-tune their behaviour.

Parameters

entry

a GtkEntry

 

hints

the hints

 

Since: 3.6


gtk_entry_get_input_hints ()

GtkInputHints
gtk_entry_get_input_hints (GtkEntry *entry);

Gets the value of the “input-hints” property.

Parameters

entry

a GtkEntry

 

Since: 3.6


gtk_entry_grab_focus_without_selecting ()

void
gtk_entry_grab_focus_without_selecting
                               (GtkEntry *entry);

Causes entry to have keyboard focus.

It behaves like gtk_widget_grab_focus(), except that it doesn't select the contents of the entry. You only want to call this on some special entries which the user usually doesn't want to replace all text in, such as search-as-you-type entries.

Parameters

entry

a GtkEntry

 

Since: 3.16

Types and Values

struct GtkEntry

struct GtkEntry;

struct GtkEntryClass

struct GtkEntryClass {
  GtkWidgetClass parent_class;

  /* Hook to customize right-click popup */
  void (* populate_popup)   (GtkEntry       *entry,
                             GtkWidget      *popup);

  /* Action signals
   */
  void (* activate)           (GtkEntry             *entry);
  void (* move_cursor)        (GtkEntry             *entry,
			       GtkMovementStep       step,
			       gint                  count,
			       gboolean              extend_selection);
  void (* insert_at_cursor)   (GtkEntry             *entry,
			       const gchar          *str);
  void (* delete_from_cursor) (GtkEntry             *entry,
			       GtkDeleteType         type,
			       gint                  count);
  void (* backspace)          (GtkEntry             *entry);
  void (* cut_clipboard)      (GtkEntry             *entry);
  void (* copy_clipboard)     (GtkEntry             *entry);
  void (* paste_clipboard)    (GtkEntry             *entry);
  void (* toggle_overwrite)   (GtkEntry             *entry);

  /* hooks to add other objects beside the entry (like in GtkSpinButton) */
  void (* get_text_area_size) (GtkEntry       *entry,
			       gint           *x,
			       gint           *y,
			       gint           *width,
			       gint           *height);
  void (* get_frame_size)     (GtkEntry       *entry,
                               gint           *x,
                               gint           *y,
			       gint           *width,
			       gint           *height);
};

Class structure for GtkEntry. All virtual functions have a default implementation. Derived classes may set the virtual function pointers for the signal handlers to NULL, but must keep get_text_area_size and get_frame_size non-NULL; either use the default implementation, or provide a custom one.

Members

populate_popup ()

Class handler for the “populate-popup” signal. If non-NULL, this will be called to add additional entries to the context menu when it is displayed.

 

activate ()

Class handler for the “activate” signal. The default implementation calls gtk_window_activate_default() on the entry’s top-level window.

 

move_cursor ()

Class handler for the “move-cursor” signal. The default implementation specifies the standard GtkEntry cursor movement behavior.

 

insert_at_cursor ()

Class handler for the “insert-at-cursor” signal. The default implementation inserts text at the cursor.

 

delete_from_cursor ()

Class handler for the “delete-from-cursor” signal. The default implementation deletes the selection or the specified number of characters or words.

 

backspace ()

Class handler for the “backspace” signal. The default implementation deletes the selection or a single character or word.

 

cut_clipboard ()

Class handler for the “cut-clipboard” signal. The default implementation cuts the selection, if one exists.

 

copy_clipboard ()

Class handler for the “copy-clipboard” signal. The default implementation copies the selection, if one exists.

 

paste_clipboard ()

Class handler for the “paste-clipboard” signal. The default implementation pastes at the current cursor position or over the current selection if one exists.

 

toggle_overwrite ()

Class handler for the “toggle-overwrite” signal. The default implementation toggles overwrite mode and blinks the cursor.

 

get_text_area_size ()

Calculate the size of the text area, which is its allocated width and requested height, minus space for margins and borders. This virtual function must be non-NULL.

 

get_frame_size ()

Calculate the size of the text area frame, which is its allocated width and requested height, minus space for margins and borders, and taking baseline and text height into account. This virtual function must be non-NULL.

 

enum GtkEntryIconPosition

Specifies the side of the entry at which an icon is placed.

Members

GTK_ENTRY_ICON_PRIMARY

At the beginning of the entry (depending on the text direction).

 

GTK_ENTRY_ICON_SECONDARY

At the end of the entry (depending on the text direction).

 

Since: 2.16


enum GtkInputPurpose

Describes primary purpose of the input widget. This information is useful for on-screen keyboards and similar input methods to decide which keys should be presented to the user.

Note that the purpose is not meant to impose a totally strict rule about allowed characters, and does not replace input validation. It is fine for an on-screen keyboard to let the user override the character set restriction that is expressed by the purpose. The application is expected to validate the entry contents, even if it specified a purpose.

The difference between GTK_INPUT_PURPOSE_DIGITS and GTK_INPUT_PURPOSE_NUMBER is that the former accepts only digits while the latter also some punctuation (like commas or points, plus, minus) and “e” or “E” as in 3.14E+000.

This enumeration may be extended in the future; input methods should interpret unknown values as “free form”.

Members

GTK_INPUT_PURPOSE_FREE_FORM

Allow any character

 

GTK_INPUT_PURPOSE_ALPHA

Allow only alphabetic characters

 

GTK_INPUT_PURPOSE_DIGITS

Allow only digits

 

GTK_INPUT_PURPOSE_NUMBER

Edited field expects numbers

 

GTK_INPUT_PURPOSE_PHONE

Edited field expects phone number

 

GTK_INPUT_PURPOSE_URL

Edited field expects URL

 

GTK_INPUT_PURPOSE_EMAIL

Edited field expects email address

 

GTK_INPUT_PURPOSE_NAME

Edited field expects the name of a person

 

GTK_INPUT_PURPOSE_PASSWORD

Like GTK_INPUT_PURPOSE_FREE_FORM , but characters are hidden

 

GTK_INPUT_PURPOSE_PIN

Like GTK_INPUT_PURPOSE_DIGITS , but characters are hidden

 

Since: 3.6


enum GtkInputHints

Describes hints that might be taken into account by input methods or applications. Note that input methods may already tailor their behaviour according to the GtkInputPurpose of the entry.

Some common sense is expected when using these flags - mixing GTK_INPUT_HINT_LOWERCASE with any of the uppercase hints makes no sense.

This enumeration may be extended in the future; input methods should ignore unknown values.

Members

GTK_INPUT_HINT_NONE

No special behaviour suggested

 

GTK_INPUT_HINT_SPELLCHECK

Suggest checking for typos

 

GTK_INPUT_HINT_NO_SPELLCHECK

Suggest not checking for typos

 

GTK_INPUT_HINT_WORD_COMPLETION

Suggest word completion

 

GTK_INPUT_HINT_LOWERCASE

Suggest to convert all text to lowercase

 

GTK_INPUT_HINT_UPPERCASE_CHARS

Suggest to capitalize all text

 

GTK_INPUT_HINT_UPPERCASE_WORDS

Suggest to capitalize the first character of each word

 

GTK_INPUT_HINT_UPPERCASE_SENTENCES

Suggest to capitalize the first word of each sentence

 

GTK_INPUT_HINT_INHIBIT_OSK

Suggest to not show an onscreen keyboard (e.g for a calculator that already has all the keys).

 

GTK_INPUT_HINT_VERTICAL_WRITING

The text is vertical. Since 3.18

 

Since: 3.6

Property Details

The “activates-default” property

  “activates-default”        gboolean

Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed.

Flags: Read / Write

Default value: FALSE


The “attributes” property

  “attributes”               PangoAttrList *

A list of Pango attributes to apply to the text of the entry.

This is mainly useful to change the size or weight of the text.

Flags: Read / Write

Since: 3.6


The “buffer” property

  “buffer”                   GtkEntryBuffer *

Text buffer object which actually stores entry text.

Flags: Read / Write / Construct


The “caps-lock-warning” property

  “caps-lock-warning”        gboolean

Whether password entries will show a warning when Caps Lock is on.

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.

Flags: Read / Write

Default value: TRUE

Since: 2.16


The “completion” property

  “completion”               GtkEntryCompletion *

The auxiliary completion object to use with the entry.

Flags: Read / Write

Since: 3.2


The “cursor-position” property

  “cursor-position”          gint

The current position of the insertion cursor in chars.

Flags: Read

Allowed values: [0,65535]

Default value: 0


The “editable” property

  “editable”                 gboolean

Whether the entry contents can be edited.

Flags: Read / Write

Default value: TRUE


The “has-frame” property

  “has-frame”                gboolean

FALSE removes outside bevel from entry.

Flags: Read / Write

Default value: TRUE


The “im-module” property

  “im-module”                gchar *

Which IM (input method) module should be used for this entry. See GtkIMContext.

Setting this to a non-NULL value overrides the system-wide IM module setting. See the GtkSettings “gtk-im-module” property.

Flags: Read / Write

Default value: NULL

Since: 2.16


The “inner-border” property

  “inner-border”             GtkBorder *

Sets the text area's border between the text and the frame.

GtkEntry:inner-border has been deprecated since version 3.4 and should not be used in newly-written code.

Use the standard border and padding CSS properties (through objects like GtkStyleContext and GtkCssProvider); the value of this style property is ignored.

Flags: Read / Write

Since: 2.10


The “input-hints” property

  “input-hints”              GtkInputHints

Additional hints (beyond “input-purpose”) that allow input methods to fine-tune their behaviour.

Flags: Read / Write

Since: 3.6


The “input-purpose” property

  “input-purpose”            GtkInputPurpose

The purpose of this text field.

This property can be used by on-screen keyboards and other input methods to adjust their behaviour.

Note that setting the purpose to GTK_INPUT_PURPOSE_PASSWORD or GTK_INPUT_PURPOSE_PIN is independent from setting “visibility”.

Flags: Read / Write

Default value: GTK_INPUT_PURPOSE_FREE_FORM

Since: 3.6


The “invisible-char” property

  “invisible-char”           guint

The invisible character is used when masking entry contents (in \"password mode\")"). When it is not explicitly set with the “invisible-char” property, GTK+ determines the character to use from a list of possible candidates, depending on availability in the current font.

This style property allows the theme to prepend a character to the list of candidates.

Flags: Read / Write

Default value: '*'

Since: 2.18


The “invisible-char-set” property

  “invisible-char-set”       gboolean

Whether the invisible char has been set for the GtkEntry.

Flags: Read / Write

Default value: FALSE

Since: 2.16


The “max-length” property

  “max-length”               gint

Maximum number of characters for this entry. Zero if no maximum.

Flags: Read / Write

Allowed values: [0,65535]

Default value: 0


The “max-width-chars” property

  “max-width-chars”          gint

The desired maximum width of the entry, in characters. If this property is set to -1, the width will be calculated automatically.

Flags: Read / Write

Allowed values: >= -1

Default value: -1

Since: 3.12


The “overwrite-mode” property

  “overwrite-mode”           gboolean

If text is overwritten when typing in the GtkEntry.

Flags: Read / Write

Default value: FALSE

Since: 2.14


The “placeholder-text” property

  “placeholder-text”         gchar *

The text that will be displayed in the GtkEntry when it is empty and unfocused.

Flags: Read / Write

Default value: NULL

Since: 3.2


The “populate-all” property

  “populate-all”             gboolean

If :populate-all is TRUE, the “populate-popup” signal is also emitted for touch popups.

Flags: Read / Write

Default value: FALSE

Since: 3.8


The “primary-icon-activatable” property

  “primary-icon-activatable” gboolean

Whether the primary icon is activatable.

GTK+ emits the “icon-press” and “icon-release” signals only on sensitive, activatable icons.

Sensitive, but non-activatable icons can be used for purely informational purposes.

Flags: Read / Write

Default value: TRUE

Since: 2.16


The “primary-icon-gicon” property

  “primary-icon-gicon”       GIcon *

The GIcon to use for the primary icon for the entry.

Flags: Read / Write

Since: 2.16


The “primary-icon-name” property

  “primary-icon-name”        gchar *

The icon name to use for the primary icon for the entry.

Flags: Read / Write

Default value: NULL

Since: 2.16


The “primary-icon-pixbuf” property

  “primary-icon-pixbuf”      GdkPixbuf *

A pixbuf to use as the primary icon for the entry.

Flags: Read / Write

Since: 2.16


The “primary-icon-sensitive” property

  “primary-icon-sensitive”   gboolean

Whether the primary icon is sensitive.

An insensitive icon appears grayed out. GTK+ does not emit the “icon-press” and “icon-release” signals and does not allow DND from insensitive icons.

An icon should be set insensitive if the action that would trigger when clicked is currently not available.

Flags: Read / Write

Default value: TRUE

Since: 2.16


The “primary-icon-stock” property

  “primary-icon-stock”       gchar *

The stock id to use for the primary icon for the entry.

GtkEntry:primary-icon-stock has been deprecated since version 3.10 and should not be used in newly-written code.

Use “primary-icon-name” instead.

Flags: Read / Write

Default value: NULL

Since: 2.16


The “primary-icon-storage-type” property

  “primary-icon-storage-type” GtkImageType

The representation which is used for the primary icon of the entry.

Flags: Read

Default value: GTK_IMAGE_EMPTY

Since: 2.16


The “primary-icon-tooltip-markup” property

  “primary-icon-tooltip-markup” gchar *

The contents of the tooltip on the primary icon, which is marked up with the Pango text markup language.

Also see gtk_entry_set_icon_tooltip_markup().

Flags: Read / Write

Default value: NULL

Since: 2.16


The “primary-icon-tooltip-text” property

  “primary-icon-tooltip-text” gchar *

The contents of the tooltip on the primary icon.

Also see gtk_entry_set_icon_tooltip_text().

Flags: Read / Write

Default value: NULL

Since: 2.16


The “progress-fraction” property

  “progress-fraction”        gdouble

The current fraction of the task that's been completed.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0

Since: 2.16


The “progress-pulse-step” property

  “progress-pulse-step”      gdouble

The fraction of total entry width to move the progress bouncing block for each call to gtk_entry_progress_pulse().

Flags: Read / Write

Allowed values: [0,1]

Default value: 0.1

Since: 2.16


The “scroll-offset” property

  “scroll-offset”            gint

Number of pixels of the entry scrolled off the screen to the left.

Flags: Read

Allowed values: >= 0

Default value: 0


The “secondary-icon-activatable” property

  “secondary-icon-activatable” gboolean

Whether the secondary icon is activatable.

GTK+ emits the “icon-press” and “icon-release” signals only on sensitive, activatable icons.

Sensitive, but non-activatable icons can be used for purely informational purposes.

Flags: Read / Write

Default value: TRUE

Since: 2.16


The “secondary-icon-gicon” property

  “secondary-icon-gicon”     GIcon *

The GIcon to use for the secondary icon for the entry.

Flags: Read / Write

Since: 2.16


The “secondary-icon-name” property

  “secondary-icon-name”      gchar *

The icon name to use for the secondary icon for the entry.

Flags: Read / Write

Default value: NULL

Since: 2.16


The “secondary-icon-pixbuf” property

  “secondary-icon-pixbuf”    GdkPixbuf *

An pixbuf to use as the secondary icon for the entry.

Flags: Read / Write

Since: 2.16


The “secondary-icon-sensitive” property

  “secondary-icon-sensitive” gboolean

Whether the secondary icon is sensitive.

An insensitive icon appears grayed out. GTK+ does not emit the “icon-press” and “icon-release” signals and does not allow DND from insensitive icons.

An icon should be set insensitive if the action that would trigger when clicked is currently not available.

Flags: Read / Write

Default value: TRUE

Since: 2.16


The “secondary-icon-stock” property

  “secondary-icon-stock”     gchar *

The stock id to use for the secondary icon for the entry.

GtkEntry:secondary-icon-stock has been deprecated since version 3.10 and should not be used in newly-written code.

Use “secondary-icon-name” instead.

Flags: Read / Write

Default value: NULL

Since: 2.16


The “secondary-icon-storage-type” property

  “secondary-icon-storage-type” GtkImageType

The representation which is used for the secondary icon of the entry.

Flags: Read

Default value: GTK_IMAGE_EMPTY

Since: 2.16


The “secondary-icon-tooltip-markup” property

  “secondary-icon-tooltip-markup” gchar *

The contents of the tooltip on the secondary icon, which is marked up with the Pango text markup language.

Also see gtk_entry_set_icon_tooltip_markup().

Flags: Read / Write

Default value: NULL

Since: 2.16


The “secondary-icon-tooltip-text” property

  “secondary-icon-tooltip-text” gchar *

The contents of the tooltip on the secondary icon.

Also see gtk_entry_set_icon_tooltip_text().

Flags: Read / Write

Default value: NULL

Since: 2.16


The “selection-bound” property

  “selection-bound”          gint

The position of the opposite end of the selection from the cursor in chars.

Flags: Read

Allowed values: [0,65535]

Default value: 0


The “shadow-type” property

  “shadow-type”              GtkShadowType

Which kind of shadow to draw around the entry when “has-frame” is set to TRUE.

GtkEntry:shadow-type has been deprecated since version 3.20 and should not be used in newly-written code.

Use CSS to determine the style of the border; the value of this style property is ignored.

Flags: Read / Write

Default value: GTK_SHADOW_IN

Since: 2.12


The “tabs” property

  “tabs”                     PangoTabArray *

A list of tabstop locations to apply to the text of the entry.

Flags: Read / Write


The “text” property

  “text”                     gchar *

The contents of the entry.

Flags: Read / Write

Default value: ""


The “text-length” property

  “text-length”              guint

The length of the text in the GtkEntry.

Flags: Read

Allowed values: <= 65535

Default value: 0

Since: 2.14


The “truncate-multiline” property

  “truncate-multiline”       gboolean

When TRUE, pasted multi-line text is truncated to the first line.

Flags: Read / Write

Default value: FALSE

Since: 2.10


The “visibility” property

  “visibility”               gboolean

FALSE displays the "invisible char" instead of the actual text (password mode).

Flags: Read / Write

Default value: TRUE


The “width-chars” property

  “width-chars”              gint

Number of characters to leave space for in the entry.

Flags: Read / Write

Allowed values: >= -1

Default value: -1


The “xalign” property

  “xalign”                   gfloat

The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.

Flags: Read / Write

Allowed values: [0,1]

Default value: 0

Since: 2.4

Style Property Details

The “icon-prelight” style property

  “icon-prelight”            gboolean

The prelight style property determines whether activatable icons prelight on mouseover.

GtkEntry:icon-prelight has been deprecated since version 3.20 and should not be used in newly-written code.

Use CSS to control the appearance of prelighted icons; the value of this style property is ignored.

Flags: Read

Default value: TRUE

Since: 2.16


The “inner-border” style property

  “inner-border”             GtkBorder *

Sets the text area's border between the text and the frame.

GtkEntry:inner-border has been deprecated since version 3.4 and should not be used in newly-written code.

Use the standard border and padding CSS properties (through objects like GtkStyleContext and GtkCssProvider); the value of this style property is ignored.

Flags: Read

Since: 2.10


The “invisible-char” style property

  “invisible-char”           guint

The invisible character is used when masking entry contents (in \"password mode\")"). When it is not explicitly set with the “invisible-char” property, GTK+ determines the character to use from a list of possible candidates, depending on availability in the current font.

This style property allows the theme to prepend a character to the list of candidates.

Flags: Read

Default value: 0

Since: 2.18


The “progress-border” style property

  “progress-border”          GtkBorder *

The border around the progress bar in the entry.

GtkEntry:progress-border has been deprecated since version 3.4 and should not be used in newly-written code.

Use the standard margin CSS property (through objects like GtkStyleContext and GtkCssProvider); the value of this style property is ignored.

Flags: Read

Since: 2.16

Signal Details

The “activate” signal

void
user_function (GtkEntry *entry,
               gpointer  user_data)

The ::activate signal is emitted when the user hits the Enter key.

While this signal is used as a keybinding signal, it is also commonly used by applications to intercept activation of entries.

The default bindings for this signal are all forms of the Enter key.

Parameters

entry

The entry on which the signal is emitted

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “backspace” signal

void
user_function (GtkEntry *entry,
               gpointer  user_data)

The ::backspace signal is a keybinding signal which gets emitted when the user asks for it.

The default bindings for this signal are Backspace and Shift-Backspace.

Parameters

entry

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “copy-clipboard” signal

void
user_function (GtkEntry *entry,
               gpointer  user_data)

The ::copy-clipboard signal is a keybinding signal which gets emitted to copy the selection to the clipboard.

The default bindings for this signal are Ctrl-c and Ctrl-Insert.

Parameters

entry

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “cut-clipboard” signal

void
user_function (GtkEntry *entry,
               gpointer  user_data)

The ::cut-clipboard signal is a keybinding signal which gets emitted to cut the selection to the clipboard.

The default bindings for this signal are Ctrl-x and Shift-Delete.

Parameters

entry

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “delete-from-cursor” signal

void
user_function (GtkEntry     *entry,
               GtkDeleteType type,
               gint          count,
               gpointer      user_data)

The ::delete-from-cursor signal is a keybinding signal which gets emitted when the user initiates a text deletion.

If the type is GTK_DELETE_CHARS, GTK+ deletes the selection if there is one, otherwise it deletes the requested number of characters.

The default bindings for this signal are Delete for deleting a character and Ctrl-Delete for deleting a word.

Parameters

entry

the object which received the signal

 

type

the granularity of the deletion, as a GtkDeleteType

 

count

the number of type units to delete

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “icon-press” signal

void
user_function (GtkEntry            *entry,
               GtkEntryIconPosition icon_pos,
               GdkEvent            *event,
               gpointer             user_data)

The ::icon-press signal is emitted when an activatable icon is clicked.

Parameters

entry

The entry on which the signal is emitted

 

icon_pos

The position of the clicked icon

 

event

the button press event.

[type Gdk.EventButton]

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 2.16


The “icon-release” signal

void
user_function (GtkEntry            *entry,
               GtkEntryIconPosition icon_pos,
               GdkEvent            *event,
               gpointer             user_data)

The ::icon-release signal is emitted on the button release from a mouse click over an activatable icon.

Parameters

entry

The entry on which the signal is emitted

 

icon_pos

The position of the clicked icon

 

event

the button release event.

[type Gdk.EventButton]

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 2.16


The “insert-at-cursor” signal

void
user_function (GtkEntry *entry,
               gchar    *string,
               gpointer  user_data)

The ::insert-at-cursor signal is a keybinding signal which gets emitted when the user initiates the insertion of a fixed string at the cursor.

This signal has no default bindings.

Parameters

entry

the object which received the signal

 

string

the string to insert

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “move-cursor” signal

void
user_function (GtkEntry       *entry,
               GtkMovementStep step,
               gint            count,
               gboolean        extend_selection,
               gpointer        user_data)

The ::move-cursor signal is a keybinding signal which gets emitted when the user initiates a cursor movement. If the cursor is not visible in entry , this signal causes the viewport to be moved instead.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.

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.

  • Arrow keys move by individual characters/lines

  • Ctrl-arrow key combinations move by words/paragraphs

  • Home/End keys move to the ends of the buffer

Parameters

entry

the object which received the signal

 

step

the granularity of the move, as a GtkMovementStep

 

count

the number of step units to move

 

extend_selection

TRUE if the move should extend the selection

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “paste-clipboard” signal

void
user_function (GtkEntry *entry,
               gpointer  user_data)

The ::paste-clipboard signal is a keybinding signal which gets emitted to paste the contents of the clipboard into the text view.

The default bindings for this signal are Ctrl-v and Shift-Insert.

Parameters

entry

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “populate-popup” signal

void
user_function (GtkEntry  *entry,
               GtkWidget *popup,
               gpointer   user_data)

The ::populate-popup signal gets emitted before showing the context menu of the entry.

If you need to add items to the context menu, connect to this signal and append your items to the widget , which will be a GtkMenu in this case.

If “populate-all” is TRUE, this signal will also be emitted to populate touch popups. In this case, widget will be a different container, e.g. a GtkToolbar. The signal handler should not make assumptions about the type of widget .

Parameters

entry

The entry on which the signal is emitted

 

popup

the container that is being populated

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “preedit-changed” signal

void
user_function (GtkEntry *entry,
               gchar    *preedit,
               gpointer  user_data)

If an input method is used, the typed text will not immediately be committed to the buffer. So if you are interested in the text, connect to this signal.

Parameters

entry

the object which received the signal

 

preedit

the current preedit string

 

user_data

user data set when the signal handler was connected.

 

Flags: Action

Since: 2.20


The “toggle-overwrite” signal

void
user_function (GtkEntry *entry,
               gpointer  user_data)

The ::toggle-overwrite signal is a keybinding signal which gets emitted to toggle the overwrite mode of the entry.

The default bindings for this signal is Insert.

Parameters

entry

the object which received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Action