Gtk.Text
Description: Reference for Gtk.Text

### Class

# GtkText

#### Description [src]

    final class Gtk.Text : Gtk.Widget
      implements Gtk.Accessible, Gtk.AccessibleText, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Editable {
      /* No available fields */
    }

A single-line text entry.

`GtkText` is the common implementation of single-line text editing that is shared between `GtkEntry`, `GtkPasswordEntry`, `GtkSpinButton`, and other widgets. In all of these, a `GtkText` instance is used as the delegate for the `GtkEditable` implementation.

A large number of key bindings s 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_set_visibility()`. In this mode, entered text is displayed using an “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_set_invisible_char()`.

If you want to add icons or progress display in an entry, look at `GtkEntry`. There are other alternatives for more specialized use cases, such as `GtkSearchEntry`.

If you need multi-line editable text, use `GtkTextView`.

# Shortcuts and Gestures

`GtkText` supports the following keyboard shortcuts:

- `Shift`+`F10` or `Menu` opens the context menu.
- `Ctrl`+`A` or `Ctrl`+`/` selects all the text.
- `Ctrl`+`Shift`+`A` or `Ctrl`+`\` unselects all.
- `Ctrl`+`Z` undoes the last modification.
- `Ctrl`+`Y` or `Ctrl`+`Shift`+`Z` redoes the last undone modification.
- `Ctrl`+`Shift`+`T` toggles the text direction.

Additionally, the following signals have default keybindings:

- `GtkText::activate`
- `GtkText::backspace`
- `GtkText::copy-clipboard`
- `GtkText::cut-clipboard`
- `GtkText::delete-from-cursor`
- `GtkText::insert-emoji`
- `GtkText::move-cursor`
- `GtkText::paste-clipboard`
- `GtkText::toggle-overwrite`

# Actions

`GtkText` defines a set of built-in actions:

- `clipboard.copy` copies the contents to the clipboard.
- `clipboard.cut` copies the contents to the clipboard and deletes it from the widget.
- `clipboard.paste` inserts the contents of the clipboard into the widget.
- `menu.popup` opens the context menu.
- `misc.insert-emoji` opens the Emoji chooser.
- `misc.toggle-visibility` toggles the `GtkText`:visibility property.
- `misc.toggle-direction` toggles the text direction.
- `selection.delete` deletes the current selection.
- `selection.select-all` selects all of the widgets content.
- `text.redo` redoes the last change to the contents.
- `text.undo` undoes the last change to the contents.

# CSS nodes

    text[.read-only]
    ├── placeholder
    ├── undershoot.left
    ├── undershoot.right
    ├── [selection]
    ├── [cursor-handle[.top]
    ├── [cursor-handle.bottom]
    ├── [block-cursor]
    ├── [cursor-handle[.top/.bottom][.insertion-cursor]]
    ╰── [window.popup]

`GtkText` 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

`GtkText` uses the `GTK_ACCESSIBLE_ROLE_NONE` role, which causes it to be skipped for accessibility. This is because `GtkText` is expected to be used as a delegate for a `GtkEditable` implementation that will be represented to accessibility.

#### Ancestors

- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- GtkAccessible
- GtkAccessibleText
- GtkBuildable
- GtkConstraintTarget
- GtkEditable

#### Constructors

###### gtk_text_new

Creates a new `GtkText`.

###### gtk_text_new_with_buffer

Creates a new `GtkText` with the specified buffer.

#### Instance methods

###### gtk_text_compute_cursor_extents

Determines the positions of the strong and weak cursors for a given character position.

since: 4.4

###### gtk_text_get_activates_default

Returns whether pressing `Enter` will activate the default widget for the window containing the widget.

###### gtk_text_get_attributes

Gets the attribute list that was set on the text widget.

###### gtk_text_get_buffer

Get the entry buffer object which holds the text for this widget.

###### gtk_text_get_enable_emoji_completion

Returns whether Emoji completion is enabled.

###### gtk_text_get_extra_menu

Gets the extra menu model of the text widget.

###### gtk_text_get_input_hints

Gets the input hints of the text widget.

###### gtk_text_get_input_purpose

Gets the input purpose of the text widget.

###### gtk_text_get_invisible_char

Retrieves the character displayed when visibility is set to false.

###### gtk_text_get_max_length

Retrieves the maximum allowed length of the contents.

###### gtk_text_get_overwrite_mode

Gets whether text is overwritten when typing.

###### gtk_text_get_placeholder_text

Retrieves the text that will be displayed when the text widget is empty and unfocused.

###### gtk_text_get_propagate_text_width

Returns whether the text widget will grow and shrink with the content.

###### gtk_text_get_tabs

Gets the tab stops for the text widget.

###### gtk_text_get_text_length

Retrieves the length of the contents.

###### gtk_text_get_truncate_multiline

Returns whether pasted text will be truncated to the first line.

###### gtk_text_get_visibility

Retrieves whether the text is visible.

###### gtk_text_grab_focus_without_selecting

Causes the text widget to have the keyboard focus.

###### gtk_text_set_activates_default

Sets whether pressing `Enter` will activate the default widget.

###### gtk_text_set_attributes

Apply attributes to the contents of the text widget.

###### gtk_text_set_buffer

Set the entry buffer object which holds the text for this widget.

###### gtk_text_set_enable_emoji_completion

Sets whether Emoji completion is enabled.

###### gtk_text_set_extra_menu

Sets a menu model to add to the context menu of the text widget.

###### gtk_text_set_input_hints

Sets hints that allow input methods to fine-tune their behaviour.

###### gtk_text_set_input_purpose

Sets the input purpose of the text widget.

###### gtk_text_set_invisible_char

Sets the character to use when in “password mode”.

###### gtk_text_set_max_length

Sets the maximum allowed length of the contents.

###### gtk_text_set_overwrite_mode

Sets whether the text is overwritten when typing.

###### gtk_text_set_placeholder_text

Sets the text to be displayed when the text widget is empty and unfocused.

###### gtk_text_set_propagate_text_width

Sets whether the text widget should grow and shrink with the content.

###### gtk_text_set_tabs

Sets tab stops for the text widget.

###### gtk_text_set_truncate_multiline

Sets whether pasted text should be truncated to the first line.

###### gtk_text_set_visibility

Sets whether the contents of the text widget are visible or not.

###### gtk_text_unset_invisible_char

Unsets the invisible char.

##### Methods inherited from GtkWidget (164)

Please see GtkWidget for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GtkAccessible (20)

###### gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

since: 4.14

###### gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

since: 4.10

###### gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

###### gtk_accessible_get_at_context

Retrieves the implementation for the given accessible object.

since: 4.10

###### gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

since: 4.10

###### gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

since: 4.10

###### gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

since: 4.10

###### gtk_accessible_get_platform_state

Queries a platform state, such as focus.

since: 4.10

###### gtk_accessible_reset_property

Resets the accessible property to its default value.

###### gtk_accessible_reset_relation

Resets the accessible relation to its default value.

###### gtk_accessible_reset_state

Resets the accessible state to its default value.

###### gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

since: 4.10

###### gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling.

since: 4.10

###### gtk_accessible_update_platform_state

Informs ATs that the platform state has changed.

since: 4.18

###### gtk_accessible_update_property

Updates a list of accessible properties.

###### gtk_accessible_update_property_value

Updates an array of accessible properties.

###### gtk_accessible_update_relation

Updates a list of accessible relations.

###### gtk_accessible_update_relation_value

Updates an array of accessible relations.

###### gtk_accessible_update_state

Updates a list of accessible states.

###### gtk_accessible_update_state_value

Updates an array of accessible states.

##### Methods inherited from GtkAccessibleText (3)

###### gtk_accessible_text_update_caret_position

Updates the position of the caret.

since: 4.14

###### gtk_accessible_text_update_contents

Notifies assistive technologies of a change in contents.

since: 4.14

###### gtk_accessible_text_update_selection_bound

Updates the boundary of the selection.

since: 4.14

##### Methods inherited from GtkBuildable (1)

###### gtk_buildable_get_buildable_id

Gets the ID of the `buildable` object.

##### Methods inherited from GtkEditable (24)

Please see GtkEditable for a full list of methods.

#### Properties

###### Gtk.Text:activates-default

Whether to activate the default widget when `Enter` is pressed.

###### Gtk.Text:attributes

A list of Pango attributes to apply to the text.

###### Gtk.Text:buffer

The `GtkEntryBuffer` object which stores the text.

###### Gtk.Text:enable-emoji-completion

Whether to suggest Emoji replacements.

###### Gtk.Text:extra-menu

A menu model whose contents will be appended to the context menu.

###### Gtk.Text:im-module

Which input method module should be used.

###### Gtk.Text:input-hints

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

###### Gtk.Text:input-purpose

The purpose of this text field.

###### Gtk.Text:invisible-char

The character to used when masking contents (in “password mode”).

###### Gtk.Text:invisible-char-set

Whether the invisible char has been set.

###### Gtk.Text:max-length

Maximum number of characters that are allowed.

###### Gtk.Text:overwrite-mode

If text is overwritten when typing.

###### Gtk.Text:placeholder-text

The text that will be displayed in the `GtkText` when it is empty and unfocused.

###### Gtk.Text:propagate-text-width

Whether the widget should grow and shrink with the content.

###### Gtk.Text:scroll-offset

Number of pixels scrolled of the screen to the left.

###### Gtk.Text:tabs

Custom tabs for this text widget.

###### Gtk.Text:truncate-multiline

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

###### Gtk.Text:visibility

If false, the text is masked with the “invisible char”.

##### Properties inherited from GtkWidget (35)

###### Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

###### Gtk.Widget:can-target

Whether the widget can receive pointer events.

###### Gtk.Widget:css-classes

A list of css classes applied to this widget.

###### Gtk.Widget:css-name

The name of this widget in the CSS tree.

###### Gtk.Widget:cursor

The cursor used by `widget`.

###### Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

###### Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

###### Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

###### Gtk.Widget:has-default

Whether the widget is the default widget.

###### Gtk.Widget:has-focus

Whether the widget has the input focus.

###### Gtk.Widget:has-tooltip

Enables or disables the emission of the `GtkWidget::query-tooltip` signal on `widget`.

###### Gtk.Widget:height-request

Overrides for height request of the widget.

###### Gtk.Widget:hexpand

Whether to expand horizontally.

###### Gtk.Widget:hexpand-set

Whether to use the `hexpand` property.

###### Gtk.Widget:layout-manager

The `GtkLayoutManager` instance to use to compute the preferred size of the widget, and allocate its children.

###### Gtk.Widget:limit-events

Makes this widget act like a modal dialog, with respect to event delivery.

since: 4.18

###### Gtk.Widget:margin-bottom

Margin on bottom side of widget.

###### Gtk.Widget:margin-end

Margin on end of widget, horizontally.

###### Gtk.Widget:margin-start

Margin on start of widget, horizontally.

###### Gtk.Widget:margin-top

Margin on top side of widget.

###### Gtk.Widget:name

The name of the widget.

###### Gtk.Widget:opacity

The requested opacity of the widget.

###### Gtk.Widget:overflow

How content outside the widget’s content area is treated.

###### Gtk.Widget:parent

The parent widget of this widget.

###### Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

###### Gtk.Widget:root

The `GtkRoot` widget of the widget tree containing this widget.

###### Gtk.Widget:scale-factor

The scale factor of the widget.

###### Gtk.Widget:sensitive

Whether the widget responds to input.

###### Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

###### Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

###### Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

###### Gtk.Widget:vexpand

Whether to expand vertically.

###### Gtk.Widget:vexpand-set

Whether to use the `vexpand` property.

###### Gtk.Widget:visible

Whether the widget is visible.

###### Gtk.Widget:width-request

Overrides for width request of the widget.

##### Properties inherited from GtkAccessible (1)

###### GtkAccessible:accessible-role

The accessible role of the given `GtkAccessible` implementation.

##### Properties inherited from GtkEditable (8)

###### GtkEditable:cursor-position

The current position of the insertion cursor in chars.

###### GtkEditable:editable

Whether the entry contents can be edited.

###### GtkEditable:enable-undo

If undo/redo should be enabled for the editable.

###### GtkEditable:max-width-chars

The desired maximum width of the entry, in characters.

###### GtkEditable:selection-bound

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

###### GtkEditable:text

The contents of the entry.

###### GtkEditable:width-chars

Number of characters to leave space for in the entry.

###### GtkEditable:xalign

The horizontal alignment, from 0 (left) to 1 (right).

#### Signals

###### Gtk.Text::activate

Emitted when the user hits the `Enter` key.

###### Gtk.Text::backspace

Emitted when the user asks for it.

###### Gtk.Text::copy-clipboard

Emitted to copy the selection to the clipboard.

###### Gtk.Text::cut-clipboard

Emitted to cut the selection to the clipboard.

###### Gtk.Text::delete-from-cursor

Emitted when the user initiates a text deletion.

###### Gtk.Text::insert-at-cursor

Emitted when the user initiates the insertion of a fixed string at the cursor.

###### Gtk.Text::insert-emoji

Emitted to present the Emoji chooser.

###### Gtk.Text::move-cursor

Emitted when the user initiates a cursor movement.

###### Gtk.Text::paste-clipboard

Emitted to paste the contents of the clipboard.

###### Gtk.Text::preedit-changed

Emitted when the preedit text changes.

###### Gtk.Text::toggle-overwrite

Emitted to toggle the overwrite mode.

##### Signals inherited from GtkWidget (13)

###### GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

###### GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

###### GtkWidget::hide

Emitted when `widget` is hidden.

###### GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

###### GtkWidget::map

Emitted when `widget` is going to be mapped.

###### GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

###### GtkWidget::move-focus

Emitted when the focus is moved.

###### GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

###### GtkWidget::realize

Emitted when `widget` is associated with a `GdkSurface`.

###### GtkWidget::show

Emitted when `widget` is shown.

###### GtkWidget::state-flags-changed

Emitted when the widget state changes.

###### GtkWidget::unmap

Emitted when `widget` is going to be unmapped.

###### GtkWidget::unrealize

Emitted when the `GdkSurface` associated with `widget` is destroyed.

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

##### Signals inherited from GtkEditable (3)

###### GtkEditable::changed

Emitted at the end of a single user-visible operation on the contents.

###### GtkEditable::delete-text

Emitted when text is deleted from the widget by the user.

###### GtkEditable::insert-text

Emitted when text is inserted into the widget by the user.