Terminal

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool allow_bold { get; set; }
  Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant.
• public bool allow_hyperlink { get; set; }
  Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed.
• public bool audible_bell { get; set; }
  Controls whether or not the terminal will beep when the child outputs the "bl" sequence.
• public EraseBinding backspace_binding { get; set; }
  Controls what string or control sequence the terminal sends to its child when the user presses the backspace key.
• public bool bold_is_bright { get; set; }
  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.
• public double cell_height_scale { get; set; }
  Scale factor for the cell height, to increase line spacing.
• public double cell_width_scale { get; set; }
  Scale factor for the cell width, to increase letter spacing.
• public int cjk_ambiguous_width { get; set; }
  This setting controls whether ambiguous-width characters are narrow or wide.
• public string current_directory_uri { get; }
  The current directory URI, or null if unset.
• public string current_file_uri { get; }
  The current file URI, or null if unset.
• public CursorBlinkMode cursor_blink_mode { get; set; }
  Sets whether or not the cursor will blink.
• public CursorShape cursor_shape { get; set; }
  Controls the shape of the cursor.
• public EraseBinding delete_binding { get; set; }
  Controls what string or control sequence the terminal sends to its child when the user presses the delete key.
• public bool enable_bidi { get; set; }
  Controls whether or not the terminal will perform bidirectional text rendering.
• public bool enable_fallback_scrolling { get; set; }
• public bool enable_shaping { get; set; }
  Controls whether or not the terminal will shape Arabic text.
• public bool enable_sixel { get; set; }
  Controls whether SIXEL image support is enabled.
• public string encoding { owned get; set; }
  Controls the encoding the terminal will expect data from the child to be encoded with.
• public FontDescription font_desc { owned get; set; }
  Specifies the font used for rendering all text displayed by the terminal, overriding any fonts set using modify_font.
• public FontOptions font_options { get; set; }
  The terminal's font options, or null to use the default font options.
• public double font_scale { get; set; }
  The terminal's font scale.
• public string hyperlink_hover_uri { owned get; }
  The currently hovered hyperlink URI, or null if unset.
• public string icon_title { get; }
• public bool input_enabled { get; set; }
  Controls whether the terminal allows user input.
• public bool pointer_autohide { get; set; }
  Controls the value of the terminal's mouse autohide setting.
• public Pty pty { get; set; }
  The PTY object for the terminal.
• public bool rewrap_on_resize { get; set; }
  Controls whether or not the terminal will rewrap its contents, including the scrollback buffer, whenever the terminal's width changes.
• public bool scroll_on_keystroke { get; set; }
  Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key.
• public bool scroll_on_output { get; set; }
  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.
• public bool scroll_unit_is_pixels { get; set; }
  Controls whether the terminal's GtkAdjustment values unit is lines or pixels.
• public uint scrollback_lines { get; set; }
  The length of the scrollback buffer used by the terminal.
• public TextBlinkMode text_blink_mode { get; set; }
  Controls whether or not the terminal will allow blinking text.
• public string window_title { get; }
  The terminal's title.
• public string word_char_exceptions { get; }
  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.
• public Align xalign { get; set; }
  The horizontal alignment of terminal within its allocation.
• public bool xfill { get; set; }
  The horizontal fillment of terminal within its allocation.
• public Align yalign { get; set; }
  The vertical alignment of terminal within its allocation
• public bool yfill { get; set; }
  The vertical fillment of terminal within its allocation

Creation methods:

• public Terminal ()
  Creates a new terminal widget.

Methods:

• public void copy_clipboard_format (Format format)
  Places the selected text in the terminal in the SELECTION_CLIPBOARD selection in the form specified by format .
• public void copy_primary ()
  Places the selected text in the terminal in the SELECTION_PRIMARY selection.
• public bool event_check_gregex_simple (Event event, Regex[] regexes, RegexMatchFlags match_flags, out unowned string[] matches)
  This function does nothing.
• public string[]? event_check_regex_array (Event event, Regex[] regexes, uint32 match_flags)
  Like vte_terminal_event_check_regex_simple, but returns an array of strings, containing the matching text (or null if no match) corresponding to each of the regexes in regexes .
• public void feed (uint8[]? data)
  Interprets data as if it were data received from a child process.
• public void feed_child (uint8[]? text)
  Sends a block of UTF-8 text to the child as if it were entered by the user at the keyboard.
• public void feed_child_binary (uint8[]? data)
  Sends a block of binary data to the child.
• public bool get_allow_bold ()
  Checks whether or not the terminal will attempt to draw bold text, by using a bold font variant.
• public bool get_allow_hyperlink ()
  Checks whether or not hyperlinks (OSC 8 escape sequence) are allowed.
• public bool get_audible_bell ()
  Checks whether or not the terminal will beep when the child outputs the "bl" sequence.
