Struct gtk4::Text

#[repr(transparent)]
pub struct Text { /* private fields */ }

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

Text is the common implementation of single-line text editing that is shared between Entry, PasswordEntry, SpinButton and other widgets. In all of these, Text is used as the delegate for the 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 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 set_invisible_char().

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

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

CSS nodes

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

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

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

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, EditableExt, WidgetExtManual, AccessibleExtManual, EditableExtManual

Implementations

impl Text

pub fn new() -> Text

Creates a new Text.

Returns

a new Text.

pub fn with_buffer(buffer: &impl IsA<EntryBuffer>) -> Text

Creates a new Text with the specified text buffer.

buffer

The buffer to use for the new Text.

Returns

a new Text

pub fn builder() -> TextBuilder

Creates a new builder-pattern struct instance to construct Text objects.

This method returns an instance of TextBuilder which can be used to create Text objects.

pub fn compute_cursor_extents(&self, position: usize) -> (Rect, Rect)

Available on crate feature v4_4 only.

Determine the positions of the strong and weak cursors if the insertion point in the layout is at @position.

The position of each cursor is stored as a zero-width rectangle. The strong cursor location is the location where characters of the directionality equal to the base direction are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction are inserted.

The rectangle positions are in widget coordinates.

position

the character position

Returns

strong

location to store the strong cursor position

weak

location to store the weak cursor position

pub fn activates_default(&self) -> bool

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

See set_activates_default().

Returns

true if the Text will activate the default widget

pub fn attributes(&self) -> Option<AttrList>

Gets the attribute list that was set on the Text.

See set_attributes().

Returns

the attribute list

pub fn buffer(&self) -> EntryBuffer

Get the EntryBuffer object which holds the text for this widget.

Returns

A EntryBuffer object.

pub fn enables_emoji_completion(&self) -> bool

Returns whether Emoji completion is enabled for this Text widget.

Returns

true if Emoji completion is enabled

pub fn extra_menu(&self) -> Option<MenuModel>

Gets the menu model for extra items in the context menu.

See set_extra_menu().

Returns

the menu model

pub fn input_hints(&self) -> InputHints

Gets the input hints of the Text.

pub fn input_purpose(&self) -> InputPurpose

Gets the input purpose of the Text.

pub fn invisible_char(&self) -> char

Retrieves the character displayed when visibility is set to false.

Note that GTK does not compute this value unless it needs it, so the value returned by this function is not very useful unless it has been explicitly set with set_invisible_char().

Returns

the current invisible char, or 0, if @text does not show invisible text at all.

pub fn max_length(&self) -> i32

Retrieves the maximum allowed length of the text in @self.

See set_max_length().

This is equivalent to getting @self’s EntryBuffer and calling EntryBufferExtManual::max_length() on it.

Returns

the maximum allowed number of characters in Text, or 0 if there is no maximum.

pub fn is_overwrite_mode(&self) -> bool

Gets whether text is overwritten when typing in the Text.

See set_overwrite_mode().

Returns

whether the text is overwritten when typing

pub fn placeholder_text(&self) -> Option<GString>

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

If no placeholder text has been set, None will be returned.

Returns

the placeholder text

pub fn propagates_text_width(&self) -> bool

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

Returns

true if @self will propagate the text width

pub fn tabs(&self) -> Option<TabArray>

Gets the tabstops that were set on the Text.

See set_tabs().

Returns

the tabstops

pub fn text_length(&self) -> u16

Retrieves the current length of the text in @self.

This is equivalent to getting @self’s EntryBuffer and calling EntryBufferExtManual::length() on it.

Returns

the current number of characters in Text, or 0 if there are none.

pub fn must_truncate_multiline(&self) -> bool

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

Returns

true if @self will truncate multi-line text

pub fn is_visible(&self) -> bool

Retrieves whether the text in @self is visible.

Returns

true if the text is currently visible

pub fn grab_focus_without_selecting(&self) -> bool

Causes @self to have keyboard focus.

