Gtk.Entry¶

Example¶

Subclasses:: Gtk.SearchEntry, Gtk.SpinButton

Methods¶

Inherited:: Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gtk.CellEditable (3), Gtk.Editable (13)
Structs:: Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`new` ()
class	`new_with_buffer` (buffer)
	`get_activates_default` ()
	`get_alignment` ()
	`get_attributes` ()
	`get_buffer` ()
	`get_completion` ()
	`get_current_icon_drag_source` ()
	`get_cursor_hadjustment` ()
	`get_has_frame` ()
	`get_icon_activatable` (icon_pos)
	`get_icon_area` (icon_pos)
	`get_icon_at_pos` (x, y)
	`get_icon_gicon` (icon_pos)
	`get_icon_name` (icon_pos)
	`get_icon_pixbuf` (icon_pos)
	`get_icon_sensitive` (icon_pos)
	`get_icon_stock` (icon_pos)
	`get_icon_storage_type` (icon_pos)
	`get_icon_tooltip_markup` (icon_pos)
	`get_icon_tooltip_text` (icon_pos)
	`get_inner_border` ()
	`get_input_hints` ()
	`get_input_purpose` ()
	`get_invisible_char` ()
	`get_layout` ()
	`get_layout_offsets` ()
	`get_max_length` ()
	`get_max_width_chars` ()
	`get_overwrite_mode` ()
	`get_placeholder_text` ()
	`get_progress_fraction` ()
	`get_progress_pulse_step` ()
	`get_tabs` ()
	`get_text` ()
	`get_text_area` ()
	`get_text_length` ()
	`get_visibility` ()
	`get_width_chars` ()
	`grab_focus_without_selecting` ()
	`im_context_filter_keypress` (event)
	`layout_index_to_text_index` (layout_index)
	`progress_pulse` ()
	`reset_im_context` ()
	`set_activates_default` (setting)
	`set_alignment` (xalign)
	`set_attributes` (attrs)
	`set_buffer` (buffer)
	`set_completion` (completion)
	`set_cursor_hadjustment` (adjustment)
	`set_has_frame` (setting)
	`set_icon_activatable` (icon_pos, activatable)
	`set_icon_drag_source` (icon_pos, target_list, actions)
	`set_icon_from_gicon` (icon_pos, icon)
	`set_icon_from_icon_name` (icon_pos, icon_name)
	`set_icon_from_pixbuf` (icon_pos, pixbuf)
	`set_icon_from_stock` (icon_pos, stock_id)
	`set_icon_sensitive` (icon_pos, sensitive)
	`set_icon_tooltip_markup` (icon_pos, tooltip)
	`set_icon_tooltip_text` (icon_pos, tooltip)
	`set_inner_border` (border)
	`set_input_hints` (hints)
	`set_input_purpose` (purpose)
	`set_invisible_char` (ch)
	`set_max_length` (max)
	`set_max_width_chars` (n_chars)
	`set_overwrite_mode` (overwrite)
	`set_placeholder_text` (text)
	`set_progress_fraction` (fraction)
	`set_progress_pulse_step` (fraction)
	`set_tabs` (tabs)
	`set_text` (text)
	`set_visibility` (visible)
	`set_width_chars` (n_chars)
	`text_index_to_layout_index` (text_index)
	`unset_invisible_char` ()

Virtual Methods¶

Inherited:: Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10), Gtk.CellEditable (3), Gtk.Editable (10)

	`do_activate` ()
	`do_backspace` ()
	`do_copy_clipboard` ()
	`do_cut_clipboard` ()
	`do_delete_from_cursor` (type, count)
	`do_get_frame_size` (x, y, width, height)
	`do_get_text_area_size` (x, y, width, height)
	`do_insert_at_cursor` (str)
	`do_insert_emoji` ()
	`do_move_cursor` (step, count, extend_selection)
	`do_paste_clipboard` ()
	`do_populate_popup` (popup)
	`do_toggle_overwrite` ()

Properties¶

Inherited:: Gtk.Widget (39), Gtk.CellEditable (1)

