path: root/doc/reference/tmpl/vte.sgml

<!-- ##### SECTION Title ##### -->
VteTerminal

<!-- ##### SECTION Short_Description ##### -->
A terminal widget implementation.

<!-- ##### SECTION Long_Description ##### -->
<para>
A VteTerminal is a terminal emulator implemented as a GTK2 widget.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT VteTerminal ##### -->
<para>
All of these fields should be considered read-only.
</para>

@widget: Base #GtkWidget of the terminal widget.
@adjustment: Scroll bar adjustments.
@char_width: Width of a narrow character cell.
@char_height: Height of a character cell.
@char_ascent: The distance (in pixels) from the baseline of drawn text to the top of the character cell.
@char_descent: The distance (in pixels) from the baseline of drawn text to the bottom of the character cell.
@row_count: Number of visible rows.
@column_count: Number of visible columns.
@window_title: The terminal's idea of what the window's title should be.
@icon_title: The terminal's idea of what the window's title should be when iconified.

<!-- ##### SIGNAL VteTerminal::beep ##### -->
<para>

</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::char-size-changed ##### -->
<para>
Emitted whenever selection of a new font causes the values of the
@char_width or @char_height fields to change.
</para>

@vteterminal: the object which received the signal.
@arg1: the new character cell width.
@arg2: the new character cell height.

<!-- ##### SIGNAL VteTerminal::child-exited ##### -->
<para>
This signal is emitted when the terminal detects that a child started using
vte_terminal_fork_command() has exited.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::commit ##### -->
<para>
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.
</para>

@vteterminal: the object which received the signal.
@arg1: a string of text.
@arg2: the length of that string of text.

<!-- ##### SIGNAL VteTerminal::contents-changed ##### -->
<para>
Emitted whenever the visible appearance of the terminal has changed.  Used
primarily by #VteTerminalAccessible.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::copy-clipboard ##### -->
<para>
Emitted whenever vte_terminal_copy_clipboard() is called.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::cursor-moved ##### -->
<para>
Emitted whenever the cursor moves to a new character cell.  Used primarily
by #VteTerminalAccessible.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::decrease-font-size ##### -->
<para>
Emitted when the user hits the '-' key while holding the Control key.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::deiconify-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::emulation-changed ##### -->
<para>
Emitted whenever the terminal's emulation changes, only possible at the
parent application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::encoding-changed ##### -->
<para>
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.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::eof ##### -->
<para>
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.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::icon-title-changed ##### -->
<para>
Emitted when the terminal's @icon_title field is modified.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::iconify-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::increase-font-size ##### -->
<para>
Emitted when the user hits the '+' key while holding the Control key.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::lower-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::maximize-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::move-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.
@arg1: the terminal's desired location, X coordinate.
@arg2: the terminal's desired location, Y coordinate.

<!-- ##### SIGNAL VteTerminal::paste-clipboard ##### -->
<para>
Emitted whenever vte_terminal_paste_clipboard() is called.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::raise-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::refresh-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::resize-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.
@arg1: the desired width in pixels, including padding.
@arg2: the desired height in pixels, including padding.

<!-- ##### SIGNAL VteTerminal::restore-window ##### -->
<para>
Emitted at the child application's request.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::selection-changed ##### -->
<para>
Emitted whenever the contents of terminal's selection changes.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::set-scroll-adjustments ##### -->
<para>

</para>

@vteterminal: the object which received the signal.
@arg1: 
@arg2: 

<!-- ##### SIGNAL VteTerminal::status-line-changed ##### -->
<para>
Emitted whenever the contents of the status line are modified or cleared.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::text-deleted ##### -->
<para>
An internal signal used for communication between the terminal and its
accessibility peer.  May not be emitted under certain circumstances.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::text-inserted ##### -->
<para>
An internal signal used for communication between the terminal and its
accessibility peer.  May not be emitted under certain circumstances.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::text-modified ##### -->
<para>
An internal signal used for communication between the terminal and its
accessibility peer.  May not be emitted under certain circumstances.
</para>

@vteterminal: the object which received the signal.

<!-- ##### SIGNAL VteTerminal::text-scrolled ##### -->
<para>
An internal signal used for communication between the terminal and its
accessibility peer.  May not be emitted under certain circumstances.
</para>

@vteterminal: the object which received the signal.
@arg1: the number of lines scrolled.

<!-- ##### SIGNAL VteTerminal::window-title-changed ##### -->
<para>
Emitted when the terminal's @window_title field is modified.
</para>

