get_text_include_trailing_spaces


Description:

[ Version ( deprecated = true , deprecated_since = "0.56" ) ]
public string get_text_include_trailing_spaces (SelectionFunc? is_selected, out Array<CharAttributes?> attributes)

Warning: get_text_include_trailing_spaces is deprecated since 0.56.

Extracts a view of the visible part of the terminal.

Note:

Use get_text instead.

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.

This method is unaware of BiDi. The columns returned in attributes are logical columns.

Note: since 0.68, passing a non-%NULL array parameter is deprecated. Starting with 0.70, passing a non-%NULL array parameter will make this function itself return null.

Parameters:

this

a Terminal

is_selected

a SelectionFunc callback

attributes

location for storing text attributes. Deprecated: 0.68: Always pass null here.

user_data

user data to be passed to the callback

Returns:

a newly allocated text string, or null.




2022 vala-language.org