Name	Type	Flags	Short Description
`activates-default`	`bool`	r/w/en	Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed
`attributes`	`Pango.AttrList`	r/w/en	A list of style attributes to apply to the text of the label
`buffer`	`Gtk.EntryBuffer`	r/w/c/en	Text buffer object which actually stores entry text
`caps-lock-warning`	`bool`	r/w/en	Whether password entries will show a warning when Caps Lock is on
`completion`	`Gtk.EntryCompletion`	r/w/en	The auxiliary completion object
`cursor-position`	`int`	r	The current position of the insertion cursor in chars
`editable`	`bool`	r/w/en	Whether the entry contents can be edited
`enable-emoji-completion`	`bool`	r/w/en	Whether to suggest Emoji replacements
`has-frame`	`bool`	r/w/en	`False` removes outside bevel from entry
`im-module`	`str`	r/w/en	Which IM module should be used
`inner-border`	`Gtk.Border`	d/r/w/en	Border between text and frame. Overrides the inner-border style property `deprecated`
`input-hints`	`Gtk.InputHints`	r/w/en	Hints for the text field behaviour
`input-purpose`	`Gtk.InputPurpose`	r/w/en	Purpose of the text field
`invisible-char`	`int`	r/w/en	The character to use when masking entry contents (in “password mode”)
`invisible-char-set`	`bool`	r/w	Whether the invisible character has been set
`max-length`	`int`	r/w/en	Maximum number of characters for this entry. Zero if no maximum
`max-width-chars`	`int`	r/w/en	The desired maximum width of the entry, in characters
`overwrite-mode`	`bool`	r/w/en	Whether new text overwrites existing text
`placeholder-text`	`str`	r/w/en	Show text in the entry when it’s empty and unfocused
`populate-all`	`bool`	r/w/en	Whether to emit `::populate-popup` for touch popups
`primary-icon-activatable`	`bool`	r/w/en	Whether the primary icon is activatable
`primary-icon-gicon`	`Gio.Icon`	r/w/en	`Gio.Icon` for primary icon
`primary-icon-name`	`str`	r/w/en	Icon name for primary icon
`primary-icon-pixbuf`	`GdkPixbuf.Pixbuf`	r/w/en	Primary pixbuf for the entry
`primary-icon-sensitive`	`bool`	r/w/en	Whether the primary icon is sensitive
`primary-icon-stock`	`str`	d/r/w/en	Stock ID for primary icon `deprecated`
`primary-icon-storage-type`	`Gtk.ImageType`	r	The representation being used for primary icon
`primary-icon-tooltip-markup`	`str`	r/w/en	The contents of the tooltip on the primary icon
`primary-icon-tooltip-text`	`str`	r/w/en	The contents of the tooltip on the primary icon
`progress-fraction`	`float`	r/w/en	The current fraction of the task that’s been completed
`progress-pulse-step`	`float`	r/w/en	The fraction of total entry width to move the progress bouncing block for each call to `Gtk.Entry.progress_pulse`()
`scroll-offset`	`int`	r/en	Number of pixels of the entry scrolled off the screen to the left
`secondary-icon-activatable`	`bool`	r/w/en	Whether the secondary icon is activatable
`secondary-icon-gicon`	`Gio.Icon`	r/w/en	`Gio.Icon` for secondary icon
`secondary-icon-name`	`str`	r/w/en	Icon name for secondary icon
`secondary-icon-pixbuf`	`GdkPixbuf.Pixbuf`	r/w/en	Secondary pixbuf for the entry
`secondary-icon-sensitive`	`bool`	r/w/en	Whether the secondary icon is sensitive
`secondary-icon-stock`	`str`	d/r/w/en	Stock ID for secondary icon `deprecated`
`secondary-icon-storage-type`	`Gtk.ImageType`	r	The representation being used for secondary icon
`secondary-icon-tooltip-markup`	`str`	r/w/en	The contents of the tooltip on the secondary icon
`secondary-icon-tooltip-text`	`str`	r/w/en	The contents of the tooltip on the secondary icon
`selection-bound`	`int`	r	The position of the opposite end of the selection from the cursor in chars
`shadow-type`	`Gtk.ShadowType`	d/r/w/en	Which kind of shadow to draw around the entry when has-frame is set `deprecated`
`show-emoji-icon`	`bool`	r/w/en	Whether to show an icon for Emoji
`tabs`	`Pango.TabArray`	r/w/en	A list of tabstop locations to apply to the text of the entry
`text`	`str`	r/w/en	The contents of the entry
`text-length`	`int`	r	Length of the text currently in the entry
`truncate-multiline`	`bool`	r/w/en	Whether to truncate multiline pastes to one line.
`visibility`	`bool`	r/w/en	`False` displays the “invisible `str`" instead of the actual text (password mode)
`width-chars`	`int`	r/w/en	Number of characters to leave space for in the entry
`xalign`	`float`	r/w/en	The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.

