GtkEntry

GtkEntry — A single line text entry field

Synopsis

#include <gtk/gtk.h>

                    GtkEntry;
GtkWidget*          gtk_entry_new                       (void);
GtkWidget*          gtk_entry_new_with_buffer           (GtkEntryBuffer *buffer);
GtkEntryBuffer*     gtk_entry_get_buffer                (GtkEntry *entry);
void                gtk_entry_set_buffer                (GtkEntry *entry,
                                                         GtkEntryBuffer *buffer);
void                gtk_entry_set_text                  (GtkEntry *entry,
                                                         const gchar *text);
const gchar*        gtk_entry_get_text                  (GtkEntry *entry);
guint16             gtk_entry_get_text_length           (GtkEntry *entry);
void                gtk_entry_get_text_area             (GtkEntry *entry,
                                                         GdkRectangle *text_area);
void                gtk_entry_set_visibility            (GtkEntry *entry,
                                                         gboolean visible);
void                gtk_entry_set_invisible_char        (GtkEntry *entry,
                                                         gunichar ch);
void                gtk_entry_unset_invisible_char      (GtkEntry *entry);
void                gtk_entry_set_max_length            (GtkEntry *entry,
                                                         gint max);
gboolean            gtk_entry_get_activates_default     (GtkEntry *entry);
gboolean            gtk_entry_get_has_frame             (GtkEntry *entry);
const GtkBorder*    gtk_entry_get_inner_border          (GtkEntry *entry);
gint                gtk_entry_get_width_chars           (GtkEntry *entry);
void                gtk_entry_set_activates_default     (GtkEntry *entry,
                                                         gboolean setting);
void                gtk_entry_set_has_frame             (GtkEntry *entry,
                                                         gboolean setting);
void                gtk_entry_set_inner_border          (GtkEntry *entry,
                                                         const GtkBorder *border);
void                gtk_entry_set_width_chars           (GtkEntry *entry,
                                                         gint n_chars);
gunichar            gtk_entry_get_invisible_char        (GtkEntry *entry);
void                gtk_entry_set_alignment             (GtkEntry *entry,
                                                         gfloat xalign);
gfloat              gtk_entry_get_alignment             (GtkEntry *entry);
void                gtk_entry_set_overwrite_mode        (GtkEntry *entry,
                                                         gboolean overwrite);
gboolean            gtk_entry_get_overwrite_mode        (GtkEntry *entry);
PangoLayout*        gtk_entry_get_layout                (GtkEntry *entry);
void                gtk_entry_get_layout_offsets        (GtkEntry *entry,
                                                         gint *x,
                                                         gint *y);
gint                gtk_entry_layout_index_to_text_index
                                                        (GtkEntry *entry,
                                                         gint layout_index);
gint                gtk_entry_text_index_to_layout_index
                                                        (GtkEntry *entry,
                                                         gint text_index);
gint                gtk_entry_get_max_length            (GtkEntry *entry);
gboolean            gtk_entry_get_visibility            (GtkEntry *entry);
void                gtk_entry_set_completion            (GtkEntry *entry,
                                                         GtkEntryCompletion *completion);
GtkEntryCompletion * gtk_entry_get_completion           (GtkEntry *entry);
void                gtk_entry_set_cursor_hadjustment    (GtkEntry *entry,
                                                         GtkAdjustment *adjustment);
GtkAdjustment*      gtk_entry_get_cursor_hadjustment    (GtkEntry *entry);
void                gtk_entry_set_progress_fraction     (GtkEntry *entry,
                                                         gdouble fraction);
gdouble             gtk_entry_get_progress_fraction     (GtkEntry *entry);
void                gtk_entry_set_progress_pulse_step   (GtkEntry *entry,
                                                         gdouble fraction);
gdouble             gtk_entry_get_progress_pulse_step   (GtkEntry *entry);
void                gtk_entry_progress_pulse            (GtkEntry *entry);
gboolean            gtk_entry_im_context_filter_keypress
                                                        (GtkEntry *entry,
                                                         GdkEventKey *event);
void                gtk_entry_reset_im_context          (GtkEntry *entry);
enum                GtkEntryIconPosition;
void                gtk_entry_set_icon_from_pixbuf      (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos,
                                                         GdkPixbuf *pixbuf);
