This file contains all functions related to Views. More...

#include "types.h"

Functions
tgui_err	tgui_show_cursor (tgui_connection c, tgui_activity a, tgui_view v, bool show)
	Sets whether an EditText shows the cursor or not. More...

tgui_err	tgui_linear_params (tgui_connection c, tgui_activity a, tgui_view v, float weight, int position)
	Sets the parameters for a View in a LinearLayout. More...

tgui_err	tgui_grid_params (tgui_connection c, tgui_activity a, tgui_view v, size_t row, size_t col, size_t row_size, size_t col_size, tgui_grid_alignment row_align, tgui_grid_alignment col_align)
	Sets the parameters for a View in a GridLayout. More...

tgui_err	tgui_view_location (tgui_connection c, tgui_activity a, tgui_view v, tgui_size_unit unit, float x, float y, bool top)
	Sets the location of the View manually. Useful for FrameLayout. Can also make it display on top of its siblings. More...

tgui_err	tgui_relative_params (tgui_connection c, tgui_activity a, tgui_view v)
	Sets the parameters for a View in a RelativeLayout. NOT IMPLEMENTED! More...

tgui_err	tgui_visibility (tgui_connection c, tgui_activity a, tgui_view v, tgui_view_visibility vis)
	Sets the visibility of a View. More...

tgui_err	tgui_set_width (tgui_connection c, tgui_activity a, tgui_view v, tgui_view_size width)
	Sets the width of a View. More...

tgui_err	tgui_set_height (tgui_connection c, tgui_activity a, tgui_view v, tgui_view_size height)
	Sets the height of a View. More...

tgui_err	tgui_get_dimensions (tgui_connection c, tgui_activity a, tgui_view v, tgui_size_unit unit, float width, float height)
	Gets the dimensions of a View. More...

tgui_err	tgui_delete_view (tgui_connection c, tgui_activity a, tgui_view v)
	Deletes a View. More...

tgui_err	tgui_delete_children (tgui_connection c, tgui_activity a, tgui_view v)
	Deletes the children of a View. More...

tgui_err	tgui_set_margin (tgui_connection c, tgui_activity a, tgui_view v, tgui_size size, tgui_direction dir)
	Sets the margins for a View. More...

tgui_err	tgui_set_padding (tgui_connection c, tgui_activity a, tgui_view v, tgui_size size, tgui_direction dir)
	Sets the padding for a View. More...

tgui_err	tgui_background_color (tgui_connection c, tgui_activity a, tgui_view v, tgui_color color)
	Sets the background color of a View. More...

tgui_err	tgui_text_color (tgui_connection c, tgui_activity a, tgui_view v, tgui_color color)
	Sets the text color of a View. More...

tgui_err	tgui_progress (tgui_connection c, tgui_activity a, tgui_view v, unsigned char progress)
	Sets the progress of a ProgressBar. More...

tgui_err	tgui_refreshing (tgui_connection c, tgui_activity a, tgui_view v, bool refreshing)
	Set whether a SwipeRefreshLayout is in the refreshing state. More...

tgui_err	tgui_set_text (tgui_connection c, tgui_activity a, tgui_view v, const char *text)
	Sets the Text of a View. More...

tgui_err	tgui_set_gravity (tgui_connection c, tgui_activity a, tgui_view v, tgui_gravity horizontal, tgui_gravity vertical)
	Sets the gravity of the text in a View. More...

tgui_err	tgui_text_size (tgui_connection c, tgui_activity a, tgui_view v, tgui_size size)
	Sets the text size of a View. More...

tgui_err	tgui_get_text (tgui_connection c, tgui_activity a, tgui_view v, char **text)
	Gets the text of a View. More...

tgui_err	tgui_set_checked (tgui_connection c, tgui_activity a, tgui_view v, bool checked)
	Sets whether a View is checked. More...

tgui_err	tgui_focus (tgui_connection c, tgui_activity a, tgui_view v, bool force_soft)
	Sets the focus to a View. More...

tgui_err	tgui_get_scroll_position (tgui_connection c, tgui_activity a, tgui_view v, tgui_size_unit unit, float x, float y)
	Gets the scroll position of a View. More...

tgui_err	tgui_set_scroll_position (tgui_connection c, tgui_activity a, tgui_view v, tgui_size x, tgui_size y, bool smooth)
	Sets the scroll position for a View. More...