Style Properties¶

Inherited:: Gtk.Widget (17)

Name	Type	Default	Flags	Short Description
`icon-prelight`	`bool`	`True`	d/r	Whether activatable icons should prelight when hovered `deprecated`
`inner-border`	`Gtk.Border`	`None`	d/r	Border between text and frame. `deprecated`
`invisible-char`	`int`	`0`	r	The character to use when masking entry contents (in “password mode”)
`progress-border`	`Gtk.Border`	`None`	d/r	Border around the progress bar `deprecated`

Signals¶

Inherited:: Gtk.Widget (69), GObject.Object (1), Gtk.CellEditable (2), Gtk.Editable (3)

Name	Short Description
`activate`	The `::activate` signal is emitted when the user hits the Enter key.
`backspace`	The `::backspace` signal is a `keybinding signal` which gets emitted when the user asks for it.
`copy-clipboard`	The `::copy-clipboard` signal is a `keybinding signal` which gets emitted to copy the selection to the clipboard.
`cut-clipboard`	The `::cut-clipboard` signal is a `keybinding signal` which gets emitted to cut the selection to the clipboard.
`delete-from-cursor`	The `::delete-from-cursor` signal is a `keybinding signal` which gets emitted when the user initiates a text deletion.
`icon-press`	The `::icon-press` signal is emitted when an activatable icon is clicked.
`icon-release`	The `::icon-release` signal is emitted on the button release from a mouse click over an activatable icon.
`insert-at-cursor`	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.
`insert-emoji`	The `::insert-emoji` signal is a `keybinding signal` which gets emitted to present the Emoji chooser for the entry.
`move-cursor`	The `::move-cursor` signal is a `keybinding signal` which gets emitted when the user initiates a cursor movement.
`paste-clipboard`	The `::paste-clipboard` signal is a `keybinding signal` which gets emitted to paste the contents of the clipboard into the text view.
`populate-popup`	The `::populate-popup` signal gets emitted before showing the context menu of the entry.
`preedit-changed`	If an input method is used, the typed text will not immediately be committed to the buffer.
`toggle-overwrite`	The `::toggle-overwrite` signal is a `keybinding signal` which gets emitted to toggle the overwrite mode of the entry.

Fields¶

Inherited:: Gtk.Widget (69), GObject.Object (1), Gtk.CellEditable (2), Gtk.Editable (3)

Name	Type	Access	Description
parent_instance	`Gtk.Widget`	r

Class Details¶

class Gtk.Entry(**kwargs)¶

Bases:: Gtk.Widget, Gtk.CellEditable, Gtk.Editable
Abstract:: No
Structure:: Gtk.EntryClass

The Gtk.Entry 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 Gtk.Entry :caps-lock-warning property.

Since 2.16, Gtk.Entry 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, Gtk.Entry 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 Gtk.Entry ::icon-press signal. To allow DND operations from an icon, use Gtk.Entry.set_icon_drag_source(). To set a tooltip on an icon, use Gtk.Entry.set_icon_tooltip_text() or the corresponding function for markup.

Note that functionality or information that is only available by clicking on an icon in an entry may not be accessible at all to users which are not able to use a mouse or other pointing device. It is therefore recommended that any such functionality should also be available by other means, e.g. via the context menu of the entry.

