Struct vte4::Terminal

pub struct Terminal { /* private fields */ }

Properties

allow-bold

Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant.

Readable | Writeable

allow-hyperlink

Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed.

Readable | Writeable

audible-bell

Controls whether or not the terminal will beep when the child outputs the “bl” sequence.

Readable | Writeable

backspace-binding

Controls what string or control sequence the terminal sends to its child when the user presses the backspace key.

Readable | Writeable

bold-is-bright

Whether the SGR 1 attribute also switches to the bright counterpart of the first 8 palette colors, in addition to making them bold (legacy behavior) or if SGR 1 only enables bold and leaves the color intact.

Readable | Writeable

cell-height-scale

Scale factor for the cell height, to increase line spacing. (The font’s height is not affected.)

Readable | Writeable

cell-width-scale

Scale factor for the cell width, to increase letter spacing. (The font’s width is not affected.)

Readable | Writeable

cjk-ambiguous-width

This setting controls whether ambiguous-width characters are narrow or wide. (Note that when using a non-UTF-8 encoding set via vte_terminal_set_encoding(), the width of ambiguous-width characters is fixed and determined by the encoding itself.)

This setting only takes effect the next time the terminal is reset, either via escape sequence or with vte_terminal_reset().

Readable | Writeable

context-menu

The menu used for context menus. Note that context menu model set with the #VteTerminal::context-menu-model property or vte_terminal_set_context_menu_model() takes precedence over this.

Readable | Writeable

context-menu-model

The menu model used for context menus. If non-None, the context menu is generated from this model, and overrides a context menu set with the #VteTerminal::context-menu property or vte_terminal_set_context_menu().

Readable | Writeable

current-container-name

The name of the current container, or None if unset.

Readable

current-container-runtime

The name of the runtime toolset used to set up the current container, or None if unset.

Readable

current-directory-uri

The current directory URI, or None if unset.

Readable

current-file-uri

The current file URI, or None if unset.

Readable

cursor-blink-mode

Sets whether or not the cursor will blink. Using CursorBlinkMode::System will use the #GtkSettings:gtk-cursor-blink setting.

Readable | Writeable

cursor-shape

Controls the shape of the cursor.

Readable | Writeable

delete-binding

Controls what string or control sequence the terminal sends to its child when the user presses the delete key.

Readable | Writeable

enable-a11y

Controls whether or not a11y is enabled for the widget.

Readable | Writeable

enable-bidi

Controls whether or not the terminal will perform bidirectional text rendering.

Readable | Writeable

enable-fallback-scrolling

Readable | Writeable

enable-shaping

Controls whether or not the terminal will shape Arabic text.

Readable | Writeable

enable-sixel

Controls whether SIXEL image support is enabled.

Readable | Writeable

encoding

Controls the encoding the terminal will expect data from the child to be encoded with. For certain terminal types, applications executing in the terminal can change the encoding. The default is defined by the application’s locale settings.

Readable | Writeable

font-desc

Specifies the font used for rendering all text displayed by the terminal, overriding any fonts set using gtk_widget_modify_font(). The terminal will immediately attempt to load the desired font, retrieve its metrics, and attempt to resize itself to keep the same number of rows and columns.

Readable | Writeable

font-options

The terminal’s font options, or None to use the default font options.

Note that on GTK4, the terminal by default uses font options with CAIRO_HINT_METRICS_ON set; to override that, use this function to set a #cairo_font_options_t that has CAIRO_HINT_METRICS_OFF set.

Readable | Writeable

font-scale

The terminal’s font scale.

Readable | Writeable

hyperlink-hover-uri

The currently hovered hyperlink URI, or None if unset.

Readable

icon-title

Readable

input-enabled

Controls whether the terminal allows user input. When user input is disabled, key press and mouse button press and motion events are not sent to the terminal’s child.

Readable | Writeable

pointer-autohide

Controls the value of the terminal’s mouse autohide setting. When autohiding is enabled, the mouse cursor will be hidden when the user presses a key and shown when the user moves the mouse.

Readable | Writeable

pty

The PTY object for the terminal.

Readable | Writeable

rewrap-on-resize

Controls whether or not the terminal will rewrap its contents, including the scrollback buffer, whenever the terminal’s width changes.

Readable | Writeable

scroll-on-insert

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the text is inserted (e.g. by a paste).

Readable | Writeable

scroll-on-keystroke

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key. Modifier keys do not trigger this behavior.

Readable | Writeable

scroll-on-output

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child.

Readable | Writeable

scroll-unit-is-pixels

Controls whether the terminal’s GtkAdjustment values unit is lines or pixels. This can be enabled when the terminal is the child of a GtkScrolledWindow to fix some bugs with its kinetic scrolling.

Readable | Writeable

scrollback-lines

The length of the scrollback buffer used by the terminal. The size of the scrollback buffer will be set to the larger of this value and the number of visible rows the widget can display, so 0 can safely be used to disable scrollback. Note that this setting only affects the normal screen buffer. For terminal types which have an alternate screen buffer, no scrollback is allowed on the alternate screen buffer.

Readable | Writeable

text-blink-mode

Controls whether or not the terminal will allow blinking text.

