ZvtTerm widget API description.

ZVT_TERM()

#define ZVT_TERM(obj)          GTK_CHECK_CAST (obj, zvt_term_get_type (), ZvtTerm)

Casts the obj GtkObject into a ZvtTerm object class.

ZVT_TERM_CLASS()

#define ZVT_TERM_CLASS(klass)  GTK_CHECK_CLASS_CAST (klass, zvt_term_get_type (), ZvtTermClass)

Casts the klass GtkObjectClass into a ZvtTermClass class.

ZVT_IS_TERM()

#define ZVT_IS_TERM(obj)       GTK_CHECK_TYPE (obj, zvt_term_get_type ())

Returns TRUE if the obj argument is a GtkObject of type ZvtTerm.

struct ZvtTerm

struct ZvtTerm;

struct ZvtTermClass

struct ZvtTermClass
{
  GtkWidgetClass parent_class;

  void (* child_died) (ZvtTerm *term);    
  void (* title_changed) (ZvtTerm *term, VTTITLE_TYPE type, char *newtitle);
};

ZVT_TERM_DO_UTMP_LOG

#define ZVT_TERM_DO_UTMP_LOG 1

ZVT_TERM_DO_WTMP_LOG

#define ZVT_TERM_DO_WTMP_LOG 2

zvt_term_new ()

GtkWidget*  zvt_term_new                    (void);

Creates a new ZVT Terminal widget. By default the terminal will be setup as 80 colmns x 24 rows, but it will size automatically to its encompassing widget, and may be smaller or larger upon realisation.

zvt_term_new_with_size ()

GtkWidget*  zvt_term_new_with_size          (int cols,
                                             int rows);

Creates a new ZVT Terminal widget of the given character dimentions. If the encompassing widget is resizable, then this size may change afterwards, but should be correct at realisation time.

zvt_term_feed ()

void        zvt_term_feed                   (ZvtTerm *term,
                                             char *text,
                                             int len);

This makes the terminal emulator process the stream of characters in text for len bytes. The text is interpreted by the terminal emulator as if it were generated by a child process.

This is used by code that needs a terminal emulator, but does not use a child process.

zvt_term_forkpty ()

int         zvt_term_forkpty                (ZvtTerm *term,
                                             int do_uwtmp_log);

Fork a child process, with a master controlling terminal.

zvt_term_closepty ()

int         zvt_term_closepty               (ZvtTerm *term);

Close master pty to the child process. It is upto the child to recognise its pty has been closed, and to exit appropriately.

Note that a child process must have first been started using zvt_term_forkpty().

zvt_term_killchild ()

int         zvt_term_killchild              (ZvtTerm *term,
                                             int signal);

Send the signal signal to the child process. Note that a child process must have first been started using zvt_term_forkpty().

zvt_term_bell ()

void        zvt_term_bell                   (void *zvt_term);

zvt_term_get_type ()

guint       zvt_term_get_type               (void);

zvt_term_set_scrollback ()

void        zvt_term_set_scrollback         (ZvtTerm *term,
                                             int lines);

Set the maximum number of scrollback lines for the widget term to lines lines.

zvt_term_get_buffer ()

char*       zvt_term_get_buffer             (ZvtTerm *term,
                                             int *len,
                                             int type,
                                             int sx,
                                             int sy,
                                             int ex,
                                             int ey);

Convert the buffer memory into a contiguous array which may be saved or processed. Note that this is not gauranteed to match the order of characters processed by the terminal, only the order in which they were displayed. Tabs will normally be preserved in the output.

All inputs are range-checked first, so it is possible to fudge a full buffer grab.

Examples: data = zvt_term_get_buffer(term, NULL, VT_SELTYPE_LINE, -term->vx->vt.scrollbackmax, 0, term->vx->vt.height, 0); or, as a rule - data = zvt_term_get_buffer(term, NULL, VT_SELTYPE_LINE, -10000, 0, 10000, 0);

Will return the contents of the entire scrollback and on-screen buffers, remembering that all inputs are range-checked first.

data = zvt_term_get_buffer(term, NULL, VT_SELTYPE_CHAR, 0, 0, 5, 10);

Will return the first 5 lines of the visible screen, and the 6th line upto column 10.

Return value: A pointer to a NUL terminated buffer containing the raw text from the buffer. If memory could not be allocated, then

zvt_term_set_font_name ()

void        zvt_term_set_font_name          (ZvtTerm *term,
                                             char *name);

Set a font by name only. If font aliases such as 'fixed' or '10x20' are passed to this function, then both the bold and non-bold font will be identical. In colour mode bold fonts are always the top 8 colour scheme entries, and so bold is still rendered.