CSS nodes

entry[.read-only][.flat][.warning][.error]
├── image.left
├── image.right
├── undershoot.left
├── undershoot.right
├── [selection]
├── [progress[.pulse]]
╰── [window.popup]

Gtk.Entry 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.

classmethod new()[source]¶

Returns:: a new Gtk.Entry.
Return type:: Gtk.Widget

Creates a new entry.

classmethod new_with_buffer(buffer)[source]¶

Parameters:: buffer (Gtk.EntryBuffer) – The buffer to use for the new Gtk.Entry.
Returns:: a new Gtk.Entry
Return type:: Gtk.Widget

Creates a new entry with the specified text buffer.

New in version 2.18.

get_activates_default()[source]¶

Returns:: True if the entry will activate the default widget
Return type:: bool

Retrieves the value set by Gtk.Entry.set_activates_default().

get_alignment()[source]¶

Returns:: the alignment
Return type:: float

Gets the value set by Gtk.Entry.set_alignment().

New in version 2.4.

get_attributes()[source]¶

Returns:: the attribute list, or None if none was set.
Return type:: Pango.AttrList or None

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

New in version 3.6.

get_buffer()[source]¶

Returns:: A Gtk.EntryBuffer object.
Return type:: Gtk.EntryBuffer

Get the Gtk.EntryBuffer object which holds the text for this widget.

New in version 2.18.

get_completion()[source]¶

Returns:: The auxiliary completion object currently in use by self.
Return type:: Gtk.EntryCompletion

Returns the auxiliary completion object currently in use by self.

New in version 2.4.

get_current_icon_drag_source()[source]¶

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

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 Gtk.Widget ::drag-data-get callback.

New in version 2.16.

get_cursor_hadjustment()[source]¶

Returns:: the horizontal cursor adjustment, or None if none has been set.
Return type:: Gtk.Adjustment or None

Retrieves the horizontal cursor adjustment for the entry. See Gtk.Entry.set_cursor_hadjustment().

New in version 2.12.

get_has_frame()[source]¶

Returns:: whether the entry has a beveled frame
Return type:: bool

Gets the value set by Gtk.Entry.set_has_frame().

get_icon_activatable(icon_pos)[source]¶

Parameters:: icon_pos (Gtk.EntryIconPosition) – Icon position
Returns:: True if the icon is activatable.
Return type:: bool

Returns whether the icon is activatable.

New in version 2.16.

get_icon_area(icon_pos)[source]¶

Parameters:: icon_pos (Gtk.EntryIconPosition) – Icon position
Returns:: Return location for the icon’s area
Return type:: icon_area: Gdk.Rectangle

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. Otherwise, icon_area will be filled with the icon’s allocation, relative to self’s allocation.

Signal Details¶

Gtk.Entry.signals.activate(entry)¶

Signal Name:: activate
Flags:: RUN_LAST, ACTION
Parameters:: entry (Gtk.Entry) – The object which received the signal

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.

Gtk.Entry.signals.backspace(entry)¶

Signal Name:: backspace
Flags:: RUN_LAST, ACTION
Parameters:: entry (Gtk.Entry) – The object which received the signal

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.

Gtk.Entry.signals.copy_clipboard(entry)¶

Signal Name:: copy-clipboard
Flags:: RUN_LAST, ACTION
Parameters:: entry (Gtk.Entry) – The object which received the signal

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.

Gtk.Entry.signals.cut_clipboard(entry)¶

Signal Name:: cut-clipboard
Flags:: RUN_LAST, ACTION
Parameters:: entry (Gtk.Entry) – The object which received the signal

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.

Gtk.Entry.signals.delete_from_cursor(entry, type, count)¶

Signal Name:

delete-from-cursor

Flags:

RUN_LAST, ACTION

Parameters:

entry (Gtk.Entry) – The object which received the signal
type (Gtk.DeleteType) – the granularity of the deletion, as a Gtk.DeleteType
count (int) – the number of type units to delete

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