Readable | Writeable

window-title

The terminal’s title.

Readable

word-char-exceptions

The set of characters which will be considered parts of a word when doing word-wise selection, in addition to the default which only considers alphanumeric characters part of a word.

If None, a built-in set is used.

Readable

xalign

The horizontal alignment of @terminal within its allocation.

Readable | Writeable

xfill

The horizontal fillment of @terminal within its allocation.

Readable | Writeable

yalign

The vertical alignment of @terminal within its allocation

Readable | Writeable

yfill

The vertical fillment of @terminal within its allocation. Note that #VteTerminal:yfill=true is only supported with #VteTerminal:yalign=Align::Start, and is ignored for all other yalign values.

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 GtkLayoutManager 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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 GtkRoot 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 Gtk::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 Gtk::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 gtk::Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Scrollable

hadjustment

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

bell

This signal is emitted when the a child sends a bell request to the terminal.

char-size-changed

Emitted whenever the cell size changes, e.g. due to a change in font, font-scale or cell-width/height-scale.

Note that this signal should rather be called “cell-size-changed”.

child-exited

This signal is emitted when the terminal detects that a child watched using vte_terminal_watch_child() has exited.

commit

Emitted whenever the terminal receives input from the user and prepares to send it to the child process.

contents-changed

Emitted whenever the visible appearance of the terminal has changed. Used primarily by #VteTerminalAccessible.

copy-clipboard

Emitted whenever vte_terminal_copy_clipboard() is called.

Action

current-directory-uri-changed

Emitted when the current directory URI is modified.

current-file-uri-changed

Emitted when the current file URI is modified.

cursor-moved

Emitted whenever the cursor moves to a new character cell. Used primarily by #VteTerminalAccessible.

decrease-font-size

Emitted when the user hits the ‘-’ key while holding the Control key.

deiconify-window

Never emitted.

encoding-changed

Emitted whenever the terminal’s current encoding has changed.

Note: support for non-UTF-8 is deprecated.

eof

Emitted when the terminal receives an end-of-file from a child which is running in the terminal. This signal is frequently (but not always) emitted with a #VteTerminal::child-exited signal.

hyperlink-hover-uri-changed

Emitted when the hovered hyperlink changes.

@uri and @bbox are owned by VTE, must not be modified, and might change after the signal handlers returns.

The signal is not re-emitted when the bounding box changes for the same hyperlink. This might change in a future VTE version without notice.

icon-title-changed

iconify-window

Never emitted.

increase-font-size

Emitted when the user hits the ‘+’ key while holding the Control key.

lower-window

Never emitted.

maximize-window

Never emitted.

move-window

Never emitted.

notification-received

Emitted when a process running in the terminal wants to send a notification to the desktop environment.

paste-clipboard

Emitted whenever vte_terminal_paste_clipboard() is called.

Action

raise-window

Never emitted.

refresh-window

Never emitted.

resize-window

Emitted at the child application’s request.

restore-window

Never emitted.

selection-changed

Emitted whenever the contents of terminal’s selection changes.

setup-context-menu

Emitted with non-None context before @terminal shows a context menu. The handler may set either a menu model using vte_terminal_set_context_menu_model(), or a menu using vte_terminal_set_context_menu(), which will then be used as context menu. If neither a menu model nor a menu are set, a context menu will not be shown.

Note that @context is only valid during the signal emission; you may not retain it to call methods on it afterwards.

Also emitted with None context after the context menu has been dismissed.

shell-precmd

Emitted right before an interactive shell shows a first-level prompt.

shell-preexec

Emitted when the interactive shell has read in a complete command and is about to execute it.

window-title-changed

Emitted when the #VteTerminal:window-title property is modified.

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 [WidgetExtManual::keynav_failed()][crate::gtk::prelude::WidgetExtManual::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 GdkSurface.

This means that [WidgetExtManual::realize()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::state_flags()][crate::gtk::prelude::WidgetExtManual::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 GdkSurface associated with @widget is destroyed.

This means that [WidgetExtManual::unrealize()][crate::gtk::prelude::WidgetExtManual::unrealize()] has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

TerminalExt, gtk::prelude::WidgetExt, gtk::prelude::AccessibleExt, gtk::prelude::BuildableExt, gtk::prelude::ConstraintTargetExt, gtk::prelude::ScrollableExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl Terminal

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

pub fn new() -> Terminal

Creates a new terminal widget.

Returns

a new #VteTerminal object

pub fn builder() -> TerminalBuilder

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

This method returns an instance of TerminalBuilder which can be used to create Terminal objects.

Trait Implementations

impl Clone for Terminal

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 Terminal

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

Formats the value using the given formatter.

impl Default for Terminal

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Terminal

type ParamSpec = ParamSpecObject

type SetValue = Terminal

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Terminal

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: TerminalImpl> IsSubclassable<T> for Terminal

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 Terminal

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 + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Terminal

type Parent = Widget

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

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

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

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

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

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 Terminal

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Terminal

impl IsA<Accessible> for Terminal

impl IsA<Buildable> for Terminal

impl IsA<ConstraintTarget> for Terminal

impl IsA<Scrollable> for Terminal

impl IsA<Widget> for Terminal