Tries to calculate bold font name from the base name. This only works with fonts where the names are alike.

zvt_term_set_fonts ()

void        zvt_term_set_fonts              (ZvtTerm *term,
                                             GdkFont *font,
                                             GdkFont *font_bold);

Load a set of fonts into the terminal.

These fonts should be the same size, otherwise it could get messy ...

zvt_term_hide_pointer ()

void        zvt_term_hide_pointer           (ZvtTerm *term);

zvt_term_show_pointer ()

void        zvt_term_show_pointer           (ZvtTerm *term);

Hide the pointer. In reality the pointer is changed to a single-pixel black dot.

zvt_term_set_bell ()

void        zvt_term_set_bell               (ZvtTerm *term,
                                             int state);

Enable or disable the terminal bell. If state is TRUE, then the bell is enabled.

zvt_term_get_bell ()

gboolean    zvt_term_get_bell               (ZvtTerm *term);

get the terminal bell state. If the bell on then TRUE is returned, otherwise FALSE.

zvt_term_set_blink ()

void        zvt_term_set_blink              (ZvtTerm *term,
                                             int state);

Use this to control the way the cursor is displayed (blinking/solid)

zvt_term_set_scroll_on_keystroke ()

void        zvt_term_set_scroll_on_keystroke
                                            (ZvtTerm *term,
                                             int state);

If state is TRUE, forces the terminal to jump out of the scrollback buffer whenever a keypress is received.

zvt_term_set_scroll_on_output ()

void        zvt_term_set_scroll_on_output   (ZvtTerm *term,
                                             int state);

If state is TRUE, forces the terminal to scroll on output being generated by a child process or by zvt_term_feed().

zvt_term_set_color_scheme ()

void        zvt_term_set_color_scheme       (ZvtTerm *term,
                                             gushort *red,
                                             gushort *grn,
                                             gushort *blu);

This function sets the colour palette for the terminal term. Each pointer points to a gushort array of 18 elements. White is 0xffff in all elements.

The elements 0 trough 15 are the first 16 colours for the terminal, with element 16 and 17 the default foreground and background colour respectively.

zvt_term_set_default_color_scheme ()

void        zvt_term_set_default_color_scheme
                                            (ZvtTerm *term);

Resets the color values to the default color scheme.

zvt_term_set_del_key_swap ()

void        zvt_term_set_del_key_swap       (ZvtTerm *term,
                                             int state);

Sets the mode for interpreting the DEL and Backspace keys.

zvt_term_set_wordclass ()

void        zvt_term_set_wordclass          (ZvtTerm *term,
                                             unsigned char *klass);

Sets the list of characters (character class) that are considered part of a word, when selecting by word. The class is defined the same was as a regular expression character class (as normally defined using []'s, but without those included). A leading or trailing hypen (-) is used to include a hyphen in the character class.

Passing a NULL class restores the default behaviour of alphanumerics plus "_" (i.e. "A-Za-z0-9_").

zvt_term_set_background ()

void        zvt_term_set_background         (ZvtTerm *terminal,
                                             char *pixmap_file,
                                             int transparent,
                                             int flags);

Sets the background of the terminal. If pixmap_file and transparent are NULL and FALSE, then a standard filled background is set.

zvt_term_set_shadow_type ()

void        zvt_term_set_shadow_type        (ZvtTerm *term,
                                             GtkShadowType type);

zvt_term_set_size ()

void        zvt_term_set_size               (ZvtTerm *term,
                                             guint width,
                                             guint height);

Causes the terminal to attempt to resize to the absolute character size of width rows by height columns.

zvt_term_get_capabilities ()

guint32     zvt_term_get_capabilities       (ZvtTerm *term);

Gets the compiled in capabilities of the terminal widget.

ZVT_TERM_PIXMAP_SUPPORT; Pixmaps can be loaded into the background using the background setting function.

ZVT_TERM_PIXMAPSCROLL_SUPPORT; The background scrolling flag of the background setting function is honoured.

ZVT_TERM_EMBOLDEN_SUPPORT; Bold fonts are autogenerated, and can be requested by setting the bold_font of the font setting function to NULL.

ZVT_TERM_MATCH_SUPPORT; The zvt_term_add_match() functions exist, and can be used to receive the match_clicked signal when the user clicks on matching text.

ZVT_TERM_TRANSPARENCY_SUPPORT; A transparent background can be requested on the current display.

zvt_term_get_adjustment ()

GtkAdjustment* zvt_term_get_adjustment      (ZvtTerm *terminal);

zvk_term_set_adjustment ()

void        zvk_term_set_adjustment         (ZvtTerm *dial,
                                             GtkAdjustment *adjustment);