It behaves like WidgetExt::grab_focus(), except that it doesn’t select the contents of @self. You only want to call this on some special entries which the user usually doesn’t want to replace all text in, such as search-as-you-type entries.

Returns

true if focus is now inside @self

pub fn set_activates_default(&self, activates: bool)

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

This usually means that the dialog containing the Text will be closed, since the default widget is usually one of the dialog buttons.

activates

true to activate window’s default widget on Enter keypress

pub fn set_attributes(&self, attrs: Option<&AttrList>)

Sets attributes that are applied to the text.

attrs

a pango::AttrList

pub fn set_buffer(&self, buffer: &impl IsA<EntryBuffer>)

Set the EntryBuffer object which holds the text for this widget.

buffer

a EntryBuffer

pub fn set_enable_emoji_completion(&self, enable_emoji_completion: bool)

Sets whether Emoji completion is enabled.

If it is, typing ‘:’, followed by a recognized keyword, will pop up a window with suggested Emojis matching the keyword.

enable_emoji_completion

true to enable Emoji completion

pub fn set_extra_menu(&self, model: Option<&impl IsA<MenuModel>>)

Sets a menu model to add when constructing the context menu for @self.

model

a GMenuModel

pub fn set_input_hints(&self, hints: InputHints)

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

hints

the hints

pub fn set_input_purpose(&self, purpose: InputPurpose)

Sets the input purpose of the Text.

This can be used by on-screen keyboards and other input methods to adjust their behaviour.

purpose

the purpose

pub fn set_invisible_char(&self, ch: char)

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

By default, GTK picks the best invisible char available in the current font. If you set the invisible char to 0, then the user will get no feedback at all; there will be no text on the screen as they type.

ch

a Unicode character

pub fn set_max_length(&self, length: i32)

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

If the current contents are longer than the given length, then they will be truncated to fit.

This is equivalent to getting @self’s EntryBuffer and calling EntryBufferExtManual::set_max_length() on it.

length

the maximum length of the Text, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536.

pub fn set_overwrite_mode(&self, overwrite: bool)

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

overwrite

new value

pub fn set_placeholder_text(&self, text: Option<&str>)

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

This can be used to give a visual hint of the expected contents of the Text.

text

a string to be displayed when @self is empty and unfocused

pub fn set_propagate_text_width(&self, propagate_text_width: bool)

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

propagate_text_width

true to propagate the text width

pub fn set_tabs(&self, tabs: Option<&TabArray>)

Sets tabstops that are applied to the text.

tabs

a pango::TabArray

pub fn set_truncate_multiline(&self, truncate_multiline: bool)

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

truncate_multiline

true to truncate multi-line text

pub fn set_visibility(&self, visible: bool)

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

When visibility is set to false, characters are displayed as the invisible char, and will also appear that way when the text in the widget is copied to the clipboard.

By default, GTK picks the best invisible character available in the current font, but it can be changed with set_invisible_char().

Note that you probably want to set property::Text::input-purpose to InputPurpose::Password or InputPurpose::Pin to inform input methods about the purpose of this self, in addition to setting visibility to false.

visible

true if the contents of the Text are displayed as plaintext

pub fn unset_invisible_char(&self)

Unsets the invisible char.

After calling this, the default invisible char is used again.

pub fn im_module(&self) -> Option<GString>

Which IM (input method) module should be used for this self.

See IMMulticontext.

Setting this to a non-None value overrides the system-wide IM module setting. See the property::Settings::gtk-im-module property.

pub fn set_im_module(&self, im_module: Option<&str>)

Which IM (input method) module should be used for this self.

See IMMulticontext.

Setting this to a non-None value overrides the system-wide IM module setting. See the property::Settings::gtk-im-module property.

pub fn is_invisible_char_set(&self) -> bool

Whether the invisible char has been set for the Text.

pub fn scroll_offset(&self) -> i32

Number of pixels scrolled of the screen to the left.

pub fn connect_activates_default_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_attributes_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_buffer_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_enable_emoji_completion_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_extra_menu_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_im_module_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_input_hints_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_input_purpose_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_invisible_char_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_invisible_char_set_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_max_length_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_overwrite_mode_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_placeholder_text_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_propagate_text_width_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_scroll_offset_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_tabs_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_truncate_multiline_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_visibility_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