@vteterminal: the object which received the signal.

<!-- ##### ENUM VteTerminalEraseBinding ##### -->
<para>
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.
</para>

@VTE_ERASE_AUTO: For backspace, attempt to determine the right value from the terminal's IO settings.  For delete, use the control sequence.
@VTE_ERASE_ASCII_BACKSPACE: Send an ASCII backspace character (0x08).
@VTE_ERASE_ASCII_DELETE: Send an ASCII delete character (0x7F).
@VTE_ERASE_DELETE_SEQUENCE: Send the "@@7" control sequence.

<!-- ##### FUNCTION vte_terminal_new ##### -->
<para>
</para>

@Returns: 


<!-- ##### FUNCTION vte_terminal_im_append_menuitems ##### -->
<para>
</para>

@terminal: 
@menushell: 


<!-- ##### FUNCTION vte_terminal_fork_command ##### -->
<para>
</para>

@terminal: 
@command: 
@argv: 
@envv: 
@directory: 
@lastlog: 
@utmp: 
@wtmp: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_forkpty ##### -->
<para>

</para>

@terminal: 
@envv: 
@directory: 
@lastlog: 
@utmp: 
@wtmp: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_set_pty ##### -->
<para>

</para>

@terminal: 
@pty_master: 


<!-- ##### FUNCTION vte_terminal_feed ##### -->
<para>

</para>

@terminal: 
@data: 
@length: 


<!-- ##### FUNCTION vte_terminal_feed_child ##### -->
<para>

</para>

@terminal: 
@text: 
@length: 


<!-- ##### FUNCTION vte_terminal_feed_child_binary ##### -->
<para>

</para>

@terminal: 
@data: 
@length: 


<!-- ##### FUNCTION vte_terminal_select_all ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_select_none ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_copy_clipboard ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_paste_clipboard ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_copy_primary ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_paste_primary ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_set_size ##### -->
<para>

</para>

@terminal: 
@columns: 
@rows: 


<!-- ##### FUNCTION vte_terminal_set_audible_bell ##### -->
<para>

</para>

@terminal: 
@is_audible: 


<!-- ##### FUNCTION vte_terminal_get_audible_bell ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_set_visible_bell ##### -->
<para>

</para>

@terminal: 
@is_visible: 


<!-- ##### FUNCTION vte_terminal_get_visible_bell ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_set_allow_bold ##### -->
<para>

</para>

@terminal: 
@allow_bold: 


<!-- ##### FUNCTION vte_terminal_get_allow_bold ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_set_scroll_on_output ##### -->
<para>

</para>

@terminal: 
@scroll: 


<!-- ##### FUNCTION vte_terminal_set_scroll_on_keystroke ##### -->
<para>

</para>

@terminal: 
@scroll: 


<!-- ##### FUNCTION vte_terminal_set_color_bold ##### -->
<para>

</para>

@terminal: 
@bold: 


<!-- ##### FUNCTION vte_terminal_set_color_foreground ##### -->
<para>

</para>

@terminal: 
@foreground: 


<!-- ##### FUNCTION vte_terminal_set_color_background ##### -->
<para>

</para>

@terminal: 
@background: 


<!-- ##### FUNCTION vte_terminal_set_color_dim ##### -->
<para>

</para>

@terminal: 
@dim: 


<!-- ##### FUNCTION vte_terminal_set_color_cursor ##### -->
<para>

</para>

@terminal: 
@cursor_background: 


<!-- ##### FUNCTION vte_terminal_set_color_highlight ##### -->
<para>

</para>

@terminal: 
@highlight_background: 


<!-- ##### FUNCTION vte_terminal_set_colors ##### -->
<para>

</para>

@terminal: 
@foreground: 
@background: 
@palette: 
@palette_size: 


<!-- ##### FUNCTION vte_terminal_set_default_colors ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_set_opacity ##### -->
<para>

</para>

@terminal: 
@opacity: 


<!-- ##### FUNCTION vte_terminal_set_background_image ##### -->
<para>

</para>

@terminal: 
@image: 


<!-- ##### FUNCTION vte_terminal_set_background_image_file ##### -->
<para>

</para>

@terminal: 
@path: 


<!-- ##### FUNCTION vte_terminal_set_background_saturation ##### -->
<para>

</para>

@terminal: 
@saturation: 


<!-- ##### FUNCTION vte_terminal_set_background_transparent ##### -->
<para>

</para>

@terminal: 
@transparent: 


<!-- ##### FUNCTION vte_terminal_set_background_tint_color ##### -->
<para>