void                gtk_entry_set_icon_from_stock       (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos,
                                                         const gchar *stock_id);
void                gtk_entry_set_icon_from_icon_name   (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos,
                                                         const gchar *icon_name);
void                gtk_entry_set_icon_from_gicon       (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos,
                                                         GIcon *icon);
GtkImageType        gtk_entry_get_icon_storage_type     (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos);
GdkPixbuf*          gtk_entry_get_icon_pixbuf           (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos);
const gchar*        gtk_entry_get_icon_stock            (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos);
const gchar*        gtk_entry_get_icon_name             (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos);
GIcon*              gtk_entry_get_icon_gicon            (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos);
void                gtk_entry_set_icon_activatable      (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos,
                                                         gboolean activatable);
gboolean            gtk_entry_get_icon_activatable      (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos);
void                gtk_entry_set_icon_sensitive        (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos,
                                                         gboolean sensitive);
gboolean            gtk_entry_get_icon_sensitive        (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos);
gint                gtk_entry_get_icon_at_pos           (GtkEntry *entry,
                                                         gint x,
                                                         gint y);
void                gtk_entry_set_icon_tooltip_text     (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos,
                                                         const gchar *tooltip);
gchar *             gtk_entry_get_icon_tooltip_text     (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos);
void                gtk_entry_set_icon_tooltip_markup   (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos,
                                                         const gchar *tooltip);
gchar *             gtk_entry_get_icon_tooltip_markup   (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos);
void                gtk_entry_set_icon_drag_source      (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos,
                                                         GtkTargetList *target_list,
                                                         GdkDragAction actions);
gint                gtk_entry_get_current_icon_drag_source
                                                        (GtkEntry *entry);
void                gtk_entry_get_icon_area             (GtkEntry *entry,
                                                         GtkEntryIconPosition icon_pos,
                                                         GdkRectangle *icon_area);

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.

Details

GtkEntry

typedef struct {
} GtkEntry;


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.

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.

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.

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().

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:

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:

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().

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().

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.

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.

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:

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().

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().

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);

This function returns the entry's "inner-border" property. See gtk_entry_set_inner_border() for more information.

entry :

a GtkEntry

Returns :

the entry's GtkBorder, or NULL if none was set. [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().

entry :

a GtkEntry

Returns :

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

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

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.

entry :

a GtkEntry

setting :

new value

gtk_entry_set_inner_border ()

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

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.

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.

entry :

a GtkEntry

n_chars :

width in chars

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().

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.

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().

entry :

a GtkEntry

Returns :

the alignment

Since 2.4


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.

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().

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.

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.

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()).

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()).

entry :

a GtkEntry

text_index :

byte index into the entry contents

Returns :

byte index into the entry layout text

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:

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().

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.

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.

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.

entry :

a GtkEntry

adjustment :

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

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().

entry :

a GtkEntry

Returns :

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

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.

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().

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().

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().

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()).

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.

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.

entry :

a GtkEntry

Since 2.22


enum GtkEntryIconPosition

typedef enum
{
  GTK_ENTRY_ICON_PRIMARY,
  GTK_ENTRY_ICON_SECONDARY
} GtkEntryIconPosition;

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

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


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.

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);

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.

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.

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.

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.

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.

entry :

A GtkEntry

icon_pos :

Icon position

Returns :

A GdkPixbuf, or NULL if no icon is set for this position. [transfer none]

Since 2.16


gtk_entry_get_icon_stock ()

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

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

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

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

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

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]

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.

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.

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.

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.

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. If x, y doesn't lie inside an icon, -1 is returned. This function is intended for use in a "query-tooltip" signal handler.

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().

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.

entry :

a GtkEntry

icon_pos :

the icon position

Returns :

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

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_enty_set_icon_tooltip_text().

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.

entry :

a GtkEntry

icon_pos :

the icon position

Returns :

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

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.

entry :

a GtkIconEntry

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.

entry :

a GtkIconEntry

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()

entry :

A GtkEntry

icon_pos :

Icon position

icon_area :

Return location for the icon's area. [out]

Since 3.0

See Also

GtkTextView, GtkEntryCompletion