vte.terminal
Module for [Terminal] class
Types 3
Methods
TerminalGidBuilder builder()Get builder for [vte.terminal.Terminal] Returns: New builder objectbool allowBold() @propertyGet `allowBold` property. Returns: Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant.void allowBold(bool propval) @propertySet `allowBold` property. Params: propval = Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant.bool allowHyperlink() @propertyGet `allowHyperlink` property. Returns: Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed.void allowHyperlink(bool propval) @propertySet `allowHyperlink` property. Params: propval = Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed.bool audibleBell() @propertyGet `audibleBell` property. Returns: Controls whether or not the terminal will beep when the child outputs the "bl" sequence.void audibleBell(bool propval) @propertySet `audibleBell` property. Params: propval = Controls whether or not the terminal will beep when the child outputs the "bl" sequence.vte.types.EraseBinding backspaceBinding() @propertyGet `backspaceBinding` property. Returns: Controls what string or control sequence the terminal sends to its child when the user presses the backspace key.void backspaceBinding(vte.types.EraseBinding propval) @propertySet `backspaceBinding` property. Params: propval = Controls what string or control sequence the terminal sends to its child when the user presses the backspace key.bool boldIsBright() @propertyGet `boldIsBright` property. Returns: 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 ...void boldIsBright(bool propval) @propertySet `boldIsBright` property. Params: propval = 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) o...double cellHeightScale() @propertyGet `cellHeightScale` property. Returns: Scale factor for the cell height, to increase line spacing. (The font's height is not affected.)void cellHeightScale(double propval) @propertySet `cellHeightScale` property. Params: propval = Scale factor for the cell height, to increase line spacing. (The font's height is not affected.)double cellWidthScale() @propertyGet `cellWidthScale` property. Returns: Scale factor for the cell width, to increase letter spacing. (The font's width is not affected.)void cellWidthScale(double propval) @propertySet `cellWidthScale` property. Params: propval = Scale factor for the cell width, to increase letter spacing. (The font's width is not affected.)int cjkAmbiguousWidth() @propertyGet `cjkAmbiguousWidth` property. Returns: This setting controls whether ambiguous-width characters are narrow or wide. (Note that when using a non-UTF-8 encoding set via [vte.terminal.Terminal.set...void cjkAmbiguousWidth(int propval) @propertySet `cjkAmbiguousWidth` property. Params: propval = This setting controls whether ambiguous-width characters are narrow or wide. (Note that when using a non-UTF-8 encoding set via [vte.terminal.Ter...gtk.popover.Popover contextMenu() @propertyGet `contextMenu` property. Returns: The menu used for context menus. Note that context menu model set with the #VteTerminal::context-menu-model property or [vte.terminal.Terminal.setContextMenuMod...void contextMenu(gtk.popover.Popover propval) @propertySet `contextMenu` property. Params: propval = The menu used for context menus. Note that context menu model set with the #VteTerminal::context-menu-model property or [vte.terminal.Terminal.setConte...gio.menu_model.MenuModel contextMenuModel() @propertyGet `contextMenuModel` property. Returns: 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::...void contextMenuModel(gio.menu_model.MenuModel propval) @propertySet `contextMenuModel` property. Params: propval = 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 #VteT...string currentDirectoryUri() @propertyGet `currentDirectoryUri` property. Returns: The current directory URI, or null if unset.string currentFileUri() @propertyGet `currentFileUri` property. Returns: The current file URI, or null if unset.vte.types.CursorBlinkMode cursorBlinkMode() @propertyGet `cursorBlinkMode` property. Returns: Sets whether or not the cursor will blink. Using [vte.types.CursorBlinkMode.System] will use the #GtkSettings:gtk-cursor-blink setting.void cursorBlinkMode(vte.types.CursorBlinkMode propval) @propertySet `cursorBlinkMode` property. Params: propval = Sets whether or not the cursor will blink. Using [vte.types.CursorBlinkMode.System] will use the #GtkSettings:gtk-cursor-blink setting.vte.types.CursorShape cursorShape() @propertyGet `cursorShape` property. Returns: Controls the shape of the cursor.void cursorShape(vte.types.CursorShape propval) @propertySet `cursorShape` property. Params: propval = Controls the shape of the cursor.vte.types.EraseBinding deleteBinding() @propertyGet `deleteBinding` property. Returns: Controls what string or control sequence the terminal sends to its child when the user presses the delete key.void deleteBinding(vte.types.EraseBinding propval) @propertySet `deleteBinding` property. Params: propval = Controls what string or control sequence the terminal sends to its child when the user presses the delete key.bool enableBidi() @propertyGet `enableBidi` property. Returns: Controls whether or not the terminal will perform bidirectional text rendering.void enableBidi(bool propval) @propertySet `enableBidi` property. Params: propval = Controls whether or not the terminal will perform bidirectional text rendering.bool enableFallbackScrolling() @propertyvoid enableFallbackScrolling(bool propval) @propertybool enableShaping() @propertyGet `enableShaping` property. Returns: Controls whether or not the terminal will shape Arabic text.void enableShaping(bool propval) @propertySet `enableShaping` property. Params: propval = Controls whether or not the terminal will shape Arabic text.bool enableSixel() @propertyGet `enableSixel` property. Returns: Controls whether SIXEL image support is enabled.void enableSixel(bool propval) @propertySet `enableSixel` property. Params: propval = Controls whether SIXEL image support is enabled.string encoding() @propertyGet `encoding` property. Returns: 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 chan...void encoding(string propval) @propertySet `encoding` property. Params: propval = Controls the encoding the terminal will expect data from the child to be encoded with. For certain terminal types, applications executing in the terminal...pango.font_description.FontDescription fontDesc() @propertyGet `fontDesc` property. Returns: Specifies the font used for rendering all text displayed by the terminal, overriding any fonts set using [gtk.widget.Widget.modifyFont]. The terminal will immedia...void fontDesc(pango.font_description.FontDescription propval) @propertySet `fontDesc` property. Params: propval = Specifies the font used for rendering all text displayed by the terminal, overriding any fonts set using [gtk.widget.Widget.modifyFont]. The terminal wil...cairo.font_options.FontOptions fontOptions() @propertyGet `fontOptions` property. Returns: The terminal's font options, or null to use the default font options.void fontOptions(cairo.font_options.FontOptions propval) @propertySet `fontOptions` property. Params: propval = The terminal's font options, or null to use the default font options.void fontScale(double propval) @propertySet `fontScale` property. Params: propval = The terminal's font scale.string hyperlinkHoverUri() @propertyGet `hyperlinkHoverUri` property. Returns: The currently hovered hyperlink URI, or null if unset.string iconTitle() @propertybool inputEnabled() @propertyGet `inputEnabled` property. Returns: 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...void inputEnabled(bool propval) @propertySet `inputEnabled` property. Params: propval = 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 t...bool pointerAutohide() @propertyGet `pointerAutohide` property. Returns: 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 sh...void pointerAutohide(bool propval) @propertySet `pointerAutohide` property. Params: propval = 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 k...void pty(vte.pty.Pty propval) @propertySet `pty` property. Params: propval = The PTY object for the terminal.bool rewrapOnResize() @propertyGet `rewrapOnResize` property. Returns: Controls whether or not the terminal will rewrap its contents, including the scrollback buffer, whenever the terminal's width changes.void rewrapOnResize(bool propval) @propertySet `rewrapOnResize` property. Params: propval = Controls whether or not the terminal will rewrap its contents, including the scrollback buffer, whenever the terminal's width changes.bool scrollOnInsert() @propertyGet `scrollOnInsert` property. Returns: 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).void scrollOnInsert(bool propval) @propertySet `scrollOnInsert` property. Params: propval = 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).bool scrollOnKeystroke() @propertyGet `scrollOnKeystroke` property. Returns: 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...void scrollOnKeystroke(bool propval) @propertySet `scrollOnKeystroke` property. Params: propval = 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 no...bool scrollOnOutput() @propertyGet `scrollOnOutput` property. Returns: 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.void scrollOnOutput(bool propval) @propertySet `scrollOnOutput` property. Params: propval = 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.bool scrollUnitIsPixels() @propertyGet `scrollUnitIsPixels` property. Returns: 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 t...void scrollUnitIsPixels(bool propval) @propertySet `scrollUnitIsPixels` property. Params: propval = Controls whether the terminal's GtkAdjustment values unit is lines or pixels. This can be enabled when the terminal is the child of a GtkScrolle...uint scrollbackLines() @propertyGet `scrollbackLines` property. Returns: 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 visib...void scrollbackLines(uint propval) @propertySet `scrollbackLines` property. Params: propval = 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...vte.types.TextBlinkMode textBlinkMode() @propertyGet `textBlinkMode` property. Returns: Controls whether or not the terminal will allow blinking text.void textBlinkMode(vte.types.TextBlinkMode propval) @propertySet `textBlinkMode` property. Params: propval = Controls whether or not the terminal will allow blinking text.string wordCharExceptions() @propertyGet `wordCharExceptions` property. 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 alphanumer...vte.types.Align xalign() @propertyGet `xalign` property. Returns: The horizontal alignment of @terminal within its allocation.void xalign(vte.types.Align propval) @propertySet `xalign` property. Params: propval = The horizontal alignment of @terminal within its allocation.bool xfill() @propertyGet `xfill` property. Returns: The horizontal fillment of @terminal within its allocation.void xfill(bool propval) @propertySet `xfill` property. Params: propval = The horizontal fillment of @terminal within its allocation.vte.types.Align yalign() @propertyGet `yalign` property. Returns: The vertical alignment of @terminal within its allocationvoid yalign(vte.types.Align propval) @propertySet `yalign` property. Params: propval = The vertical alignment of @terminal within its allocationbool yfill() @propertyGet `yfill` property. Returns: The vertical fillment of @terminal within its allocation. Note that #VteTerminal:yfill=true is only supported with #VteTerminal:yalign=[vte.types.Align.Start], and is...void yfill(bool propval) @propertySet `yfill` property. Params: propval = The vertical fillment of @terminal within its allocation. Note that #VteTerminal:yfill=true is only supported with #VteTerminal:yalign=[vte.types.Align.Start...string checkHyperlinkAt(double x, double y)Returns a nonempty string: the target of the explicit hyperlink (printed using the OSC 8 escape sequence) at the position (x, y), or null.string checkMatchAt(double x, double y, out int tag)Checks if the text in and around the position (x, y) matches any of the regular expressions previously set using vteterminalmatch_add(). If a match exists, the text string is returned and if tag i...string[] checkRegexSimpleAt(double x, double y, vte.regex.Regex[] regexes, uint matchFlags)Like [vte.terminal.Terminal.checkRegexSimpleAt], but returns an array of strings, containing the matching text (or null if no match) corresponding to each of the regexes in regexes.void copyClipboard()Places the selected text in the terminal in the #GDKSELECTIONCLIPBOARD selection.void copyClipboardFormat(vte.types.Format format)Places the selected text in the terminal in the #GDKSELECTIONCLIPBOARD selection in the form specified by format.void copyPrimary()Places the selected text in the terminal in the #GDKSELECTIONPRIMARY selection.void feed(ubyte[] data = null)Interprets data as if it were data received from a child process.void feedChild(ubyte[] text = null)Sends a block of UTF-8 text to the child as if it were entered by the user at the keyboard.void feedChildBinary(ubyte[] data = null)Sends a block of binary data to the child.bool getAllowBold()Checks whether or not the terminal will attempt to draw bold text, by using a bold font variant. Returns: true if bolding is enabled, false if notbool getAllowHyperlink()Checks whether or not hyperlinks (OSC 8 escape sequence) are allowed. Returns: true if hyperlinks are enabled, false if notbool getAudibleBell()Checks whether or not the terminal will beep when the child outputs the "bl" sequence. Returns: true if audible bell is enabled, false if notbool getBoldIsBright()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 ...double getCellHeightScale()double getCellWidthScale()glong getCharHeight()glong getCharWidth()int getCjkAmbiguousWidth()Returns whether ambiguous-width characters are narrow or wide. (Note that when using a non-UTF-8 encoding set via [vte.terminal.Terminal.setEncoding], the width of ambiguous-width characters is fix...void getColorBackgroundForDraw(out gdk.rgba.RGBA color)Returns the background colour, as used by terminal when drawing the background, which may be different from the color set by [vte.terminal.Terminal.setColorBackground].glong getColumnCount()string getCurrentDirectoryUri()string getCurrentFileUri()vte.types.CursorBlinkMode getCursorBlinkMode()Returns the currently set cursor blink mode. Returns: cursor blink mode.void getCursorPosition(out glong column, out glong row)Reads the location of the insertion cursor and returns it. The row coordinate is absolute.vte.types.CursorShape getCursorShape()Returns the currently set cursor shape. Returns: cursor shape.bool getEnableBidi()Checks whether the terminal performs bidirectional text rendering. Returns: true if BiDi is enabled, false if notbool getEnableFallbackScrolling()bool getEnableShaping()Checks whether the terminal shapes Arabic text. Returns: true if Arabic shaping is enabled, false if notbool getEnableSixel()string getEncoding()Determines the name of the encoding in which the terminal expects data to be encoded, or null if UTF-8 is in use. Returns: the current encoding for the terminalpango.font_description.FontDescription getFont()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, ...double getFontScale()bool getHasSelection()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. Returns: true if part of the text in ...string getIconTitle()bool getInputEnabled()Returns whether the terminal allow user input. Returns:bool getMouseAutohide()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. Thi...vte.pty.Pty getPty()Returns the #VtePty of terminal. Returns: a #VtePty, or nullbool getRewrapOnResize()Checks whether or not the terminal will rewrap its contents upon resize. Returns: true if rewrapping is enabled, false if notglong getRowCount()bool getScrollOnInsert()bool getScrollOnKeystroke()bool getScrollOnOutput()bool getScrollUnitIsPixels()glong getScrollbackLines()vte.types.TextBlinkMode getTextBlinkMode()Checks whether or not the terminal will allow blinking text. Returns: the blinking settingstring getTextFormat(vte.types.Format format)Returns text from the visible part of the terminal in the specified format.string getTextRangeFormat(vte.types.Format format, glong startRow, glong startCol, glong endRow, glong endCol, out size_t length)Returns the specified range of text in the specified format.string getTextSelected(vte.types.Format format)Gets the currently selected text in the format specified by format. Since 0.72, this function also supports [vte.types.Format.Html] format.string getTextSelectedFull(vte.types.Format format, out size_t length)Gets the currently selected text in the format specified by format.string getWindowTitle()string getWordCharExceptions()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.bool getXfill()bool getYfill()int matchAddRegex(vte.regex.Regex regex, uint flags)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 highlig...string matchCheck(glong column, glong row, out int tag)Checks if the text in and around the specified position matches any of the regular expressions previously set using vteterminalmatch_add(). If a match exists, the text string is returned and if ta...void matchRemove(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.void matchRemoveAll()Clears the list of regular expressions the terminal uses to highlight text when the user moves the mouse cursor.void matchSetCursor(int tag, gdk.cursor.Cursor cursor = null)Sets which cursor the terminal will use if the pointer is over the pattern specified by tag. The terminal keeps a reference to cursor.void matchSetCursorName(int tag, string cursorName)Sets which cursor the terminal will use if the pointer is over the pattern specified by tag.void pasteClipboard()Sends the contents of the #GDKSELECTIONCLIPBOARD selection to the terminal's child. It's called on paste menu item, or when user presses Shift+Insert.void pastePrimary()Sends the contents of the #GDKSELECTIONPRIMARY selection to the terminal's child. The terminal will call also paste the #GDKSELECTIONPRIMARY selection when the user clicks with the the second mouse...void pasteText(string text)Sends text to the terminal's child as if retrived from the clipboard, this differs from [vte.terminal.Terminal.feedChild] in that it may process text before passing it to the child (e.g. apply brac...vte.pty.Pty ptyNewSync(vte.types.PtyFlags flags, gio.cancellable.Cancellable cancellable = null)Creates a new #VtePty, sets the emulation property from #VteTerminal:emulation, and sets the size using terminal's size.void reset(bool clearTabstops, bool clearHistory)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...bool searchFindNext()Searches the next string matching the search regex set with [vte.terminal.Terminal.searchSetRegex]. Returns: true if a match was foundbool searchFindPrevious()Searches the previous string matching the search regex set with [vte.terminal.Terminal.searchSetRegex]. Returns: true if a match was foundbool searchGetWrapAround()void searchSetRegex(vte.regex.Regex regex, uint flags)Sets the regex to search for. Unsets the search regex when passed null.void searchSetWrapAround(bool wrapAround)Sets whether search should wrap around to the beginning of the terminal content when reaching its end.void selectAll()Selects all text within the terminal (not including the scrollback buffer).void setAllowBold(bool allowBold)Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant.void setAllowHyperlink(bool allowHyperlink)Controls whether or not hyperlinks (OSC 8 escape sequence) are allowed.void setAudibleBell(bool isAudible)Controls whether or not the terminal will beep when the child outputs the "bl" sequence.void setBackspaceBinding(vte.types.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.void setBoldIsBright(bool boldIsBright)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 th...void setCellHeightScale(double scale)Sets the terminal's cell height scale to scale.void setCellWidthScale(double scale)Sets the terminal's cell width scale to scale.void setCjkAmbiguousWidth(int 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.Terminal.setEncoding], the width of ambiguous-width cha...void setClearBackground(bool setting)Sets whether to paint the background with the background colour. The default is true.void setColorBackground(gdk.rgba.RGBA 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.void setColorBold(gdk.rgba.RGBA bold)Sets the color used to draw bold text in the default foreground color. If bold is null then the default color is used.void setColorCursor(gdk.rgba.RGBA cursorBackground)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.void setColorCursorForeground(gdk.rgba.RGBA cursorForeground)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.void setColorForeground(gdk.rgba.RGBA foreground)Sets the foreground color used to draw normal text.void setColorHighlight(gdk.rgba.RGBA highlightBackground)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 bec...void setColorHighlightForeground(gdk.rgba.RGBA highlightForeground)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 bec...void setColors(gdk.rgba.RGBA foreground, gdk.rgba.RGBA background, gdk.rgba.RGBA[] palette = null)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 v...void setContextMenu(gtk.widget.Widget menu = null)Sets menu as the context menu in terminal. Use null to unset the current menu.void setContextMenuModel(gio.menu_model.MenuModel model = null)Sets model as the context menu model in terminal. Use null to unset the current menu model.void setCursorBlinkMode(vte.types.CursorBlinkMode mode)Sets whether or not the cursor will blink. Using [vte.types.CursorBlinkMode.System] will use the #GtkSettings::gtk-cursor-blink setting.void setCursorShape(vte.types.CursorShape shape)Sets the shape of the cursor drawn.void setDefaultColors()Reset the terminal palette to reasonable compiled-in default color.void setDeleteBinding(vte.types.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.void setEnableBidi(bool enableBidi)Controls whether or not the terminal will perform bidirectional text rendering.void setEnableFallbackScrolling(bool enable)Controls whether the terminal uses scroll events to scroll the history if the event was not otherwise consumed by it.void setEnableShaping(bool enableShaping)Controls whether or not the terminal will shape Arabic text.void setEnableSixel(bool enabled)Set whether to enable SIXEL images.bool setEncoding(string codeset = null)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...void setFont(pango.font_description.FontDescription fontDesc = null)Sets the font used for rendering all text displayed by the terminal, overriding any fonts set using [gtk.widget.Widget.modifyFont]. The terminal will immediately attempt to load the desired font, ...void setFontOptions(cairo.font_options.FontOptions fontOptions = null)Sets the terminal's font options to options.void setFontScale(double scale)Sets the terminal's font scale to scale.void setInputEnabled(bool 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.void setMouseAutohide(bool setting)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 s...void setPty(vte.pty.Pty pty = null)Sets pty as the PTY to use in terminal. Use null to unset the PTY.void setRewrapOnResize(bool rewrap)Controls whether or not the terminal will rewrap its contents, including the scrollback history, whenever the terminal's width changes.void setScrollOnInsert(bool scroll)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.void setScrollOnKeystroke(bool scroll)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.void setScrollOnOutput(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.void setScrollUnitIsPixels(bool enable)Controls whether the terminal's scroll unit is lines or pixels.void setScrollbackLines(glong 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...void setSize(glong columns, glong rows)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.void setTextBlinkMode(vte.types.TextBlinkMode textBlinkMode)Controls whether or not the terminal will allow blinking text.void setWordCharExceptions(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 characte...void setXalign(vte.types.Align align_)Sets the horizontal alignment of terminal within its allocation.void setXfill(bool fill)Sets the horizontal fillment of terminal within its allocation.void setYalign(vte.types.Align align_)Sets the vertical alignment of terminal within its allocation.void setYfill(bool fill)Sets the vertical fillment of terminal within its allocation. Note that yfill is only supported with yalign set to [vte.types.Align.Start], and is ignored for all other yalign values.void spawnAsync(vte.types.PtyFlags ptyFlags, string workingDirectory, string[] argv, string[] envv, glib.types.SpawnFlags spawnFlags, glib.types.SpawnChildSetupFunc childSetup, int timeout, gio.cancellable.Cancellable cancellable = null, vte.types.TerminalSpawnAsyncCallback callback = null)A convenience function that wraps creating the #VtePty and spawning the child process on it. Like [vte.terminal.Terminal.spawnWithFdsAsync], except that this function does not allow passing file de...bool spawnSync(vte.types.PtyFlags ptyFlags, string workingDirectory, string[] argv, string[] envv, glib.types.SpawnFlags spawnFlags, glib.types.SpawnChildSetupFunc childSetup, out glib.types.Pid childPid, gio.cancellable.Cancellable cancellable = null)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 defau...void spawnWithFdsAsync(vte.types.PtyFlags ptyFlags, string workingDirectory, string[] argv, string[] envv, int[] fds, int[] mapFds, glib.types.SpawnFlags spawnFlags, glib.types.SpawnChildSetupFunc childSetup, int timeout, gio.cancellable.Cancellable cancellable = null, vte.types.TerminalSpawnAsyncCallback callback = null)A convenience function that wraps creating the #VtePty and spawning the child process on it. See [vte.pty.Pty.newSync], [vte.pty.Pty.spawnWithFdsAsync], and [vte.pty.Pty.spawnFinish] for more infor...void unselectAll()Clears the current selection.void watchChild(glib.types.Pid childPid)Watches child_pid. When the process exists, the #VteTerminal::child-exited signal will be called with the child's exit status.bool writeContentsSync(gio.output_stream.OutputStream stream, vte.types.WriteFlags flags, gio.cancellable.Cancellable cancellable = null)Write contents of the current contents of terminal (including any scrollback history) to stream according to flags.gulong connectBell(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `Bell` signal.gulong connectCharSizeChanged(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] == uint)))
&& (Parameters!T.length < 2 || (ParameterStorageClassTuple!T[1] == ParameterStorageClass.none && is(Parameters!T[1] == uint)))
&& (Parameters!T.length < 3 || (ParameterStorageClassTuple!T[2] == ParameterStorageClass.none && is(Parameters!T[2] : vte.terminal.Terminal)))
&& Parameters!T.length < 4)Connect to `CharSizeChanged` signal.gulong connectChildExited(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] == int)))
&& (Parameters!T.length < 2 || (ParameterStorageClassTuple!T[1] == ParameterStorageClass.none && is(Parameters!T[1] : vte.terminal.Terminal)))
&& Parameters!T.length < 3)Connect to `ChildExited` signal.gulong connectCommit(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] == string)))
&& (Parameters!T.length < 2 || (ParameterStorageClassTuple!T[1] == ParameterStorageClass.none && is(Parameters!T[1] : vte.terminal.Terminal)))
&& Parameters!T.length < 3)Connect to `Commit` signal.gulong connectContentsChanged(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `ContentsChanged` signal.gulong connectCopyClipboard(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `CopyClipboard` signal.gulong connectCurrentDirectoryUriChanged(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `CurrentDirectoryUriChanged` signal.gulong connectCurrentFileUriChanged(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `CurrentFileUriChanged` signal.gulong connectCursorMoved(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `CursorMoved` signal.gulong connectDecreaseFontSize(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `DecreaseFontSize` signal.gulong connectDeiconifyWindow(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `DeiconifyWindow` signal.gulong connectEncodingChanged(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `EncodingChanged` signal.gulong connectEof(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `Eof` signal.gulong connectHyperlinkHoverUriChanged(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] == string)))
&& (Parameters!T.length < 2 || (ParameterStorageClassTuple!T[1] == ParameterStorageClass.none && is(Parameters!T[1] == gdk.rectangle.Rectangle)))
&& (Parameters!T.length < 3 || (ParameterStorageClassTuple!T[2] == ParameterStorageClass.none && is(Parameters!T[2] : vte.terminal.Terminal)))
&& Parameters!T.length < 4)Connect to `HyperlinkHoverUriChanged` signal.gulong connectIconTitleChanged(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `IconTitleChanged` signal.gulong connectIconifyWindow(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `IconifyWindow` signal.gulong connectIncreaseFontSize(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `IncreaseFontSize` signal.gulong connectLowerWindow(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `LowerWindow` signal.gulong connectMaximizeWindow(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `MaximizeWindow` signal.gulong connectMoveWindow(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] == uint)))
&& (Parameters!T.length < 2 || (ParameterStorageClassTuple!T[1] == ParameterStorageClass.none && is(Parameters!T[1] == uint)))
&& (Parameters!T.length < 3 || (ParameterStorageClassTuple!T[2] == ParameterStorageClass.none && is(Parameters!T[2] : vte.terminal.Terminal)))
&& Parameters!T.length < 4)Connect to `MoveWindow` signal.gulong connectPasteClipboard(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `PasteClipboard` signal.gulong connectRaiseWindow(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `RaiseWindow` signal.gulong connectRefreshWindow(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `RefreshWindow` signal.gulong connectResizeWindow(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] == uint)))
&& (Parameters!T.length < 2 || (ParameterStorageClassTuple!T[1] == ParameterStorageClass.none && is(Parameters!T[1] == uint)))
&& (Parameters!T.length < 3 || (ParameterStorageClassTuple!T[2] == ParameterStorageClass.none && is(Parameters!T[2] : vte.terminal.Terminal)))
&& Parameters!T.length < 4)Connect to `ResizeWindow` signal.gulong connectRestoreWindow(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `RestoreWindow` signal.gulong connectSelectionChanged(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `SelectionChanged` signal.gulong connectSetupContextMenu(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] == vte.event_context.EventContext)))
&& (Parameters!T.length < 2 || (ParameterStorageClassTuple!T[1] == ParameterStorageClass.none && is(Parameters!T[1] : vte.terminal.Terminal)))
&& Parameters!T.length < 3)Connect to `SetupContextMenu` signal.gulong connectWindowTitleChanged(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : vte.terminal.Terminal)))
&& Parameters!T.length < 2)Connect to `WindowTitleChanged` signal.classTerminalGidBuilderImpl(T) : gtk.widget.WidgetGidBuilderImpl!T, gtk.scrollable.ScrollableGidBuilderImpl!T
Methods
T allowBold(bool propval)Set `allowBold` property. Params: propval = Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant. Returns: Builder instance for fluent chainingT allowHyperlink(bool propval)Set `allowHyperlink` property. Params: propval = Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed. Returns: Builder instance for fluent chainingT audibleBell(bool propval)Set `audibleBell` property. Params: propval = Controls whether or not the terminal will beep when the child outputs the "bl" sequence. Returns: Builder instance for fluent chainingT backspaceBinding(vte.types.EraseBinding propval)Set `backspaceBinding` property. Params: propval = Controls what string or control sequence the terminal sends to its child when the user presses the backspace key. Returns: Builder instance for fl...T boldIsBright(bool propval)Set `boldIsBright` property. Params: propval = 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) o...T cellHeightScale(double propval)Set `cellHeightScale` property. Params: propval = Scale factor for the cell height, to increase line spacing. (The font's height is not affected.) Returns: Builder instance for fluent chainingT cellWidthScale(double propval)Set `cellWidthScale` property. Params: propval = Scale factor for the cell width, to increase letter spacing. (The font's width is not affected.) Returns: Builder instance for fluent chainingT cjkAmbiguousWidth(int propval)Set `cjkAmbiguousWidth` property. Params: propval = This setting controls whether ambiguous-width characters are narrow or wide. (Note that when using a non-UTF-8 encoding set via [vte.terminal.Ter...T contextMenu(gtk.popover.Popover propval)Set `contextMenu` property. Params: propval = The menu used for context menus. Note that context menu model set with the #VteTerminal::context-menu-model property or [vte.terminal.Terminal.setConte...T contextMenuModel(gio.menu_model.MenuModel propval)Set `contextMenuModel` property. Params: propval = 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 #VteT...T cursorBlinkMode(vte.types.CursorBlinkMode propval)Set `cursorBlinkMode` property. Params: propval = Sets whether or not the cursor will blink. Using [vte.types.CursorBlinkMode.System] will use the #GtkSettings:gtk-cursor-blink setting. Returns: Bu...T cursorShape(vte.types.CursorShape propval)Set `cursorShape` property. Params: propval = Controls the shape of the cursor. Returns: Builder instance for fluent chainingT deleteBinding(vte.types.EraseBinding propval)Set `deleteBinding` property. Params: propval = Controls what string or control sequence the terminal sends to its child when the user presses the delete key. Returns: Builder instance for fluent c...T enableBidi(bool propval)Set `enableBidi` property. Params: propval = Controls whether or not the terminal will perform bidirectional text rendering. Returns: Builder instance for fluent chainingT enableFallbackScrolling(bool propval)T enableShaping(bool propval)Set `enableShaping` property. Params: propval = Controls whether or not the terminal will shape Arabic text. Returns: Builder instance for fluent chainingT enableSixel(bool propval)Set `enableSixel` property. Params: propval = Controls whether SIXEL image support is enabled. Returns: Builder instance for fluent chainingT encoding(string propval)Set `encoding` property. Params: propval = Controls the encoding the terminal will expect data from the child to be encoded with. For certain terminal types, applications executing in the terminal...T fontDesc(pango.font_description.FontDescription propval)Set `fontDesc` property. Params: propval = Specifies the font used for rendering all text displayed by the terminal, overriding any fonts set using [gtk.widget.Widget.modifyFont]. The terminal wil...T fontOptions(cairo.font_options.FontOptions propval)Set `fontOptions` property. Params: propval = The terminal's font options, or null to use the default font options.T fontScale(double propval)Set `fontScale` property. Params: propval = The terminal's font scale. Returns: Builder instance for fluent chainingT inputEnabled(bool propval)Set `inputEnabled` property. Params: propval = 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 t...T pointerAutohide(bool propval)Set `pointerAutohide` property. Params: propval = 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 k...T pty(vte.pty.Pty propval)Set `pty` property. Params: propval = The PTY object for the terminal. Returns: Builder instance for fluent chainingT rewrapOnResize(bool propval)Set `rewrapOnResize` property. Params: propval = Controls whether or not the terminal will rewrap its contents, including the scrollback buffer, whenever the terminal's width changes. Returns: Buil...T scrollOnInsert(bool propval)Set `scrollOnInsert` property. Params: propval = 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). Returns...T scrollOnKeystroke(bool propval)Set `scrollOnKeystroke` property. Params: propval = 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 no...T scrollOnOutput(bool propval)Set `scrollOnOutput` property. Params: propval = 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. Return...T scrollUnitIsPixels(bool propval)Set `scrollUnitIsPixels` property. Params: propval = Controls whether the terminal's GtkAdjustment values unit is lines or pixels. This can be enabled when the terminal is the child of a GtkScrolle...T scrollbackLines(uint propval)Set `scrollbackLines` property. Params: propval = 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...T textBlinkMode(vte.types.TextBlinkMode propval)Set `textBlinkMode` property. Params: propval = Controls whether or not the terminal will allow blinking text. Returns: Builder instance for fluent chainingT xalign(vte.types.Align propval)Set `xalign` property. Params: propval = The horizontal alignment of @terminal within its allocation. Returns: Builder instance for fluent chainingT xfill(bool propval)Set `xfill` property. Params: propval = The horizontal fillment of @terminal within its allocation. Returns: Builder instance for fluent chainingT yalign(vte.types.Align propval)Set `yalign` property. Params: propval = The vertical alignment of @terminal within its allocation Returns: Builder instance for fluent chainingT yfill(bool propval)Set `yfill` property. Params: propval = The vertical fillment of @terminal within its allocation. Note that #VteTerminal:yfill=true is only supported with #VteTerminal:yalign=[vte.types.Align.Start...