GtkText

The gtk.text.Text widget is a single-line text entry widget.

gtk.text.Text is the common implementation of single-line text editing that is shared between gtk.entry.Entry, gtk.password_entry.PasswordEntry, gtk.spin_button.SpinButton, and other widgets. In all of these, gtk.text.Text is used as the delegate for the gtk.editable.Editable implementation.

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.text.Text.setVisibility. 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.text.Text.setInvisibleChar.

If you are looking to add icons or progress display in an entry, look at gtk.entry.Entry. There other alternatives for more specialized use cases, such as gtk.search_entry.SearchEntry.

If you need multi-line editable text, look at gtk.text_view.TextView.

CSS nodes

text[.read-only]
├── placeholder
├── undershoot.left
├── undershoot.right
├── [selection]
├── [block-cursor]
╰── [window.popup]

gtk.text.Text has a main node with the name text. Depending on the properties of the widget, the .read-only style class may appear.

When the entry has a selection, it adds a subnode with the name selection.

When the entry is in overwrite mode, it adds a subnode with the name block-cursor that determines how the block cursor is drawn.

The CSS node for a context menu is added as a subnode with the name popup.

The undershoot nodes are used to draw the underflow indication when content is scrolled out of view. These nodes get the .left or .right style class 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.

Accessibility

gtk.text.Text uses the gtk.types.AccessibleRole.None role, which causes it to be skipped for accessibility. This is because gtk.text.Text is expected to be used as a delegate for a gtk.editable.Editable implementation that will be represented to accessibility.

struct GtkText {}

Members

Variables

parentInstance
GtkWidget parentInstance;