Top | ![]() |
![]() |
![]() |
![]() |
gboolean | allow-bold | Read / Write |
gboolean | audible-bell | Read / Write |
VteEraseBinding | backspace-binding | Read / Write |
gint | cjk-ambiguous-width | Read / Write |
gchar * | current-directory-uri | Read |
gchar * | current-file-uri | Read |
VteCursorBlinkMode | cursor-blink-mode | Read / Write |
VteCursorShape | cursor-shape | Read / Write |
VteEraseBinding | delete-binding | Read / Write |
gchar * | encoding | Read / Write |
PangoFontDescription * | font-desc | Read / Write |
gdouble | font-scale | Read / Write |
gchar * | icon-title | Read |
gboolean | input-enabled | Read / Write |
gboolean | pointer-autohide | Read / Write |
VtePty * | pty | Read / Write |
gboolean | rewrap-on-resize | Read / Write |
gboolean | scroll-on-keystroke | Read / Write |
gboolean | scroll-on-output | Read / Write |
guint | scrollback-lines | Read / Write |
gchar * | window-title | Read |
void | bell | Run Last |
void | char-size-changed | Run Last |
void | child-exited | Run Last |
void | commit | Run Last |
void | contents-changed | Run Last |
void | copy-clipboard | Action |
void | current-directory-uri-changed | Run Last |
void | current-file-uri-changed | Run Last |
void | cursor-moved | Run Last |
void | decrease-font-size | Run Last |
void | deiconify-window | Run Last |
void | encoding-changed | Run Last |
void | eof | Run Last |
void | icon-title-changed | Run Last |
void | iconify-window | Run Last |
void | increase-font-size | Run Last |
void | lower-window | Run Last |
void | maximize-window | Run Last |
void | move-window | Run Last |
void | paste-clipboard | Action |
void | raise-window | Run Last |
void | refresh-window | Run Last |
void | resize-window | Run Last |
void | restore-window | Run Last |
void | selection-changed | Run Last |
void | text-deleted | Run Last |
void | text-inserted | Run Last |
void | text-modified | Run Last |
void | text-scrolled | Run Last |
void | window-title-changed | Run Last |
struct | VteTerminal |
enum | VteCursorBlinkMode |
enum | VteCursorShape |
enum | VteEraseBinding |
enum | VteWriteFlags |
GEnum ├── VteCursorBlinkMode ├── VteCursorShape ├── VteEraseBinding ╰── VteWriteFlags GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── VteTerminal
gboolean (*VteSelectionFunc) (VteTerminal *terminal
,glong column
,glong row
,gpointer data
);
Specifies the type of a selection function used to check whether a cell has to be selected or not.
void vte_terminal_feed (VteTerminal *terminal
,const char *data
);
Interprets data
as if it were data received from a child process. This
can either be used to drive the terminal without a child process, or just
to mess with your users.
void vte_terminal_feed_child (VteTerminal *terminal
,const char *text
);
Sends a block of UTF-8 text to the child as if it were entered by the user at the keyboard.
void vte_terminal_feed_child_binary (VteTerminal *terminal
,const guint8 *data
);
Sends a block of binary data to the child.
Since 0.12.1
void
vte_terminal_select_all ();
Selects all text within the terminal (including the scrollback buffer).
Since 0.16
void
vte_terminal_copy_clipboard ();
Places the selected text in the terminal in the GDK_SELECTION_CLIPBOARD selection.
void
vte_terminal_paste_clipboard ();
Sends the contents of the GDK_SELECTION_CLIPBOARD selection to the terminal's child. If necessary, the data is converted from UTF-8 to the terminal's current encoding. It's called on paste menu item, or when user presses Shift+Insert.
void
vte_terminal_copy_primary ();
Places the selected text in the terminal in the GDK_SELECTION_PRIMARY selection.
void
vte_terminal_paste_primary ();
Sends the contents of the GDK_SELECTION_PRIMARY selection to the terminal's child. If necessary, the data is converted from UTF-8 to the terminal's current encoding. The terminal will call also paste the GDK_SELECTION_PRIMARY selection when the user clicks with the the second mouse button.
void vte_terminal_set_size (VteTerminal *terminal
,glong columns
);
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
vte_terminal_set_font_scale (VteTerminal *terminal
);
Sets the terminal's font scale to scale
.
Since 0.30
void
vte_terminal_set_audible_bell (VteTerminal *terminal
);
Controls whether or not the terminal will beep when the child outputs the "bl" sequence.
gboolean
vte_terminal_get_audible_bell (VteTerminal *terminal
);
Checks whether or not the terminal will beep when the child outputs the "bl" sequence.
void
vte_terminal_set_allow_bold (VteTerminal *terminal
);
Controls whether or not the terminal will attempt to draw bold text, either by using a bold font variant or by repainting text with a different offset.
gboolean vte_terminal_get_allow_bold ();
Checks whether or not the terminal will attempt to draw bold text by repainting text with a one-pixel offset.
void
vte_terminal_set_scroll_on_output (VteTerminal *terminal
);
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 vte_terminal_set_scroll_on_keystroke (VteTerminal *terminal
,gboolean 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
vte_terminal_set_rewrap_on_resize (VteTerminal *terminal
);
Controls whether or not the terminal will rewrap its contents, including the scrollback history, whenever the terminal's width changes.
Since 0.36
gboolean vte_terminal_get_rewrap_on_resize ();
Checks whether or not the terminal will rewrap its contents upon resize.
Since 0.36
void
vte_terminal_set_color_bold (VteTerminal *terminal
);
Sets the color used to draw bold text in the default foreground color.
If bold
is NULL
then the default color is used.
void
vte_terminal_set_color_foreground (VteTerminal *terminal
);
Sets the foreground color used to draw normal text.
void
vte_terminal_set_color_background (VteTerminal *terminal
);
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
vte_terminal_set_color_cursor (VteTerminal *terminal
);
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.
terminal |
||
cursor_background |
the new color to use for the text cursor, or |
[allow-none] |
void
vte_terminal_set_color_highlight (VteTerminal *terminal
);
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.
terminal |
||
highlight_background |
the new color to use for highlighted text, or |
[allow-none] |
void
vte_terminal_set_color_highlight_foreground
(VteTerminal *terminal
);
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.
terminal |
||
highlight_foreground |
the new color to use for highlighted text, or |
[allow-none] |
void vte_terminal_set_colors (VteTerminal *terminal
,const GdkRGBA *foreground
,const GdkRGBA *background
,const GdkRGBA *palette
);
The terminal widget uses a 28-color model comprised of the default foreground and background colors, the bold foreground color, the dim foreground color, an eight color palette, bold versions of the eight color palette, and a dim version of the the eight color palette.
palette_size
must be either 0, 8, 16, or 24, or between 25 and 256 inclusive.
If foreground
is NULL
and
palette_size
is greater than 0, the new foreground color is taken from
palette
[7]. If background
is NULL
and palette_size
is greater than 0,
the new background color is taken from palette
[0]. If
palette_size
is 8 or 16, the third (dim) and possibly the second (bold)
8-color palettes are extrapolated from the new background color and the items
in palette
.
void
vte_terminal_set_default_colors ();
Reset the terminal palette to reasonable compiled-in default color.
void
vte_terminal_set_cursor_shape (VteTerminal *terminal
);
Sets the shape of the cursor drawn.
Since 0.20
VteCursorShape vte_terminal_get_cursor_shape ();
Returns the currently set cursor shape.
Since 0.17.6
VteCursorBlinkMode vte_terminal_get_cursor_blink_mode ();
Returns the currently set cursor blink mode.
Since 0.17.1
void
vte_terminal_set_cursor_blink_mode (VteTerminal *terminal
);
Sets whether or not the cursor will blink. Using VTE_CURSOR_BLINK_SYSTEM
will use the “gtk-cursor-blink” setting.
Since 0.17.1
void
vte_terminal_set_scrollback_lines (VteTerminal *terminal
);
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.
A negative value means "infinite 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.
void
vte_terminal_set_font (VteTerminal *terminal
);
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.
const PangoFontDescription *
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.
gboolean 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.
void
vte_terminal_set_backspace_binding (VteTerminal *terminal
);
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
vte_terminal_set_delete_binding (VteTerminal *terminal
);
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
vte_terminal_set_mouse_autohide (VteTerminal *terminal
);
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()
.
gboolean 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()
.
void vte_terminal_reset (VteTerminal *terminal
,gboolean clear_tabstops
);
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.
char * vte_terminal_get_text (VteTerminal *terminal
,VteSelectionFunc is_selected
,gpointer user_data
);
Extracts a view of the visible part of the terminal. If is_selected
is not
NULL
, characters will only be read if is_selected
returns TRUE
after being
passed the column and row, respectively. A VteCharAttributes structure
is added to attributes
for each byte added to the returned string detailing
the character's position, colors, and other characteristics.
terminal |
||
is_selected |
a VteSelectionFunc callback. |
[scope call][allow-none] |
user_data |
user data to be passed to the callback. |
[closure] |
attributes |
location for storing text attributes. |
[out caller-allocates][transfer full][array][element-type Vte.CharAttributes] |
char * vte_terminal_get_text_include_trailing_spaces (VteTerminal *terminal
,VteSelectionFunc is_selected
,gpointer user_data
);
Extracts a view of the visible part of the terminal. If is_selected
is not
NULL
, characters will only be read if is_selected
returns TRUE
after being
passed the column and row, respectively. A VteCharAttributes structure
is added to attributes
for each byte added to the returned string detailing
the character's position, colors, and other characteristics. This function
differs from vte_terminal_get_text()
in that trailing spaces at the end of
lines are included.
terminal |
||
is_selected |
a VteSelectionFunc callback. |
[scope call][allow-none] |
user_data |
user data to be passed to the callback. |
[closure] |
attributes |
location for storing text attributes. |
[out caller-allocates][transfer full][array][element-type Vte.CharAttributes] |
Since 0.11.11
char * vte_terminal_get_text_range (VteTerminal *terminal
,glong start_row
,glong start_col
,glong end_row
,glong end_col
,VteSelectionFunc is_selected
,gpointer user_data
);
Extracts a view of the visible part of the terminal. If is_selected
is not
NULL
, characters will only be read if is_selected
returns TRUE
after being
passed the column and row, respectively. A VteCharAttributes structure
is added to attributes
for each byte added to the returned string detailing
the character's position, colors, and other characteristics. The
entire scrollback buffer is scanned, so it is possible to read the entire
contents of the buffer using this function.
terminal |
||
start_row |
first row to search for data |
|
start_col |
first column to search for data |
|
end_row |
last row to search for data |
|
end_col |
last column to search for data |
|
is_selected |
a VteSelectionFunc callback. |
[scope call][allow-none] |
user_data |
user data to be passed to the callback. |
[closure] |
attributes |
location for storing text attributes. |
[out caller-allocates][transfer full][array][element-type Vte.CharAttributes] |
void vte_terminal_get_cursor_position (VteTerminal *terminal
,glong *column
);
Reads the location of the insertion cursor and returns it. The row coordinate is absolute.
int vte_terminal_match_add_gregex (VteTerminal *terminal
,GRegex *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.17.1
void
vte_terminal_match_remove (VteTerminal *terminal
);
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
vte_terminal_match_remove_all ();
Clears the list of regular expressions the terminal uses to highlight text when the user moves the mouse cursor.
Since 0.30
char * vte_terminal_match_check (VteTerminal *terminal
,glong column
,glong row
);
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
.
If more than one regular expression has been set with
vte_terminal_match_add()
, then expressions are checked in the order in
which they were added.
terminal |
||
column |
the text column |
|
row |
the text row |
|
tag |
a location to store the tag, or |
[out][allow-none] |
char * vte_terminal_match_check_event (VteTerminal *terminal
,GdkEvent *event
);
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()
. 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
.
If more than one regular expression has been set with
vte_terminal_match_add()
, then expressions are checked in the order in
which they were added.
void vte_terminal_match_set_cursor (VteTerminal *terminal
,int tag
);
Sets which cursor the terminal will use if the pointer is over the pattern
specified by tag
. The terminal keeps a reference to cursor
.
Since 0.11
void vte_terminal_match_set_cursor_type (VteTerminal *terminal
,int tag
);
Sets which cursor the terminal will use if the pointer is over the pattern
specified by tag
.
Since 0.11.9
void vte_terminal_match_set_cursor_name (VteTerminal *terminal
,int tag
);
Sets which cursor the terminal will use if the pointer is over the pattern
specified by tag
.
terminal |
||
tag |
the tag of the regex which should use the specified cursor |
|
cursor_name |
the name of the cursor |
Since 0.17.1
void
vte_terminal_set_cjk_ambiguous_width (VteTerminal *terminal
);
This setting controls whether ambiguous-width characters are narrow or wide
when using the UTF-8 encoding (vte_terminal_set_encoding()
). In all other encodings,
the width of ambiguous-width characters is fixed.
This setting only takes effect the next time the terminal is reset, either
via escape sequence or with vte_terminal_reset()
.
Since 0.38
int
vte_terminal_get_cjk_ambiguous_width ();
Returns whether ambiguous-width characters are narrow or wide when using
the UTF-8 encoding (vte_terminal_set_encoding()
).
Since 0.38
gboolean vte_terminal_set_encoding (VteTerminal *terminal
,const char *codeset
);
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".
const char *
vte_terminal_get_encoding ();
Determines the name of the encoding in which the terminal expects data to be encoded.
gboolean vte_terminal_write_contents_sync (VteTerminal *terminal
,GOutputStream *stream
,VteWriteFlags flags
,GCancellable *cancellable
);
Write contents of the current contents of terminal
(including any
scrollback history) to stream
according to flags
.
If cancellable
is not NULL
, then the operation can be cancelled by triggering
the cancellable object from another thread. If the operation was cancelled,
the error G_IO_ERROR_CANCELLED
will be returned in error
.
This is a synchronous operation and will make the widget (and input
processing) during the write operation, which may take a long time
depending on scrollback history and stream
availability for writing.
terminal |
||
stream |
a GOutputStream to write to |
|
flags |
a set of VteWriteFlags |
|
cancellable |
a GCancellable object, or |
[allow-none] |
error |
[allow-none] |
gboolean vte_terminal_search_find_next ();
Searches the next string matching the search regex set with
vte_terminal_search_set_gregex()
.
Since 0.26
gboolean vte_terminal_search_find_previous ();
Searches the previous string matching the search regex set with
vte_terminal_search_set_gregex()
.
Since 0.26
void vte_terminal_search_set_gregex (VteTerminal *terminal
,GRegex *regex
);
Sets the GRegex regex to search for. Unsets the search regex when passed NULL
.
Since 0.26
void
vte_terminal_search_set_wrap_around (VteTerminal *terminal
);
Sets whether search should wrap around to the beginning of the terminal content when reaching its end.
Since 0.26
char *
vte_get_user_shell (void
);
Gets the user's shell, or NULL
. In the latter case, the
system default (usually "/bin/sh") should be used.
Since 0.28
gboolean vte_terminal_spawn_sync (VteTerminal *terminal
,VtePtyFlags pty_flags
,const char *working_directory
,char **argv
,char **envv
,GSpawnFlags spawn_flags
,GSpawnChildSetupFunc child_setup
,gpointer child_setup_data
,GPid *child_pid
,GCancellable *cancellable
);
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.
Note that G_SPAWN_DO_NOT_REAP_CHILD
will always be added to spawn_flags
.
Note that unless spawn_flags
contains G_SPAWN_LEAVE_DESCRIPTORS_OPEN
, all file
descriptors except stdin/stdout/stderr will be closed before calling exec()
in the child.
See vte_pty_new()
, g_spawn_async()
and vte_terminal_watch_child()
for more information.
terminal |
||
pty_flags |
flags from VtePtyFlags |
|
working_directory |
the name of a directory the command should start
in, or |
[allow-none] |
argv |
child's argument vector. |
[array zero-terminated=1][element-type filename] |
envv |
a list of environment
variables to be added to the environment before starting the process, or |
[allow-none][array zero-terminated=1][element-type filename] |
spawn_flags |
flags from GSpawnFlags |
|
child_setup |
an extra child setup function to run in the child just before |
[allow-none][scope call] |
child_setup_data |
user data for |
|
child_pid |
a location to store the child PID, or |
[out][allow-none][transfer full] |
cancellable |
a GCancellable, or |
[allow-none] |
error |
[allow-none] |
Since 0.30
VtePty * vte_terminal_get_pty ();
Returns the VtePty of terminal
.
Since 0.26
void
vte_terminal_set_pty (VteTerminal *terminal
);
Sets pty
as the PTY to use in terminal
.
Use NULL
to unset the PTY.
Since 0.26.
VtePty * vte_terminal_pty_new_sync (VteTerminal *terminal
,VtePtyFlags flags
,GCancellable *cancellable
);
Creates a new VtePty, and sets the emulation property from “emulation”.
See vte_pty_new()
for more information.
terminal |
||
flags |
flags from VtePtyFlags |
|
cancellable |
a GCancellable, or |
[allow-none] |
error |
[allow-none] |
Since 0.30
void
vte_terminal_watch_child (VteTerminal *terminal
);
Watches child_pid
. When the process exists, the “child-exited”
signal will be called with the child's exit status.
Prior to calling this function, a VtePty must have been set in terminal
using vte_terminal_set_pty()
.
When the child exits, the terminal's VtePty will be set to NULL
.
Note: g_child_watch_add()
or g_child_watch_add_full()
must not have
been called for child_pid
, nor a GSource for it been created with
g_child_watch_source_new()
.
Note: when using the g_spawn_async()
family of functions,
the G_SPAWN_DO_NOT_REAP_CHILD
flag MUST have been passed.
Since 0.26
void vte_terminal_get_geometry_hints (VteTerminal *terminal
,GdkGeometry *hints
,int min_rows
);
Fills in some hints
from terminal
's geometry. The hints
filled are those covered by the GDK_HINT_RESIZE_INC
,
GDK_HINT_MIN_SIZE
and GDK_HINT_BASE_SIZE
flags.
See gtk_window_set_geometry_hints()
for more information.
terminal
must be realized (see gtk_widget_get_realized()
).
terminal |
||
hints |
a GdkGeometry to fill in. |
[out caller-allocates] |
min_rows |
the minimum number of rows to request |
|
min_columns |
the minimum number of columns to request |
void
vte_terminal_set_geometry_hints_for_window
(VteTerminal *terminal
);
Sets terminal
as window
's geometry widget. See
gtk_window_set_geometry_hints()
for more information.
terminal
must be realized (see gtk_widget_get_realized()
).
const char *
vte_terminal_get_current_directory_uri
();
the URI of the current directory of the
process running in the terminal, or NULL
.
[transfer none]
Since 0.34
const char *
vte_terminal_get_current_file_uri ();
the URI of the current file the
process running in the terminal is operating on, or NULL
if
not set.
[transfer none]
Since 0.34
An enumerated type which can be used to indicate the cursor blink mode for the terminal.
An enumerated type which can be used to indicate what should the terminal draw at the cursor position.
An enumerated type which can be used to indicate which string the terminal should send to an application when the user presses the Delete or Backspace keys.
“allow-bold”
property“allow-bold” gboolean
Controls whether or not the terminal will attempt to draw bold text. This may happen either by using a bold font variant, or by repainting text with a different offset.
Flags: Read / Write
Default value: TRUE
Since 0.20
“audible-bell”
property“audible-bell” gboolean
Controls whether or not the terminal will beep when the child outputs the "bl" sequence.
Flags: Read / Write
Default value: TRUE
Since 0.20
“backspace-binding”
property“backspace-binding” VteEraseBinding
*Controls what string or control sequence the terminal sends to its child when the user presses the backspace key.
Flags: Read / Write
Default value: VTE_ERASE_AUTO
Since 0.20
“cjk-ambiguous-width”
property“cjk-ambiguous-width” gint
This setting controls whether ambiguous-width characters are narrow or wide
when using the UTF-8 encoding (vte_terminal_set_encoding()
). In all other encodings,
the width of ambiguous-width characters is fixed.
This setting only takes effect the next time the terminal is reset, either
via escape sequence or with vte_terminal_reset()
.
Flags: Read / Write
Allowed values: [1,2]
Default value: 1
Since 0.38
“current-directory-uri”
property“current-directory-uri” gchar *
The current directory URI, or NULL
if unset.
Flags: Read
Default value: NULL
Since 0.34
“current-file-uri”
property“current-file-uri” gchar *
The current file URI, or NULL
if unset.
Flags: Read
Default value: NULL
Since 0.34
“cursor-blink-mode”
property“cursor-blink-mode” VteCursorBlinkMode
Sets whether or not the cursor will blink. Using VTE_CURSOR_BLINK_SYSTEM
will use the “gtk-cursor-blink” setting.
Flags: Read / Write
Default value: VTE_CURSOR_BLINK_SYSTEM
Since 0.20
“cursor-shape”
property“cursor-shape” VteCursorShape
Controls the shape of the cursor.
Flags: Read / Write
Default value: VTE_CURSOR_SHAPE_BLOCK
Since 0.20
“delete-binding”
property“delete-binding” VteEraseBinding
Controls what string or control sequence the terminal sends to its child when the user presses the delete key.
Flags: Read / Write
Default value: VTE_ERASE_AUTO
Since 0.20
“encoding”
property“encoding” gchar *
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.
Flags: Read / Write
Default value: NULL
Since 0.20
“font-desc”
property “font-desc” PangoFontDescription *
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.
Flags: Read / Write
Since 0.20
“font-scale”
property“font-scale” gdouble
The terminal's font scale.
Flags: Read / Write
Allowed values: [0.25,4]
Default value: 1
Since 0.30
“icon-title”
property“icon-title” gchar *
The terminal's so-called icon title, or NULL
if no icon title has been set.
Flags: Read
Default value: NULL
Since 0.20
“input-enabled”
property“input-enabled” gboolean
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.
Flags: Read / Write
Default value: TRUE
“pointer-autohide”
property“pointer-autohide” gboolean
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.
Flags: Read / Write
Default value: FALSE
Since 0.20
“rewrap-on-resize”
property“rewrap-on-resize” gboolean
Controls whether or not the terminal will rewrap its contents, including the scrollback buffer, whenever the terminal's width changes.
Flags: Read / Write
Default value: TRUE
Since 0.36
“scroll-on-keystroke”
property“scroll-on-keystroke” gboolean
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.
Flags: Read / Write
Default value: FALSE
Since 0.20
“scroll-on-output”
property“scroll-on-output” gboolean
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.
Flags: Read / Write
Default value: TRUE
Since 0.20
“scrollback-lines”
property“scrollback-lines” guint
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.
Flags: Read / Write
Default value: 512
Since 0.20
“window-title”
property“window-title” gchar *
The terminal's title.
Flags: Read
Default value: NULL
Since 0.20
“bell”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
This signal is emitted when the a child sends a bell request to the terminal.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“char-size-changed”
signalvoid user_function (VteTerminal *vteterminal, guint width, guint height, gpointer user_data)
Emitted whenever selection of a new font causes the values of the
char_width
or char_height
fields to change.
vteterminal |
the object which received the signal |
|
width |
the new character cell width |
|
height |
the new character cell height |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“child-exited”
signalvoid user_function (VteTerminal *vteterminal, gint status, gpointer user_data)
This signal is emitted when the terminal detects that a child
watched using vte_terminal_watch_child()
has exited.
vteterminal |
the object which received the signal |
|
status |
the child's exit status |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“commit”
signalvoid user_function (VteTerminal *vteterminal, gchar *text, guint size, gpointer user_data)
Emitted whenever the terminal receives input from the user and prepares to send it to the child process. The signal is emitted even when there is no child process.
vteterminal |
the object which received the signal |
|
text |
a string of text |
|
size |
the length of that string of text |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“contents-changed”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted whenever the visible appearance of the terminal has changed. Used primarily by VteTerminalAccessible.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“copy-clipboard”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted whenever vte_terminal_copy_clipboard()
is called.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
“current-directory-uri-changed”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted when the current directory URI is modified.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since 0.34
“current-file-uri-changed”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted when the current file URI is modified.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since 0.34
“cursor-moved”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted whenever the cursor moves to a new character cell. Used primarily by VteTerminalAccessible.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“decrease-font-size”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted when the user hits the '-' key while holding the Control key.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“deiconify-window”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted at the child application's request.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“encoding-changed”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted whenever the terminal's current encoding has changed, either as a result of receiving a control sequence which toggled between the local and UTF-8 encodings, or at the parent application's request.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“eof”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
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 “child-exited” signal.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“icon-title-changed”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted when the terminal's icon_title
field is modified.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“iconify-window”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted at the child application's request.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“increase-font-size”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted when the user hits the '+' key while holding the Control key.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“lower-window”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted at the child application's request.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“maximize-window”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted at the child application's request.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“move-window”
signalvoid user_function (VteTerminal *vteterminal, guint x, guint y, gpointer user_data)
Emitted at the child application's request.
vteterminal |
the object which received the signal |
|
x |
the terminal's desired location, X coordinate |
|
y |
the terminal's desired location, Y coordinate |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“paste-clipboard”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted whenever vte_terminal_paste_clipboard()
is called.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
“raise-window”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted at the child application's request.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“refresh-window”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted at the child application's request.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“resize-window”
signalvoid user_function (VteTerminal *vteterminal, guint width, guint height, gpointer user_data)
Emitted at the child application's request.
vteterminal |
the object which received the signal |
|
width |
the desired number of columns |
|
height |
the desired number of rows |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“restore-window”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted at the child application's request.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“selection-changed”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted whenever the contents of terminal's selection changes.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“text-deleted”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“text-inserted”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“text-modified”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“text-scrolled”
signalvoid user_function (VteTerminal *vteterminal, gint delta, gpointer user_data)
An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.
vteterminal |
the object which received the signal |
|
delta |
the number of lines scrolled |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“window-title-changed”
signalvoid user_function (VteTerminal *vteterminal, gpointer user_data)
Emitted when the terminal's window_title
field is modified.
vteterminal |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last