ZVT Terminal Widget Reference Guide | |||
---|---|---|---|
<<< Previous Page | Home | Next Page >>> |
The following pages contain the complete API reference.
If state is TRUE, forces the terminal to jump out of the scrollback buffer whenever a keypress is received.
If state is TRUE, forces the terminal to scroll on output being generated by a child process or by zvt_term_feed().
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_").
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.
A pointer to a ZvtTerm widget is returned, or NULL on error.
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.
A pointer to a ZvtTerm widget is returned, or NULL on error.
Performs a complete reset on the terminal. Resets all attributes, and if hard is TRUE, also clears the screen.
term | A ZvtTerm widget. |
red | pointer to a gushort array of 18 elements with red values. |
grn | pointer to a gushort array of 18 elements with green values. |
blu | pointer to a gushort array of 18 elements with blue values. |
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.
Causes the terminal to attempt to resize to the absolute character size of width rows by height columns.
Hide the pointer. In reality the pointer is changed to a single-pixel black dot.
Set the maximum number of scrollback lines for the widget term to lines lines.
term | A ZvtTerm widget. |
font | Font used for regular text. |
font_bold | Font used for bold text. May be null, in which case the bold font is rendered by over-striking. |
Load a set of fonts into the terminal.
These fonts should be the same size, otherwise it could get messy ...
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.
Writes len bytes of data, starting from data to the subordinate child process. If the child is unable to handle all of the data at once, then it will return, and asynchronously continue to feed the data to the child.
The number of bytes written initially.
Send the signal signal to the child process. Note that a child process must have first been started using zvt_term_forkpty().
See kill(2).
signal(5).
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().
See close(2).
term | An initialised ZvtTerm. |
regex | A regular expression to match. It should be concise enough so that it doesn't match whole lines. |
highlight_mask | Mask of bits used to set the attributes used to highlight the match as the mouse moves over it. |
data | User data. |
Add a new auto-match regular expression. The zvt_term_match_check() function can be used to check for matches using screen coordinates.
Each regular expression regex will be matched against each line in the visible buffer.
The highlight_mask is taken from the VTATTR_* bits, as defined in vt.h. These include VTATTR_BOLD, VTATTR_UNDERLINE, etc. Colours may also be set by including the colour index in the appropriate bit position. Colours and attributes may be combined.
e.g. to set foreground colour 2, and background colour 5, use highlight_mask = (2<FORECOLOURB)|(5<BACKCOLOURB).
Returns -1 when the regular expression is invalid and cannot be compiled (see regcomp(3c)). Otherwise returns 0.
term | An initialised ZvtTerm. |
regex | A regular expression to remove, or NULL to remove all match strings. |
Remove a specific match string, or all match strings from the terminal term.
term | An initialised ZvtTerm. |
x | X coordinate, in character coordinates. |
y | Y coordinate to check, in character coordinates. |
user_data_ptr | A pointer to a location to hold the user-data associated with this match. If NULL, then this is ignored. |
Check for a match at a given character location.
Returns the string matched. If user_data_ptr is non-NULL, then it is set to the user_data associated with this match type. The return value is only guaranteed valid until the next iteration of the gtk main loop.
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.
terminal | A ZvtTerm widget. |
pixmap_file | file containing the pixmap image |
transparent | true if we want to run in transparent mode |
flags | A bitmask of background options: ZVT_BACKGROUND_SHADED, shade the transparency pixmap. ZVT_BACKGROUND_SCROLL, allow smart scrolling of the pixmap, ignored if transparency is requested. |
Sets the background of the terminal. If pixmap_file and transparent are NULL and FALSE, then a standard filled background is set.
Enable or disable the terminal bell. If state is TRUE, then the bell is enabled.
get the terminal bell state. If the bell on then TRUE is returned, otherwise FALSE.
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.
a bitmask of the capabilities
term | Valid ZvtTerm widget. |
len | Placeholder to store the length of text selected. May be NULL in which case the value is not returned. |
type | Type of selection. VT_SELTYPE_LINE, select by line, VT_SELTYPE_WORD, select by word, or VT_SELTYPE_CHAR, select by character. |
sx | Start of selection, horizontal. |
sy | Start of selection, vertical. 0 is the top of the visible screen, <0 is scrollback lines, >0 is visible lines (upto the height of the window). |
ex | End of selection, horizontal. |
ey | End of selection, vertical, as above. |
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.
Example 1.
|
A pointer to a NUL terminated buffer containing the raw text from the buffer. If memory could not be allocated, then returns NULL. Note that it is upto the caller to free the memory, using g_free(3c). If len was supplied, then the length of data is stored there.