impl Text

pub fn connect_activate<F: Fn(&Text) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when the user hits the Enter key.

The default bindings for this signal are all forms of the Enter key.

pub fn connect_backspace<F: Fn(&Text) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when the user asks for it.

This is a keybinding signal.

The default bindings for this signal are Backspace and Shift-Backspace.

pub fn connect_copy_clipboard<F: Fn(&Text) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted to copy the selection to the clipboard.

This is a keybinding signal.

The default bindings for this signal are Ctrl-c and Ctrl-Insert.

pub fn connect_cut_clipboard<F: Fn(&Text) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted to cut the selection to the clipboard.

This is a keybinding signal.

The default bindings for this signal are Ctrl-x and Shift-Delete.

pub fn connect_delete_from_cursor<F: Fn(&Text, DeleteType, i32) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted when the user initiates a text deletion.

This is a keybinding signal.

If the @type_ is DeleteType::Chars, GTK deletes the selection if there is one, otherwise it deletes the requested number of characters.

The default bindings for this signal are Delete for deleting a character and Ctrl-Delete for deleting a word.

type_

the granularity of the deletion, as a DeleteType

count

the number of @type_ units to delete

pub fn connect_insert_at_cursor<F: Fn(&Text, &str) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

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

This is a keybinding signal.

This signal has no default bindings.

string

the string to insert

pub fn connect_insert_emoji<F: Fn(&Text) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted to present the Emoji chooser for the widget.

This is a keybinding signal.

The default bindings for this signal are Ctrl-. and Ctrl-;

pub fn connect_move_cursor<F: Fn(&Text, MovementStep, i32, bool) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted when the user initiates a cursor movement.

If the cursor is not visible in @self_, this signal causes the viewport to be moved instead.

This is a keybinding signal.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without it does not. There are too many key combinations to list them all here.

• ←, →, ↑, ↓ move by individual characters/lines
• Ctrl-→, etc. move by words/paragraphs
• Home, End move to the ends of the buffer

step

the granularity of the move, as a MovementStep

count

the number of @step units to move

extend

true if the move should extend the selection

pub fn connect_paste_clipboard<F: Fn(&Text) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted to paste the contents of the clipboard.

This is a keybinding signal.

The default bindings for this signal are Ctrl-v and Shift-Insert.

pub fn connect_populate_popup<F: Fn(&Text, &Widget) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_preedit_changed<F: Fn(&Text, &str) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted when the preedit text changes.

If an input method is used, the typed text will not immediately be committed to the buffer. So if you are interested in the text, connect to this signal.

preedit

the current preedit string

pub fn connect_toggle_overwrite<F: Fn(&Text) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted to toggle the overwrite mode of the Text.

This is a keybinding signal.

The default bindings for this signal is Insert.

pub fn emit_activate(&self)

pub fn emit_backspace(&self)

pub fn emit_copy_clipboard(&self)

pub fn emit_cut_clipboard(&self)

pub fn emit_delete_from_cursor(&self, type_: DeleteType, count: i32)

pub fn emit_insert_at_cursor(&self, string: &str)

pub fn emit_insert_emoji(&self)

pub fn emit_move_cursor(&self, step: MovementStep, count: i32, extend: bool)

pub fn emit_paste_clipboard(&self)

pub fn emit_preedit_changed(&self, preedit: &str)

pub fn emit_toggle_overwrite(&self)

Trait Implementations

impl Clone for Text

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Text

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Text

fn default() -> Self

Returns the “default value” for a type.

impl Display for Text

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Text

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Text

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl ParentClassIs for Text

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for Text

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<OT: ObjectType> PartialOrd<OT> for Text

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Text

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Text

impl IsA<Accessible> for Text

impl IsA<Buildable> for Text

impl IsA<ConstraintTarget> for Text

impl IsA<Editable> for Text

impl IsA<Widget> for Text