GtkEntry

CSS nodes

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.

gtk_entry_new ()

GtkWidget *
gtk_entry_new (void);

Creates a new entry.

gtk_entry_new_with_buffer ()

GtkWidget *
gtk_entry_new_with_buffer (GtkEntryBuffer *buffer);

Creates a new entry with the specified text buffer.

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.

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.

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

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:

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:

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

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.

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.

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.

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:

gtk_entry_get_activates_default ()

gboolean
gtk_entry_get_activates_default (GtkEntry *entry);

Retrieves the value set by gtk_entry_set_activates_default().

gtk_entry_get_has_frame ()

gboolean
gtk_entry_get_has_frame (GtkEntry *entry);

Gets the value set by gtk_entry_set_has_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.

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

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

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

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.

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.

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.

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 .

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

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.

Since: 2.4

gtk_entry_get_alignment ()

gfloat
gtk_entry_get_alignment (GtkEntry *entry);

Gets the value set by gtk_entry_set_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.

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

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.

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

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.

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.

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

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

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.

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.

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:

entry
├── image.left
├── image.right
├── undershoot.left
├── undershoot.right
├── [selection]
├── [progress[.pulse]]
╰── [window.popup]

gtk_entry_get_visibility ()

gboolean
gtk_entry_get_visibility (GtkEntry *entry);

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

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.

Since: 2.4

gtk_entry_get_completion ()

GtkEntryCompletion *
gtk_entry_get_completion (GtkEntry *entry);

Returns the auxiliary completion object currently in use by entry .

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.

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

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.

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

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

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

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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

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.

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.

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.

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.

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.

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

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 .

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

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 .

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.

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.

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

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.

Since: 3.6

gtk_entry_get_input_purpose ()

GtkInputPurpose
gtk_entry_get_input_purpose (GtkEntry *entry);

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

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.

Since: 3.6

gtk_entry_get_input_hints ()

GtkInputHints
gtk_entry_get_input_hints (GtkEntry *entry);

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

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.

Since: 3.16

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.

enum GtkEntryIconPosition

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

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

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.

Since: 3.6

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.

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.

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.

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.

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

The “icon-prelight” style property

  “icon-prelight”            gboolean

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

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.

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.

Flags: Read

Since: 2.16

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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 .

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.

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.

Flags: Action