If the type is Gtk.DeleteType.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.

Gtk.Entry.signals.icon_press(entry, icon_pos, event)¶

Signal Name:

icon-press

Flags:

RUN_LAST

Parameters:

entry (Gtk.Entry) – The object which received the signal
icon_pos (Gtk.EntryIconPosition) – The position of the clicked icon
event (Gdk.Event) – the button press event

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

New in version 2.16.

Gtk.Entry.signals.icon_release(entry, icon_pos, event)¶

Signal Name:

icon-release

Flags:

RUN_LAST

Parameters:

entry (Gtk.Entry) – The object which received the signal
icon_pos (Gtk.EntryIconPosition) – The position of the clicked icon
event (Gdk.Event) – the button release event

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

New in version 2.16.

Gtk.Entry.signals.insert_at_cursor(entry, string)¶

Signal Name:

insert-at-cursor

Flags:

RUN_LAST, ACTION

Parameters:

entry (Gtk.Entry) – The object which received the signal
string (str) – the string to insert

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.

Gtk.Entry.signals.insert_emoji(entry)¶

Signal Name:: insert-emoji
Flags:: RUN_LAST, ACTION
Parameters:: entry (Gtk.Entry) – The object which received the signal

The ::insert-emoji signal is a keybinding signal which gets emitted to present the Emoji chooser for the entry.

The default bindings for this signal are Ctrl-. and Ctrl-;

New in version 3.22.27.

Gtk.Entry.signals.move_cursor(entry, step, count, extend_selection)¶

Signal Name:

move-cursor

Flags:

RUN_LAST, ACTION

Parameters:

entry (Gtk.Entry) – The object which received the signal
step (Gtk.MovementStep) – the granularity of the move, as a Gtk.MovementStep
count (int) – the number of step units to move
extend_selection (bool) – True if the move should extend the selection

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

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

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifer does not. There are too many key combinations to list them all here.

Arrow keys move by individual characters/lines
Ctrl-arrow key combinations move by words/paragraphs
Home/End keys move to the ends of the buffer

Gtk.Entry.signals.paste_clipboard(entry)¶

Signal Name:: paste-clipboard
Flags:: RUN_LAST, ACTION
Parameters:: entry (Gtk.Entry) – The object which received the signal

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.

Gtk.Entry.signals.populate_popup(entry, widget)¶

Signal Name:

populate-popup

Flags:

RUN_LAST

Parameters:

entry (Gtk.Entry) – The object which received the signal
widget (Gtk.Widget) – the container that is being populated

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 Gtk.Menu in this case.

If Gtk.Entry :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 Gtk.Toolbar. The signal handler should not make assumptions about the type of widget.

Gtk.Entry.signals.preedit_changed(entry, preedit)¶

Signal Name:

preedit-changed

Flags:

RUN_LAST, ACTION

Parameters:

entry (Gtk.Entry) – The object which received the signal
preedit (str) – the current preedit string

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.

New in version 2.20.

Gtk.Entry.signals.toggle_overwrite(entry)¶

Signal Name:: toggle-overwrite
Flags:: RUN_LAST, ACTION
Parameters:: entry (Gtk.Entry) – The object which received the signal

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.

Property Details¶

Gtk.Entry.props.activates_default¶

Name:: activates-default
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Gtk.Entry.props.attributes¶

Name:: attributes
Type:: Pango.AttrList
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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 Pango.Attribute's start_index and end_index must refer to the Gtk.EntryBuffer text, i.e. without the preedit string.

New in version 3.6.

Gtk.Entry.props.buffer¶

Name:: buffer
Type:: Gtk.EntryBuffer
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Text buffer object which actually stores entry text

Gtk.Entry.props.caps_lock_warning¶

Name:: caps-lock-warning
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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.

New in version 2.16.

Gtk.Entry.props.completion¶

Name:: completion
Type:: Gtk.EntryCompletion
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The auxiliary completion object to use with the entry.

New in version 3.2.

Gtk.Entry.props.cursor_position¶

Name:: cursor-position
Type:: int
Default Value:: 0
Flags:: READABLE