• public bool 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.
• public double get_cell_height_scale ()
• public double get_cell_width_scale ()
• public long get_char_height ()
• public long get_char_width ()
• public int get_cjk_ambiguous_width ()
  Returns whether ambiguous-width characters are narrow or wide.
• public RGBA get_color_background_for_draw ()
  Returns the background colour, as used by this when drawing the background, which may be different from the color set by set_color_background.
• public long get_column_count ()
• public unowned string? get_current_directory_uri ()
• public unowned string? get_current_file_uri ()
• public CursorBlinkMode get_cursor_blink_mode ()
  Returns the currently set cursor blink mode.
• public void get_cursor_position (out long column, out long row)
  Reads the location of the insertion cursor and returns it.
• public CursorShape get_cursor_shape ()
  Returns the currently set cursor shape.
• public bool get_enable_bidi ()
  Checks whether the terminal performs bidirectional text rendering.
• public bool get_enable_fallback_scrolling ()
• public bool get_enable_shaping ()
  Checks whether the terminal shapes Arabic text.
• public bool get_enable_sixel ()
• public unowned string? 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.
• public unowned FontDescription get_font ()
  Queries the terminal for information about the fonts which will be used to draw text in the terminal.
• public unowned FontOptions? get_font_options ()
• public double get_font_scale ()
• public void get_geometry_hints (out Geometry hints, int min_rows, int min_columns)
  Fills in some hints from this 's geometry.
• public bool get_has_selection ()
  Checks if the terminal currently contains selected text.
• public unowned string? get_icon_title ()
• public bool get_input_enabled ()
  Returns whether the terminal allow user input.
• public bool get_mouse_autohide ()
  Determines the value of the terminal's mouse autohide setting.
• public unowned Pty get_pty ()
  Returns the Pty of this.
• public bool get_rewrap_on_resize ()
  Checks whether or not the terminal will rewrap its contents upon resize.
• public long get_row_count ()
• public bool get_scroll_on_keystroke ()
• public bool get_scroll_on_output ()
• public bool get_scroll_unit_is_pixels ()
• public long get_scrollback_lines ()
• public string? get_text (SelectionFunc? is_selected, out Array<CharAttributes?>? attributes)
  Extracts a view of the visible part of the terminal.
• public TextBlinkMode get_text_blink_mode ()
  Checks whether or not the terminal will allow blinking text.
• public string get_text_include_trailing_spaces (SelectionFunc? is_selected, out Array<CharAttributes?>? attributes)
  Extracts a view of the visible part of the terminal.
• public string? get_text_range (long start_row, long start_col, long end_row, long end_col, SelectionFunc? is_selected, out Array<CharAttributes?>? attributes)
  Extracts a view of the visible part of the terminal.
• public string? get_text_range_format (Format format, long start_row, long start_col, long end_row, long end_col, out size_t length)
  Returns the specified range of text in the specified format.
• public string? get_text_selected (Format format)
  Gets the currently selected text in the format specified by format .
• public string? get_text_selected_full (Format format, out size_t length)
  Gets the currently selected text in the format specified by format .
• public unowned string? get_window_title ()
• public unowned string? 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.
• public Align get_xalign ()
• public bool get_xfill ()
• public Align get_yalign ()
• public bool get_yfill ()
• public string? hyperlink_check_event (Event event)
  Returns a nonempty string: the target of the explicit hyperlink (printed using the OSC 8 escape sequence) at the position of the event, or null.
• public int match_add_gregex (Regex gregex, RegexMatchFlags gflags)
  This function does nothing since version 0.60.
• public int match_add_regex (Regex regex, uint32 flags)
  Adds the regular expression regex to the list of matching expressions.
• public string? match_check (long column, long row, out int tag)
  Checks if the text in and around the specified position matches any of the regular expressions previously set using vte_terminal_match_add.
• public string? match_check_event (Event event, out int tag)
  Checks if the text in and around the position of the event matches any of the regular expressions previously set using vte_terminal_match_add.
• public void match_remove (int tag)
  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.
• public void match_remove_all ()
  Clears the list of regular expressions the terminal uses to highlight text when the user moves the mouse cursor.
• public void match_set_cursor (int tag, Cursor? cursor)
  Sets which cursor the terminal will use if the pointer is over the pattern specified by tag.
• public void match_set_cursor_name (int tag, string cursor_name)
  Sets which cursor the terminal will use if the pointer is over the pattern specified by tag.
• public void match_set_cursor_type (int tag, CursorType cursor_type)
  Sets which cursor the terminal will use if the pointer is over the pattern specified by tag.
• public void paste_primary ()
  Sends the contents of the SELECTION_PRIMARY selection to the terminal's child.
• public void paste_text (string text)
  Sends text to the terminal's child as if retrived from the clipboard, this differs from feed_child in that it may process text before passing it to the child (e.g. apply bracketed mode)
