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: Whether to activate the default widget when Enter is pressed.

props.attributes: AttrList

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.

The PangoAttribute’s start_index and end_index must refer to the EntryBuffer text, i.e. without the preedit string.

props.buffer: EntryBuffer: The buffer object which actually stores the text.

props.completion: EntryCompletion: The auxiliary completion object to use with the entry.

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

props.enable_emoji_completion: bool: Whether to suggest Emoji replacements for :-delimited names like :heart:.

props.extra_menu: MenuModel: A menu model whose contents will be appended to the context menu.

props.has_frame: bool: Whether the entry should draw a frame.

props.im_module: str

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

See IMContext.

Setting this to a non-None value overrides the system-wide IM module setting. See the GtkSettings gtk_im_module property.

props.input_hints: InputHints

Additional hints that allow input methods to fine-tune their behavior.

Also see input_purpose

props.input_purpose: InputPurpose

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 PASSWORD or PIN is independent from setting visibility.

props.invisible_char: int: The character to use when masking entry contents (“password mode”).

props.invisible_char_set: bool: Whether the invisible char has been set for the GtkEntry.

props.max_length: int: Maximum number of characters for this entry.

props.overwrite_mode: bool: If text is overwritten when typing in the GtkEntry.

props.placeholder_text: str: The text that will be displayed in the GtkEntry when it is empty and unfocused.

props.primary_icon_activatable: bool

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.

props.primary_icon_gicon: Icon: The GIcon to use for the primary icon for the entry.

props.primary_icon_name: str: The icon name to use for the primary icon for the entry.

props.primary_icon_paintable: Paintable: A GdkPaintable to use as the primary icon for the entry.

props.primary_icon_sensitive: bool

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.

props.primary_icon_storage_type: ImageType: The representation which is used for the primary icon of the entry.

props.primary_icon_tooltip_markup: str

The contents of the tooltip on the primary icon, with markup.

Also see set_icon_tooltip_markup.

props.primary_icon_tooltip_text: str

The contents of the tooltip on the primary icon.

Also see set_icon_tooltip_text.

props.progress_fraction: float: The current fraction of the task that’s been completed.

props.progress_pulse_step: float

The fraction of total entry width to move the progress bouncing block for each pulse.

See progress_pulse.

props.scroll_offset: int: Number of pixels of the entry scrolled off the screen to the left.

props.secondary_icon_activatable: bool

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.

props.secondary_icon_gicon: Icon: The GIcon to use for the secondary icon for the entry.

props.secondary_icon_name: str: The icon name to use for the secondary icon for the entry.

props.secondary_icon_paintable: Paintable: A GdkPaintable to use as the secondary icon for the entry.

props.secondary_icon_sensitive: bool

Whether the secondary icon is sensitive.

An insensitive icon appears grayed out. GTK does not emit the icon_press[ and [signal``Gtk`.Entry::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.

props.secondary_icon_storage_type: ImageType: The representation which is used for the secondary icon of the entry.

props.secondary_icon_tooltip_markup: str

The contents of the tooltip on the secondary icon, with markup.

Also see set_icon_tooltip_markup.

props.secondary_icon_tooltip_text: str

The contents of the tooltip on the secondary icon.

Also see set_icon_tooltip_text.

props.show_emoji_icon: bool

props.tabs: TabArray

props.text_length: int: The length of the text in the GtkEntry.

props.truncate_multiline: bool: When True, pasted multi-line text is truncated to the first line.

props.visibility: bool: Whether the entry should show the “invisible char” instead of the actual text (“password mode”).

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

Emitted when an activatable icon is clicked.

Parameters:: icon_pos – The position of the clicked icon

icon_release(icon_pos: EntryIconPosition) → None

Emitted on the button release from a mouse click over an activatable icon.

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