Sets our main struct and passes it to the parent class.
Creates a new GtkText.
Creates a new GtkText with the specified text buffer.
Emitted when the user hits the Enter key.
Emitted when the user asks for it.
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 the user initiates the insertion of a fixed string at the cursor.
Emitted to present the Emoji chooser for the @self.
Emitted when the user initiates a cursor movement.
Emitted to paste the contents of the clipboard.
Emitted when the preedit text changes.
Emitted to toggle the overwrite mode of the GtkText.
Retrieves the value set by gtk_text_set_activates_default().
Gets the attribute list that was set on the GtkText using gtk_text_set_attributes().
Get the GtkEntryBuffer object which holds the text for this self.
Returns whether Emoji completion is enabled for this GtkText widget.
Gets the menu model set with gtk_text_set_extra_menu().
Gets the input hints of the GtkText.
Gets the input purpose of the GtkText.
Retrieves the character displayed in place of the real characters for entries with visibility set to false.
Retrieves the maximum allowed length of the text in @self.
Gets the value set by gtk_text_set_overwrite_mode().
Retrieves the text that will be displayed when @self is empty and unfocused
Returns whether the GtkText will grow and shrink with the content.
the main Gtk struct as a void*
Gets the tabstops that were set on the GtkText using gtk_text_set_tabs().
Retrieves the current length of the text in @self.
Get the main Gtk struct
Returns whether the GtkText will truncate multi-line text that is pasted into the widget
Retrieves whether the text in @self is visible.
Causes @self to have keyboard focus.
If @activates is %TRUE, pressing Enter in the @self will activate the default widget for the window containing @self.
Sets attributes that are applied to the text.
Set the GtkEntryBuffer object which holds the text for this widget.
Sets whether Emoji completion is enabled.
Sets a menu model to add when constructing the context menu for @self.
Sets input hints that allow input methods to fine-tune their behaviour.
Sets the input purpose of the GtkText.
Sets the character to use in place of the actual text when in “password mode”.
Sets the maximum allowed length of the contents of the widget.
Sets whether the text is overwritten when typing in the GtkText.
Sets text to be displayed in @self when it is empty.
Sets whether the GtkText should grow and shrink with the content.
Sets tabstops that are applied to the text.
Sets whether the GtkText should truncate multi-line text that is pasted into the widget.
Sets whether the contents of the GtkText are visible or not.
Unsets the invisible char.
the main Gtk struct
the main Gtk struct
Get the main Gtk struct
the main Gtk struct as a void*
Obtains the current default reading direction.
Sets the default reading direction for widgets.
Enable or disable an action installed with gtk_widget_class_install_action().
For widgets that can be “activated” (buttons, menu items, etc.) this function activates them.
Looks up the action in the action groups associated with @widget and its ancestors, and activates it.
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.
This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.
Called by widgets as the user moves around the window using keyboard shortcuts.
Computes the bounds for @widget in the coordinate space of @target.
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 @widget's coordinate system into @target's coordinate system.
Tests if the point at (@x, @y) is contained in @widget.
Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget.
Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.
Checks to see if a drag movement has passed the GTK drag threshold.
Notifies the user about an input-related error on this widget.
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.
Retrieves the widget’s allocation.
Gets the first ancestor of @widget with type @widget_type.
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.
Queries the cursor set on @widget.
Gets the reading direction for a particular widget.
Get the GdkDisplay for the toplevel window associated with this widget.
Returns the widgets first child.
Returns the current focus child of @widget.
Returns whether the widget should grab focus when it is clicked with the mouse.
Determines whether @widget can own the input focus.
Gets the font map of @widget.
Returns the cairo_font_options_t used for Pango rendering.
Obtains the frame clock for a widget.
Gets the horizontal alignment of @widget.
Returns the current value of the has-tooltip property.
Returns the content height of the widget.
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.
Returns the widgets last child.
Retrieves the layout manager used by @widget
Whether the widget is mapped.
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 name of a widget.
Returns the GtkNative widget that contains @widget.
Returns the widgets next sibling.
#Fetches the requested opacity for this widget.
Returns the widgets overflow value.
Gets a PangoContext with the appropriate font map, font description, and base direction for this widget.
Returns the parent widget of @widget.
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
Returns the widgets previous sibling.
Gets the primary clipboard of @widget.
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.
Returns the GtkRoot widget of @widget.
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.
Gets the size request that was explicitly set for the widget using gtk_widget_set_size_request().
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.
Gets the contents of the tooltip for @widget.
Gets the contents of the tooltip for @widget.
Gets the vertical alignment of @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.
Determines whether the widget is visible.
Returns the content width of the widget.
Causes @widget to have the keyboard focus for the GtkWindow it's inside.
Returns whether @css_class is currently applied to @widget.
Determines whether @widget is the current default widget within its toplevel.
Determines if the widget has the global input focus.
Determines if the widget should show a visible indication that it has the global input focus.
Reverses the effects of gtk_widget_show().
Returns whether the widget is currently being destroyed.
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.
Determines if the widget is the focus widget within its toplevel.
Returns the widget’s effective sensitivity.
Determines whether the widget and all its parents are marked as visible.
Emits the ::keynav-failed signal on the widget.
Returns the widgets for which this widget is the target of a mnemonic.
Causes a widget to be mapped if it isn’t already.
Measures @widget in the orientation @orientation and for the given @for_size.
Emits the GtkWidget::mnemonic-activate signal.
Returns a GListModel to track the children of @widget.
Returns a GListModel to track the [class@Gtk.EventController]s of @widget.
Finds the descendant of @widget closest to the screen at the point (@x, @y).
Flags the widget for a rerun of the GtkWidgetClass::size_allocate function.
Schedules this widget to be redrawn in paint phase of the current or the next frame.
Flags a widget to have its size renegotiated.
Creates the GDK resources associated with a widget.
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().
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.
Will clear all style classes applied to @widget and replace them with @classes.
Sets the cursor to be shown when pointer devices point towards @widget.
Sets a named cursor to be shown when pointer devices point towards @widget.
Sets the reading direction on a particular widget.
Set @child as the current focus child of @widget.
Sets whether the widget should grab focus when it is clicked with the mouse.
Specifies whether @widget can own the input focus.
Sets the font map to use for Pango rendering.
Sets the cairo_font_options_t used for Pango rendering in this widget.
Sets the horizontal alignment of @widget.
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 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.
Sets the start margin of @widget.
Sets the top margin of @widget.
Sets a widgets name.
Request the @widget to be rendered partially transparent.
Sets how @widget treats content that is drawn outside the widget's content area.
Sets @parent as the parent widget of @widget.
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 the vertical alignment of @widget.
Sets whether the widget would like any available extra vertical space.
Sets whether the vexpand flag will be used.
Sets the visibility state of @widget.
Returns whether @widget should contribute to the measuring and allocation of its parent.
Flags a widget to be displayed.
Allocates widget with a transformation that translates the origin to the position in @allocation.
Snapshot the a child of @widget.
Translate coordinates relative to @src_widget’s allocation to coordinates relative to @dest_widget’s allocations.
Triggers a tooltip query on the display where the toplevel of @widget is located.
Causes a widget to be unmapped if it’s currently mapped.
Dissociate @widget from its parent.
Causes a widget to be unrealized (frees all GDK resources associated with the widget).
Turns off flag values for the current widget state.
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 if keyboard navigation fails.
Emitted when @widget is going to be mapped.
Emitted when a widget is activated via a mnemonic.
Emitted when the focus is moved.
Emitted when the widgets tooltip is about to be shown.
Emitted when @widget is associated with a GdkSurface.
Emitted when @widget is shown.
Emitted when the widget state changes.
Emitted when @widget is going to be unmapped.
Emitted when the GdkSurface associated with @widget is destroyed.
Get the main Gtk struct
the main Gtk struct as a void*
Gets a property of the GtkEditable delegate for @object.
Sets a property on the GtkEditable delegate for @object.
Installs the GtkEditable properties for @class.
Deletes the currently selected text of the editable.
Deletes a sequence of characters.
Undoes the setup done by [method@Gtk.Editable.init_delegate].
Gets the alignment of the editable.
Retrieves a sequence of characters.
Gets the GtkEditable that @editable is delegating its implementation to.
Retrieves whether @editable is editable.
Gets if undo/redo actions are enabled for @editable
Retrieves the desired maximum width of @editable, in characters.
Retrieves the current position of the cursor relative to the start of the content of the editable.
Retrieves the selection bound of the editable.
Retrieves the contents of @editable.
Gets the number of characters of space reserved for the contents of the editable.
Sets up a delegate for GtkEditable.
Inserts @length bytes of @text into the contents of the widget, at position @position.
Selects a region of text.
Sets the alignment for the contents of the editable.
Determines if the user can edit the text in the editable widget.
If enabled, changes to @editable will be saved for undo/redo actions.
Sets the desired maximum width in characters of @editable.
Sets the cursor position in the editable to the given value.
Sets the text in the editable to the given value.
Changes the size request of the editable to be about the right size for @n_chars characters.
Emitted at the end of a single user-visible operation on the contents.
Emitted when text is deleted from the widget by the user.
Emitted when text is inserted into the widget by the user.
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, GtkSpinButton` 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 GtkEntry. There other alternatives for more specialized use cases, such as GtkSearchEntry.
If you need multi-line editable text, look at GtkTextView.
CSS nodes
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.