• public Pty pty_new_sync (PtyFlags flags, Cancellable? cancellable = null) throws Error
  Creates a new Pty, sets the emulation property from VteTerminal:emulation, and sets the size using this's size.
• public void reset (bool clear_tabstops, bool clear_history)
  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.
• public bool search_find_next ()
  Searches the next string matching the search regex set with search_set_regex.
• public bool search_find_previous ()
  Searches the previous string matching the search regex set with search_set_regex.
• public unowned Regex search_get_gregex ()
• public unowned Regex search_get_regex ()
• public bool search_get_wrap_around ()
• public void search_set_gregex (Regex? gregex, RegexMatchFlags gflags)
  This function does nothing since version 0.60.
• public void search_set_regex (Regex? regex, uint32 flags)
  Sets the regex to search for.
• public void search_set_wrap_around (bool wrap_around)
  Sets whether search should wrap around to the beginning of the terminal content when reaching its end.
• public void select_all ()
  Selects all text within the terminal (not including the scrollback buffer).
• public void set_allow_bold (bool allow_bold)
  Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant.
• public void set_allow_hyperlink (bool allow_hyperlink)
  Controls whether or not hyperlinks (OSC 8 escape sequence) are allowed.
• public void set_audible_bell (bool is_audible)
  Controls whether or not the terminal will beep when the child outputs the "bl" sequence.
