Struct TextView

pub struct TextView { /* private fields */ }

A widget that displays the contents of a TextBuffer.

You may wish to begin by reading the conceptual overview, which gives an overview of all the objects and data types related to the text widget and how they work together.

Shortcuts and Gestures

TextView supports the following keyboard shortcuts:

• Shift+F10 or Menu opens the context menu.
• Ctrl+Z undoes the last modification.
• Ctrl+Y or Ctrl+Shift+Z redoes the last undone modification.

Additionally, the following signals have default keybindings:

• backspace
• copy-clipboard
• cut-clipboard
• delete-from-cursor
• insert-emoji
• move-cursor
• paste-clipboard
• select-all
• toggle-cursor-visible
• toggle-overwrite

Actions

TextView 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.
• 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

textview.view
├── border.top
├── border.left
├── text
│   ╰── [selection]
├── border.right
├── border.bottom
╰── [window.popup]

TextView has a main css node with name textview and style class .view, and subnodes for each of the border windows, and the main text area, with names border and text, respectively. The border nodes each get one of the style classes .left, .right, .top or .bottom.

A node representing the selection will appear below the text node.

If a context menu is opened, the window node will appear as a subnode of the main node.

Accessibility

TextView uses the AccessibleRole::TextBox role.

Properties

accepts-tab

Whether Tab will result in a tab character being entered.

Readable | Writeable

bottom-margin

The bottom margin for text in the text view.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

Don’t confuse this property with margin-bottom.

Readable | Writeable

buffer

The buffer which is displayed.

Readable | Writeable

cursor-visible

If the insertion cursor is shown.

Readable | Writeable

editable

Whether the text can be modified by the user.

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

See IMMulticontext.

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

Readable | Writeable

indent

Amount to indent the paragraph, in pixels.

A negative value of indent will produce a hanging indentation. That is, the first line will have the full width, and subsequent lines will be indented by the absolute value of indent.

Readable | Writeable

input-hints

Additional hints (beyond input-purpose) 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.

Readable | Writeable

justification

Left, right, or center justification.

Readable | Writeable

left-margin

The default left margin for text in the text view.

Tags in the buffer may override the default.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

Readable | Writeable

monospace

Whether text should be displayed in a monospace font.

If true, set the .monospace style class on the text view to indicate that a monospace font is desired.

Readable | Writeable

overwrite

Whether entered text overwrites existing contents.

Readable | Writeable

pixels-above-lines

Pixels of blank space above paragraphs.

Readable | Writeable

pixels-below-lines

Pixels of blank space below paragraphs.

Readable | Writeable

pixels-inside-wrap

Pixels of blank space between wrapped lines in a paragraph.

Readable | Writeable

right-margin

The default right margin for text in the text view.

Tags in the buffer may override the default.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

Readable | Writeable

tabs

Custom tabs for this text.

Readable | Writeable

top-margin

The top margin for text in the text view.

Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.

Don’t confuse this property with margin-top.

Readable | Writeable

wrap-mode

Whether to wrap lines never, at word boundaries, or at character boundaries.

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

Overrides 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 NULL 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 NULL: 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 NULL: 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

Overrides 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

Scrollable

hadjustment

Horizontal Adjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

Readable | Writeable | Construct

hscroll-policy

Determines when horizontal scrolling should start.

Readable | Writeable

vadjustment

Vertical Adjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

Readable | Writeable | Construct

vscroll-policy

Determines when vertical scrolling should start.

Readable | Writeable

Signals

backspace

Gets emitted when the user asks for it.

The ::backspace signal is a keybinding signal.

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

Action

copy-clipboard

Gets emitted to copy the selection to the clipboard.

The ::copy-clipboard signal is a keybinding signal.

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

Action

cut-clipboard

Gets emitted to cut the selection to the clipboard.

The ::cut-clipboard signal is a keybinding signal.

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

Action

delete-from-cursor

Gets emitted when the user initiates a text deletion.

