textscreen/txt_table.h File Reference

Table widget. More...

Go to the source code of this file.

Data Structures
struct	txt_table_s
Typedefs
typedef struct txt_table_s	txt_table_t
	Table widget.
Functions
void	TXT_InitTable (txt_table_t *table, int columns)
txt_table_t *	TXT_NewTable (int columns)
	Create a new table.
txt_table_t *	TXT_NewHorizBox (TXT_UNCAST_ARG(first_widget),...)
	Create a table containing the specified widgets packed horizontally, from left to right.
txt_widget_t *	TXT_GetSelectedWidget (TXT_UNCAST_ARG(table))
	Get the currently selected widget within a table.
void	TXT_AddWidget (TXT_UNCAST_ARG(table), TXT_UNCAST_ARG(widget))
	Add a widget to a table.
void	TXT_AddWidgets (TXT_UNCAST_ARG(table),...)
	Add multiple widgets to a table.
int	TXT_SelectWidget (TXT_UNCAST_ARG(table), TXT_UNCAST_ARG(widget))
	Select the given widget that is contained within the specified table.
void	TXT_SetColumnWidths (TXT_UNCAST_ARG(table),...)
	Set the widths of the columns of the table.
void	TXT_ClearTable (TXT_UNCAST_ARG(table))
	Remove all widgets from a table.
int	TXT_PageTable (TXT_UNCAST_ARG(table), int pagex, int pagey)
	Hack to move the selection in a table by a 'page', triggered by the scrollpane.
Variables
txt_widget_class_t	txt_table_class

---

Detailed Description

Table widget.

---

Typedef Documentation

typedef struct txt_table_s txt_table_t

Table widget.

A table is a widget that contains other widgets. It may have multiple columns, in which case the child widgets are laid out in a grid. Columns automatically grow as necessary, although minimum column widths can be set using TXT_SetColumnWidths.

To create a new table, use TXT_NewTable. It is also possible to use TXT_NewHorizBox to create a table, specifying widgets to place inside a horizontal list. A vertical list is possible simply by creating a table containing a single column.

---

Function Documentation

void TXT_AddWidget	(	TXT_UNCAST_ARG(table)	,
		TXT_UNCAST_ARG(widget)
	)

Add a widget to a table.

Widgets are added to tables horizontally, from left to right. For example, for a table with three columns, the first call to this function will add a widget to the first column, the second call to the second column, the third call to the third column, and the fourth will return to the first column, starting a new row.

For adding many widgets, it may be easier to use TXT_AddWidgets.

Parameters:

table	The table.
widget	The widget to add.

void TXT_AddWidgets	(	TXT_UNCAST_ARG(table)	,
			...
	)

Add multiple widgets to a table.

Widgets are added as described in the documentation for the TXT_AddWidget function. This function adds multiple widgets. The number of arguments is variable, and the argument list must be terminated by a NULL pointer.

Parameters:

table

The table.

void TXT_ClearTable

(

TXT_UNCAST_ARG(table)

)

Remove all widgets from a table.

Parameters:

table

The table.

txt_widget_t* TXT_GetSelectedWidget

(

TXT_UNCAST_ARG(table)

)

Get the currently selected widget within a table.

This function will recurse through subtables if necessary.

Parameters:

table

The table.

Returns:

Pointer to the widget that is currently selected.

void TXT_InitTable	(	txt_table_t *	table,
		int	columns
	)

txt_table_t* TXT_NewHorizBox	(	TXT_UNCAST_ARG(first_widget)	,
			...
	)

Create a table containing the specified widgets packed horizontally, from left to right.

The arguments to this function are variable. Each argument must be a pointer to a widget, and the list is terminated with a NULL.

Returns:

Pointer to the new table structure.

txt_table_t* TXT_NewTable

(

int

columns

)

Create a new table.

Parameters:

columns

The number of columns in the new table.

Returns:

Pointer to the new table structure.

int TXT_PageTable	(	TXT_UNCAST_ARG(table)	,
		int	pagex,
		int	pagey
	)

Hack to move the selection in a table by a 'page', triggered by the scrollpane.

This acts as per the keyboard events for the arrows, but moves the selection by at least the specified number of characters.

Parameters:

table	The table.
pagex	Minimum distance to move the selection horizontally.
pagey	Minimum distance to move the selection vertically.

Returns:

Non-zero if the selection has been changed.

int TXT_SelectWidget	(	TXT_UNCAST_ARG(table)	,
		TXT_UNCAST_ARG(widget)
	)

Select the given widget that is contained within the specified table.

This function will recursively search through subtables if necessary.

Parameters:

table	The table.
widget	The widget to select.

Returns:

Non-zero (true) if it has been selected, or zero (false) if it was not found within this table.

void TXT_SetColumnWidths	(	TXT_UNCAST_ARG(table)	,
			...
	)

Set the widths of the columns of the table.

The arguments to this function are variable, and correspond to the number of columns in the table. For example, if a table has five columns, the width of each of the five columns must be specified.

The width values are in number of characters.

Note that this function only sets the minimum widths for columns; if the columns contain widgets that are wider than the widths specified, they will be larger.

Parameters:

table

The table.

---

Variable Documentation

txt_widget_class_t txt_table_class