Class
VteTerminal
Instance methods
vte_terminal_check_hyperlink_at
Returns a nonempty string: the target of the explicit hyperlink (printed using the OSC 8
escape sequence) at the position (x, y), or NULL
.
since: 0.70
vte_terminal_check_match_at
Checks if the text in and around the position (x, y) matches any of the
regular expressions previously set using vte_terminal_match_add(). If a
match exists, the text string is returned and if tag
is not NULL
, the number
associated with the matched regular expression will be stored in tag
.
since: 0.70
vte_terminal_check_regex_array_at
Like vte_terminal_check_regex_simple_at(), but returns an array of strings,
containing the matching text (or NULL
if no match) corresponding to each of the
regexes in regexes
.
since: 0.70
vte_terminal_check_regex_simple_at
Checks each regex in regexes
if the text in and around the position (x, y)
matches the regular expressions. If a match exists, the matched
text is stored in matches
at the position of the regex in regexes
; otherwise
NULL
is stored there. Each non-NULL
element of matches
should be freed with g_free().
since: 0.70
vte_terminal_copy_clipboard
Places the selected text in the terminal in the #GDK_SELECTION_CLIPBOARD selection.
deprecated: 0.50
vte_terminal_copy_clipboard_format
Places the selected text in the terminal in the #GDK_SELECTION_CLIPBOARD
selection in the form specified by format
.
since: 0.50
vte_terminal_copy_primary
Places the selected text in the terminal in the #GDK_SELECTION_PRIMARY selection.
vte_terminal_dup_termprop_string
Returns the value of a VTE_PROPERTY_STRING
termprop, or NULL
if
prop
is unset, or prop
is not a registered property.
since: 0.78
vte_terminal_dup_termprop_string_by_id
Like vte_terminal_dup_termprop_string()
except that it takes the termprop
by ID. See that function for more information.
since: 0.78
vte_terminal_dup_termprop_uuid
Returns the value of a VTE_PROPERTY_UUID
termprop as a VteUuid
, or NULL
if
prop
is unset, or prop
is not a registered property.
since: 0.78
vte_terminal_dup_termprop_uuid_by_id
Like vte_terminal_dup_termprop_uuid()
except that it takes the termprop
by ID. See that function for more information.
since: 0.78
vte_terminal_feed_child
Sends a block of UTF-8 text to the child as if it were entered by the user at the keyboard.
vte_terminal_get_allow_bold
Checks whether or not the terminal will attempt to draw bold text, by using a bold font variant.
deprecated: 0.60
vte_terminal_get_allow_hyperlink
Checks whether or not hyperlinks (OSC 8 escape sequence) are allowed.
since: 0.50
vte_terminal_get_audible_bell
Checks whether or not the terminal will beep when the child outputs the “bl” sequence.
vte_terminal_get_bold_is_bright
Checks 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.
since: 0.52
vte_terminal_get_cjk_ambiguous_width
Returns 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.).
vte_terminal_get_color_background_for_draw
Returns the background colour, as used by terminal
when
drawing the background, which may be different from
the color set by vte_terminal_set_color_background().
since: 0.54
vte_terminal_get_cursor_position
Reads the location of the insertion cursor and returns it. The row coordinate is absolute.
vte_terminal_get_enable_a11y
Checks whether the terminal communicates with a11y backends.
since: 0.78
vte_terminal_get_enable_bidi
Checks whether the terminal performs bidirectional text rendering.
since: 0.58
vte_terminal_get_encoding
Determines the name of the encoding in which the terminal expects data to be
encoded, or NULL
if UTF-8 is in use.
deprecated: 0.54
vte_terminal_get_font
Queries the terminal for information about the fonts which will be used to draw text in the terminal. The actual font takes the font scale into account, this is not reflected in the return value, the unscaled font is returned.
vte_terminal_get_has_selection
Checks if the terminal currently contains selected text. Note that this
is different from determining if the terminal is the owner of any
GtkClipboard
items.
vte_terminal_get_mouse_autohide
Determines 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. This setting can be changed using vte_terminal_set_mouse_autohide().
vte_terminal_get_rewrap_on_resize
Checks whether or not the terminal will rewrap its contents upon resize.
deprecated: 0.58
vte_terminal_get_termprop_bool
For a VTE_PROPERTY_BOOL
termprop, sets value
to prop
‘s value,
or to FALSE
if prop
is unset, or prop
is not a registered property.
since: 0.78
vte_terminal_get_termprop_bool_by_id
Like vte_terminal_get_termprop_bool()
except that it takes the termprop
by ID. See that function for more information.
since: 0.78
vte_terminal_get_termprop_data
Returns the value of a VTE_PROPERTY_DATA
termprop, or NULL
if
prop
is unset, or prop
is not a registered property.
since: 0.78
vte_terminal_get_termprop_data_by_id
Like vte_terminal_get_termprop_data()
except that it takes the termprop
by ID. See that function for more information.
since: 0.78
vte_terminal_get_termprop_double
For a VTE_PROPERTY_DOUBLE
termprop, sets value
to prop
‘s value,
which is finite; or to 0.0 if prop
is unset, or prop
is not a
registered property.
since: 0.78
vte_terminal_get_termprop_double_by_id
Like vte_terminal_get_termprop_double()
except that it takes the termprop
by ID. See that function for more information.
since: 0.78
vte_terminal_get_termprop_int
For a VTE_PROPERTY_INT
termprop, sets value
to prop
‘s value,
or to 0 if prop
is unset, or if prop
is not a registered property.
since: 0.78
vte_terminal_get_termprop_int_by_id
Like vte_terminal_get_termprop_int()
except that it takes the termprop
by ID. See that function for more information.
since: 0.78
vte_terminal_get_termprop_rgba
Stores the value of a VTE_PROPERTY_RGB
or VTE_PROPERTY_RGBA
termprop in color
and
returns TRUE
if the termprop is set, or stores rgb(0,0,0) or rgba(0,0,0,1) in color
and returns FALSE
if the termprop is unset.
since: 0.78
vte_terminal_get_termprop_rgba_by_id
Like vte_terminal_get_termprop_rgba()
except that it takes the termprop
by ID. See that function for more information.
since: 0.78
vte_terminal_get_termprop_string
Returns the value of a VTE_PROPERTY_STRING
termprop, or NULL
if
prop
is unset, or prop
is not a registered property.
since: 0.78
vte_terminal_get_termprop_string_by_id
Like vte_terminal_get_termprop_string()
except that it takes the termprop
by ID. See that function for more information.
since: 0.78
vte_terminal_get_termprop_uint
For a VTE_PROPERTY_UINT
termprop, sets value
to prop
‘s value,
or to 0 if prop
is unset, or prop
is not a registered property.
since: 0.78
vte_terminal_get_termprop_uint_by_id
Like vte_terminal_get_termprop_uint()
except that it takes the termprop
by ID. See that function for more information.
since: 0.78
vte_terminal_get_termprop_value
Returns TRUE
with the value of prop
stored in value
(if not NULL
) if,
the termprop has a value, or FALSE
if prop
is unset, or prop
is not
a registered property; in that case value
will not be set.
since: 0.78
vte_terminal_get_termprop_value_by_id
Like vte_terminal_get_termprop_value()
except that it takes the termprop
by ID. See that function for more information.
since: 0.78
vte_terminal_get_text_blink_mode
Checks whether or not the terminal will allow blinking text.
since: 0.52
vte_terminal_get_text_format
Returns text from the visible part of the terminal in the specified format.
since: 0.76
vte_terminal_get_text_include_trailing_spaces
Extracts a view of the visible part of the terminal.
deprecated: 0.56
vte_terminal_get_text_range
Extracts a view of the visible part of the terminal. The entire scrollback buffer is scanned, so it is possible to read the entire contents of the buffer using this function.
deprecated: 0.76
vte_terminal_get_text_range_format
Returns the specified range of text in the specified format.
since: 0.72
vte_terminal_get_text_selected
Gets the currently selected text in the format specified by format
.
Since 0.72, this function also supports VTE_FORMAT_HTML
format.
since: 0.70
vte_terminal_get_text_selected_full
Gets the currently selected text in the format specified by format
.
since: 0.72
vte_terminal_get_word_char_exceptions
Returns 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.
since: 0.40
vte_terminal_match_add_regex
Adds the regular expression regex
to the list of matching expressions. When the
user moves the mouse cursor over a section of displayed text which matches
this expression, the text will be highlighted.
since: 0.46
vte_terminal_match_check
Checks if the text in and around the specified position matches any of the
regular expressions previously set using vte_terminal_match_add(). If a
match exists, the text string is returned and if tag
is not NULL
, the number
associated with the matched regular expression will be stored in tag
.
deprecated: 0.46
vte_terminal_match_remove
Removes the regular expression which is associated with the given tag
from
the list of expressions which the terminal will highlight when the user
moves the mouse cursor over matching text.
vte_terminal_match_remove_all
Clears the list of regular expressions the terminal uses to highlight text when the user moves the mouse cursor.
vte_terminal_match_set_cursor
Sets which cursor the terminal will use if the pointer is over the pattern
specified by tag
. The terminal keeps a reference to cursor
.
deprecated: 0.40
vte_terminal_match_set_cursor_name
Sets which cursor the terminal will use if the pointer is over the pattern
specified by tag
.
vte_terminal_paste_clipboard
Sends the contents of the #GDK_SELECTION_CLIPBOARD selection to the terminal’s child. It’s called on paste menu item, or when user presses Shift+Insert.
vte_terminal_paste_primary
Sends the contents of the #GDK_SELECTION_PRIMARY selection to the terminal’s child. The terminal will call also paste the
GDK_SELECTION_PRIMARY selection when the user clicks with the the second
mouse button.
vte_terminal_paste_text
Sends text
to the terminal’s child as if retrived from the clipboard,
this differs from vte_terminal_feed_child()
in that it may process
text
before passing it to the child (e.g. apply bracketed mode).
since: 0.68
vte_terminal_pty_new_sync
Creates a new VtePty
, sets the emulation property
from VteTerminal:emulation
, and sets the size using
terminal
‘s size.
vte_terminal_ref_termprop_data_bytes
Returns the value of a VTE_PROPERTY_DATA
termprop as a GBytes
, or NULL
if
prop
is unset, or prop
is not a registered property.
since: 0.78
vte_terminal_ref_termprop_data_bytes_by_id
Like vte_terminal_ref_termprop_data_bytes()
except that it takes the termprop
by ID. See that function for more information.
since: 0.78
vte_terminal_ref_termprop_uri
Returns the value of a VTE_PROPERTY_URI
termprop as a GUri
, or NULL
if
prop
is unset, or prop
is not a registered property.
since: 0.78
vte_terminal_ref_termprop_uri_by_id
Like vte_terminal_ref_termprop_uri()
except that it takes the termprop
by ID. See that function for more information.
since: 0.78
vte_terminal_ref_termprop_variant
Returns the value of prop
as a GVariant
, or NULL
if
prop
unset, or prop
is not a registered property.
since: 0.78
vte_terminal_ref_termprop_variant_by_id
Like vte_terminal_ref_termprop_variant()
except that it takes the termprop
by ID. See that function for more information.
since: 0.78
vte_terminal_reset
Resets as much of the terminal’s internal state as possible, discarding any unprocessed input data, resetting character attributes, cursor state, national character set state, status line, terminal modes (insert/delete), selection state, and encoding.
vte_terminal_search_find_next
Searches the next string matching the search regex set with vte_terminal_search_set_regex().
vte_terminal_search_find_previous
Searches the previous string matching the search regex set with vte_terminal_search_set_regex().
vte_terminal_search_set_regex
Sets the regex to search for. Unsets the search regex when passed NULL
.
since: 0.46
vte_terminal_search_set_wrap_around
Sets whether search should wrap around to the beginning of the terminal content when reaching its end.
vte_terminal_set_allow_bold
Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant.
deprecated: 0.60
vte_terminal_set_allow_hyperlink
Controls whether or not hyperlinks (OSC 8 escape sequence) are allowed.
since: 0.50
vte_terminal_set_audible_bell
Controls whether or not the terminal will beep when the child outputs the “bl” sequence.
vte_terminal_set_backspace_binding
Modifies the terminal’s backspace key binding, which controls what string or control sequence the terminal sends to its child when the user presses the backspace key.
vte_terminal_set_bold_is_bright
Sets 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.
since: 0.52
vte_terminal_set_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.).
vte_terminal_set_clear_background
Sets whether to paint the background with the background colour.
The default is TRUE
.
since: 0.52
vte_terminal_set_color_background
Sets the background color for text which does not have a specific background color assigned. Only has effect when no background image is set and when the terminal is not transparent.
vte_terminal_set_color_bold
Sets the color used to draw bold text in the default foreground color.
If bold
is NULL
then the default color is used.
vte_terminal_set_color_cursor
Sets the background color for text which is under the cursor. If NULL
, text
under the cursor will be drawn with foreground and background colors reversed.
vte_terminal_set_color_cursor_foreground
Sets the foreground color for text which is under the cursor. If NULL
, text
under the cursor will be drawn with foreground and background colors reversed.
since: 0.44
vte_terminal_set_color_highlight
Sets the background color for text which is highlighted. If NULL
,
it is unset. If neither highlight background nor highlight foreground are set,
highlighted text (which is usually highlighted because it is selected) will
be drawn with foreground and background colors reversed.
vte_terminal_set_color_highlight_foreground
Sets the foreground color for text which is highlighted. If NULL
,
it is unset. If neither highlight background nor highlight foreground are set,
highlighted text (which is usually highlighted because it is selected) will
be drawn with foreground and background colors reversed.
vte_terminal_set_colors
palette
specifies the new values for the 256 palette colors: 8 standard colors,
their 8 bright counterparts, 6x6x6 color cube, and 24 grayscale colors.
Omitted entries will default to a hardcoded value.
vte_terminal_set_context_menu
Sets menu
as the context menu in terminal
.
Use NULL
to unset the current menu.
since: 0.76
vte_terminal_set_context_menu_model
Sets model
as the context menu model in terminal
.
Use NULL
to unset the current menu model.
since: 0.76
vte_terminal_set_cursor_blink_mode
Sets whether or not the cursor will blink. Using VTE_CURSOR_BLINK_SYSTEM
will use the GtkSettings::gtk-cursor-blink
setting.
vte_terminal_set_delete_binding
Modifies the terminal’s delete key binding, which controls what string or control sequence the terminal sends to its child when the user presses the delete key.
vte_terminal_set_enable_a11y
Controls whether or not the terminal will communicate with a11y backends.
since: 0.78
vte_terminal_set_enable_bidi
Controls whether or not the terminal will perform bidirectional text rendering.
since: 0.58
vte_terminal_set_enable_fallback_scrolling
Controls whether the terminal uses scroll events to scroll the history if the event was not otherwise consumed by it.
since: 0.64
vte_terminal_set_enable_legacy_osc777
Sets whether legacy OSC 777 sequences are translated to their corresponding termprops.
since: 0.78
vte_terminal_set_enable_shaping
Controls whether or not the terminal will shape Arabic text.
since: 0.58
vte_terminal_set_encoding
Changes 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. If codeset
is NULL
, it uses “UTF-8”.
deprecated: 0.54
vte_terminal_set_font
Sets 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. The font scale is applied to the specified font.
vte_terminal_set_input_enabled
Enables or disables user input. When user input is disabled, the terminal’s child will not receive any key press, or mouse button press or motion events sent to it.
vte_terminal_set_mouse_autohide
Changes 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. This setting can be read using vte_terminal_get_mouse_autohide().
vte_terminal_set_rewrap_on_resize
Controls whether or not the terminal will rewrap its contents, including the scrollback history, whenever the terminal’s width changes.
deprecated: 0.58
vte_terminal_set_scroll_on_insert
Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when text is inserted, e.g. by a paste.
since: 0.76
vte_terminal_set_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.
since: 0.52
vte_terminal_set_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.
since: 0.52
vte_terminal_set_scroll_unit_is_pixels
Controls whether the terminal’s scroll unit is lines or pixels.
since: 0.66
vte_terminal_set_scrollback_lines
Sets 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.
vte_terminal_set_size
Attempts to change the terminal’s size in terms of rows and columns. If the attempt succeeds, the widget will resize itself to the proper size.
vte_terminal_set_suppress_legacy_signals
Suppress emissions of signals and property notifications that are deprecated.
since: 0.78
vte_terminal_set_text_blink_mode
Controls whether or not the terminal will allow blinking text.
since: 0.52
vte_terminal_set_word_char_exceptions
With this function you can provide a 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.
since: 0.40
vte_terminal_set_xalign
Sets the horizontal alignment of terminal
within its allocation.
since: 0.76
vte_terminal_set_yfill
Sets the vertical fillment of terminal
within its allocation.
Note that yfill is only supported with yalign set to
VTE_ALIGN_START
, and is ignored for all other yalign values.
since: 0.76
vte_terminal_spawn_async
A convenience function that wraps creating the VtePty
and spawning
the child process on it. Like vte_terminal_spawn_with_fds_async(),
except that this function does not allow passing file descriptors to
the child process. See vte_terminal_spawn_with_fds_async()
for more information.
since: 0.48
vte_terminal_spawn_sync
Starts the specified command under a newly-allocated controlling
pseudo-terminal. The argv
and envv
lists should be NULL
-terminated.
The “TERM” environment variable is automatically set to a default value,
but can be overridden from envv
.
pty_flags
controls logging the session to the specified system log files.
deprecated: 0.48
vte_terminal_spawn_with_fds_async
A convenience function that wraps creating the VtePty
and spawning
the child process on it. See vte_pty_new_sync(), vte_pty_spawn_with_fds_async(),
and vte_pty_spawn_finish()
for more information.
since: 0.62
vte_terminal_watch_child
Watches child_pid
. When the process exists, the VteTerminal::child-exited
signal will be called with the child’s exit status.
vte_terminal_write_contents_sync
Write contents of the current contents of terminal
(including any
scrollback history) to stream
according to flags
.
Methods inherited from GtkAccessible (19)
gtk_accessible_announce
Requests the user’s screen reader to announce the given message.
gtk_accessible_get_accessible_parent
Retrieves the accessible parent for an accessible object.
gtk_accessible_get_accessible_role
Retrieves the accessible role of an accessible object.
gtk_accessible_get_at_context
Retrieves the accessible implementation for the given GtkAccessible
.
gtk_accessible_get_bounds
Queries the coordinates and dimensions of this accessible.
gtk_accessible_get_first_accessible_child
Retrieves the first accessible child of an accessible object.
gtk_accessible_get_next_accessible_sibling
Retrieves the next accessible sibling of an accessible object.
gtk_accessible_get_platform_state
Query a platform state, such as focus.
gtk_accessible_reset_property
Resets the accessible property
to its default value.
gtk_accessible_reset_relation
Resets the accessible relation
to its default value.
gtk_accessible_reset_state
Resets the accessible state
to its default value.
gtk_accessible_set_accessible_parent
Sets the parent and sibling of an accessible object.
gtk_accessible_update_next_accessible_sibling
Updates the next accessible sibling of self
.
gtk_accessible_update_property
Updates a list of accessible properties.
gtk_accessible_update_property_value
Updates an array of accessible properties.
gtk_accessible_update_relation
Updates a list of accessible relations.
gtk_accessible_update_relation_value
Updates an array of accessible relations.
gtk_accessible_update_state
Updates a list of accessible states. See the GtkAccessibleState
documentation for the value types of accessible states.
gtk_accessible_update_state_value
Updates an array of accessible states.
Methods inherited from GtkAccessibleText (3)
gtk_accessible_text_update_caret_position
Updates the position of the caret.
gtk_accessible_text_update_contents
Notifies assistive technologies of a change in contents.
gtk_accessible_text_update_selection_bound
Updates the boundary of the selection.
Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id
Gets the ID of the buildable
object.
Methods inherited from GtkScrollable (9)
gtk_scrollable_get_border
Returns the size of a non-scrolling border around the outside of the scrollable.
gtk_scrollable_get_hadjustment
Retrieves the GtkAdjustment
used for horizontal scrolling.
gtk_scrollable_get_hscroll_policy
Gets the horizontal GtkScrollablePolicy
.
gtk_scrollable_get_vadjustment
Retrieves the GtkAdjustment
used for vertical scrolling.
gtk_scrollable_get_vscroll_policy
Gets the vertical GtkScrollablePolicy
.
gtk_scrollable_set_hadjustment
Sets the horizontal adjustment of the GtkScrollable
.
gtk_scrollable_set_hscroll_policy
Sets the GtkScrollablePolicy
.
gtk_scrollable_set_vadjustment
Sets the vertical adjustment of the GtkScrollable
.
gtk_scrollable_set_vscroll_policy
Sets the GtkScrollablePolicy
.
Properties
Vte.Terminal:allow-bold
Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant.
deprecated: 0.60
Vte.Terminal:allow-hyperlink
Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed.
since: 0.50
Vte.Terminal:audible-bell
Controls whether or not the terminal will beep when the child outputs the “bl” sequence.
Vte.Terminal:backspace-binding
Controls what string or control sequence the terminal sends to its child when the user presses the backspace key.
Vte.Terminal: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.
since: 0.52
Vte.Terminal:cell-height-scale
Scale factor for the cell height, to increase line spacing. (The font’s height is not affected.).
since: 0.52
Vte.Terminal:cell-width-scale
Scale factor for the cell width, to increase letter spacing. (The font’s width is not affected.).
since: 0.52
Vte.Terminal: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.).
Vte.Terminal: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.
since: 0.76
Vte.Terminal:context-menu-model
The menu model used for context menus. If non-NULL
, 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().
since: 0.76
Vte.Terminal:cursor-blink-mode
Sets whether or not the cursor will blink. Using VTE_CURSOR_BLINK_SYSTEM
will use the GtkSettings:gtk-cursor-blink
setting.
Vte.Terminal:delete-binding
Controls what string or control sequence the terminal sends to its child when the user presses the delete key.
Vte.Terminal:enable-bidi
Controls whether or not the terminal will perform bidirectional text rendering.
since: 0.58
Vte.Terminal:enable-legacy-osc777
Whether legacy OSC 777 sequences are translated to their corresponding termprops.
since: 0.78
Vte.Terminal:enable-shaping
Controls whether or not the terminal will shape Arabic text.
since: 0.58
Vte.Terminal: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.
deprecated: 0.54
Vte.Terminal: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.
Vte.Terminal:font-options
The terminal’s font options, or NULL
to use the default font options.
since: 0.74
Vte.Terminal: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.
Vte.Terminal: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.
Vte.Terminal:rewrap-on-resize
Controls whether or not the terminal will rewrap its contents, including the scrollback buffer, whenever the terminal’s width changes.
deprecated: 0.58
Vte.Terminal: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).
since: 0.76
Vte.Terminal: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.
Vte.Terminal: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.
Vte.Terminal: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.
since: 0.66
Vte.Terminal: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.
Vte.Terminal:text-blink-mode
Controls whether or not the terminal will allow blinking text.
since: 0.52
Vte.Terminal: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.
since: 0.40
Vte.Terminal:yfill
The vertical fillment of terminal
within its allocation.
Note that VteTerminal:yfill
=TRUE
is only supported with
VteTerminal:yalign
=VTE_ALIGN_START
, and is ignored for
all other yalign values.
since: 0.76
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
Gtk.Widget:can-target
Whether the widget can receive pointer events.
Gtk.Widget:css-classes
A list of css classes applied to this widget.
Gtk.Widget:css-name
The name of this widget in the CSS tree.
Gtk.Widget:cursor
The cursor used by widget
.
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
Gtk.Widget:has-default
Whether the widget is the default widget.
Gtk.Widget:has-focus
Whether the widget has the input focus.
Gtk.Widget:has-tooltip
Enables or disables the emission of the ::query-tooltip signal on widget
.
Gtk.Widget:height-request
Override for height request of the widget.
Gtk.Widget:hexpand
Whether to expand horizontally.
Gtk.Widget:hexpand-set
Whether to use the hexpand
property.
Gtk.Widget:layout-manager
The GtkLayoutManager
instance to use to compute the preferred size
of the widget, and allocate its children.
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
Gtk.Widget:margin-top
Margin on top side of widget.
Gtk.Widget:name
The name of the widget.
Gtk.Widget:opacity
The requested opacity of the widget.
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
Gtk.Widget:parent
The parent widget of this widget.
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
Gtk.Widget:root
The GtkRoot
widget of the widget tree containing this widget.
Gtk.Widget:scale-factor
The scale factor of the widget.
Gtk.Widget:sensitive
Whether the widget responds to input.
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
Gtk.Widget:vexpand
Whether to expand vertically.
Gtk.Widget:vexpand-set
Whether to use the vexpand
property.
Gtk.Widget:visible
Whether the widget is visible.
Gtk.Widget:width-request
Override for width request of the widget.
Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role
The accessible role of the given GtkAccessible
implementation.
Properties inherited from GtkScrollable (4)
Gtk.Scrollable:hadjustment
Horizontal GtkAdjustment
of the scrollable widget.
Gtk.Scrollable:hscroll-policy
Determines when horizontal scrolling should start.
Gtk.Scrollable:vadjustment
Vertical GtkAdjustment
of the scrollable widget.
Gtk.Scrollable:vscroll-policy
Determines when vertical scrolling should start.
Signals
Vte.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.
Vte.Terminal::child-exited
This signal is emitted when the terminal detects that a child
watched using vte_terminal_watch_child()
has exited.
Vte.Terminal::commit
Emitted whenever the terminal receives input from the user and prepares to send it to the child process.
Vte.Terminal::contents-changed
Emitted whenever the visible appearance of the terminal has changed.
Used primarily by VteTerminalAccessible
.
Vte.Terminal::current-directory-uri-changed
Emitted when the current directory URI is modified.
deprecated: 0.78
Vte.Terminal::current-file-uri-changed
Emitted when the current file URI is modified.
deprecated: 0.78
Vte.Terminal::cursor-moved
Emitted whenever the cursor moves to a new character cell. Used
primarily by VteTerminalAccessible
.
Vte.Terminal::decrease-font-size
Emitted when the user hits the ‘-‘ key while holding the Control key.
Vte.Terminal::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.
Vte.Terminal::increase-font-size
Emitted when the user hits the ‘+’ key while holding the Control key.
Vte.Terminal::setup-context-menu
Emitted with non-NULL
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.
Vte.Terminal::termprop-changed
The “termprop-changed” signal is emitted when a termprop has changed or been reset.
since: 0.78
Vte.Terminal::termprops-changed
Emitted when termprops have changed. props
is an array containing
the IDs of the terminal properties that may have changed since
the last emission of this signal, in an undefined order.
Note that emission of this signal is delayed from the receipt of the
OSC sequences, and a termprop may have been changed more than once
inbetween signal emissions, but only the value set last is retrievable.
since: 0.78
Vte.Terminal::window-title-changed
Emitted when the VteTerminal:window-title
property is modified.
deprecated: 0.78
Signals inherited from GtkWidget (13)
GtkWidget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold.
GtkWidget::direction-changed
Emitted when the text direction of a widget changes.
GtkWidget::hide
Emitted when widget
is hidden.
GtkWidget::keynav-failed
Emitted if keyboard navigation fails.
GtkWidget::map
Emitted when widget
is going to be mapped.
GtkWidget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
GtkWidget::move-focus
Emitted when the focus is moved.
GtkWidget::query-tooltip
Emitted when the widget’s tooltip is about to be shown.
GtkWidget::realize
Emitted when widget
is associated with a GdkSurface
.
GtkWidget::show
Emitted when widget
is shown.
GtkWidget::state-flags-changed
Emitted when the widget state changes.
GtkWidget::unmap
Emitted when widget
is going to be unmapped.
GtkWidget::unrealize
Emitted when the GdkSurface
associated with widget
is destroyed.
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct VteTerminalClass {
GtkWidgetClass parent_class;
void (* eof) (
VteTerminal* terminal
);
void (* child_exited) (
VteTerminal* terminal,
int status
);
void (* encoding_changed) (
VteTerminal* terminal
);
void (* char_size_changed) (
VteTerminal* terminal,
guint char_width,
guint char_height
);
void (* window_title_changed) (
VteTerminal* terminal
);
void (* icon_title_changed) (
VteTerminal* terminal
);
void (* selection_changed) (
VteTerminal* terminal
);
void (* contents_changed) (
VteTerminal* terminal
);
void (* cursor_moved) (
VteTerminal* terminal
);
void (* commit) (
VteTerminal* terminal,
const gchar* text,
guint size
);
void (* deiconify_window) (
VteTerminal* terminal
);
void (* iconify_window) (
VteTerminal* terminal
);
void (* raise_window) (
VteTerminal* terminal
);
void (* lower_window) (
VteTerminal* terminal
);
void (* refresh_window) (
VteTerminal* terminal
);
void (* restore_window) (
VteTerminal* terminal
);
void (* maximize_window) (
VteTerminal* terminal
);
void (* resize_window) (
VteTerminal* terminal,
guint width,
guint height
);
void (* move_window) (
VteTerminal* terminal,
guint x,
guint y
);
void (* increase_font_size) (
VteTerminal* terminal
);
void (* decrease_font_size) (
VteTerminal* terminal
);
void (* copy_clipboard) (
VteTerminal* terminal
);
void (* paste_clipboard) (
VteTerminal* terminal
);
void (* bell) (
VteTerminal* terminal
);
void (* setup_context_menu) (
VteTerminal* terminal,
const VteEventContext* context
);
gboolean (* termprops_changed) (
VteTerminal* terminal,
const int* props,
int n_props
);
void (* termprop_changed) (
VteTerminal* terminal,
const char* prop
);
gpointer _padding;
VteTerminalClassPrivate* priv;
}
All of these fields should be considered read-only, except for derived classes.
Class members
parent_class: GtkWidgetClass
No description available.
eof: void (* eof) ( VteTerminal* terminal )
No description available.
child_exited: void (* child_exited) ( VteTerminal* terminal, int status )
No description available.
encoding_changed: void (* encoding_changed) ( VteTerminal* terminal )
No description available.
char_size_changed: void (* char_size_changed) ( VteTerminal* terminal, guint char_width, guint char_height )
No description available.
window_title_changed: void (* window_title_changed) ( VteTerminal* terminal )
No description available.
icon_title_changed: void (* icon_title_changed) ( VteTerminal* terminal )
No description available.
selection_changed: void (* selection_changed) ( VteTerminal* terminal )
No description available.
contents_changed: void (* contents_changed) ( VteTerminal* terminal )
No description available.
cursor_moved: void (* cursor_moved) ( VteTerminal* terminal )
No description available.
commit: void (* commit) ( VteTerminal* terminal, const gchar* text, guint size )
No description available.
deiconify_window: void (* deiconify_window) ( VteTerminal* terminal )
No description available.
iconify_window: void (* iconify_window) ( VteTerminal* terminal )
No description available.
raise_window: void (* raise_window) ( VteTerminal* terminal )
No description available.
lower_window: void (* lower_window) ( VteTerminal* terminal )
No description available.
refresh_window: void (* refresh_window) ( VteTerminal* terminal )
No description available.
restore_window: void (* restore_window) ( VteTerminal* terminal )
No description available.
maximize_window: void (* maximize_window) ( VteTerminal* terminal )
No description available.
resize_window: void (* resize_window) ( VteTerminal* terminal, guint width, guint height )
No description available.
move_window: void (* move_window) ( VteTerminal* terminal, guint x, guint y )
No description available.
increase_font_size: void (* increase_font_size) ( VteTerminal* terminal )
No description available.
decrease_font_size: void (* decrease_font_size) ( VteTerminal* terminal )
No description available.
copy_clipboard: void (* copy_clipboard) ( VteTerminal* terminal )
No description available.
paste_clipboard: void (* paste_clipboard) ( VteTerminal* terminal )
No description available.
bell: void (* bell) ( VteTerminal* terminal )
No description available.
setup_context_menu: void (* setup_context_menu) ( VteTerminal* terminal, const VteEventContext* context )
No description available.
termprops_changed: gboolean (* termprops_changed) ( VteTerminal* terminal, const int* props, int n_props )
No description available.
termprop_changed: void (* termprop_changed) ( VteTerminal* terminal, const char* prop )
No description available.
_padding: gpointer
No description available.
priv: VteTerminalClassPrivate*
No description available.
Virtual methods
Vte.TerminalClass.copy_clipboard
Places the selected text in the terminal in the #GDK_SELECTION_CLIPBOARD selection.
deprecated: 0.50
Vte.TerminalClass.paste_clipboard
Sends the contents of the #GDK_SELECTION_CLIPBOARD selection to the terminal’s child. It’s called on paste menu item, or when user presses Shift+Insert.