The ::delete-from-cursor signal 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, Ctrl+Delete for deleting a word and Ctrl+Backspace for deleting a word backwards.

Action

extend-selection

Emitted when the selection needs to be extended at @location.

insert-at-cursor

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

The ::insert-at-cursor signal is a keybinding signal.

This signal has no default bindings.

Action

insert-emoji

Gets emitted to present the Emoji chooser for the @text_view.

The ::insert-emoji signal is a keybinding signal.

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

Action

move-cursor

Gets emitted when the user initiates a cursor movement.

The ::move-cursor signal is a keybinding signal. If the cursor is not visible in @text_view, this signal causes the viewport to be moved instead.

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
• PgUp and PgDn move vertically by pages
• Ctrl+PgUp and Ctrl+PgDn move horizontally by pages

Action

move-viewport

Gets emitted to move the viewport.

The ::move-viewport signal is a keybinding signal, which can be bound to key combinations to allow the user to move the viewport, i.e. change what part of the text view is visible in a containing scrolled window.

There are no default bindings for this signal.

Action

paste-clipboard

Gets emitted to paste the contents of the clipboard into the text view.

The ::paste-clipboard signal is a keybinding signal.

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

Action

preedit-changed

Emitted when preedit text of the active IM 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.

This signal is only emitted if the text at the given position is actually editable.

Action

select-all

Gets emitted to select or unselect the complete contents of the text view.

The ::select-all signal is a keybinding signal.

The default bindings for this signal are Ctrl+a and Ctrl+/ for selecting and Shift+Ctrl+a and Ctrl+</kbd> for unselecting.

Action

set-anchor

Gets emitted when the user initiates settings the “anchor” mark.

The ::set-anchor signal is a keybinding signal which gets emitted when the user initiates setting the “anchor” mark. The “anchor” mark gets placed at the same position as the “insert” mark.

This signal has no default bindings.

Action

toggle-cursor-visible

Gets emitted to toggle the cursor-visible property.

The ::toggle-cursor-visible signal is a keybinding signal.

The default binding for this signal is F7.

Action

toggle-overwrite

Gets emitted to toggle the overwrite mode of the text view.

The ::toggle-overwrite signal is a keybinding signal.

The default binding 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).

Implements

TextViewExt, WidgetExt, [trait@glib::ObjectExt], AccessibleExt, BuildableExt, ConstraintTargetExt, AccessibleTextExt, ScrollableExt, WidgetExtManual, AccessibleExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl TextView

pub const NONE: Option<&'static TextView> = None

pub fn new() -> TextView

Creates a new TextView.

If you don’t call TextViewExt::set_buffer() before using the text view, an empty default buffer will be created for you. Get the buffer with TextViewExt::buffer(). If you want to specify your own buffer, consider with_buffer().

Returns

a new TextView

pub fn with_buffer(buffer: &impl IsA<TextBuffer>) -> TextView

Creates a new TextView widget displaying the buffer @buffer.

One buffer can be shared among many widgets. @buffer may be None to create a default buffer, in which case this function is equivalent to new(). The text view adds its own reference count to the buffer; it does not take over an existing reference.

buffer

a TextBuffer

Returns

a new TextView.

pub fn builder() -> TextViewBuilder

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

This method returns an instance of TextViewBuilder which can be used to create TextView objects.

Trait Implementations

impl Clone for TextView

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for TextView

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

Formats the value using the given formatter.

impl Default for TextView

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for TextView

type ParamSpec = ParamSpecObject

type SetValue = TextView

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, TextView>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TextView

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

where H: Hasher,

Hashes the memory address of this object.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: TextViewImpl> IsSubclassable<T> for TextView

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for TextView

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for TextView

type Parent = Widget

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for TextView

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TextView

impl IsA<Accessible> for TextView

impl IsA<AccessibleText> for TextView

impl IsA<Buildable> for TextView

impl IsA<ConstraintTarget> for TextView

impl IsA<Scrollable> for TextView

impl IsA<Widget> for TextView