Entry#

class Entry(**properties: Any)#

Superclasses: Widget, InitiallyUnowned, Object

Implemented Interfaces: Accessible, Buildable, CellEditable, ConstraintTarget, Editable

GtkEntry 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 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 set_invisible_char.

GtkEntry has the ability to display progress or activity information behind the text. To make an entry display such information, use set_progress_fraction or 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 set_icon_from_gicon or one of the various other functions that set an icon from an icon name or a paintable. To trigger an action when the user clicks an icon, connect to the icon_press signal. To allow DND operations from an icon, use set_icon_drag_source. To set a tooltip on an icon, use 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#

entry[.flat][.warning][.error]
├── text[.readonly]
├── image.left
├── image.right
╰── [progress[.pulse]]

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 shows progress, it adds a subnode with the name progress. The node has the style class .pulse when the shown progress is pulsing.

For all the subnodes added to the text node in various situations, see Text.

GtkEntry as GtkBuildable#

The GtkEntry implementation of the GtkBuildable interface supports a custom <attributes> element, which supports any number of <attribute> elements. The <attribute> element has attributes named “name“, “value“, “start“ and “end“ and allows you to specify PangoAttribute values for this label.

An example of a UI definition fragment specifying Pango attributes:

<object class="GtkEntry">
  <attributes>
    <attribute name="weight" value="PANGO_WEIGHT_BOLD"/>
    <attribute name="background" value="red" start="5" end="10"/>
  </attributes>
</object>

The start and end attributes specify the range of characters to which the Pango attribute applies. If start and end are not specified, the attribute is applied to the whole text. Note that specifying ranges does not make much sense with translatable attributes. Use markup embedded in the translatable content instead.

Accessibility#

GtkEntry uses the TEXT_BOX role.

Constructors#

class Entry

classmethod new() → Widget#: Creates a new entry.

classmethod new_with_buffer(buffer: EntryBuffer) → Widget#

Creates a new entry with the specified text buffer.

Parameters:: buffer – The buffer to use for the new GtkEntry.

Methods#

class Entry

get_activates_default() → bool#: Retrieves the value set by set_activates_default().

get_alignment() → float#

Gets the value set by set_alignment().

Properties#

class Entry

props.activates_default: bool#: The type of the None singleton.

props.attributes: AttrList#: The type of the None singleton.

props.buffer: EntryBuffer#: The type of the None singleton.

props.completion: EntryCompletion#: The type of the None singleton.

Deprecated since version 4.10: GtkEntryCompletion will be removed in GTK 5.

props.enable_emoji_completion: bool#: The type of the None singleton.

props.extra_menu: MenuModel#: The type of the None singleton.

props.has_frame: bool#: The type of the None singleton.

props.im_module: str#: The type of the None singleton.

props.input_hints: InputHints#: The type of the None singleton.

props.input_purpose: InputPurpose#: The type of the None singleton.

props.invisible_char: int#: The type of the None singleton.

props.invisible_char_set: bool#: The type of the None singleton.

props.max_length: int#: The type of the None singleton.

props.overwrite_mode: bool#: The type of the None singleton.

props.placeholder_text: str#: The type of the None singleton.

props.primary_icon_activatable: bool#: The type of the None singleton.

props.primary_icon_gicon: Icon#: The type of the None singleton.

props.primary_icon_name: str#: The type of the None singleton.

props.primary_icon_paintable: Paintable#: The type of the None singleton.

props.primary_icon_sensitive: bool#: The type of the None singleton.

props.primary_icon_storage_type: ImageType#: The type of the None singleton.

props.primary_icon_tooltip_markup: str#: The type of the None singleton.

props.primary_icon_tooltip_text: str#: The type of the None singleton.

props.progress_fraction: float#: The type of the None singleton.

props.progress_pulse_step: float#: The type of the None singleton.

props.scroll_offset: int#: The type of the None singleton.

props.secondary_icon_activatable: bool#: The type of the None singleton.

props.secondary_icon_gicon: Icon#: The type of the None singleton.

props.secondary_icon_name: str#: The type of the None singleton.

props.secondary_icon_paintable: Paintable#: The type of the None singleton.

props.secondary_icon_sensitive: bool#: The type of the None singleton.

props.secondary_icon_storage_type: ImageType#: The type of the None singleton.

props.secondary_icon_tooltip_markup: str#: The type of the None singleton.

props.secondary_icon_tooltip_text: str#: The type of the None singleton.

props.show_emoji_icon: bool#: The type of the None singleton.

props.tabs: TabArray#: The type of the None singleton.

props.text_length: int#: The type of the None singleton.

props.truncate_multiline: bool#: The type of the None singleton.

props.visibility: bool#: The type of the None singleton.

Signals#

class Entry.signals

activate() → None#

Emitted when the entry is activated.

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

icon_press(icon_pos: EntryIconPosition) → None#

The type of the None singleton.

Parameters:: icon_pos – The position of the clicked icon

icon_release(icon_pos: EntryIconPosition) → None#

The type of the None singleton.

Parameters:: icon_pos – The position of the clicked icon

Virtual Methods#

class Entry

do_activate() → None#: Class handler for the GtkEntry::activate signal. The default implementation activates the gtk.activate-default action.

Fields#

class Entry

parent_instance#