diff options
Diffstat (limited to 'src/vte.h')
| -rw-r--r-- | src/vte.h | 273 |
1 files changed, 78 insertions, 195 deletions
@@ -1,19 +1,19 @@ /* * Copyright (C) 2001,2002,2003,2009,2010 Red Hat, Inc. * - * This is free software; you can redistribute it and/or modify it under - * the terms of the GNU Library General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. + * Lesser General Public License for more details. * - * You should have received a copy of the GNU Library General Public - * License along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef vte_vte_h_included @@ -34,18 +34,6 @@ G_BEGIN_DECLS -#ifdef VTE_SEAL_ENABLE -#define _VTE_SEAL(name) _vte_sealed__ ## name -#else -#define _VTE_SEAL(name) name -#endif - -#ifdef VTE_DISABLE_DEPRECATED -#define _VTE_DEPRECATED(name) _vte_deprecated__ ## name -#else -#define _VTE_DEPRECATED(name) name -#endif - #define VTE_TYPE_TERMINAL (vte_terminal_get_type()) #define VTE_TERMINAL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), VTE_TYPE_TERMINAL, VteTerminal)) #define VTE_TERMINAL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), VTE_TYPE_TERMINAL, VteTerminalClass)) @@ -57,27 +45,14 @@ typedef struct _VteTerminal VteTerminal; typedef struct _VteTerminalPrivate VteTerminalPrivate; typedef struct _VteTerminalClass VteTerminalClass; typedef struct _VteTerminalClassPrivate VteTerminalClassPrivate; +typedef struct _VteCharAttributes VteCharAttributes; /** * VteTerminal: - * - * All of these fields should be considered read-only and deprecated. */ struct _VteTerminal { GtkWidget widget; /*< private >*/ - GtkAdjustment *_VTE_SEAL(adjustment); /* Scrolling adjustment. */ - - /* Metric and sizing data. */ - glong _VTE_SEAL(char_width), _VTE_SEAL(char_height); /* dimensions of character cells */ - glong _VTE_SEAL(char_ascent), _VTE_SEAL(char_descent); /* important font metrics */ - glong _VTE_SEAL(row_count), _VTE_SEAL(column_count); /* dimensions of the window */ - - /* Titles. */ - char *_VTE_SEAL(window_title); - char *_VTE_SEAL(icon_title); - - /*< private >*/ VteTerminalPrivate *pvt; }; @@ -94,7 +69,7 @@ struct _VteTerminalClass { /*< protected > */ /* Default signal handlers. */ void (*eof)(VteTerminal* terminal); - void (*child_exited)(VteTerminal* terminal); + void (*child_exited)(VteTerminal* terminal, int status); void (*emulation_changed)(VteTerminal* terminal); void (*encoding_changed)(VteTerminal* terminal); void (*char_size_changed)(VteTerminal* terminal, guint char_width, guint char_height); @@ -116,6 +91,9 @@ struct _VteTerminalClass { void (*resize_window)(VteTerminal* terminal, guint width, guint height); void (*move_window)(VteTerminal* terminal, guint x, guint y); + /* FIXMEchpe: should these return gboolean and have defaul thandlers + * settings the "scale" property? + */ void (*increase_font_size)(VteTerminal* terminal); void (*decrease_font_size)(VteTerminal* terminal); @@ -126,66 +104,16 @@ struct _VteTerminalClass { void (*copy_clipboard)(VteTerminal* terminal); void (*paste_clipboard)(VteTerminal* terminal); -#if !GTK_CHECK_VERSION (2, 91, 2) - void (* set_scroll_adjustments) (GtkWidget *widget, - GtkAdjustment *hadjustment, - GtkAdjustment *vadjustment); -#endif - void (*beep)(VteTerminal* terminal); -#if GTK_CHECK_VERSION (2, 99, 0) /* Padding for future expansion. */ gpointer padding[16]; -#else - /* Padding for future expansion. */ - void (*vte_reserved3)(void); - void (*vte_reserved4)(void); - - /*< private > */ - /* Signals we might emit. */ - guint _VTE_DEPRECATED(eof_signal); - guint _VTE_DEPRECATED(child_exited_signal); - guint _VTE_DEPRECATED(emulation_changed_signal); - guint _VTE_DEPRECATED(encoding_changed_signal); - guint _VTE_DEPRECATED(char_size_changed_signal); - guint _VTE_DEPRECATED(window_title_changed_signal); - guint _VTE_DEPRECATED(icon_title_changed_signal); - guint _VTE_DEPRECATED(selection_changed_signal); - guint _VTE_DEPRECATED(contents_changed_signal); - guint _VTE_DEPRECATED(cursor_moved_signal); - guint _VTE_DEPRECATED(status_line_changed_signal); - guint _VTE_DEPRECATED(commit_signal); - guint _VTE_DEPRECATED(deiconify_window_signal); - guint _VTE_DEPRECATED(iconify_window_signal); - guint _VTE_DEPRECATED(raise_window_signal); - guint _VTE_DEPRECATED(lower_window_signal); - guint _VTE_DEPRECATED(refresh_window_signal); - guint _VTE_DEPRECATED(restore_window_signal); - guint _VTE_DEPRECATED(maximize_window_signal); - guint _VTE_DEPRECATED(resize_window_signal); - guint _VTE_DEPRECATED(move_window_signal); - guint _VTE_DEPRECATED(increase_font_size_signal); - guint _VTE_DEPRECATED(decrease_font_size_signal); - guint _VTE_DEPRECATED(text_modified_signal); - guint _VTE_DEPRECATED(text_inserted_signal); - guint _VTE_DEPRECATED(text_deleted_signal); - guint _VTE_DEPRECATED(text_scrolled_signal); - guint _VTE_DEPRECATED(reserved1); - guint _VTE_DEPRECATED(reserved2); - guint _VTE_DEPRECATED(reserved3); - guint _VTE_DEPRECATED(reserved4); - guint _VTE_DEPRECATED(reserved5); - guint _VTE_DEPRECATED(reserved6); -#endif -#if GTK_CHECK_VERSION (2, 99, 0) VteTerminalClassPrivate *priv; -#endif }; /** - * VteTerminalEraseBinding: + * VteEraseBinding: * @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). @@ -202,10 +130,10 @@ typedef enum { VTE_ERASE_ASCII_DELETE, VTE_ERASE_DELETE_SEQUENCE, VTE_ERASE_TTY -} VteTerminalEraseBinding; +} VteEraseBinding; /** - * VteTerminalCursorBlinkMode: + * VteCursorBlinkMode: * @VTE_CURSOR_BLINK_SYSTEM: Follow GTK+ settings for cursor blinking. * @VTE_CURSOR_BLINK_ON: Cursor blinks. * @VTE_CURSOR_BLINK_OFF: Cursor does not blink. @@ -217,10 +145,10 @@ typedef enum { VTE_CURSOR_BLINK_SYSTEM, VTE_CURSOR_BLINK_ON, VTE_CURSOR_BLINK_OFF -} VteTerminalCursorBlinkMode; +} VteCursorBlinkMode; /** - * VteTerminalCursorShape: + * VteCursorShape: * @VTE_CURSOR_SHAPE_BLOCK: Draw a block cursor. This is the default. * @VTE_CURSOR_SHAPE_IBEAM: Draw a vertical bar on the left side of character. * This is similar to the default cursor for other GTK+ widgets. @@ -233,22 +161,14 @@ typedef enum { VTE_CURSOR_SHAPE_BLOCK, VTE_CURSOR_SHAPE_IBEAM, VTE_CURSOR_SHAPE_UNDERLINE -} VteTerminalCursorShape; +} VteCursorShape; /* The structure we return as the supplemental attributes for strings. */ -struct _VteCharAttributes { - /*< private >*/ - long row, column; - GdkColor fore, back; - guint underline:1, strikethrough:1; -}; typedef struct _VteCharAttributes VteCharAttributes; - -/* The name of the same structure in the 0.10 series, for API compatibility. */ -struct vte_char_attributes { +struct _VteCharAttributes { /*< private >*/ long row, column; - GdkColor fore, back; + PangoColor fore, back; guint underline:1, strikethrough:1; }; @@ -262,23 +182,25 @@ GType vte_terminal_get_type(void); GtkWidget *vte_terminal_new(void); -VtePty *vte_terminal_pty_new (VteTerminal *terminal, - VtePtyFlags flags, - GError **error); +VtePty *vte_terminal_pty_new_sync (VteTerminal *terminal, + VtePtyFlags flags, + GCancellable *cancellable, + GError **error); void vte_terminal_watch_child (VteTerminal *terminal, GPid child_pid); -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 /* out */, - GError **error); +gboolean vte_terminal_spawn_sync(VteTerminal *terminal, + VtePtyFlags pty_flags, + const char *working_directory, + char **argv, + char **envv, + GSpawnFlags spawn_flags, + GSpawnChildSetupFunc child_setup, + gpointer child_setup_data, + GPid *child_pid /* out */, + GCancellable *cancellable, + GError **error); /* Send data to the terminal to display, or to the terminal's forked command * to handle in some way. If it's 'cat', they should be the same. */ @@ -293,44 +215,29 @@ void vte_terminal_paste_clipboard(VteTerminal *terminal); void vte_terminal_copy_primary(VteTerminal *terminal); void vte_terminal_paste_primary(VteTerminal *terminal); -/* simple manipulation of selection */ void vte_terminal_select_all(VteTerminal *terminal); -void vte_terminal_select_none(VteTerminal *terminal); +void vte_terminal_unselect_all(VteTerminal *terminal); /* Set the terminal's size. */ void vte_terminal_set_size(VteTerminal *terminal, glong columns, glong rows); +void vte_terminal_set_font_scale(VteTerminal *terminal, + gdouble scale); +gdouble vte_terminal_get_font_scale(VteTerminal *terminal); + /* Set various on-off settings. */ 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_scroll_background(VteTerminal *terminal, gboolean scroll); 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_rewrap_on_resize(VteTerminal *terminal, gboolean rewrap); +gboolean vte_terminal_get_rewrap_on_resize(VteTerminal *terminal); /* Set the color scheme. */ -void vte_terminal_set_color_dim(VteTerminal *terminal, - const GdkColor *dim); -void vte_terminal_set_color_bold(VteTerminal *terminal, - const GdkColor *bold); -void vte_terminal_set_color_foreground(VteTerminal *terminal, - const GdkColor *foreground); -void vte_terminal_set_color_background(VteTerminal *terminal, - const GdkColor *background); -void vte_terminal_set_color_cursor(VteTerminal *terminal, - const GdkColor *cursor_background); -void vte_terminal_set_color_highlight(VteTerminal *terminal, - const GdkColor *highlight_background); -void vte_terminal_set_colors(VteTerminal *terminal, - const GdkColor *foreground, - const GdkColor *background, - const GdkColor *palette, - glong palette_size); - -#if GTK_CHECK_VERSION (2, 99, 0) void vte_terminal_set_color_bold_rgba(VteTerminal *terminal, const GdkRGBA *bold); void vte_terminal_set_color_dim_rgba(VteTerminal *terminal, @@ -343,48 +250,32 @@ void vte_terminal_set_color_cursor_rgba(VteTerminal *terminal, const GdkRGBA *cursor_background); void vte_terminal_set_color_highlight_rgba(VteTerminal *terminal, const GdkRGBA *highlight_background); +void vte_terminal_set_color_highlight_foreground_rgba(VteTerminal *terminal, + const GdkRGBA *highlight_foreground); void vte_terminal_set_colors_rgba(VteTerminal *terminal, const GdkRGBA *foreground, const GdkRGBA *background, const GdkRGBA *palette, gsize palette_size); -#endif void vte_terminal_set_default_colors(VteTerminal *terminal); -/* Background effects. */ -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_tint_color(VteTerminal *terminal, - const GdkColor *color); -void vte_terminal_set_background_saturation(VteTerminal *terminal, - double saturation); -void vte_terminal_set_background_transparent(VteTerminal *terminal, - gboolean transparent); -void vte_terminal_set_opacity(VteTerminal *terminal, guint16 opacity); - /* Set whether or not the cursor blinks. */ void vte_terminal_set_cursor_blink_mode(VteTerminal *terminal, - VteTerminalCursorBlinkMode mode); -VteTerminalCursorBlinkMode vte_terminal_get_cursor_blink_mode(VteTerminal *terminal); + VteCursorBlinkMode mode); +VteCursorBlinkMode vte_terminal_get_cursor_blink_mode(VteTerminal *terminal); /* Set cursor shape */ void vte_terminal_set_cursor_shape(VteTerminal *terminal, - VteTerminalCursorShape shape); -VteTerminalCursorShape vte_terminal_get_cursor_shape(VteTerminal *terminal); + VteCursorShape shape); +VteCursorShape vte_terminal_get_cursor_shape(VteTerminal *terminal); /* Set the number of scrollback lines, above or at an internal minimum. */ void vte_terminal_set_scrollback_lines(VteTerminal *terminal, glong lines); -/* Append the input method menu items to a given shell. */ -void vte_terminal_im_append_menuitems(VteTerminal *terminal, - GtkMenuShell *menushell); - /* Set or retrieve the current font. */ void vte_terminal_set_font(VteTerminal *terminal, const PangoFontDescription *font_desc); -void vte_terminal_set_font_from_string(VteTerminal *terminal, const char *name); const PangoFontDescription *vte_terminal_get_font(VteTerminal *terminal); void vte_terminal_set_allow_bold(VteTerminal *terminal, gboolean allow_bold); gboolean vte_terminal_get_allow_bold(VteTerminal *terminal); @@ -392,17 +283,11 @@ gboolean vte_terminal_get_allow_bold(VteTerminal *terminal); /* Check if the terminal is the current selection owner. */ gboolean vte_terminal_get_has_selection(VteTerminal *terminal); -/* Set the list of word chars, optionally using hyphens to specify ranges - * (to get a hyphen, place it first), and check if a character is in the - * range. */ -void vte_terminal_set_word_chars(VteTerminal *terminal, const char *spec); -gboolean vte_terminal_is_word_char(VteTerminal *terminal, gunichar c); - /* Set what happens when the user strikes backspace or delete. */ void vte_terminal_set_backspace_binding(VteTerminal *terminal, - VteTerminalEraseBinding binding); + VteEraseBinding binding); void vte_terminal_set_delete_binding(VteTerminal *terminal, - VteTerminalEraseBinding binding); + VteEraseBinding binding); /* Manipulate the autohide setting. */ void vte_terminal_set_mouse_autohide(VteTerminal *terminal, gboolean setting); @@ -438,8 +323,6 @@ char *vte_terminal_attributes_to_html(VteTerminal *terminal, GArray *attributes); void vte_terminal_get_cursor_position(VteTerminal *terminal, glong *column, glong *row); -/* Display string matching: clear all matching expressions. */ -void vte_terminal_match_clear_all(VteTerminal *terminal); /* Add a matching expression, returning the tag the widget assigns to that * expression. */ @@ -451,8 +334,8 @@ 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); -/* Remove a matching expression by tag. */ void vte_terminal_match_remove(VteTerminal *terminal, int tag); +void vte_terminal_match_remove_all(VteTerminal *terminal); /* Check if a given cell on the screen contains part of a matched string. If * it does, return the string, and store the match tag in the optional tag @@ -462,7 +345,8 @@ char *vte_terminal_match_check(VteTerminal *terminal, int *tag); void vte_terminal_search_set_gregex (VteTerminal *terminal, - GRegex *regex); + GRegex *regex, + GRegexMatchFlags flags); GRegex *vte_terminal_search_get_gregex (VteTerminal *terminal); void vte_terminal_search_set_wrap_around (VteTerminal *terminal, gboolean wrap_around); @@ -474,63 +358,62 @@ gboolean vte_terminal_search_find_next (VteTerminal *terminal); /* Set the emulation type. Most of the time you won't need this. */ 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); + +const char *vte_get_default_emulation(void); /* Set the character encoding. Most of the time you won't need this. */ void vte_terminal_set_encoding(VteTerminal *terminal, const char *codeset); const char *vte_terminal_get_encoding(VteTerminal *terminal); +/* CJK compatibility setting */ +void vte_terminal_set_cjk_ambiguous_width(VteTerminal *terminal, int width); +int vte_terminal_get_cjk_ambiguous_width(VteTerminal *terminal); + /* Get the contents of the status line. */ const char *vte_terminal_get_status_line(VteTerminal *terminal); -void vte_terminal_set_pty_object(VteTerminal *terminal, VtePty *pty); -VtePty *vte_terminal_get_pty_object(VteTerminal *terminal); +void vte_terminal_set_pty(VteTerminal *terminal, VtePty *pty); +VtePty *vte_terminal_get_pty(VteTerminal *terminal); char *vte_get_user_shell (void); /* Accessors for bindings. */ -#if !GTK_CHECK_VERSION (2, 91, 2) -GtkAdjustment *vte_terminal_get_adjustment(VteTerminal *terminal); -#endif - glong vte_terminal_get_char_width(VteTerminal *terminal); glong vte_terminal_get_char_height(VteTerminal *terminal); glong vte_terminal_get_row_count(VteTerminal *terminal); glong vte_terminal_get_column_count(VteTerminal *terminal); const char *vte_terminal_get_window_title(VteTerminal *terminal); const char *vte_terminal_get_icon_title(VteTerminal *terminal); +const char *vte_terminal_get_current_directory_uri(VteTerminal *terminal); +const char *vte_terminal_get_current_file_uri(VteTerminal *terminal); -int vte_terminal_get_child_exit_status(VteTerminal *terminal); - +/* Window geometry helpers */ +void vte_terminal_get_geometry_hints(VteTerminal *terminal, + GdkGeometry *hints, + int min_rows, + int min_columns); +void vte_terminal_set_geometry_hints_for_window(VteTerminal *terminal, + GtkWindow *window); /* Writing contents out */ /** - * VteTerminalWriteFlags: - * @VTE_TERMINAL_WRITE_DEFAULT: Write contents as UTF-8 text. This is the default. + * VteWriteFlags: + * @VTE_WRITE_DEFAULT: Write contents as UTF-8 text. This is the default. * * A flag type to determine how terminal contents should be written * to an output stream. */ typedef enum { - VTE_TERMINAL_WRITE_DEFAULT = 0 -} VteTerminalWriteFlags; + VTE_WRITE_DEFAULT = 0 +} VteWriteFlags; gboolean vte_terminal_write_contents (VteTerminal *terminal, GOutputStream *stream, - VteTerminalWriteFlags flags, + VteWriteFlags flags, GCancellable *cancellable, GError **error); -#undef _VTE_SEAL -#undef _VTE_DEPRECATED - G_END_DECLS -#ifndef VTE_DISABLE_DEPRECATED -#define __VTE_VTE_H_INSIDE__ 1 -#include "vtedeprecated.h" -#undef __VTE_VTE_H_INSIDE__ -#endif /* VTE_DISABLE_DEPRECATED */ - #endif |