Text
The GtkText widget is a single-line text entry widget.
GtkText is the common implementation of single-line text editing that is shared between class@Gtk.Entry, class@Gtk.PasswordEntry, class@Gtk.SpinButton, and other widgets. In all of these, GtkText is used as the delegate for the iface@Gtk.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 method@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 method@Gtk.Text.set_invisible_char.
If you are looking to add icons or progress display in an entry, look at class@Gtk.Entry. There other alternatives for more specialized use cases, such as class@Gtk.SearchEntry.
If you need multi-line editable text, look at class@Gtk.TextView.
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.
Additionally, the following signals have default keybindings:
signal@Gtk.Text::activate
signal@Gtk.Text::backspace
signal@Gtk.Text::copy-clipboard
signal@Gtk.Text::cut-clipboard
signal@Gtk.Text::delete-from-cursor
signal@Gtk.Text::insert-emoji
signal@Gtk.Text::move-cursor
signal@Gtk.Text::paste-clipboard
signal@Gtk.Text::toggle-overwrite
Actions
GtkText defines a set of built-in actions:
clipboard.copycopies the contents to the clipboard.clipboard.cutcopies the contents to the clipboard and deletes it from the widget.clipboard.pasteinserts the contents of the clipboard into the widget.menu.popupopens the context menu.misc.insert-emojiopens the Emoji chooser.misc.toggle-visibilitytoggles theGtkText:visibility property.selection.deletedeletes the current selection.selection.select-allselects all of the widgets content.text.redoredoes the last change to the contents.text.undoundoes the last change to the contents.
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 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.
Skipped during bindings generation
method
im-module: Property has no getter nor settermethod
invisible-char-set: Property has no getter nor settermethod
scroll-offset: Property has no getter nor setter
Constructors
Properties
The accessible role of the given GtkAccessible implementation.
Whether to activate the default widget when Enter is pressed.
A list of Pango attributes to apply to the text of the GtkText.
The GtkEntryBuffer object which stores the text.
A list of css classes applied to this widget.
The current position of the insertion cursor in chars.
Whether to suggest Emoji replacements.
If undo/redo should be enabled for the editable.
Whether the widget should grab focus when it is clicked with the mouse.
Enables or disables the emission of the ::query-tooltip signal on @widget.
Whether to use the hexpand property.
Additional hints that allow input methods to fine-tune their behaviour.
The purpose of this text field.
The character to used when masking contents (in “password mode”).
The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.
Margin on bottom side of widget.
Margin on start of widget, horizontally.
The desired maximum width of the entry, in characters.
If text is overwritten when typing in the GtkText.
The text that will be displayed in the GtkText when it is empty and unfocused.
Whether the widget should grow and shrink with the content.
Whether the widget will receive the default action when it is focused.
The scale factor of the widget.
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Sets the text of tooltip to be the given string.
When true, pasted multi-line text is truncated to the first line.
Whether to use the vexpand property.
If false, the text is masked with the “invisible char”.
Number of characters to leave space for in the entry.
Functions
Enable or disable an action installed with gtk_widget_class_install_action().
Looks up the action in the action groups associated with
Activates the default.activate action from @widget.
Adds @controller to @widget so that it will receive events.
Adds a style class to @widget.
Adds a widget to the list of mnemonic labels for this widget.
Queues an animation frame update and adds a callback to be called before each frame.
Requests the user's screen reader to announce the given message.
Called by widgets as the user moves around the window using keyboard shortcuts.
Computes the bounds for @widget in the coordinate space of @target.
Determine the positions of the strong and weak cursors if the insertion point in the layout is at @position.
Computes whether a container should give this widget extra space when possible.
Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.
Computes a matrix suitable to describe a transformation from
Emitted when the user hits the Enter key.
Emitted when the user asks for it.
Emitted at the end of a single user-visible operation on the contents.
Emitted to copy the selection to the clipboard.
Emitted to cut the selection to the clipboard.
Emitted when the user initiates a text deletion.
Emitted when text is deleted from the widget by the user.
Signals that all holders of a reference to the widget should release the reference that they hold.
Emitted when the text direction of a widget changes.
Emitted when @widget is hidden.
Emitted when the user initiates the insertion of a fixed string at the cursor.
Emitted to present the Emoji chooser for the widget.
Emitted if keyboard navigation fails.
Emitted when @widget is going to be mapped.
Emitted when a widget is activated via a mnemonic.
Emitted when the user initiates a cursor movement.
Emitted when the focus is moved.
Emitted to paste the contents of the clipboard.
Emitted when the preedit text changes.
Emitted when @widget is associated with a GdkSurface.
Emitted when @widget is shown.
Emitted when the widget state changes.
Emitted to toggle the overwrite mode of the GtkText.
Emitted when @widget is going to be unmapped.
Emitted when the GdkSurface associated with @widget is destroyed.
Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.
Retrieves the accessible platform state from the editable delegate.
Deletes the currently selected text of the editable.
Deletes a sequence of characters.
Clears the template children for the given widget.
Undoes the setup done by method@Gtk.Editable.init_delegate.
Retrieves the accessible parent for an accessible object.
Retrieves the accessible role of an accessible object.
Returns whether pressing Enter will activate the default widget for the window containing @self.
Gets the alignment of the editable.
Returns the baseline that has currently been allocated to @widget.
Returns the height that has currently been allocated to @widget.
Returns the width that has currently been allocated to @widget.
Gets the first ancestor of @widget with type @widget_type.
Retrieves the accessible implementation for the given GtkAccessible.
Gets the attribute list that was set on the GtkText.
Returns the baseline that has currently been allocated to @widget.
Get the GtkEntryBuffer object which holds the text for this widget.
Gets the ID of the @buildable object.
Determines whether the input focus can enter @widget or any of its children.
Queries whether @widget can be the target of pointer events.
Gets the value set with gtk_widget_set_child_visible().
Gets the clipboard object for @widget.
Returns the list of style classes applied to @widget.
Returns the CSS name that is used for @self.
Gets the GtkEditable that @editable is delegating its implementation to.
Gets the reading direction for a particular widget.
Get the GdkDisplay for the toplevel window associated with this widget.
Retrieves whether @editable is editable.
Returns whether Emoji completion is enabled for this GtkText widget.
Gets if undo/redo actions are enabled for @editable
Gets the menu model for extra items in the context menu.
Retrieves the first accessible child of an accessible object.
Returns the widget’s first child.
Determines whether @widget can own the input focus.
Returns the current focus child of @widget.
Returns whether the widget should grab focus when it is clicked with the mouse.
Gets the font map of @widget.
Obtains the frame clock for a widget.
Returns the current value of the has-tooltip property.
Gets whether the widget would like any available extra horizontal space.
Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.
Gets the input hints of the GtkText.
Gets the input purpose of the GtkText.
Retrieves the character displayed when visibility is set to false.
Returns the widget’s last child.
Retrieves the layout manager used by @widget.
Gets the bottom margin of @widget.
Gets the end margin of @widget.
Gets the start margin of @widget.
Gets the top margin of @widget.
Retrieves the maximum allowed length of the text in @self.
Retrieves the desired maximum width of @editable, in characters.
Retrieves the next accessible sibling of an accessible object
Returns the widget’s next sibling.
#Fetches the requested opacity for this widget.
Returns the widget’s overflow value.
Gets whether text is overwritten when typing in the GtkText.
Retrieves the text that will be displayed when
Query a platform state, such as focus.
Retrieves the current position of the cursor relative to the start of the content of the editable.
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
Returns the widget’s previous sibling.
Gets the primary clipboard of @widget.
Returns whether the GtkText will grow and shrink with the content.
Determines whether @widget is realized.
Determines whether @widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.
Returns the widget’s sensitivity.
Gets the settings object holding the settings used for this widget.
Returns the content width or height of the widget.
Returns the widget state as a flag set.
Returns the style context associated to @widget.
Fetch an object build from the template XML for @widget_type in this @widget instance.
Retrieves the current length of the text in @self.
Gets the contents of the tooltip for @widget.
Gets the contents of the tooltip for @widget.
Returns whether the GtkText will truncate multi-line text that is pasted into the widget
Gets whether the widget would like any available extra vertical space.
Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.
Retrieves whether the text in @self is visible.
Determines whether the widget is visible.
Gets the number of characters of space reserved for the contents of the editable.
Causes @self to have keyboard focus.
Returns whether @css_class is currently applied to @widget.
Determines whether @widget is the current default widget within its toplevel.
Determines if the widget should show a visible indication that it has the global input focus.
Returns whether the widget is currently being destroyed.
Sets up a delegate for GtkEditable.
Creates and initializes child widgets defined in templates.
Inserts @group into @widget.
Inserts @widget into the child widget list of @parent.
Inserts @widget into the child widget list of @parent.
Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.
Determines whether @widget can be drawn to.
Returns the widget’s effective sensitivity.
Emits the ::keynav-failed signal on the widget.
Returns the widgets for which this widget is the target of a mnemonic.
Emits the ::mnemonic-activate signal.
Returns a GListModel to track the children of @widget.
Returns a GListModel to track the class@Gtk.EventControllers of @widget.
Flags the widget for a rerun of the vfunc@Gtk.Widget.size_allocate function.
Flags a widget to have its size renegotiated.
Removes @controller from @widget, so that it doesn't process events anymore.
Removes a style from @widget.
Removes a widget from the list of mnemonic labels for this widget.
Removes a tick callback previously registered with gtk_widget_add_tick_callback().
Resets the accessible @property to its default value.
Resets the accessible @relation to its default value.
Resets the accessible @state to its default value.
Selects a region of text.
Sets the parent and sibling of an accessible object.
If @activates is true, pressing Enter will activate the default widget for the window containing @self.
Sets the alignment for the contents of the editable.
Sets attributes that are applied to the text.
Set the GtkEntryBuffer object which holds the text for this widget.
Specifies whether the input focus can enter the widget or any of its children.
Sets whether @widget can be the target of pointer events.
Sets whether @widget should be mapped along with its parent.
Clear all style classes applied to @widget and replace them with @classes.
Sets a named cursor to be shown when pointer devices point towards @widget.
Sets the reading direction on a particular widget.
Determines if the user can edit the text in the editable widget.
Sets whether Emoji completion is enabled.
If enabled, changes to @editable will be saved for undo/redo actions.
Sets a menu model to add when constructing the context menu for @self.
Specifies whether @widget can own the input focus.
Set @child as the current focus child of @widget.
Sets whether the widget should grab focus when it is clicked with the mouse.
Sets the font map to use for Pango rendering.
Sets the has-tooltip property on @widget to @has_tooltip.
Sets whether the widget would like any available extra horizontal space.
Sets whether the hexpand flag will be used.
Sets input hints that allow input methods to fine-tune their behaviour.
Sets the input purpose of the GtkText.
Sets the character to use when in “password mode”.
Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @widget.
Sets the bottom margin of @widget.
Sets the end margin of @widget.
Set all margins to the same value.
Set start and end margin to horizontal and top and bottom margin to vertical
Set margins.
Sets the start margin of @widget.
Sets the top margin of @widget.
Sets the maximum allowed length of the contents of the widget.
Sets the desired maximum width in characters of @editable.
Request the @widget to be rendered partially transparent.
Sets how @widget treats content that is drawn outside the widget's content area.
Sets whether the text is overwritten when typing in the GtkText.
Sets text to be displayed in @self when it is empty.
Sets the cursor position in the editable to the given value.
Sets whether the GtkText should grow and shrink with the content.
Specifies whether @widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
Sets the sensitivity of a widget.
Sets the minimum size of a widget.
Turns on flag values in the current widget state.
Sets @markup as the contents of the tooltip, which is marked up with Pango markup.
Sets @text as the contents of the tooltip.
Sets whether the GtkText should truncate multi-line text that is pasted into the widget.
Sets whether the widget would like any available extra vertical space.
Sets whether the vexpand flag will be used.
Sets whether the contents of the GtkText are visible or not.
Sets the visibility state of @widget.
Changes the size request of the editable to be about the right size for @n_chars characters.
Returns whether @widget should contribute to the measuring and allocation of its parent.
Triggers a tooltip query on the display where the toplevel of @widget is located.
Unsets the invisible char.
Turns off flag values for the current widget state.
Updates the position of the caret.
Notifies assistive technologies of a change in contents.
Updates the next accessible sibling of @self.
Updates the boundary of the selection.