tgui_err	tgui_set_list (tgui_connection c, tgui_activity a, tgui_view v, const char const list)
	Sets the list of a Spinner. More...

tgui_err	tgui_set_image (tgui_connection c, tgui_activity a, tgui_view v, const void *img, size_t length)
	Sets the image of an ImageView. More...

tgui_err	tgui_add_buffer (tgui_connection c, tgui_buffer *buffer)
	Creates a memory buffer shared with the plugin and maps it. More...

tgui_err	tgui_delete_buffer (tgui_connection c, tgui_buffer *buffer)
	Deletes the buffer in the plugin, closes the file descriptor and removes the memory mapping. More...

tgui_err	tgui_blit_buffer (tgui_connection c, const tgui_buffer *buffer)
	Blits a buffer in the plugin, making the image available to ImageViews on the next refresh. More...

tgui_err	tgui_set_buffer (tgui_connection c, tgui_activity a, tgui_view v, const tgui_buffer *buffer)
	Sets an ImageVIew to display the contents of a buffer. More...

tgui_err	tgui_refresh_image_view (tgui_connection c, tgui_activity a, tgui_view v)
	Refreshes an ImageView after blitting the contents of its buffer. More...

tgui_err	tgui_select_tab (tgui_connection c, tgui_activity a, tgui_view v, unsigned int index)
	Selects a tab in a TabLayout. More...

tgui_err	tgui_select_item (tgui_connection c, tgui_activity a, tgui_view v, unsigned int index)
	Selects an item in a Spinner. More...

tgui_err	tgui_set_clickable (tgui_connection c, tgui_activity a, tgui_view v, bool clickable)
	Sets whether a View is clickable by the user. More...

Detailed Description

This file contains all functions related to Views.

Function Documentation

◆ tgui_show_cursor()

tgui_err tgui_show_cursor	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		bool	show
	)

Sets whether an EditText shows the cursor or not.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
show	Whether to show the cursor or not.

Returns: tgui_err The error code.

◆ tgui_linear_params()

tgui_err tgui_linear_params	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		float	weight,
		int	position
	)

Sets the parameters for a View in a LinearLayout.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
weight	The layout weight. Use a negative number to keep the current weight.
position	the position in the View. Use 0 to keep the position.

Returns: tgui_err The error code.

◆ tgui_grid_params()

tgui_err tgui_grid_params	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		size_t	row,
		size_t	col,
		size_t	row_size,
		size_t	col_size,
		tgui_grid_alignment	row_align,
		tgui_grid_alignment	col_align
	)

Sets the parameters for a View in a GridLayout.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
row	The row position.
col	The column position.
row_size	How many rows the View occupies.
col_size	How many columns the View occupies.
row_align	The alignment in the row.
col_align	The alignment in the column.

Returns: tgui_err The error code.

◆ tgui_view_location()

tgui_err tgui_view_location	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		tgui_size_unit	unit,
		float	x,
		float	y,
		bool	top
	)

Sets the location of the View manually. Useful for FrameLayout. Can also make it display on top of its siblings.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
unit	The unit for x and y.
x	The horizontal position.
y	The vertical position.
top	Set to true if you want to move the View on top of its siblings.

Returns: tgui_err The error code.

◆ tgui_relative_params()

tgui_err tgui_relative_params	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v
	)

Sets the parameters for a View in a RelativeLayout. NOT IMPLEMENTED!

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.

Returns: tgui_err The error code.

◆ tgui_visibility()

tgui_err tgui_visibility	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		tgui_view_visibility	vis
	)

Sets the visibility of a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
vis	The visibility.

Returns: tgui_err The error code.

◆ tgui_set_width()

tgui_err tgui_set_width	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		tgui_view_size	width
	)

Sets the width of a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
width	The width.

Returns: tgui_err The error code.

◆ tgui_set_height()

tgui_err tgui_set_height	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		tgui_view_size	height
	)

Sets the height of a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
height	The height.

Returns: tgui_err The error code.

◆ tgui_get_dimensions()

tgui_err tgui_get_dimensions	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		tgui_size_unit	unit,
		float *	width,
		float *	height
	)

Gets the dimensions of a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

	c	The connection to use.
	a	The Activity the View is in.
	v	The View.
	unit	The unit of the returned dimensions.
