Class

Gtk.Text

Description [src]

final class Gtk.Text : Gtk.Widget {
  /* No available fields */
}

The GtkText widget is a single-line text entry widget.

GtkText is the common implementation of single-line text editing that is shared between GtkEntry, GtkPasswordEntry,GtkSpinButtonand other widgets. In all of these,GtkText` is used as the delegate for the GtkEditable 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_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_text_set_invisible_char().

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

If you need multi-line editable text, look at GtkTextView.

CSS nodes

text[.read-only]
├── placeholder
├── undershoot.left
├── undershoot.right
├── [selection]
├── [block-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 below text 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.

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.

Hierarchy

Hierarchy for Gtk.Text

Ancestors

Constructors

gtk_text_new

Creates a new GtkText.

gtk_text_new_with_buffer

Creates a new GtkText with the specified text buffer.

Instance methods

gtk_text_get_activates_default

Retrieves the value set by gtk_text_set_activates_default().

gtk_text_get_attributes

Gets the attribute list that was set on the GtkText using gtk_text_set_attributes().

gtk_text_get_buffer

Get the GtkEntryBuffer object which holds the text for this self.

gtk_text_get_enable_emoji_completion

Returns whether Emoji completion is enabled for this GtkText widget.

gtk_text_get_extra_menu

Gets the menu model set with gtk_text_set_extra_menu().

gtk_text_get_input_hints

Gets the input hints of the GtkText.

gtk_text_get_input_purpose

Gets the input purpose of the GtkText.

gtk_text_get_invisible_char

Retrieves the character displayed in place of the real characters for entries with visibility set to false.

gtk_text_get_max_length

Retrieves the maximum allowed length of the text in self.

gtk_text_get_overwrite_mode

Gets the value set by gtk_text_set_overwrite_mode().

gtk_text_get_placeholder_text

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

gtk_text_get_propagate_text_width

Returns whether the GtkText will grow and shrink with the content.

gtk_text_get_tabs

Gets the tabstops that were set on the GtkText using gtk_text_set_tabs().

gtk_text_get_text_length

Retrieves the current length of the text in self.

gtk_text_get_truncate_multiline

Returns whether the GtkText will truncate multi-line text that is pasted into the widget

gtk_text_get_visibility

Retrieves whether the text in self is visible.

gtk_text_grab_focus_without_selecting

Causes self to have keyboard focus.

gtk_text_set_activates_default

If activates is TRUE, pressing Enter in the self will activate the default widget for the window containing self.

gtk_text_set_attributes

Sets attributes that are applied to the text.

gtk_text_set_buffer

Set the GtkEntryBuffer 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 when constructing the context menu for self.

gtk_text_set_input_hints

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

gtk_text_set_input_purpose

Sets the input purpose of the GtkText.

gtk_text_set_invisible_char

Sets the character to use in place of the actual text when in “password mode”.

gtk_text_set_max_length

Sets the maximum allowed length of the contents of the widget.

gtk_text_set_overwrite_mode

Sets whether the text is overwritten when typing in the GtkText.

gtk_text_set_placeholder_text

Sets text to be displayed in self when it is empty.

gtk_text_set_propagate_text_width

Sets whether the GtkText should grow and shrink with the content.

gtk_text_set_tabs

Sets tabstops that are applied to the text.

gtk_text_set_truncate_multiline

Sets whether the GtkText should truncate multi-line text that is pasted into the widget.

gtk_text_set_visibility

Sets whether the contents of the GtkText are visible or not.

gtk_text_unset_invisible_char

Unsets the invisible char.

Methods inherited from GtkWidget (159)
Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role

Retrieves the GtkAccessibleRole for the given GtkAccessible.

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_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. See the GtkAccessibleState documentation for the value types of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Methods inherited from GtkEditable (23)
gtk_editable_delete_selection

Deletes the currently selected text of the editable.

gtk_editable_delete_text

Deletes a sequence of characters.

gtk_editable_finish_delegate

Undoes the setup done by gtk_editable_init_delegate().

gtk_editable_get_alignment

Gets the alignment of the editable.

gtk_editable_get_chars

Retrieves a sequence of characters.

gtk_editable_get_delegate

Gets the GtkEditable that editable is delegating its implementation to.

gtk_editable_get_editable

Retrieves whether editable is editable.

gtk_editable_get_enable_undo

Gets if undo/redo actions are enabled for editable

gtk_editable_get_max_width_chars

Retrieves the desired maximum width of editable, in characters.

gtk_editable_get_position

Retrieves the current position of the cursor relative to the start of the content of the editable.

gtk_editable_get_selection_bounds

Retrieves the selection bound of the editable.

gtk_editable_get_text

Retrieves the contents of editable.

gtk_editable_get_width_chars

Gets the number of characters of space reserved for the contents of the editable.

gtk_editable_init_delegate

Sets up a delegate for GtkEditable.

gtk_editable_insert_text

Inserts length bytes of text into the contents of the widget, at position position.

gtk_editable_select_region

Selects a region of text.

gtk_editable_set_alignment

Sets the alignment for the contents of the editable.

gtk_editable_set_editable

Determines if the user can edit the text in the editable widget.

gtk_editable_set_enable_undo

If enabled, changes to editable will be saved for undo/redo actions.

gtk_editable_set_max_width_chars

Sets the desired maximum width in characters of editable.

gtk_editable_set_position

Sets the cursor position in the editable to the given value.

gtk_editable_set_text

Sets the text in the editable to the given value.

gtk_editable_set_width_chars

Changes the size request of the editable to be about the right size for n_chars characters.

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 of the GtkText.

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 IM (input method) module should be used for this self.

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 for the GtkText.

Gtk.Text:max-length

Maximum number of characters that are allowed.

Gtk.Text:overwrite-mode

If text is overwritten when typing in the GtkText.

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

A list of tabstops to apply to the text of the GtkText.

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 (34)
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 ::query-tooltip signal on widget.

Gtk.Widget:height-request

Override 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: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

Override for width request of the widget.

Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Properties inherited from GtkEditable (8)
Gtk.Editable:cursor-position

The current position of the insertion cursor in chars.

Gtk.Editable:editable

Whether the entry contents can be edited.

Gtk.Editable:enable-undo

If undo/redo should be enabled for the editable.

Gtk.Editable:max-width-chars

The desired maximum width of the entry, in characters.

Gtk.Editable:selection-bound

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

Gtk.Editable:text

The contents of the entry.

Gtk.Editable:width-chars

Number of characters to leave space for in the entry.

Gtk.Editable: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 for the self.

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 of the GtkText.

Signals inherited from GtkWidget (13)
Gtk.Widget::destroy

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

Gtk.Widget::direction-changed

Emitted when the text direction of a widget changes.

Gtk.Widget::hide

Emitted when widget is hidden.

Gtk.Widget::keynav-failed

Emitted if keyboard navigation fails.

Gtk.Widget::map

Emitted when widget is going to be mapped.

Gtk.Widget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

Gtk.Widget::move-focus

Emitted when the focus is moved.

Gtk.Widget::query-tooltip

Emitted when the widgets tooltip is about to be shown.

Gtk.Widget::realize

Emitted when widget is associated with a GdkSurface.

Gtk.Widget::show

Emitted when widget is shown.

Gtk.Widget::state-flags-changed

Emitted when the widget state changes.

Gtk.Widget::unmap

Emitted when widget is going to be unmapped.

Gtk.Widget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Signals inherited from GtkEditable (3)
Gtk.Editable::changed

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

Gtk.Editable::delete-text

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

Gtk.Editable::insert-text

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