• public void set_backspace_binding (EraseBinding 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.
• public void set_bold_is_bright (bool 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.
• public void set_cell_height_scale (double scale)
  Sets the terminal's cell height scale to scale.
• public void set_cell_width_scale (double scale)
  Sets the terminal's cell width scale to scale.
• public void set_cjk_ambiguous_width (int width)
  This setting controls whether ambiguous-width characters are narrow or wide.
• public void set_clear_background (bool setting)
  Sets whether to paint the background with the background colour.
• public void set_color_background (RGBA background)
  Sets the background color for text which does not have a specific background color assigned.
• public void set_color_bold (RGBA? bold)
  Sets the color used to draw bold text in the default foreground color.
• public void set_color_cursor (RGBA? cursor_background)
  Sets the background color for text which is under the cursor.
• public void set_color_cursor_foreground (RGBA? cursor_foreground)
  Sets the foreground color for text which is under the cursor.
• public void set_color_foreground (RGBA foreground)
  Sets the foreground color used to draw normal text.
• public void set_color_highlight (RGBA? highlight_background)
  Sets the background color for text which is highlighted.
• public void set_color_highlight_foreground (RGBA? highlight_foreground)
  Sets the foreground color for text which is highlighted.
• public void set_colors (RGBA? foreground, RGBA? background, RGBA[]? palette)
  palette specifies the new values for the 256 palette colors: 8 standard colors, their 8 bright counterparts, 6x6x6 color cube, and 24 grayscale colors.
• public void set_cursor_blink_mode (CursorBlinkMode mode)
  Sets whether or not the cursor will blink.
• public void set_cursor_shape (CursorShape shape)
  Sets the shape of the cursor drawn.
• public void set_default_colors ()
  Reset the terminal palette to reasonable compiled-in default color.
• public void set_delete_binding (EraseBinding 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.
• public void set_enable_bidi (bool enable_bidi)
  Controls whether or not the terminal will perform bidirectional text rendering.
• public void set_enable_fallback_scrolling (bool enable)
  Controls whether the terminal uses scroll events to scroll the history if the event was not otherwise consumed by it.
• public void set_enable_shaping (bool enable_shaping)
  Controls whether or not the terminal will shape Arabic text.
• public void set_enable_sixel (bool enabled)
  Set whether to enable SIXEL images.
• public bool set_encoding (string? codeset) throws Error
  Changes the encoding the terminal will expect data from the child to be encoded with.
• public void set_font (FontDescription? font_desc)
  Sets the font used for rendering all text displayed by the terminal, overriding any fonts set using modify_font.
• public void set_font_options (FontOptions? font_options)
  Sets the terminal's font options to options.
• public void set_font_scale (double scale)
  Sets the terminal's font scale to scale.
• public void set_geometry_hints_for_window (Window window)
  Sets this as window's geometry widget.
• public void set_input_enabled (bool enabled)
  Enables or disables user input.
• public void set_mouse_autohide (bool setting)
  Changes the value of the terminal's mouse autohide setting.
• public void set_pty (Pty? pty)
  Sets pty as the PTY to use in this .
• public void set_rewrap_on_resize (bool rewrap)
  Controls whether or not the terminal will rewrap its contents, including the scrollback history, whenever the terminal's width changes.
• public void set_scroll_on_keystroke (bool scroll)
  Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key.
• public void set_scroll_on_output (bool scroll)
  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.
• public void set_scroll_unit_is_pixels (bool enable)
  Controls whether the terminal's scroll unit is lines or pixels.
• public void set_scrollback_lines (long lines)
  Sets the length of the scrollback buffer used by the terminal.
• public void set_size (long columns, long rows)
  Attempts to change the terminal's size in terms of rows and columns.
• public void set_text_blink_mode (TextBlinkMode text_blink_mode)
  Controls whether or not the terminal will allow blinking text.
• public void set_word_char_exceptions (string 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.
• public void set_xalign (Align align)
  Sets the horizontal alignment of this within its allocation.
• public void set_xfill (bool fill)
  Sets the horizontal fillment of this within its allocation.
• public void set_yalign (Align align)
  Sets the vertical alignment of this within its allocation.
• public void set_yfill (bool fill)
  Sets the vertical fillment of this within its allocation.
• public void spawn_async (PtyFlags pty_flags, string? working_directory, string[] argv, string[]? envv, SpawnFlags spawn_flags, owned SpawnChildSetupFunc? child_setup, int timeout, Cancellable? cancellable, TerminalSpawnAsyncCallback? callback)
  A convenience function that wraps creating the Pty and spawning the child process on it.
• public bool spawn_sync (PtyFlags pty_flags, string? working_directory, string[] argv, string[]? envv, SpawnFlags spawn_flags, SpawnChildSetupFunc? child_setup, out Pid child_pid, Cancellable? cancellable = null) throws Error
  Starts the specified command under a newly-allocated controlling pseudo-terminal.
• public void spawn_with_fds_async (PtyFlags pty_flags, string? working_directory, string[] argv, string[]? envv, int[]? fds, int[]? map_fds, SpawnFlags spawn_flags, owned SpawnChildSetupFunc? child_setup, int timeout, Cancellable? cancellable, TerminalSpawnAsyncCallback? callback)
  A convenience function that wraps creating the Pty and spawning the child process on it.
• public void unselect_all ()
  Clears the current selection.
• public void watch_child (Pid child_pid)
  Watches child_pid.
• public bool write_contents_sync (OutputStream stream, WriteFlags flags, Cancellable? cancellable = null) throws Error
  Write contents of the current contents of this (including any scrollback history) to stream according to flags.

Signals:

• public virtual signal void bell ()
  This signal is emitted when the a child sends a bell request to the terminal.
• public virtual signal void char_size_changed (uint char_width, uint char_height)
  Emitted whenever the cell size changes, e.g. due to a change in font, font-scale or cell-width/height-scale.
• public virtual signal void child_exited (int status)
  This signal is emitted when the terminal detects that a child watched using watch_child has exited.
• public virtual signal void commit (string text, uint size)
  Emitted whenever the terminal receives input from the user and prepares to send it to the child process.
• public virtual signal void contents_changed ()
  Emitted whenever the visible appearance of the terminal has changed.
• public virtual signal void copy_clipboard ()
  Emitted whenever copy_clipboard is called.
• public signal void current_directory_uri_changed ()
  Emitted when the current directory URI is modified.
• public signal void current_file_uri_changed ()
  Emitted when the current file URI is modified.
• public virtual signal void cursor_moved ()
  Emitted whenever the cursor moves to a new character cell.
• public virtual signal void decrease_font_size ()
  Emitted when the user hits the '-' key while holding the Control key.
• public virtual signal void deiconify_window ()
  Never emitted.
• public virtual signal void encoding_changed ()
  Emitted whenever the terminal's current encoding has changed.
• public virtual signal void eof ()
  Emitted when the terminal receives an end-of-file from a child which is running in the terminal.
• public signal void hyperlink_hover_uri_changed (string uri, Rectangle bbox)
  Emitted when the hovered hyperlink changes.
• public virtual signal void icon_title_changed ()
• public virtual signal void iconify_window ()
  Never emitted.
• public virtual signal void increase_font_size ()
  Emitted when the user hits the '+' key while holding the Control key.
• public virtual signal void lower_window ()
  Never emitted.
• public virtual signal void maximize_window ()
  Never emitted.
• public virtual signal void move_window (uint x, uint y)
  Never emitted.
• public virtual signal void paste_clipboard ()
  Emitted whenever paste_clipboard is called.
• public virtual signal void raise_window ()
  Never emitted.
• public virtual signal void refresh_window ()
  Never emitted.
• public virtual signal void resize_window (uint width, uint height)
  Emitted at the child application's request.
• public virtual signal void restore_window ()
  Never emitted.
• public virtual signal void selection_changed ()
  Emitted whenever the contents of terminal's selection changes.
• public virtual signal void text_deleted ()
• public virtual signal void text_inserted ()
• public virtual signal void text_modified ()
• public virtual signal void text_scrolled (int delta)
• public virtual signal void window_title_changed ()
  Emitted when the window_title property is modified.

Inherited Members: