terminal widget

A VteTerminal packed inside a GtkScrolledWindow

Definition

<terminal tag_attr="value"...>
	<variable>varname</variable>
	<height>value</height>
	<width>value</width>
	<input>command</input>
	<input file>filename</input>
	<sensitive>state</sensitive>
	<action>activity</action>...
	<action signal="type">activity</action>...
	<action type="function">parameter</action>...
</terminal>

"..." denotes acceptance of multiples of the same thing.

Tag Attributes

See the VteTerminal widget and ancestor class properties.

The following custom tag attributes are available:

Name Description Value Since
space-expand Pack widget expanding into space true or false
space-fill Pack widget filling space true or false
block-function-signals Block signal emissions from functions true or false
file-monitor Emit signal when input file(s) change true or false
auto-refresh Auto refresh when input file(s) change true or false
hscrollbar-policy Policy for the horizontal scrollbar 0, 1, 2 (always, automatic, never)
vscrollbar-policy Policy for the vertical scrollbar 0, 1, 2 (always, automatic, never)
font-name Font description Example: Monospace Bold 14
background-tint-color[1] Background tint colour A standard name, #rgb or #rrggbb
text-background-color Text background colour A standard name, #rgb or #rrggbb
text-foreground-color Text foreground colour A standard name, #rgb or #rrggbb
bold-foreground-color Bold text foreground colour A standard name, #rgb or #rrggbb
dim-foreground-color Dim text foreground colour A standard name, #rgb or #rrggbb
cursor-background-color Cursor background colour A standard name, #rgb or #rrggbb
highlight-background-color Highlighted text background colour A standard name, #rgb or #rrggbb
argv? Arguments starting at argv0 (command) Example: /bin/sh
envv? Environment variables starting at envv0 Example: MESSAGE=Hello

Directives

Some of these may have tag attribute equivalents.

Name Description Contents Mandatory Since
variable Shell variable name Command's PID (0 if dead)
height Initial height An integer > 0 or -1 to ignore
width Initial width An integer > 0 or -1 to ignore
input Data input source Shell command
input file Data input source Filename
sensitive Active state true or false
action Execute command on default signal Shell command
action Perform function on default signal function:parameter
action signal="type" Execute command on signal Shell command
action signal="type" Perform function on signal function:parameter
action type="function" Perform function on default signal parameter

Signals

The default signal is "child-exited", emitted when the terminal detects that the child has exited.

The "file-changed" signal is emitted if file-monitor is true and the input file being monitored has changed.

The following signals are connected-up for all widgets:

button-press-event, button-release-event, configure-event, enter-notify-event, leave-notify-event, focus-in-event, focus-out-event, hide, show, key-press-event, key-release-event, map-event, unmap-event

Functions

The following functions can be performed upon this widget by any widget capable of emitting signals:

Type Description Parameter Since
enable Reactivate timer Shell variable name
disable Deactivate timer Shell variable name
show Show widget Shell variable name
hide Hide widget Shell variable name
grabfocus Grab input focus Shell variable name
refresh Reload input data Shell variable name
clear Reset terminal and re-execute command Shell variable name

The following general functions can be performed by any widget capable of emitting signals:

Type Description Parameter Since
command Execute command Shell command
exit Exit dialog A value for the EXIT shell variable
closewindow Close dialog Shell variable name
launch Launch dialog Shell variable name
presentwindow Present dialog Shell variable name

Notes

1. There exists an equivalently named "background-tint-color" VTE property but it doesn't accept strings so it's converted by Gtkdialog.

This is a non-mandatory widget that requires libvte support be built into Gtkdialog at compile time.

This widget was introduced in version 0.8.1.


button, checkbox, colorbutton, comboboxentry, comboboxtext, combobox, edit, entry, eventbox, expander, fontbutton, frame, hbox, hscale, hseparator, list, menubar, menuitemseparator, menuitem, menu, notebook, pixmap, progressbar, radiobutton, separator, spinbutton, statusbar, table, terminal, text, timer, togglebutton, tree, vbox, vscale, vseparator, window,