</para>

@terminal: 
@color: 


<!-- ##### FUNCTION vte_terminal_set_scroll_background ##### -->
<para>

</para>

@terminal: 
@scroll: 


<!-- ##### FUNCTION vte_terminal_set_cursor_blinks ##### -->
<para>

</para>

@terminal: 
@blink: 


<!-- ##### FUNCTION vte_terminal_get_cursor_blink_mode ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_set_cursor_blink_mode ##### -->
<para>

</para>

@terminal: 
@mode: 


<!-- ##### FUNCTION vte_terminal_set_scrollback_lines ##### -->
<para>

</para>

@terminal: 
@lines: 


<!-- ##### FUNCTION vte_terminal_set_font ##### -->
<para>

</para>

@terminal: 
@font_desc: 


<!-- ##### FUNCTION vte_terminal_set_font_from_string ##### -->
<para>

</para>

@terminal: 
@name: 


<!-- ##### FUNCTION vte_terminal_set_font_from_string_full ##### -->
<para>

</para>

@terminal: 
@name: 
@antialias: 


<!-- ##### FUNCTION vte_terminal_set_font_full ##### -->
<para>

</para>

@terminal: 
@font_desc: 
@antialias: 


<!-- ##### FUNCTION vte_terminal_get_font ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_using_xft ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_has_selection ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_set_word_chars ##### -->
<para>

</para>

@terminal: 
@spec: 


<!-- ##### FUNCTION vte_terminal_is_word_char ##### -->
<para>

</para>

@terminal: 
@c: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_set_backspace_binding ##### -->
<para>

</para>

@terminal: 
@binding: 


<!-- ##### FUNCTION vte_terminal_set_delete_binding ##### -->
<para>

</para>

@terminal: 
@binding: 


<!-- ##### FUNCTION vte_terminal_set_mouse_autohide ##### -->
<para>

</para>

@terminal: 
@setting: 


<!-- ##### FUNCTION vte_terminal_get_mouse_autohide ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_reset ##### -->
<para>

</para>

@terminal: 
@full: 
@clear_history: 


<!-- ##### FUNCTION vte_terminal_get_text ##### -->
<para>

</para>

@terminal: 
@is_selected: 
@data: 
@attributes: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_text_include_trailing_spaces ##### -->
<para>

</para>

@terminal: 
@is_selected: 
@data: 
@attributes: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_text_range ##### -->
<para>

</para>

@terminal: 
@start_row: 
@start_col: 
@end_row: 
@end_col: 
@is_selected: 
@data: 
@attributes: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_cursor_position ##### -->
<para>

</para>

@terminal: 
@column: 
@row: 


<!-- ##### FUNCTION vte_terminal_match_clear_all ##### -->
<para>

</para>

@terminal: 


<!-- ##### FUNCTION vte_terminal_match_add ##### -->
<para>

</para>

@terminal: 
@match: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_match_add_gregex ##### -->
<para>

</para>

@terminal: 
@regex: 
@flags: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_match_remove ##### -->
<para>

</para>

@terminal: 
@tag: 


<!-- ##### FUNCTION vte_terminal_match_check ##### -->
<para>

</para>

@terminal: 
@column: 
@row: 
@tag: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_match_set_cursor ##### -->
<para>

</para>

@terminal: 
@tag: 
@cursor: 


<!-- ##### FUNCTION vte_terminal_match_set_cursor_type ##### -->
<para>

</para>

@terminal: 
@tag: 
@cursor_type: 


<!-- ##### FUNCTION vte_terminal_match_set_cursor_name ##### -->
<para>

</para>

@terminal: 
@tag: 
@cursor_name: 


<!-- ##### FUNCTION vte_terminal_set_emulation ##### -->
<para>

</para>

@terminal: 
@emulation: 


<!-- ##### FUNCTION vte_terminal_get_emulation ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_default_emulation ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_set_encoding ##### -->
<para>

</para>

@terminal: 
@codeset: 


<!-- ##### FUNCTION vte_terminal_get_encoding ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_status_line ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_padding ##### -->
<para>

</para>

@terminal: 
@xpad: 
@ypad: 


<!-- ##### FUNCTION vte_terminal_get_adjustment ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_char_ascent ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_char_descent ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_char_height ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_char_width ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_column_count ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_icon_title ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_row_count ##### -->
<para>

</para>

@terminal: 
@Returns: 


<!-- ##### FUNCTION vte_terminal_get_window_title ##### -->
<para>

</para>

@terminal: 
@Returns: