get_text_range


Description:

public string? get_text_range (long start_row, long start_col, long end_row, long end_col, SelectionFunc? is_selected, out Array<CharAttributes?>? 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 CharAttributes 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.

This method is unaware of BiDi. The columns passed in start_col and end_row, and returned in attributes are logical columns.

Parameters:

this

a Terminal

start_row

first row to search for data

start_col

first column to search for data

end_row

last row to search for data

end_col

last column to search for data

is_selected

a SelectionFunc callback

attributes

location for storing text attributes

user_data

user data to be passed to the callback

Returns:

a newly allocated text string, or null.