Struct Text

Source

pub struct Text { /* private fields */ }

Expand description

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.

§Shortcuts and Gestures

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

§Actions

Text 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 Text:visibility property.
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]
├── [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 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

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.

§Properties

§`activates-default`

Whether to activate the default widget when Enter is pressed.

Readable | Writeable

§`attributes`

A list of Pango attributes to apply to the text of the Text.

This is mainly useful to change the size or weight of the text.

The PangoAttribute’s @start_index and @end_index must refer to the EntryBuffer text, i.e. without the preedit string.

Readable | Writeable

§`buffer`

The EntryBuffer object which stores the text.

Readable | Writeable | Construct

§`enable-emoji-completion`

Whether to suggest Emoji replacements.

Readable | Writeable

§`extra-menu`

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

Readable | Writeable

§`im-module`

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 gtk-im-module property.

Readable | Writeable

§`input-hints`

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

Readable | Writeable

§`input-purpose`

The purpose of this text field.

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

Note that setting the purpose to InputPurpose::Password or InputPurpose::Pin is independent from setting visibility.

Readable | Writeable

§`invisible-char`

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

Readable | Writeable

§`invisible-char-set`

Whether the invisible char has been set for the Text.

Readable | Writeable

§`max-length`

Maximum number of characters that are allowed.

Zero indicates no limit.

Readable | Writeable

§`overwrite-mode`

If text is overwritten when typing in the Text.

Readable | Writeable

§`placeholder-text`

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

Readable | Writeable

§`propagate-text-width`

Whether the widget should grow and shrink with the content.

Readable | Writeable

§`scroll-offset`

Number of pixels scrolled of the screen to the left.

Readable

§`tabs`

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

Readable | Writeable

§`truncate-multiline`

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

Readable | Writeable

§`visibility`

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

Readable | Writeable

Widget

§`can-focus`

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

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

§`can-target`

Whether the widget can receive pointer events.

Readable | Writeable

§`css-classes`

A list of css classes applied to this widget.

Readable | Writeable

§`css-name`

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

§`cursor`

The cursor used by @widget.

Readable | Writeable

§`focus-on-click`

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

This property is only relevant for widgets that can take focus.

Readable | Writeable

§`focusable`

Whether this widget itself will accept the input focus.

Readable | Writeable

§`halign`

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

§`has-default`

Whether the widget is the default widget.

Readable

§`has-focus`

Whether the widget has the input focus.

Readable

§`has-tooltip`

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

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

§`height-request`

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

§`hexpand`

Whether to expand horizontally.

Readable | Writeable

§`hexpand-set`

Whether to use the hexpand property.

Readable | Writeable

§`layout-manager`

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

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

§`margin-bottom`

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

§`margin-end`

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

§`margin-start`

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

§`margin-top`

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

§`name`

The name of the widget.

Readable | Writeable

§`opacity`

The requested opacity of the widget.

Readable | Writeable

§`overflow`

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

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

§`parent`

The parent widget of this widget.

Readable

§`receives-default`

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

Readable | Writeable

§`root`

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

§`scale-factor`

The scale factor of the widget.

Readable

§`sensitive`

Whether the widget responds to input.

Readable | Writeable

§`tooltip-markup`

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

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

§`tooltip-text`

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

§`valign`

How to distribute vertical space if widget gets extra space.

Readable | Writeable

§`vexpand`

Whether to expand vertically.

Readable | Writeable

§`vexpand-set`

Whether to use the vexpand property.

Readable | Writeable

§`visible`

Whether the widget is visible.

Readable | Writeable

§`width-request`

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

§`accessible-role`

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Editable

§`cursor-position`

The current position of the insertion cursor in chars.

Readable

§`editable`

Whether the entry contents can be edited.

Readable | Writeable

§`enable-undo`

If undo/redo should be enabled for the editable.

Readable | Writeable

§`max-width-chars`

The desired maximum width of the entry, in characters.

Readable | Writeable

§`selection-bound`

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

Readable

§`text`

The contents of the entry.

Readable | Writeable

§`width-chars`

Number of characters to leave space for in the entry.

Readable | Writeable

§`xalign`

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

Reversed for RTL layouts.

Readable | Writeable

§Signals

§`activate`

Emitted when the user hits the Enter key.

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

Action

§`backspace`

Emitted when the user asks for it.

This is a keybinding signal.

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

Action

§`copy-clipboard`

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.

Action

§`cut-clipboard`

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.

Action

§`delete-from-cursor`

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.

Action

§`insert-at-cursor`

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.

Action

§`insert-emoji`

Emitted to present the Emoji chooser for the widget.

This is a keybinding signal.

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

Action

§`move-cursor`

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 and End move to the ends of the buffer

Action

§`paste-clipboard`

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.

Action

§`preedit-changed`

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.

Action

§`toggle-overwrite`

Emitted to toggle the overwrite mode of the Text.

This is a keybinding signal.

The default bindings for this signal is Insert.

Action

Widget

§`destroy`

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

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

§`direction-changed`

Emitted when the text direction of a widget changes.

§`hide`

Emitted when @widget is hidden.

§`keynav-failed`

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

§`map`

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

§`mnemonic-activate`

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

§`move-focus`

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

§`query-tooltip`

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

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

§`realize`

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

§`show`

Emitted when @widget is shown.

§`state-flags-changed`

Emitted when the widget state changes.

See WidgetExt::state_flags().

§`unmap`

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

§`unrealize`

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Editable

§`changed`

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

E.g., a paste operation that replaces the contents of the selection will cause only one signal emission (even though it is implemented by first deleting the selection, then inserting the new content, and may cause multiple ::notify::text signals to be emitted).

§`delete-text`

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

The default handler for this signal will normally be responsible for deleting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the range of deleted text, or prevent it from being deleted entirely.

The @start_pos and @end_pos parameters are interpreted as for EditableExt::delete_text().

§`insert-text`

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

The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the inserted text, or prevent it from being inserted entirely.

§Implements

WidgetExt, [trait@glib::ObjectExt], AccessibleExt, BuildableExt, ConstraintTargetExt, AccessibleTextExt, EditableExt, WidgetExtManual, AccessibleExtManual, EditableExtManual

GLib type: GObject with reference counted clone semantics.

Struct TextCopy item path

§Shortcuts and Gestures

§Actions

§CSS nodes

§Accessibility

§Properties

§activates-default

§attributes

§buffer

§enable-emoji-completion

§extra-menu

§im-module

§input-hints

§input-purpose

§invisible-char

§invisible-char-set

§max-length

§overwrite-mode

§placeholder-text

§propagate-text-width

§scroll-offset

§tabs

§truncate-multiline

§visibility

Widget

§can-focus

§can-target

§css-classes

§css-name

§cursor

§focus-on-click

§focusable

§halign

§has-default

§has-focus

§has-tooltip

§height-request

§hexpand

§hexpand-set

§layout-manager

§margin-bottom

§margin-end

§margin-start

§margin-top

§name

§opacity

§overflow

§parent

§receives-default

§root

§scale-factor

§sensitive

§tooltip-markup

§tooltip-text

§valign

§vexpand

§vexpand-set

§visible

§width-request

Accessible

§accessible-role

Editable

§cursor-position

§editable

§enable-undo

§max-width-chars

§selection-bound

§text

§width-chars

§xalign

§Signals

§activate

§backspace

§copy-clipboard

§cut-clipboard

§delete-from-cursor

§insert-at-cursor

§insert-emoji

§move-cursor

§paste-clipboard

Struct Text

§`activates-default`

§`attributes`

§`buffer`

§`enable-emoji-completion`

§`extra-menu`

§`im-module`

§`input-hints`

§`input-purpose`

§`invisible-char`

§`invisible-char-set`

§`max-length`

§`overwrite-mode`

§`placeholder-text`

§`propagate-text-width`

§`scroll-offset`

§`tabs`

§`truncate-multiline`

§`visibility`

§`can-focus`

§`can-target`

§`css-classes`

§`css-name`

§`cursor`

§`focus-on-click`

§`focusable`

§`halign`

§`has-default`

§`has-focus`

§`has-tooltip`

§`height-request`

§`hexpand`

§`hexpand-set`

§`layout-manager`

§`margin-bottom`

§`margin-end`

§`margin-start`

§`margin-top`

§`name`

§`opacity`

§`overflow`

§`parent`

§`receives-default`

§`root`

§`scale-factor`

§`sensitive`

§`tooltip-markup`

§`tooltip-text`

§`valign`

§`vexpand`

§`vexpand-set`

§`visible`

§`width-request`

§`accessible-role`

§`cursor-position`

§`editable`

§`enable-undo`

§`max-width-chars`

§`selection-bound`

§`text`

§`width-chars`

§`xalign`

§`activate`

§`backspace`

§`copy-clipboard`

§`cut-clipboard`

§`delete-from-cursor`

§`insert-at-cursor`

§`insert-emoji`

§`move-cursor`

§`paste-clipboard`

§`preedit-changed`

§`toggle-overwrite`

§`destroy`

§`direction-changed`

§`hide`

§`keynav-failed`

§`map`

§`mnemonic-activate`

§`move-focus`