[out]	width	If successful, will contain the View width in the desired unit.
[out]	height	If successful, will contain the View height in the desired unit.

Returns: tgui_err The error code.

◆ tgui_delete_view()

tgui_err tgui_delete_view	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v
	)

Deletes a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.

Returns: tgui_err The error code.

◆ tgui_delete_children()

tgui_err tgui_delete_children	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v
	)

Deletes the children of a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.

Returns: tgui_err The error code.

◆ tgui_set_margin()

tgui_err tgui_set_margin	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		tgui_size	size,
		tgui_direction	dir
	)

Sets the margins for a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
size	The margin size.
dir	The direction(s) to apply the margin.

Returns: tgui_err The error code.

◆ tgui_set_padding()

tgui_err tgui_set_padding	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		tgui_size	size,
		tgui_direction	dir
	)

Sets the padding for a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
size	The padding size.
dir	The direction(s) to apply the padding.

Returns: tgui_err The error code.

◆ tgui_background_color()

tgui_err tgui_background_color	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		tgui_color	color
	)

Sets the background color of a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
color	The color.

Returns: tgui_err The error code.

◆ tgui_text_color()

tgui_err tgui_text_color	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		tgui_color	color
	)

Sets the text color of a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
color	The text color.

Returns: tgui_err The error code.

◆ tgui_progress()

tgui_err tgui_progress	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		unsigned char	progress
	)

Sets the progress of a ProgressBar.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
progress	The progress from 0 to 100(inclusive).

Returns: tgui_err The error code.

◆ tgui_refreshing()

tgui_err tgui_refreshing	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		bool	refreshing
	)

Set whether a SwipeRefreshLayout is in the refreshing state.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
refreshing	The refreshing state.

Returns: tgui_err The error code.

◆ tgui_set_text()

tgui_err tgui_set_text	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		const char *	text
	)

Sets the Text of a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
text	The text.

Returns: tgui_err The error code.

◆ tgui_set_gravity()

tgui_err tgui_set_gravity	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		tgui_gravity	horizontal,
		tgui_gravity	vertical
	)

Sets the gravity of the text in a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
horizontal	The horizontal gravity.
vertical	The vertical gravity.

Returns: tgui_err The error code.

◆ tgui_text_size()

tgui_err tgui_text_size	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		tgui_size	size
	)

Sets the text size of a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
size	The text size.

Returns: tgui_err The error code.

◆ tgui_get_text()

tgui_err tgui_get_text	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		char **	text
	)

Gets the text of a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

	c	The connection to use.
	a	The Activity the View is in.
	v	The View.
[out]	text	The text of the View. When successful, this has to be freed with free().

Returns: tgui_err The error code.

◆ tgui_set_checked()

tgui_err tgui_set_checked	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		bool	checked
	)

Sets whether a View is checked.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
checked	The new checked status.

Returns: tgui_err The error code.

◆ tgui_focus()

tgui_err tgui_focus	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		bool	force_soft
	)

Sets the focus to a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
force_soft	If true, forces the software keyboard to open.

Returns: tgui_err The error code.

◆ tgui_get_scroll_position()

tgui_err tgui_get_scroll_position	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		tgui_size_unit	unit,
		float *	x,
		float *	y
	)

Gets the scroll position of a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

	c	The connection to use.
	a	The Activity the View is in.
	v	The View.
	unit	The unit for x and y.
[out]	x	The x scroll position.
[out]	y	The y scroll position.

Returns: tgui_err The error code.

◆ tgui_set_scroll_position()

tgui_err tgui_set_scroll_position	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		tgui_size	x,
		tgui_size	y,
		bool	smooth
	)

Sets the scroll position for a View.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
x	The x scroll position.
y	The y scroll position.
smooth	Whether to jump or scroll smoothly.

Returns: tgui_err The error code.

◆ tgui_set_list()

tgui_err tgui_set_list	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		const char const	list
	)

Sets the list of a Spinner.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

	c	The connection to use.
	a	The Activity the View is in.
	v	The View.
[in]	list	A NULL terminated list of pointers to strings.

Returns: tgui_err The error code.

◆ tgui_set_image()

tgui_err tgui_set_image	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		const void *	img,
		size_t	length
	)

Sets the image of an ImageView.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
img	The image data in PGN/JPEG.
length	The length of the image data.

Returns: tgui_err The error code.