The current position of the insertion cursor in chars

Gtk.Entry.props.editable¶

Name:: editable
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether the entry contents can be edited

Gtk.Entry.props.enable_emoji_completion¶

Name:: enable-emoji-completion
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether to suggest Emoji replacements

Gtk.Entry.props.has_frame¶

Name:: has-frame
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

False removes outside bevel from entry

Gtk.Entry.props.im_module¶

Name:: im-module
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Setting this to a non-None value overrides the system-wide IM module setting. See the Gtk.Settings Gtk.Settings :gtk-im-module property.

New in version 2.16.

Gtk.Entry.props.inner_border¶

Name:: inner-border
Type:: Gtk.Border
Default Value:: None
Flags:: DEPRECATED, READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 2.10.

Deprecated since version 3.4: Use the standard border and padding CSS properties (through objects like Gtk.StyleContext and Gtk.CssProvider); the value of this style property is ignored.

Gtk.Entry.props.input_hints¶

Name:: input-hints
Type:: Gtk.InputHints
Default Value:: Gtk.InputHints.NONE
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Additional hints (beyond Gtk.Entry :input-purpose) that allow input methods to fine-tune their behaviour.

New in version 3.6.

Gtk.Entry.props.input_purpose¶

Name:: input-purpose
Type:: Gtk.InputPurpose
Default Value:: Gtk.InputPurpose.FREE_FORM
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 3.6.

Gtk.Entry.props.invisible_char¶

Name:: invisible-char
Type:: int
Default Value:: 42
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The invisible character is used when masking entry contents (in \”password mode\”)”). When it is not explicitly set with the Gtk.Entry :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.

New in version 2.18.

Gtk.Entry.props.invisible_char_set¶

Name:: invisible-char-set
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether the invisible str has been set for the Gtk.Entry.

New in version 2.16.

Gtk.Entry.props.max_length¶

Name:: max-length
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Gtk.Entry.props.max_width_chars¶

Name:: max-width-chars
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 3.12.

Gtk.Entry.props.overwrite_mode¶

Name:: overwrite-mode
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

If text is overwritten when typing in the Gtk.Entry.

New in version 2.14.

Gtk.Entry.props.placeholder_text¶

Name:: placeholder-text
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 3.2.

Gtk.Entry.props.populate_all¶

Name:: populate-all
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

If :populate-all is True, the Gtk.Entry ::populate-popup signal is also emitted for touch popups.

New in version 3.8.

Gtk.Entry.props.primary_icon_activatable¶

Name:: primary-icon-activatable
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether the primary icon is activatable.

GTK+ emits the Gtk.Entry ::icon-press and Gtk.Entry ::icon-release signals only on sensitive, activatable icons.

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

New in version 2.16.

Gtk.Entry.props.primary_icon_gicon¶

Name:: primary-icon-gicon
Type:: Gio.Icon
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The Gio.Icon to use for the primary icon for the entry.

New in version 2.16.

Gtk.Entry.props.primary_icon_name¶

Name:: primary-icon-name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 2.16.

Gtk.Entry.props.primary_icon_pixbuf¶

Name:: primary-icon-pixbuf
Type:: GdkPixbuf.Pixbuf
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 2.16.

Gtk.Entry.props.primary_icon_sensitive¶

Name:: primary-icon-sensitive
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether the primary icon is sensitive.

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

New in version 2.16.

Gtk.Entry.props.primary_icon_stock¶

Name:: primary-icon-stock
Type:: str
Default Value:: None
Flags:: DEPRECATED, READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 2.16.

Deprecated since version 3.10: Use Gtk.Entry :primary-icon-name instead.

Gtk.Entry.props.primary_icon_storage_type¶

Name:: primary-icon-storage-type
Type:: Gtk.ImageType
Default Value:: Gtk.ImageType.EMPTY
Flags:: READABLE

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

New in version 2.16.

Gtk.Entry.props.primary_icon_tooltip_markup¶

Name:: primary-icon-tooltip-markup
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 2.16.

