![]() |
![]() |
![]() |
VTE Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Style Properties | Signals |
struct VteTerminal; enum VteTerminalAntiAlias; enum VteTerminalCursorBlinkMode; enum VteTerminalCursorShape; enum VteTerminalEraseBinding; enum VteTerminalWriteFlags; gboolean (*VteSelectionFunc) (VteTerminal *terminal
,glong column
,glong row
,gpointer data
); GtkWidget * vte_terminal_new (void
); void vte_terminal_feed (VteTerminal *terminal
,const char *data
,glong length
); void vte_terminal_feed_child (VteTerminal *terminal
,const char *text
,glong length
); void vte_terminal_feed_child_binary (VteTerminal *terminal
,const char *data
,glong length
); int vte_terminal_get_child_exit_status (VteTerminal *terminal
); void vte_terminal_select_all (VteTerminal *terminal
); void vte_terminal_select_none (VteTerminal *terminal
); void vte_terminal_copy_clipboard (VteTerminal *terminal
); void vte_terminal_paste_clipboard (VteTerminal *terminal
); void vte_terminal_copy_primary (VteTerminal *terminal
); void vte_terminal_paste_primary (VteTerminal *terminal
); void vte_terminal_set_size (VteTerminal *terminal
,glong columns
,glong rows
); void vte_terminal_set_audible_bell (VteTerminal *terminal
,gboolean is_audible
); gboolean vte_terminal_get_audible_bell (VteTerminal *terminal
); void vte_terminal_set_visible_bell (VteTerminal *terminal
,gboolean is_visible
); gboolean vte_terminal_get_visible_bell (VteTerminal *terminal
); void vte_terminal_set_allow_bold (VteTerminal *terminal
,gboolean allow_bold
); gboolean vte_terminal_get_allow_bold (VteTerminal *terminal
); void vte_terminal_set_scroll_on_output (VteTerminal *terminal
,gboolean scroll
); void vte_terminal_set_scroll_on_keystroke (VteTerminal *terminal
,gboolean scroll
); void vte_terminal_set_color_bold (VteTerminal *terminal
,const GdkColor *bold
); void vte_terminal_set_color_bold_rgba (VteTerminal *terminal
,const GdkRGBA *bold
); void vte_terminal_set_color_foreground (VteTerminal *terminal
,const GdkColor *foreground
); void vte_terminal_set_color_foreground_rgba (VteTerminal *terminal
,const GdkRGBA *foreground
); void vte_terminal_set_color_background (VteTerminal *terminal
,const GdkColor *background
); void vte_terminal_set_color_background_rgba (VteTerminal *terminal
,const GdkRGBA *background
); void vte_terminal_set_color_dim (VteTerminal *terminal
,const GdkColor *dim
); void vte_terminal_set_color_dim_rgba (VteTerminal *terminal
,const GdkRGBA *dim
); void vte_terminal_set_color_cursor (VteTerminal *terminal
,const GdkColor *cursor_background
); void vte_terminal_set_color_cursor_rgba (VteTerminal *terminal
,const GdkRGBA *cursor_background
); void vte_terminal_set_color_highlight (VteTerminal *terminal
,const GdkColor *highlight_background
); void vte_terminal_set_color_highlight_rgba (VteTerminal *terminal
,const GdkRGBA *highlight_background
); void vte_terminal_set_colors (VteTerminal *terminal
,const GdkColor *foreground
,const GdkColor *background
,const GdkColor *palette
,glong palette_size
); void vte_terminal_set_colors_rgba (VteTerminal *terminal
,const GdkRGBA *foreground
,const GdkRGBA *background
,const GdkRGBA *palette
,gsize palette_size
); void vte_terminal_set_default_colors (VteTerminal *terminal
); void vte_terminal_set_cursor_shape (VteTerminal *terminal
,VteTerminalCursorShape shape
); VteTerminalCursorShape vte_terminal_get_cursor_shape (VteTerminal *terminal
); void vte_terminal_set_cursor_blinks (VteTerminal *terminal
,gboolean blink
); VteTerminalCursorBlinkMode vte_terminal_get_cursor_blink_mode (VteTerminal *terminal
); void vte_terminal_set_cursor_blink_mode (VteTerminal *terminal
,VteTerminalCursorBlinkMode mode
); void vte_terminal_set_scrollback_lines (VteTerminal *terminal
,glong lines
); void vte_terminal_set_font (VteTerminal *terminal
,const PangoFontDescription *font_desc
); void vte_terminal_set_font_from_string (VteTerminal *terminal
,const char *name
); void vte_terminal_set_font_from_string_full (VteTerminal *terminal
,const char *name
,VteTerminalAntiAlias antialias
); void vte_terminal_set_font_full (VteTerminal *terminal
,const PangoFontDescription *font_desc
,VteTerminalAntiAlias antialias
); const PangoFontDescription * vte_terminal_get_font (VteTerminal *terminal
); gboolean vte_terminal_get_using_xft (VteTerminal *terminal
); gboolean vte_terminal_get_has_selection (VteTerminal *terminal
); void vte_terminal_set_word_chars (VteTerminal *terminal
,const char *spec
); gboolean vte_terminal_is_word_char (VteTerminal *terminal
,gunichar c
); void vte_terminal_set_backspace_binding (VteTerminal *terminal
,VteTerminalEraseBinding binding
); void vte_terminal_set_delete_binding (VteTerminal *terminal
,VteTerminalEraseBinding binding
); void vte_terminal_set_mouse_autohide (VteTerminal *terminal
,gboolean setting
); gboolean vte_terminal_get_mouse_autohide (VteTerminal *terminal
); void vte_terminal_reset (VteTerminal *terminal
,gboolean clear_tabstops
,gboolean clear_history
); char * vte_terminal_get_text (VteTerminal *terminal
,VteSelectionFunc is_selected
,gpointer user_data
,GArray *attributes
); char * vte_terminal_get_text_include_trailing_spaces (VteTerminal *terminal
,VteSelectionFunc is_selected
,gpointer user_data
,GArray *attributes
); 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
,GArray *attributes
); void vte_terminal_get_cursor_position (VteTerminal *terminal
,glong *column
,glong *row
); void vte_terminal_match_clear_all (VteTerminal *terminal
); int vte_terminal_match_add (VteTerminal *terminal
,const char *match
); int vte_terminal_match_add_gregex (VteTerminal *terminal
,GRegex *regex
,GRegexMatchFlags flags
); void vte_terminal_match_remove (VteTerminal *terminal
,int tag
); char * vte_terminal_match_check (VteTerminal *terminal
,glong column
,glong row
,int *tag
); void vte_terminal_match_set_cursor (VteTerminal *terminal
,int tag
,GdkCursor *cursor
); void vte_terminal_match_set_cursor_type (VteTerminal *terminal
,int tag
,GdkCursorType cursor_type
); void vte_terminal_match_set_cursor_name (VteTerminal *terminal
,int tag
,const char *cursor_name
); void vte_terminal_set_emulation (VteTerminal *terminal
,const char *emulation
); const char * vte_terminal_get_emulation (VteTerminal *terminal
); const char * vte_terminal_get_default_emulation (VteTerminal *terminal
); void vte_terminal_set_encoding (VteTerminal *terminal
,const char *codeset
); const char * vte_terminal_get_encoding (VteTerminal *terminal
); const char * vte_terminal_get_status_line (VteTerminal *terminal
); void vte_terminal_get_padding (VteTerminal *terminal
,int *xpad
,int *ypad
); gboolean vte_terminal_write_contents (VteTerminal *terminal
,GOutputStream *stream
,VteTerminalWriteFlags flags
,GCancellable *cancellable
,GError **error
); gboolean vte_terminal_search_find_next (VteTerminal *terminal
); gboolean vte_terminal_search_find_previous (VteTerminal *terminal
); GRegex * vte_terminal_search_get_gregex (VteTerminal *terminal
); gboolean vte_terminal_search_get_wrap_around (VteTerminal *terminal
); void vte_terminal_search_set_gregex (VteTerminal *terminal
,GRegex *regex
); void vte_terminal_search_set_wrap_around (VteTerminal *terminal
,gboolean wrap_around
); char * vte_get_user_shell (void
); pid_t vte_terminal_fork_command (VteTerminal *terminal
,const char *command
,char **argv
,char **envv
,const char *working_directory
,gboolean lastlog
,gboolean utmp
,gboolean wtmp
); gboolean vte_terminal_fork_command_full (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
,GError **error
); pid_t vte_terminal_forkpty (VteTerminal *terminal
,char **envv
,const char *working_directory
,gboolean lastlog
,gboolean utmp
,gboolean wtmp
); int vte_terminal_get_pty (VteTerminal *terminal
); VtePty * vte_terminal_get_pty_object (VteTerminal *terminal
); VtePty * vte_terminal_pty_new (VteTerminal *terminal
,VtePtyFlags flags
,GError **error
); void vte_terminal_set_pty (VteTerminal *terminal
,int pty_master
); void vte_terminal_set_pty_object (VteTerminal *terminal
,VtePty *pty
); void vte_terminal_watch_child (VteTerminal *terminal
,GPid child_pid
); GtkAdjustment * vte_terminal_get_adjustment (VteTerminal *terminal
); glong vte_terminal_get_char_ascent (VteTerminal *terminal
); glong vte_terminal_get_char_descent (VteTerminal *terminal
); glong vte_terminal_get_char_height (VteTerminal *terminal
); glong vte_terminal_get_char_width (VteTerminal *terminal
); glong vte_terminal_get_column_count (VteTerminal *terminal
); const char * vte_terminal_get_icon_title (VteTerminal *terminal
); glong vte_terminal_get_row_count (VteTerminal *terminal
); const char * vte_terminal_get_window_title (VteTerminal *terminal
); const char * vte_terminal_get_current_directory_uri (VteTerminal *terminal
); const char * vte_terminal_get_current_file_uri (VteTerminal *terminal
); void vte_terminal_im_append_menuitems (VteTerminal *terminal
,GtkMenuShell *menushell
); void vte_terminal_set_opacity (VteTerminal *terminal
,guint16 opacity
); void vte_terminal_set_background_image (VteTerminal *terminal
,GdkPixbuf *image
); void vte_terminal_set_background_image_file (VteTerminal *terminal
,const char *path
); void vte_terminal_set_background_saturation (VteTerminal *terminal
,double saturation
); void vte_terminal_set_background_transparent (VteTerminal *terminal
,gboolean transparent
); void vte_terminal_set_background_tint_color (VteTerminal *terminal
,const GdkColor *color
); void vte_terminal_set_scroll_background (VteTerminal *terminal
,gboolean scroll
);
GObject +----GInitiallyUnowned +----GtkWidget +----VteTerminal
GEnum +----VteTerminalAntiAlias
GEnum +----VteTerminalCursorBlinkMode
GEnum +----VteTerminalCursorShape
GEnum +----VteTerminalEraseBinding
GEnum +----VteTerminalWriteFlags
"allow-bold" gboolean : Read / Write "audible-bell" gboolean : Read / Write "background-image-file" gchar* : Read / Write "background-image-pixbuf" GdkPixbuf* : Read / Write "background-opacity" gdouble : Read / Write "background-saturation" gdouble : Read / Write "background-tint-color" GdkColor* : Read / Write "background-transparent" gboolean : Read / Write "backspace-binding" VteTerminalEraseBinding : Read / Write "current-directory-uri" gchar* : Read "current-file-uri" gchar* : Read "cursor-blink-mode" VteTerminalCursorBlinkMode : Read / Write "cursor-shape" VteTerminalCursorShape : Read / Write "delete-binding" VteTerminalEraseBinding : Read / Write "emulation" gchar* : Read / Write "encoding" gchar* : Read / Write "font-desc" PangoFontDescription* : Read / Write "icon-title" gchar* : Read "pointer-autohide" gboolean : Read / Write "pty" gint : Read / Write "pty-object" VtePty* : Read / Write "scroll-background" gboolean : Read / Write "scroll-on-keystroke" gboolean : Read / Write "scroll-on-output" gboolean : Read / Write "scrollback-lines" guint : Read / Write "visible-bell" gboolean : Read / Write "window-title" gchar* : Read "word-chars" gchar* : Read / Write
"beep" :Run Last
"char-size-changed" :Run Last
"child-exited" :Run Last
"commit" :Run Last
"contents-changed" :Run Last
"copy-clipboard" :Action
"current-directory-uri-changed" :Run Last
"current-file-uri-changed" :Run Last
"cursor-moved" :Run Last
"decrease-font-size" :Run Last
"deiconify-window" :Run Last
"emulation-changed" :Run Last
"encoding-changed" :Run Last
"eof" :Run Last
"icon-title-changed" :Run Last
"iconify-window" :Run Last
"increase-font-size" :Run Last
"lower-window" :Run Last
"maximize-window" :Run Last
"move-window" :Run Last
"paste-clipboard" :Action
"raise-window" :Run Last
"refresh-window" :Run Last
"resize-window" :Run Last
"restore-window" :Run Last
"selection-changed" :Run Last
"status-line-changed" :Run Last
"text-deleted" :Run Last
"text-inserted" :Run Last
"text-modified" :Run Last
"text-scrolled" :Run Last
"window-title-changed" :Run Last
struct VteTerminal;
All of these fields should be considered read-only and deprecated.
typedef enum { VTE_ANTI_ALIAS_USE_DEFAULT, VTE_ANTI_ALIAS_FORCE_ENABLE, VTE_ANTI_ALIAS_FORCE_DISABLE } VteTerminalAntiAlias;
VteTerminalAntiAlias
is deprecated and should not be used in newly-written code.
An enumeration describing which anti-alias setting to use.
Deprecated
: 0.20
typedef enum { VTE_CURSOR_BLINK_SYSTEM, VTE_CURSOR_BLINK_ON, VTE_CURSOR_BLINK_OFF } VteTerminalCursorBlinkMode;
An enumerated type which can be used to indicate the cursor blink mode for the terminal.
typedef enum { VTE_CURSOR_SHAPE_BLOCK, VTE_CURSOR_SHAPE_IBEAM, VTE_CURSOR_SHAPE_UNDERLINE } VteTerminalCursorShape;
An enumerated type which can be used to indicate what should the terminal draw at the cursor position.
typedef enum { VTE_ERASE_AUTO, VTE_ERASE_ASCII_BACKSPACE, VTE_ERASE_ASCII_DELETE, VTE_ERASE_DELETE_SEQUENCE, VTE_ERASE_TTY } VteTerminalEraseBinding;
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.
For backspace, attempt to determine the right value from the terminal's IO settings. For delete, use the control sequence. | |
Send an ASCII backspace character (0x08). | |
Send an ASCII delete character (0x7F). | |
Send the "@7 " control sequence.
|
|
Send terminal's "erase" setting. |
typedef enum { VTE_TERMINAL_WRITE_DEFAULT = 0 } VteTerminalWriteFlags;
A flag type to determine how terminal contents should be written to an output stream.
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.
|
terminal in which the cell is. |
|
column in which the cell is. |
|
row in which the cell is. |
|
user data. [closure] |
Returns : |
TRUE if cell has to be selected; FALSE if otherwise. |
GtkWidget * vte_terminal_new (void
);
Creates a new terminal widget.
Returns : |
a new VteTerminal object. [transfer none][type Vte.Terminal] |
void vte_terminal_feed (VteTerminal *terminal
,const char *data
,glong length
);
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.
|
a VteTerminal |
|
a string in the terminal's current encoding. [array length=length][element-type guint8] |
|
the length of the string |
void vte_terminal_feed_child (VteTerminal *terminal
,const char *text
,glong length
);
Sends a block of UTF-8 text to the child as if it were entered by the user at the keyboard.
|
a VteTerminal |
|
data to send to the child |
|
length of text in bytes, or -1 if text is NUL-terminated |
void vte_terminal_feed_child_binary (VteTerminal *terminal
,const char *data
,glong length
);
Sends a block of binary data to the child.
|
a VteTerminal |
|
data to send to the child |
|
length of data
|
Since 0.12.1
int vte_terminal_get_child_exit_status (VteTerminal *terminal
);
Gets the exit status of the command started by vte_terminal_fork_command()
.
See your C library's documentation for more details on how to interpret the
exit status.
Note that this function may only be called from the signal handler of the "child-exited" signal.
|
a VteTerminal |
Returns : |
the child's exit status |
Since 0.20
void vte_terminal_select_all (VteTerminal *terminal
);
Selects all text within the terminal (including the scrollback buffer).
|
a VteTerminal |
Since 0.16
void vte_terminal_select_none (VteTerminal *terminal
);
Clears the current selection.
|
a VteTerminal |
Since 0.16
void vte_terminal_copy_clipboard (VteTerminal *terminal
);
Places the selected text in the terminal in the GDK_SELECTION_CLIPBOARD selection.
|
a VteTerminal |
void vte_terminal_paste_clipboard (VteTerminal *terminal
);
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.
|
a VteTerminal |
void vte_terminal_copy_primary (VteTerminal *terminal
);
Places the selected text in the terminal in the GDK_SELECTION_PRIMARY selection.
|
a VteTerminal |
void vte_terminal_paste_primary (VteTerminal *terminal
);
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.
|
a VteTerminal |
void vte_terminal_set_size (VteTerminal *terminal
,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.
|
a VteTerminal |
|
the desired number of columns |
|
the desired number of rows |
void vte_terminal_set_audible_bell (VteTerminal *terminal
,gboolean is_audible
);
Controls whether or not the terminal will beep when the child outputs the "bl" sequence.
|
a VteTerminal |
|
TRUE if the terminal should beep |
gboolean vte_terminal_get_audible_bell (VteTerminal *terminal
);
Checks whether or not the terminal will beep when the child outputs the "bl" sequence.
|
a VteTerminal |
Returns : |
TRUE if audible bell is enabled, FALSE if not |
void vte_terminal_set_visible_bell (VteTerminal *terminal
,gboolean is_visible
);
Controls whether or not the terminal will present a visible bell to the user when the child outputs the "bl" sequence. The terminal will clear itself to the default foreground color and then repaint itself.
|
a VteTerminal |
|
whether the terminal should flash on bell |
gboolean vte_terminal_get_visible_bell (VteTerminal *terminal
);
Checks whether or not the terminal will present a visible bell to the user when the child outputs the "bl" sequence. The terminal will clear itself to the default foreground color and then repaint itself.
|
a VteTerminal |
Returns : |
TRUE if visible bell is enabled, FALSE if not |
void vte_terminal_set_allow_bold (VteTerminal *terminal
,gboolean allow_bold
);
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.
|
a VteTerminal |
|
TRUE if the terminal should attempt to draw bold text |
gboolean vte_terminal_get_allow_bold (VteTerminal *terminal
);
Checks whether or not the terminal will attempt to draw bold text by repainting text with a one-pixel offset.
|
a VteTerminal |
Returns : |
TRUE if bolding is enabled, FALSE if not |
void vte_terminal_set_scroll_on_output (VteTerminal *terminal
,gboolean 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.
|
a VteTerminal |
|
whether the terminal should scroll on output |
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.
|
a VteTerminal |
|
whether the terminal should scroll on keystrokes |
void vte_terminal_set_color_bold (VteTerminal *terminal
,const GdkColor *bold
);
Sets the color used to draw bold text in the default foreground color.
|
a VteTerminal |
|
the new bold color |
void vte_terminal_set_color_bold_rgba (VteTerminal *terminal
,const GdkRGBA *bold
);
Sets the color used to draw bold text in the default foreground color.
If bold
is NULL
then the default color is used.
|
a VteTerminal |
|
the new bold color or NULL . [allow-none]
|
void vte_terminal_set_color_foreground (VteTerminal *terminal
,const GdkColor *foreground
);
Sets the foreground color used to draw normal text
|
a VteTerminal |
|
the new foreground color |
void vte_terminal_set_color_foreground_rgba (VteTerminal *terminal
,const GdkRGBA *foreground
);
Sets the foreground color used to draw normal text.
|
a VteTerminal |
|
the new foreground color |
Since 0.28
void vte_terminal_set_color_background (VteTerminal *terminal
,const GdkColor *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.
|
a VteTerminal |
|
the new background color |
void vte_terminal_set_color_background_rgba (VteTerminal *terminal
,const GdkRGBA *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.
|
a VteTerminal |
|
the new background color |
Since 0.28
void vte_terminal_set_color_dim (VteTerminal *terminal
,const GdkColor *dim
);
Sets the color used to draw dim text in the default foreground color.
|
a VteTerminal |
|
the new dim color |
void vte_terminal_set_color_dim_rgba (VteTerminal *terminal
,const GdkRGBA *dim
);
Sets the color used to draw dim text in the default foreground color.
If dim
is NULL
then the default color is used.
|
a VteTerminal |
|
the new dim color or NULL . [allow-none]
|
Since 0.28
void vte_terminal_set_color_cursor (VteTerminal *terminal
,const GdkColor *cursor_background
);
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.
|
a VteTerminal |
|
the new color to use for the text cursor, or NULL . [allow-none]
|
Since 0.11.11
void vte_terminal_set_color_cursor_rgba (VteTerminal *terminal
,const GdkRGBA *cursor_background
);
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.
|
a VteTerminal |
|
the new color to use for the text cursor, or NULL . [allow-none]
|
Since 0.28
void vte_terminal_set_color_highlight (VteTerminal *terminal
,const GdkColor *highlight_background
);
Sets the background color for text which is highlighted. If NULL
,
highlighted text (which is usually highlighted because it is selected) will
be drawn with foreground and background colors reversed.
|
a VteTerminal |
|
the new color to use for highlighted text, or NULL . [allow-none]
|
Since 0.11.11
void vte_terminal_set_color_highlight_rgba (VteTerminal *terminal
,const GdkRGBA *highlight_background
);
Sets the background color for text which is highlighted. If NULL
,
highlighted text (which is usually highlighted because it is selected) will
be drawn with foreground and background colors reversed.
|
a VteTerminal |
|
the new color to use for highlighted text, or NULL . [allow-none]
|
Since 0.28
void vte_terminal_set_colors (VteTerminal *terminal
,const GdkColor *foreground
,const GdkColor *background
,const GdkColor *palette
,glong palette_size
);
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 255 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
.
|
a VteTerminal |
|
the new foreground color, or NULL . [allow-none]
|
|
the new background color, or NULL . [allow-none]
|
|
the color palette. [array length=palette_size zero-terminated=0][element-type Gdk.Color] |
|
the number of entries in palette
|
void vte_terminal_set_colors_rgba (VteTerminal *terminal
,const GdkRGBA *foreground
,const GdkRGBA *background
,const GdkRGBA *palette
,gsize palette_size
);
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 255 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
.
|
a VteTerminal |
|
the new foreground color, or NULL . [allow-none]
|
|
the new background color, or NULL . [allow-none]
|
|
the color palette. [array length=palette_size zero-terminated=0][element-type Gdk.RGBA] |
|
the number of entries in palette
|
Since 0.28
void vte_terminal_set_default_colors (VteTerminal *terminal
);
Reset the terminal palette to reasonable compiled-in default color.
|
a VteTerminal |
void vte_terminal_set_cursor_shape (VteTerminal *terminal
,VteTerminalCursorShape shape
);
Sets the shape of the cursor drawn.
|
a VteTerminal |
|
the VteTerminalCursorShape to use |
Since 0.20
VteTerminalCursorShape vte_terminal_get_cursor_shape (VteTerminal *terminal
);
Returns the currently set cursor shape.
|
a VteTerminal |
Returns : |
cursor shape. |
Since 0.17.6
void vte_terminal_set_cursor_blinks (VteTerminal *terminal
,gboolean blink
);
vte_terminal_set_cursor_blinks
is deprecated and should not be used in newly-written code. 0.17.1 Use vte_terminal_set_cursor_blink_mode()
instead.
Sets whether or not the cursor will blink.
|
a VteTerminal |
|
whether the cursor should blink |
VteTerminalCursorBlinkMode vte_terminal_get_cursor_blink_mode
(VteTerminal *terminal
);
Returns the currently set cursor blink mode.
|
a VteTerminal |
Returns : |
cursor blink mode. |
Since 0.17.1
void vte_terminal_set_cursor_blink_mode (VteTerminal *terminal
,VteTerminalCursorBlinkMode mode
);
Sets whether or not the cursor will blink. Using VTE_CURSOR_BLINK_SYSTEM
will use the "gtk-cursor-blink" setting.
|
a VteTerminal |
|
the VteTerminalCursorBlinkMode to use |
Since 0.17.1
void vte_terminal_set_scrollback_lines (VteTerminal *terminal
,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 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.
|
a VteTerminal |
|
the length of the history buffer |
void vte_terminal_set_font (VteTerminal *terminal
,const PangoFontDescription *font_desc
);
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.
|
a VteTerminal |
|
a PangoFontDescription for the desired font, or NULL . [allow-none]
|
void vte_terminal_set_font_from_string (VteTerminal *terminal
,const char *name
);
A convenience function which converts name
into a PangoFontDescription and
passes it to vte_terminal_set_font()
.
|
a VteTerminal |
|
a pango font description in string form. [type utf8] |
void vte_terminal_set_font_from_string_full (VteTerminal *terminal
,const char *name
,VteTerminalAntiAlias antialias
);
vte_terminal_set_font_from_string_full
has been deprecated since version 0.20 and should not be used in newly-written code. Use vte_terminal_set_font()
A convenience function which converts name
into a PangoFontDescription and
passes it to vte_terminal_set_font_full()
.
|
a VteTerminal |
|
A string describing the font. |
|
Whether or not to antialias the font (if possible). |
Since 0.11.11
void vte_terminal_set_font_full (VteTerminal *terminal
,const PangoFontDescription *font_desc
,VteTerminalAntiAlias antialias
);
vte_terminal_set_font_full
has been deprecated since version 0.20 and should not be used in newly-written code. Use vte_terminal_set_font()
Sets the font used for rendering all text displayed by the terminal,
overriding any fonts set using gtk_widget_modify_font()
. The terminal
will immediately attempt to load the desired font, retrieve its
metrics, and attempt to resize itself to keep the same number of rows
and columns.
|
a VteTerminal |
|
The PangoFontDescription of the desired font, or NULL
|
|
Specify if anti aliasing of the fonts is to be used or not. |
Since 0.11.11
const PangoFontDescription * vte_terminal_get_font (VteTerminal *terminal
);
Queries the terminal for information about the fonts which will be used to draw text in the terminal.
|
a VteTerminal |
Returns : |
a PangoFontDescription describing the font the terminal is currently using to render text. [transfer none] |
gboolean vte_terminal_get_using_xft (VteTerminal *terminal
);
vte_terminal_get_using_xft
is deprecated and should not be used in newly-written code. 0.20
A VteTerminal can use multiple methods to draw text. This function allows an application to determine whether or not the current method uses fontconfig to find fonts. This setting cannot be changed by the caller, but in practice usually matches the behavior of GTK+ itself.
|
a VteTerminal |
Returns : |
TRUE |
gboolean vte_terminal_get_has_selection (VteTerminal *terminal
);
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.
|
a VteTerminal |
Returns : |
TRUE if part of the text in the terminal is selected. |
void vte_terminal_set_word_chars (VteTerminal *terminal
,const char *spec
);
When the user double-clicks to start selection, the terminal will extend
the selection on word boundaries. It will treat characters included in spec
as parts of words, and all other characters as word separators. Ranges of
characters can be specified by separating them with a hyphen.
As a special case, if spec
is NULL
or the empty string, the terminal will
treat all graphic non-punctuation non-space characters as word characters.
|
a VteTerminal |
|
a specification |
gboolean vte_terminal_is_word_char (VteTerminal *terminal
,gunichar c
);
Checks if a particular character is considered to be part of a word or not,
based on the values last passed to vte_terminal_set_word_chars()
.
|
a VteTerminal |
|
a candidate Unicode code point |
Returns : |
TRUE if the character is considered to be part of a word |
void vte_terminal_set_backspace_binding (VteTerminal *terminal
,VteTerminalEraseBinding 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.
|
a VteTerminal |
|
a VteTerminalEraseBinding for the backspace key |
void vte_terminal_set_delete_binding (VteTerminal *terminal
,VteTerminalEraseBinding 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.
|
a VteTerminal |
|
a VteTerminalEraseBinding for the delete key |
void vte_terminal_set_mouse_autohide (VteTerminal *terminal
,gboolean 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 setting can be read using
vte_terminal_get_mouse_autohide()
.
|
a VteTerminal |
|
whether the mouse pointer should autohide |
gboolean vte_terminal_get_mouse_autohide (VteTerminal *terminal
);
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()
.
|
a VteTerminal |
Returns : |
TRUE if autohiding is enabled, FALSE if not |
void vte_terminal_reset (VteTerminal *terminal
,gboolean clear_tabstops
,gboolean clear_history
);
Resets as much of the terminal's internal state as possible, discarding any unprocessed input data, resetting character attributes, cursor state, national character set state, status line, terminal modes (insert/delete), selection state, and encoding.
|
a VteTerminal |
|
whether to reset tabstops |
|
whether to empty the terminal's scrollback buffer |
char * vte_terminal_get_text (VteTerminal *terminal
,VteSelectionFunc is_selected
,gpointer user_data
,GArray *attributes
);
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.
|
a VteTerminal |
|
a VteSelectionFunc callback. [scope call][allow-none] |
|
user data to be passed to the callback. [closure] |
|
location for storing text attributes. [out caller-allocates][transfer full][array][element-type Vte.CharAttributes] |
Returns : |
a newly allocated text string, or NULL . [transfer full]
|
char * vte_terminal_get_text_include_trailing_spaces (VteTerminal *terminal
,VteSelectionFunc is_selected
,gpointer user_data
,GArray *attributes
);
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.
|
a VteTerminal |
|
a VteSelectionFunc callback. [scope call][allow-none] |
|
user data to be passed to the callback. [closure] |
|
location for storing text attributes. [out caller-allocates][transfer full][array][element-type Vte.CharAttributes] |
Returns : |
a newly allocated text string, or NULL . [transfer full]
|
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
,GArray *attributes
);
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.
|
a VteTerminal |
|
first row to search for data |
|
first column to search for data |
|
last row to search for data |
|
last column to search for data |
|
a VteSelectionFunc callback. [scope call][allow-none] |
|
user data to be passed to the callback. [closure] |
|
location for storing text attributes. [out caller-allocates][transfer full][array][element-type Vte.CharAttributes] |
Returns : |
a newly allocated text string, or NULL . [transfer full]
|
void vte_terminal_get_cursor_position (VteTerminal *terminal
,glong *column
,glong *row
);
Reads the location of the insertion cursor and returns it. The row coordinate is absolute.
|
a VteTerminal |
|
a location to store the column, or NULL . [out][allow-none]
|
|
a location to store the row, or NULL . [out][allow-none]
|
void vte_terminal_match_clear_all (VteTerminal *terminal
);
Clears the list of regular expressions the terminal uses to highlight text when the user moves the mouse cursor.
|
a VteTerminal |
int vte_terminal_match_add (VteTerminal *terminal
,const char *match
);
vte_terminal_match_add
has been deprecated since version 0.17.1 and should not be used in newly-written code. Use vte_terminal_match_add_gregex()
instead
Adds a regular expression 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.
|
a VteTerminal |
|
a regular expression |
Returns : |
an integer associated with this expression |
int vte_terminal_match_add_gregex (VteTerminal *terminal
,GRegex *regex
,GRegexMatchFlags 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 highlighted.
|
a VteTerminal |
|
a GRegex |
|
the GRegexMatchFlags to use when matching the regex |
Returns : |
an integer associated with this expression |
Since 0.17.1
void vte_terminal_match_remove (VteTerminal *terminal
,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.
|
a VteTerminal |
|
the tag of the regex to remove |
char * vte_terminal_match_check (VteTerminal *terminal
,glong column
,glong row
,int *tag
);
Checks if the text in and around the specified position matches any of the
regular expressions previously set using vte_terminal_match_add()
. 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.
|
a VteTerminal |
|
the text column |
|
the text row |
|
a location to store the tag, or NULL . [out][allow-none]
|
Returns : |
a newly allocated string which matches one of the previously set regular expressions. [transfer full] |
void vte_terminal_match_set_cursor (VteTerminal *terminal
,int tag
,GdkCursor *cursor
);
Sets which cursor the terminal will use if the pointer is over the pattern
specified by tag
. The terminal keeps a reference to cursor
.
|
a VteTerminal |
|
the tag of the regex which should use the specified cursor |
|
the GdkCursor which the terminal should use when the pattern is
highlighted, or NULL to use the standard cursor. [allow-none]
|
Since 0.11
void vte_terminal_match_set_cursor_type (VteTerminal *terminal
,int tag
,GdkCursorType cursor_type
);
Sets which cursor the terminal will use if the pointer is over the pattern
specified by tag
.
|
a VteTerminal |
|
the tag of the regex which should use the specified cursor |
|
a GdkCursorType |
Since 0.11.9
void vte_terminal_match_set_cursor_name (VteTerminal *terminal
,int tag
,const char *cursor_name
);
Sets which cursor the terminal will use if the pointer is over the pattern
specified by tag
.
|
a VteTerminal |
|
the tag of the regex which should use the specified cursor |
|
the name of the cursor |
Since 0.17.1
void vte_terminal_set_emulation (VteTerminal *terminal
,const char *emulation
);
Sets what type of terminal the widget attempts to emulate by scanning for control sequences defined in the system's termcap file. Unless you are interested in this feature, always use "xterm".
|
a VteTerminal |
|
the name of a terminal description, or NULL to use the default. [allow-none]
|
const char * vte_terminal_get_emulation (VteTerminal *terminal
);
Queries the terminal for its current emulation, as last set by a call to
vte_terminal_set_emulation()
.
|
a VteTerminal |
Returns : |
an interned string containing the name of the terminal type the widget is attempting to emulate |
const char * vte_terminal_get_default_emulation (VteTerminal *terminal
);
Queries the terminal for its default emulation, which is attempted if the
terminal type passed to vte_terminal_set_emulation()
is NULL
.
|
a VteTerminal |
Returns : |
an interned string containing the name of the default terminal type the widget attempts to emulate. [transfer none][type utf8] |
Since 0.11.11
void 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. The default encoding is defined by the application's locale settings.
|
a VteTerminal |
|
a valid GIConv target, or NULL to use the default encoding. [allow-none]
|
const char * vte_terminal_get_encoding (VteTerminal *terminal
);
Determines the name of the encoding in which the terminal expects data to be encoded.
|
a VteTerminal |
Returns : |
the current encoding for the terminal. [transfer none] |
const char * vte_terminal_get_status_line (VteTerminal *terminal
);
Some terminal emulations specify a status line which is separate from the main display area, and define a means for applications to move the cursor to the status line and back.
|
a VteTerminal |
Returns : |
the current contents of the terminal's status line. For terminals like "xterm", this will usually be the empty string. The string must not be modified or freed by the caller. [transfer none] |
void vte_terminal_get_padding (VteTerminal *terminal
,int *xpad
,int *ypad
);
vte_terminal_get_padding
has been deprecated since version 0.26 and should not be used in newly-written code. Get the "inner-border" style property instead
Determines the amount of additional space the widget is using to pad the
edges of its visible area. This is necessary for cases where characters in
the selected font don't themselves include a padding area and the text
itself would otherwise be contiguous with the window border. Applications
which use the widget's row_count
, column_count
, char_height
, and
char_width
fields to set geometry hints using
gtk_window_set_geometry_hints()
will need to add this value to the base
size. The values returned in xpad
and ypad
are the total padding used in
each direction, and do not need to be doubled.
|
a VteTerminal |
|
address in which to store left/right-edge padding |
|
address in which to store top/bottom-edge ypadding |
gboolean vte_terminal_write_contents (VteTerminal *terminal
,GOutputStream *stream
,VteTerminalWriteFlags flags
,GCancellable *cancellable
,GError **error
);
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.
|
a VteTerminal |
|
a GOutputStream to write to |
|
a set of VteTerminalWriteFlags |
|
a GCancellable object, or NULL . [allow-none]
|
|
a GError location to store the error occuring, or NULL . [allow-none]
|
Returns : |
TRUE on success, FALSE if there was an error |
Since 0.24
gboolean vte_terminal_search_find_next (VteTerminal *terminal
);
Searches the next string matching the search regex set with
vte_terminal_search_set_gregex()
.
|
a VteTerminal |
Returns : |
TRUE if a match was found |
Since 0.26
gboolean vte_terminal_search_find_previous (VteTerminal *terminal
);
Searches the previous string matching the search regex set with
vte_terminal_search_set_gregex()
.
|
a VteTerminal |
Returns : |
TRUE if a match was found |
Since 0.26
GRegex * vte_terminal_search_get_gregex (VteTerminal *terminal
);
|
a VteTerminal |
Returns : |
the search GRegex regex set in terminal , or NULL . [transfer none]
|
Since 0.26
gboolean vte_terminal_search_get_wrap_around (VteTerminal *terminal
);
|
a VteTerminal |
Returns : |
whether searching will wrap around |
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
.
|
a VteTerminal |
|
a GRegex, or NULL . [allow-none]
|
Since 0.26
void vte_terminal_search_set_wrap_around (VteTerminal *terminal
,gboolean wrap_around
);
Sets whether search should wrap around to the beginning of the terminal content when reaching its end.
|
a VteTerminal |
|
whether search should wrap |
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.
Returns : |
a newly allocated string with the
user's shell, or NULL . [transfer full][type filename]
|
Since 0.28
pid_t vte_terminal_fork_command (VteTerminal *terminal
,const char *command
,char **argv
,char **envv
,const char *working_directory
,gboolean lastlog
,gboolean utmp
,gboolean wtmp
);
vte_terminal_fork_command
has been deprecated since version 0.26 and should not be used in newly-written code. Use vte_terminal_fork_command_full()
Starts the specified command under a newly-allocated controlling
pseudo-terminal. The argv
and envv
lists should be NULL
-terminated, and
argv[0] is expected to be the name of the file being run, as it would be if
execve()
were being called. TERM is automatically set to reflect the
terminal widget's emulation setting. If lastlog
, utmp
, or wtmp
are TRUE
,
logs the session to the specified system log files.
Note that all file descriptors except stdin/stdout/stderr will be closed
before calling exec()
in the child.
|
a VteTerminal |
|
the name of a binary to run, or NULL to spawn the user's shell. [allow-none][type filename]
|
|
the argument list to be passed to command , or NULL . [allow-none][array zero-terminated=1][element-type filename]
|
|
a list of environment variables to be added to the environment before
starting command , or NULL . [allow-none][array zero-terminated=1][element-type filename]
|
|
the name of a directory the command should start in, or NULL . [allow-none][type filename]
|
|
TRUE if the session should be logged to the lastlog |
|
TRUE if the session should be logged to the utmp/utmpx log |
|
TRUE if the session should be logged to the wtmp/wtmpx log |
Returns : |
the PID of the new process, or -1 on failure |
gboolean vte_terminal_fork_command_full (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
,GError **error
);
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 reflect the
terminal widget's emulation setting.
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.
|
a VteTerminal |
|
flags from VtePtyFlags |
|
the name of a directory the command should start
in, or NULL to use the current working directory. [allow-none]
|
|
child's argument vector. [array zero-terminated=1][element-type filename] |
|
a list of environment
variables to be added to the environment before starting the process, or NULL . [allow-none][array zero-terminated=1][element-type filename]
|
|
flags from GSpawnFlags |
|
an extra child setup function to run in the child just before exec() , or NULL . [allow-none][scope call]
|
|
user data for child_setup
|
|
a location to store the child PID, or NULL . [out][allow-none][transfer full]
|
|
return location for a GError, or NULL . [allow-none]
|
Returns : |
TRUE on success, or FALSE on error with error filled in |
Since 0.26
pid_t vte_terminal_forkpty (VteTerminal *terminal
,char **envv
,const char *working_directory
,gboolean lastlog
,gboolean utmp
,gboolean wtmp
);
vte_terminal_forkpty
has been deprecated since version 0.26 and should not be used in newly-written code. Use VtePty and fork()
instead
Starts a new child process under a newly-allocated controlling
pseudo-terminal. TERM is automatically set to reflect the terminal widget's
emulation setting. If lastlog
, utmp
, or wtmp
are TRUE
, logs the session
to the specified system log files.
Note that all file descriptors except stdin/stdout/stderr will be closed in the child.
Note that envv
and working_directory
are silently ignored.
|
a VteTerminal |
|
a list of environment variables to be added to the environment before
starting returning in the child process, or NULL
|
|
the name of a directory the child process should change to, or
NULL
|
|
TRUE if the session should be logged to the lastlog |
|
TRUE if the session should be logged to the utmp/utmpx log |
|
TRUE if the session should be logged to the wtmp/wtmpx log |
Returns : |
the ID of the new process in the parent, 0 in the child, and -1 if there was an error |
Since 0.11.11
int vte_terminal_get_pty (VteTerminal *terminal
);
vte_terminal_get_pty
has been deprecated since version 0.26 and should not be used in newly-written code. Use vte_terminal_get_pty_object()
and vte_pty_get_fd()
Returns the file descriptor of the master end of terminal
's PTY.
|
a VteTerminal |
Returns : |
the file descriptor, or -1 if the terminal has no PTY. |
Since 0.20
VtePty * vte_terminal_get_pty_object (VteTerminal *terminal
);
Returns the VtePty of terminal
.
|
a VteTerminal |
Returns : |
a VtePty, or NULL . [transfer none]
|
Since 0.26
VtePty * vte_terminal_pty_new (VteTerminal *terminal
,VtePtyFlags flags
,GError **error
);
Creates a new VtePty, and sets the emulation property from "emulation".
See vte_pty_new()
for more information.
|
a VteTerminal |
|
flags from VtePtyFlags |
|
return location for a GError, or NULL . [allow-none]
|
Returns : |
a new VtePty. [transfer full] |
Since 0.26
void vte_terminal_set_pty (VteTerminal *terminal
,int pty_master
);
vte_terminal_set_pty
has been deprecated since version 0.26 and should not be used in newly-written code. Use vte_pty_new_foreign()
and vte_terminal_set_pty_object()
Attach an existing PTY master side to the terminal widget. Use
instead of vte_terminal_fork_command()
or vte_terminal_forkpty()
.
|
a VteTerminal |
|
a file descriptor of the master end of a PTY, or -1
|
Since 0.12.1
void vte_terminal_set_pty_object (VteTerminal *terminal
,VtePty *pty
);
Sets pty
as the PTY to use in terminal
.
Use NULL
to unset the PTY.
|
a VteTerminal |
|
a VtePty, or NULL . [allow-none]
|
Since 0.26.
void vte_terminal_watch_child (VteTerminal *terminal
,GPid child_pid
);
Watches child_pid
. When the process exists, the "child-exited"
signal will be called. Use vte_terminal_get_child_exit_status()
to
retrieve the child's exit status.
Prior to calling this function, a VtePty must have been set in terminal
using vte_terminal_set_pty_object()
.
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.
|
a VteTerminal |
|
a GPid |
Since 0.26
GtkAdjustment * vte_terminal_get_adjustment (VteTerminal *terminal
);
vte_terminal_get_adjustment
has been deprecated since version 0.28 and should not be used in newly-written code. Use gtk_scrollable_get_vadjustment()
instead
An accessor function provided for the benefit of language bindings.
|
a VteTerminal |
Returns : |
the contents of terminal 's adjustment field. [transfer none]
|
glong vte_terminal_get_char_ascent (VteTerminal *terminal
);
vte_terminal_get_char_ascent
is deprecated and should not be used in newly-written code. 0.20
An accessor function provided for the benefit of language bindings.
|
a VteTerminal |
Returns : |
the contents of terminal 's char_ascent field |
glong vte_terminal_get_char_descent (VteTerminal *terminal
);
vte_terminal_get_char_descent
is deprecated and should not be used in newly-written code. 0.20
An accessor function provided for the benefit of language bindings.
|
a VteTerminal |
Returns : |
the contents of terminal 's char_descent field |
glong vte_terminal_get_char_height (VteTerminal *terminal
);
|
a VteTerminal |
Returns : |
the height of a character cell |
glong vte_terminal_get_char_width (VteTerminal *terminal
);
|
a VteTerminal |
Returns : |
the width of a character cell |
glong vte_terminal_get_column_count (VteTerminal *terminal
);
|
a VteTerminal |
Returns : |
the number of columns |
const char * vte_terminal_get_icon_title (VteTerminal *terminal
);
|
a VteTerminal |
Returns : |
the icon title. [transfer none] |
glong vte_terminal_get_row_count (VteTerminal *terminal
);
|
a VteTerminal |
Returns : |
the number of rows |
const char * vte_terminal_get_window_title (VteTerminal *terminal
);
|
a VteTerminal |
Returns : |
the window title. [transfer none] |
const char * vte_terminal_get_current_directory_uri
(VteTerminal *terminal
);
|
a VteTerminal |
Returns : |
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 (VteTerminal *terminal
);
|
a VteTerminal |
Returns : |
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
void vte_terminal_im_append_menuitems (VteTerminal *terminal
,GtkMenuShell *menushell
);
vte_terminal_im_append_menuitems
is deprecated and should not be used in newly-written code. 0.34.6
Appends menu items for various input methods to the given menu. The user can select one of these items to modify the input method used by the terminal.
|
a VteTerminal |
|
a GtkMenuShell |
void vte_terminal_set_opacity (VteTerminal *terminal
,guint16 opacity
);
vte_terminal_set_opacity
is deprecated and should not be used in newly-written code. 0.34.8
Sets the opacity of the terminal background, were 0 means completely transparent and 65535 means completely opaque.
|
a VteTerminal |
|
the new opacity |
void vte_terminal_set_background_image (VteTerminal *terminal
,GdkPixbuf *image
);
vte_terminal_set_background_image
is deprecated and should not be used in newly-written code. 0.34.8
Sets a background image for the widget. Text which would otherwise be
drawn using the default background color will instead be drawn over the
specified image. If necessary, the image will be tiled to cover the
widget's entire visible area. If specified by
vte_terminal_set_background_saturation()
, the terminal will tint its
in-memory copy of the image before applying it to the terminal.
|
a VteTerminal |
|
a GdkPixbuf to use, or NULL to unset the background. [allow-none]
|
void vte_terminal_set_background_image_file (VteTerminal *terminal
,const char *path
);
vte_terminal_set_background_image_file
is deprecated and should not be used in newly-written code. 0.34.8
Sets a background image for the widget. If specified by
vte_terminal_set_background_saturation()
, the terminal will tint its
in-memory copy of the image before applying it to the terminal.
|
a VteTerminal |
|
path to an image file. [type filename] |
void vte_terminal_set_background_saturation (VteTerminal *terminal
,double saturation
);
vte_terminal_set_background_saturation
is deprecated and should not be used in newly-written code. 0.34.8
If a background image has been set using
vte_terminal_set_background_image()
,
vte_terminal_set_background_image_file()
, or
vte_terminal_set_background_transparent()
, and the saturation value is less
than 1.0, the terminal will adjust the colors of the image before drawing
the image. To do so, the terminal will create a copy of the background
image (or snapshot of the root window) and modify its pixel values.
|
a VteTerminal |
|
a floating point value between 0.0 and 1.0. |
void vte_terminal_set_background_transparent (VteTerminal *terminal
,gboolean transparent
);
vte_terminal_set_background_transparent
is deprecated and should not be used in newly-written code. 0.34.8
Sets the terminal's background image to the pixmap stored in the root window, adjusted so that if there are no windows below your application, the widget will appear to be transparent.
|
a VteTerminal |
|
whether the terminal should fake transparency |
void vte_terminal_set_background_tint_color (VteTerminal *terminal
,const GdkColor *color
);
vte_terminal_set_background_tint_color
is deprecated and should not be used in newly-written code. 0.34.8
If a background image has been set using
vte_terminal_set_background_image()
,
vte_terminal_set_background_image_file()
, or
vte_terminal_set_background_transparent()
, and the value set by
vte_terminal_set_background_saturation()
is less than one, the terminal
will adjust the color of the image before drawing the image. To do so,
the terminal will create a copy of the background image (or snapshot of
the root window) and modify its pixel values. The initial tint color
is black.
|
a VteTerminal |
|
a color which the terminal background should be tinted to if its saturation is not 1.0. |
Since 0.11
void vte_terminal_set_scroll_background (VteTerminal *terminal
,gboolean scroll
);
vte_terminal_set_scroll_background
is deprecated and should not be used in newly-written code. 0.34.8
Controls whether or not the terminal will scroll the background image (if one is set) when the text in the window must be scrolled.
|
a VteTerminal |
|
whether the terminal should scroll the background image along with the text |
Since 0.11
"allow-bold"
property "allow-bold" gboolean : Read / Write
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.
Default value: TRUE
Since 0.20
"audible-bell"
property "audible-bell" gboolean : Read / Write
Controls whether or not the terminal will beep when the child outputs the "bl" sequence.
Default value: TRUE
Since 0.20
"background-image-file"
property "background-image-file" gchar* : Read / Write
Default value: NULL
"background-image-pixbuf"
property "background-image-pixbuf" GdkPixbuf* : Read / Write
VteTerminal:background-image-pixbuf
is deprecated and should not be used in newly-written code. 0.34.8
Sets a background image for the widget. Text which would otherwise be drawn using the default background color will instead be drawn over the specified image. If necessary, the image will be tiled to cover the widget's entire visible area. If specified by "background-saturation":, the terminal will tint its in-memory copy of the image before applying it to the terminal.
Since 0.20
"background-opacity"
property "background-opacity" gdouble : Read / Write
VteTerminal:background-opacity
is deprecated and should not be used in newly-written code. 0.34.8
Sets the opacity of the terminal background, were 0.0 means completely transparent and 1.0 means completely opaque.
Allowed values: [0,1]
Default value: 1
Since 0.20
"background-saturation"
property "background-saturation" gdouble : Read / Write
VteTerminal:background-saturation
is deprecated and should not be used in newly-written code. 0.34.8
If a background image has been set using "background-image-file": or "background-image-pixbuf":, or "background-transparent":, and the saturation value is less than 1.0, the terminal will adjust the colors of the image before drawing the image. To do so, the terminal will create a copy of the background image (or snapshot of the root window) and modify its pixel values.
Allowed values: [0,1]
Default value: 0.4
Since 0.20
"background-tint-color"
property "background-tint-color" GdkColor* : Read / Write
VteTerminal:background-tint-color
is deprecated and should not be used in newly-written code. 0.34.8
If a background image has been set using "background-image-file": or "background-image-pixbuf":, or "background-transparent":, and and the value set by VteTerminal:background-saturation: is less than 1.0, the terminal will adjust the color of the image before drawing the image. To do so, the terminal will create a copy of the background image (or snapshot of the root window) and modify its pixel values. The initial tint color is black.
Since 0.20
"background-transparent"
property "background-transparent" gboolean : Read / Write
VteTerminal:background-transparent
is deprecated and should not be used in newly-written code. 0.34.8
Sets whther the terminal uses the pixmap stored in the root window as the background, adjusted so that if there are no windows below your application, the widget will appear to be transparent.
Note: When using a compositing window manager, you should instead set a RGBA colourmap on the toplevel window, so you get real transparency.
Default value: FALSE
Since 0.20
"backspace-binding"
property"backspace-binding" VteTerminalEraseBinding : Read / Write
*Controls what string or control sequence the terminal sends to its child when the user presses the backspace key.
Default value: VTE_ERASE_AUTO
Since 0.20
"current-directory-uri"
property "current-directory-uri" gchar* : Read
The current directory URI, or NULL
if unset.
Default value: NULL
Since 0.34
"current-file-uri"
property "current-file-uri" gchar* : Read
The current file URI, or NULL
if unset.
Default value: NULL
Since 0.34
"cursor-blink-mode"
property"cursor-blink-mode" VteTerminalCursorBlinkMode : Read / Write
Sets whether or not the cursor will blink. Using VTE_CURSOR_BLINK_SYSTEM
will use the "gtk-cursor-blink" setting.
Default value: VTE_CURSOR_BLINK_SYSTEM
Since 0.20
"cursor-shape"
property"cursor-shape" VteTerminalCursorShape : Read / Write
Controls the shape of the cursor.
Default value: VTE_CURSOR_SHAPE_BLOCK
Since 0.20
"delete-binding"
property"delete-binding" VteTerminalEraseBinding : Read / Write
Controls what string or control sequence the terminal sends to its child when the user presses the delete key.
Default value: VTE_ERASE_AUTO
Since 0.20
"emulation"
property "emulation" gchar* : Read / Write
Sets what type of terminal the widget attempts to emulate by scanning for control sequences defined in the system's termcap file. Unless you are interested in this feature, always use the default which is "xterm".
Default value: "xterm"
Since 0.20
"encoding"
property "encoding" gchar* : Read / Write
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.
Default value: NULL
Since 0.20
"font-desc"
property "font-desc" PangoFontDescription* : Read / Write
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.
Since 0.20
"icon-title"
property "icon-title" gchar* : Read
The terminal's so-called icon title, or NULL
if no icon title has been set.
Default value: NULL
Since 0.20
"pointer-autohide"
property "pointer-autohide" gboolean : Read / Write
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.
Default value: FALSE
Since 0.20
"pty"
property "pty" gint : Read / Write
VteTerminal:pty
has been deprecated since version 0.26 and should not be used in newly-written code. Use the "pty-object" property instead
The file descriptor of the master end of the terminal's PTY.
Allowed values: >= -1
Default value: -1
Since 0.20
"pty-object"
property"pty-object" VtePty* : Read / Write
The PTY object for the terminal.
Since 0.26
"scroll-background"
property "scroll-background" gboolean : Read / Write
Controls whether or not the terminal will scroll the background image (if one is set) when the text in the window must be scrolled.
Default value: FALSE
Since 0.20
"scroll-on-keystroke"
property "scroll-on-keystroke" gboolean : Read / Write
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.
Default value: FALSE
Since 0.20
"scroll-on-output"
property "scroll-on-output" gboolean : Read / Write
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.
Default value: TRUE
Since 0.20
"scrollback-lines"
property "scrollback-lines" guint : Read / Write
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.
Default value: 100
Since 0.20
"visible-bell"
property "visible-bell" gboolean : Read / Write
Controls whether the terminal will present a visible bell to the user when the child outputs the "bl" sequence. The terminal will clear itself to the default foreground color and then repaint itself.
Default value: FALSE
Since 0.20
"window-title"
property "window-title" gchar* : Read
The terminal's title.
Default value: NULL
Since 0.20
"word-chars"
property "word-chars" gchar* : Read / Write
When the user double-clicks to start selection, the terminal will extend the selection on word boundaries. It will treat characters the word-chars characters as parts of words, and all other characters as word separators. Ranges of characters can be specified by separating them with a hyphen.
As a special case, when setting this to NULL
or the empty string, the terminal will
treat all graphic non-punctuation non-space characters as word characters.
Default value: NULL
Since 0.20
"beep"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
This signal is emitted when the a child sends a beep request to the terminal.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"char-size-changed"
signalvoid user_function (VteTerminal *vteterminal,
guint width,
guint height,
gpointer user_data) : Run Last
Emitted whenever selection of a new font causes the values of the
char_width
or char_height
fields to change.
|
the object which received the signal |
|
the new character cell width |
|
the new character cell height |
|
user data set when the signal handler was connected. |
"child-exited"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
This signal is emitted when the terminal detects that a child started
using vte_terminal_fork_command()
has exited.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"commit"
signalvoid user_function (VteTerminal *vteterminal,
gchar *text,
guint size,
gpointer user_data) : Run Last
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.
|
the object which received the signal |
|
a string of text |
|
the length of that string of text |
|
user data set when the signal handler was connected. |
"contents-changed"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted whenever the visible appearance of the terminal has changed. Used primarily by VteTerminalAccessible.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"copy-clipboard"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Action
Emitted whenever vte_terminal_copy_clipboard()
is called.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"current-directory-uri-changed"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted when the current directory URI is modified.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
Since 0.34
"current-file-uri-changed"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted when the current file URI is modified.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
Since 0.34
"cursor-moved"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted whenever the cursor moves to a new character cell. Used primarily by VteTerminalAccessible.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"decrease-font-size"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted when the user hits the '-' key while holding the Control key.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"deiconify-window"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted at the child application's request.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"emulation-changed"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted whenever the terminal's emulation changes, only possible at the parent application's request.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"encoding-changed"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
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.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"eof"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
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.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"icon-title-changed"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted when the terminal's icon_title
field is modified.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"iconify-window"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted at the child application's request.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"increase-font-size"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted when the user hits the '+' key while holding the Control key.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"lower-window"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted at the child application's request.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"maximize-window"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted at the child application's request.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"move-window"
signalvoid user_function (VteTerminal *vteterminal,
guint x,
guint y,
gpointer user_data) : Run Last
Emitted at the child application's request.
|
the object which received the signal |
|
the terminal's desired location, X coordinate |
|
the terminal's desired location, Y coordinate |
|
user data set when the signal handler was connected. |
"paste-clipboard"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Action
Emitted whenever vte_terminal_paste_clipboard()
is called.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"raise-window"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted at the child application's request.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"refresh-window"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted at the child application's request.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"resize-window"
signalvoid user_function (VteTerminal *vteterminal,
guint width,
guint height,
gpointer user_data) : Run Last
Emitted at the child application's request.
|
the object which received the signal |
|
the desired width in pixels, including padding |
|
the desired height in pixels, including padding |
|
user data set when the signal handler was connected. |
"restore-window"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted at the child application's request.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"selection-changed"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted whenever the contents of terminal's selection changes.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"status-line-changed"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted whenever the contents of the status line are modified or cleared.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"text-deleted"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"text-inserted"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"text-modified"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.
|
the object which received the signal |
|
user data set when the signal handler was connected. |
"text-scrolled"
signalvoid user_function (VteTerminal *vteterminal,
gint delta,
gpointer user_data) : Run Last
An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.
|
the object which received the signal |
|
the number of lines scrolled |
|
user data set when the signal handler was connected. |
"window-title-changed"
signalvoid user_function (VteTerminal *vteterminal,
gpointer user_data) : Run Last
Emitted when the terminal's window_title
field is modified.
|
the object which received the signal |
|
user data set when the signal handler was connected. |