◆ tgui_add_buffer()

tgui_err tgui_add_buffer	(	tgui_connection	c,
		tgui_buffer *	buffer
	)

Creates a memory buffer shared with the plugin and maps it.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_SYSTEM: mmap failed

Parameters

	c	The connection to use.
[in]	buffer	A buffer with the width and height fields > 0 and a valid format field. The data, id and fd fields are filled out if successful.

Returns: tgui_err The error code.

◆ tgui_delete_buffer()

tgui_err tgui_delete_buffer	(	tgui_connection	c,
		tgui_buffer *	buffer
	)

Deletes the buffer in the plugin, closes the file descriptor and removes the memory mapping.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.

Parameters

c	The connection to use.
buffer	The buffer to delete.

Returns: tgui_err The error code.

◆ tgui_blit_buffer()

tgui_err tgui_blit_buffer	(	tgui_connection	c,
		const tgui_buffer *	buffer
	)

Blits a buffer in the plugin, making the image available to ImageViews on the next refresh.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

	c	The connection to use.
[in]	buffer	The buffer to blit.

Returns: tgui_err The error code.

◆ tgui_set_buffer()

tgui_err tgui_set_buffer	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		const tgui_buffer *	buffer
	)

Sets an ImageVIew to display the contents of a buffer.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

	c	The connection to use.
	a	The Activity the View is in.
	v	The View.
[in]	buffer	The buffer to set.

Returns: tgui_err The error code.

◆ tgui_refresh_image_view()

tgui_err tgui_refresh_image_view	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v
	)

Refreshes an ImageView after blitting the contents of its buffer.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.

Returns: tgui_err The error code.

◆ tgui_select_tab()

tgui_err tgui_select_tab	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		unsigned int	index
	)

Selects a tab in a TabLayout.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
index	The tab to select.

Returns: tgui_err The error code.

◆ tgui_select_item()

tgui_err tgui_select_item	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		unsigned int	index
	)

Selects an item in a Spinner.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
index	The item to select.

Returns: tgui_err The error code.

◆ tgui_set_clickable()

tgui_err tgui_set_clickable	(	tgui_connection	c,
		tgui_activity	a,
		tgui_view	v,
		bool	clickable
	)

Sets whether a View is clickable by the user.

Errors

TGUI_ERR_MESSAGE: Protobuf I/O error.
TGUI_ERR_NOMEM: Not enough memory.
TGUI_ERR_EXCEPTION: Generic exception triggered.
TGUI_ERR_ACTIVITY_DESTROYED: The Activity was already closed.
TGUI_ERR_VIEW_INVALID: Invalid view type.

Parameters

c	The connection to use.
a	The Activity the View is in.
v	The View.
clickable	The new clickable state.

Returns: tgui_err The error code.

Functions

Detailed Description

Function Documentation

◆ tgui_show_cursor()

Errors

◆ tgui_linear_params()

Errors

◆ tgui_grid_params()

Errors

◆ tgui_view_location()

Errors

◆ tgui_relative_params()

Errors

◆ tgui_visibility()

Errors

◆ tgui_set_width()

Errors

◆ tgui_set_height()

Errors

◆ tgui_get_dimensions()

Errors

◆ tgui_delete_view()

Errors

◆ tgui_delete_children()

Errors

◆ tgui_set_margin()

Errors

◆ tgui_set_padding()

Errors

◆ tgui_background_color()

Errors

◆ tgui_text_color()

Errors

◆ tgui_progress()

Errors

◆ tgui_refreshing()

Errors

◆ tgui_set_text()

Errors

◆ tgui_set_gravity()

Errors

◆ tgui_text_size()

Errors

◆ tgui_get_text()

Errors

◆ tgui_set_checked()

Errors

◆ tgui_focus()

Errors

◆ tgui_get_scroll_position()

Errors

◆ tgui_set_scroll_position()

Errors

◆ tgui_set_list()

Errors

◆ tgui_set_image()

Errors

◆ tgui_add_buffer()

Errors

◆ tgui_delete_buffer()

Errors

◆ tgui_blit_buffer()

Errors

◆ tgui_set_buffer()

Errors

◆ tgui_refresh_image_view()

Errors

◆ tgui_select_tab()

Errors

◆ tgui_select_item()

Errors

◆ tgui_set_clickable()

Errors