Gtk.Entry.props.primary_icon_tooltip_text¶

Name:: primary-icon-tooltip-text
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The contents of the tooltip on the primary icon.

Also see Gtk.Entry.set_icon_tooltip_text().

New in version 2.16.

Gtk.Entry.props.progress_fraction¶

Name:: progress-fraction
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 2.16.

Gtk.Entry.props.progress_pulse_step¶

Name:: progress-pulse-step
Type:: float
Default Value:: 0.1
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 2.16.

Gtk.Entry.props.scroll_offset¶

Name:: scroll-offset
Type:: int
Default Value:: 0
Flags:: READABLE, EXPLICIT_NOTIFY

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

Gtk.Entry.props.secondary_icon_activatable¶

Name:: secondary-icon-activatable
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether the secondary icon is activatable.

GTK+ emits the Gtk.Entry ::icon-press and Gtk.Entry ::icon-release signals only on sensitive, activatable icons.

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

New in version 2.16.

Gtk.Entry.props.secondary_icon_gicon¶

Name:: secondary-icon-gicon
Type:: Gio.Icon
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The Gio.Icon to use for the secondary icon for the entry.

New in version 2.16.

Gtk.Entry.props.secondary_icon_name¶

Name:: secondary-icon-name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 2.16.

Gtk.Entry.props.secondary_icon_pixbuf¶

Name:: secondary-icon-pixbuf
Type:: GdkPixbuf.Pixbuf
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 2.16.

Gtk.Entry.props.secondary_icon_sensitive¶

Name:: secondary-icon-sensitive
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether the secondary icon is sensitive.

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

New in version 2.16.

Gtk.Entry.props.secondary_icon_stock¶

Name:: secondary-icon-stock
Type:: str
Default Value:: None
Flags:: DEPRECATED, READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 2.16.

Deprecated since version 3.10: Use Gtk.Entry :secondary-icon-name instead.

Gtk.Entry.props.secondary_icon_storage_type¶

Name:: secondary-icon-storage-type
Type:: Gtk.ImageType
Default Value:: Gtk.ImageType.EMPTY
Flags:: READABLE

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

New in version 2.16.

Gtk.Entry.props.secondary_icon_tooltip_markup¶

Name:: secondary-icon-tooltip-markup
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 2.16.

Gtk.Entry.props.secondary_icon_tooltip_text¶

Name:: secondary-icon-tooltip-text
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The contents of the tooltip on the secondary icon.

Also see Gtk.Entry.set_icon_tooltip_text().

New in version 2.16.

Gtk.Entry.props.selection_bound¶

Name:: selection-bound
Type:: int
Default Value:: 0
Flags:: READABLE

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

Gtk.Entry.props.shadow_type¶

Name:: shadow-type
Type:: Gtk.ShadowType
Default Value:: Gtk.ShadowType.IN
Flags:: DEPRECATED, READABLE, WRITABLE, EXPLICIT_NOTIFY

Which kind of shadow to draw around the entry when Gtk.Entry :has-frame is set to True.

New in version 2.12.

Deprecated since version 3.20: Use CSS to determine the style of the border; the value of this style property is ignored.

Gtk.Entry.props.show_emoji_icon¶

Name:: show-emoji-icon
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether to show an icon for Emoji

Gtk.Entry.props.tabs¶

Name:: tabs
Type:: Pango.TabArray
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Gtk.Entry.props.text¶

Name:: text
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The contents of the entry

Gtk.Entry.props.text_length¶

Name:: text-length
Type:: int
Default Value:: 0
Flags:: READABLE

The length of the text in the Gtk.Entry.

New in version 2.14.

Gtk.Entry.props.truncate_multiline¶

Name:: truncate-multiline
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 2.10.

Gtk.Entry.props.visibility¶

Name:: visibility
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

False displays the “invisible str" instead of the actual text (password mode)

Gtk.Entry.props.width_chars¶

Name:: width-chars
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Number of characters to leave space for in the entry

Gtk.Entry.props.xalign¶

Name:: xalign
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 2.4.