Method

VteTerminalget_text_range

Declaration [src]

char*
vte_terminal_get_text_range (
  VteTerminal* terminal,
  glong start_row,
  glong start_col,
  glong end_row,
  glong end_col,
  VteSelectionFunc is_selected,
  gpointer user_data,
  GArray* attributes
)

Description [src]

Extracts a view of the visible part of the terminal. 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.

Since 0.68, passing a non-NULL array parameter is deprecated. Since 0.72, passing a non-NULL array parameter will make this function itself return NULL. Since 0.72, passing a non-NULL is_selected function will make this function itself return NULL.

Parameters

start_row glong
 

First row to search for data.

start_col glong
 

First column to search for data.

end_row glong
 

Last row to search for data.

end_col glong
 

Last column to search for data.

is_selected VteSelectionFunc
 

A VteSelectionFunc callback. Deprecated: 0.44: Always pass NULL here.

user_data gpointer
 

User data to be passed to the callback.

attributes An array of VteCharAttributes
 

Location for storing text attributes. Deprecated: 0.68: Always pass NULL here.

 The argument will be set by the function.
 The argument can be set to NULL.
 The argument can be NULL.
 The instance takes ownership of the data, and is responsible for freeing it.

Return value

Returns: char*
 

A newly allocated text string, or NULL.

 The caller of the method takes ownership of the data, and is responsible for freeing it.
 The return value can be NULL.
 The string is a NUL terminated UTF-8 string.