uiTable Struct Reference

Description

A control to display data in a tabular fashion.

The view of the architecture.

Data is retrieved from a uiTableModel via methods that you need to define in a uiTableModelHandler.

Make sure the uiTableModel columns return the right type, as specified in the uiTableAppend*Column() parameters.

The *EditableModelColumn parameters typically point to a uiTableModel column index, that specifies the property on a per row basis.
They can however also be passed two special values defining the property for all rows: uiTableModelColumnNeverEditable and uiTableModelColumnAlwaysEditable.

#include <ui.h>

Public Member Functions
void	uiTableAppendTextColumn (uiTable *t, const char *name, int textModelColumn, int textEditableModelColumn, uiTableTextColumnOptionalParams *textParams)
	Appends a text column to the table.
void	uiTableAppendImageColumn (uiTable *t, const char *name, int imageModelColumn)
	Appends an image column to the table.
void	uiTableAppendImageTextColumn (uiTable *t, const char *name, int imageModelColumn, int textModelColumn, int textEditableModelColumn, uiTableTextColumnOptionalParams *textParams)
	Appends a column to the table that displays both an image and text.
void	uiTableAppendCheckboxColumn (uiTable *t, const char *name, int checkboxModelColumn, int checkboxEditableModelColumn)
	Appends a column to the table containing a checkbox.
void	uiTableAppendCheckboxTextColumn (uiTable *t, const char *name, int checkboxModelColumn, int checkboxEditableModelColumn, int textModelColumn, int textEditableModelColumn, uiTableTextColumnOptionalParams *textParams)
	Appends a column to the table containing a checkbox and text.
void	uiTableAppendProgressBarColumn (uiTable *t, const char *name, int progressModelColumn)
	Appends a column to the table containing a progress bar.
void	uiTableAppendButtonColumn (uiTable *t, const char *name, int buttonModelColumn, int buttonClickableModelColumn)
	Appends a column to the table containing a button.
int	uiTableHeaderVisible (uiTable *t)
	Returns whether or not the table header is visible.
void	uiTableHeaderSetVisible (uiTable *t, int visible)
	Sets whether or not the table header is visible.
void	uiTableOnRowClicked (uiTable *t, void(*f)(uiTable *t, int row, void *data), void *data)
	Registers a callback for when the user single clicks a table row.
void	uiTableOnRowDoubleClicked (uiTable *t, void(*f)(uiTable *t, int row, void *data), void *data)
	Registers a callback for when the user double clicks a table row.
void	uiTableHeaderSetSortIndicator (uiTable *t, int column, uiSortIndicator indicator)
	Sets the column's sort indicator displayed in the table header.
uiSortIndicator	uiTableHeaderSortIndicator (uiTable *t, int column)
	Returns the column's sort indicator displayed in the table header.
void	uiTableHeaderOnClicked (uiTable *t, void(*f)(uiTable *sender, int column, void *senderData), void *data)
	Registers a callback for when a table column header is clicked.
int	uiTableColumnWidth (uiTable *t, int column)
	Returns the table column width.
void	uiTableColumnSetWidth (uiTable *t, int column, int width)
	Sets the table column width.
uiTableSelectionMode	uiTableGetSelectionMode (uiTable *t)
	Returns the table selection mode.
void	uiTableSetSelectionMode (uiTable *t, uiTableSelectionMode mode)
	Sets the table selection mode.
void	uiTableOnSelectionChanged (uiTable *t, void(*f)(uiTable *t, void *data), void *data)
	Registers a callback for when the table selection changed.
uiTableSelection *	uiTableGetSelection (uiTable *t)
	Returns the current table selection.
void	uiTableSetSelection (uiTable *t, uiTableSelection *sel)
	Sets the current table selection clearing any previous selection.
Public Member Functions inherited from uiControl
void	uiControlDestroy (uiControl *c)
	Dispose and free all allocated resources.
uintptr_t	uiControlHandle (uiControl *c)
	Returns the control's OS-level handle.
uiControl *	uiControlParent (uiControl *c)
	Returns the parent control.
void	uiControlSetParent (uiControl *c, uiControl *parent)
	Sets the control's parent.
int	uiControlToplevel (uiControl *c)
	Returns whether or not the control is a top level control.
int	uiControlVisible (uiControl *c)
	Returns whether or not the control is visible.
void	uiControlShow (uiControl *c)
	Shows the control.
void	uiControlHide (uiControl *c)
	Hides the control.
int	uiControlEnabled (uiControl *c)
	Returns whether or not the control is enabled.
void	uiControlEnable (uiControl *c)
	Enables the control.
void	uiControlDisable (uiControl *c)
	Disables the control.
void	uiFreeControl (uiControl *c)
	Frees the memory associated with the control reference.
void	uiControlVerifySetParent (uiControl *c, uiControl *parent)
	Makes sure the control's parent can be set to parent.
int	uiControlEnabledToUser (uiControl *c)
	Returns whether or not the control can be interacted with by the user.
void	uiControlSetTooltip (uiControl *c, const char *tooltip)
	Sets the control tooltip.

Static Public Member Functions
uiTable *	uiNewTable (uiTableParams *params)
	Creates a new table.
Static Public Member Functions inherited from uiControl
uiControl *	uiAllocControl (size_t n, uint32_t OSsig, uint32_t typesig, const char *typenamestr)
	Allocates a uiControl.

Additional Inherited Members
Public Attributes inherited from uiControl
uint32_t	Signature
uint32_t	OSSignature
uint32_t	TypeSignature
void(*	Destroy )(uiControl *)
uintptr_t(*	Handle )(uiControl *)
uiControl *(*	Parent )(uiControl *)
void(*	SetParent )(uiControl *, uiControl *)
int(*	Toplevel )(uiControl *)
int(*	Visible )(uiControl *)
void(*	Show )(uiControl *)
void(*	Hide )(uiControl *)
int(*	Enabled )(uiControl *)
void(*	Enable )(uiControl *)
void(*	Disable )(uiControl *)

Member Function Documentation

uiNewTable()

uiTable * uiNewTable ( uiTableParams * params )

static

Creates a new table.

Parameters

params

Table parameters.

Returns

A new uiTable instance.

uiTableAppendButtonColumn()

void uiTableAppendButtonColumn	(	uiTable *	t,
		const char *	name,
		int	buttonModelColumn,
		int	buttonClickableModelColumn )

Appends a column to the table containing a button.

Button clicks are signaled to the uiTableModelHandler via a call to SetCellValue() with a value of NULL for the buttonModelColumn.

CellValue() must return the button text to display.

Parameters

t	uiTable instance.
name	Column title text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.
buttonModelColumn	Column that holds the button text to be displayed. uiTableValueTypeString
buttonClickableModelColumn	Column that defines whether or not the button is clickable. uiTableValueTypeInt TRUE to make button clickable, FALSE otherwise. uiTableModelColumnNeverEditable to make all rows never clickable. uiTableModelColumnAlwaysEditable to make all rows always clickable.

uiTableAppendCheckboxColumn()

void uiTableAppendCheckboxColumn	(	uiTable *	t,
		const char *	name,
		int	checkboxModelColumn,
		int	checkboxEditableModelColumn )

Appends a column to the table containing a checkbox.

Parameters

t	uiTable instance.
name	Column title text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.
checkboxModelColumn	Column that holds the data to be displayed. uiTableValueTypeInt TRUE for a checked checkbox, FALSE otherwise.
checkboxEditableModelColumn	Column that defines whether or not the checkbox is editable. uiTableValueTypeInt TRUE to make checkbox editable, FALSE otherwise. uiTableModelColumnNeverEditable to make all rows never editable. uiTableModelColumnAlwaysEditable to make all rows always editable.

uiTableAppendCheckboxTextColumn()

void uiTableAppendCheckboxTextColumn	(	uiTable *	t,
		const char *	name,
		int	checkboxModelColumn,
		int	checkboxEditableModelColumn,
		int	textModelColumn,
		int	textEditableModelColumn,
		uiTableTextColumnOptionalParams *	textParams )

Appends a column to the table containing a checkbox and text.

Parameters

t	uiTable instance.
name	Column title text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.
checkboxModelColumn	Column that holds the data to be displayed. uiTableValueTypeInt TRUE for a checked checkbox, FALSE otherwise.
checkboxEditableModelColumn	Column that defines whether or not the checkbox is editable. uiTableValueTypeInt TRUE to make checkbox editable, FALSE otherwise. uiTableModelColumnNeverEditable to make all rows never editable. uiTableModelColumnAlwaysEditable to make all rows always editable.
textModelColumn	Column that holds the text to be displayed. uiTableValueTypeString
textEditableModelColumn	Column that defines whether or not the text is editable. uiTableValueTypeInt TRUE to make text editable, FALSE otherwise. uiTableModelColumnNeverEditable to make all rows never editable. uiTableModelColumnAlwaysEditable to make all rows always editable.
textParams	Text display settings, NULL to use defaults.

uiTableAppendImageColumn()

void uiTableAppendImageColumn	(	uiTable *	t,
		const char *	name,
		int	imageModelColumn )

Appends an image column to the table.

Images are drawn at icon size, using the representation that best fits the pixel density of the screen.

Parameters

t	uiTable instance.
name	Column title text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.
imageModelColumn	Column that holds the images to be displayed. uiTableValueTypeImage

uiTableAppendImageTextColumn()

void uiTableAppendImageTextColumn	(	uiTable *	t,
		const char *	name,
		int	imageModelColumn,
		int	textModelColumn,
		int	textEditableModelColumn,
		uiTableTextColumnOptionalParams *	textParams )

Appends a column to the table that displays both an image and text.

Images are drawn at icon size, using the representation that best fits the pixel density of the screen.

Parameters

t	uiTable instance.
name	Column title text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.
imageModelColumn	Column that holds the images to be displayed. uiTableValueTypeImage
textModelColumn	Column that holds the text to be displayed. uiTableValueTypeString
textEditableModelColumn	Column that defines whether or not the text is editable. uiTableValueTypeInt TRUE to make text editable, FALSE otherwise. uiTableModelColumnNeverEditable to make all rows never editable. uiTableModelColumnAlwaysEditable to make all rows always editable.
textParams	Text display settings, NULL to use defaults.

uiTableAppendProgressBarColumn()

void uiTableAppendProgressBarColumn	(	uiTable *	t,
		const char *	name,
		int	progressModelColumn )

Appends a column to the table containing a progress bar.

The workings and valid range are exactly the same as that of uiProgressBar.

Parameters

t	uiTable instance.
name	Column title text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.
progressModelColumn	Column that holds the data to be displayed. uiTableValueTypeInt Integer in range of [-1, 100], see uiProgressBar for details.

See also

uiProgressBar

uiTableAppendTextColumn()

void uiTableAppendTextColumn	(	uiTable *	t,
		const char *	name,
		int	textModelColumn,
		int	textEditableModelColumn,
		uiTableTextColumnOptionalParams *	textParams )

Appends a text column to the table.

Parameters

t	uiTable instance.
name	Column title text. A valid, NUL terminated UTF-8 string. Data is copied internally. Ownership is not transferred.
textModelColumn	Column that holds the text to be displayed. uiTableValueTypeString
textEditableModelColumn	Column that defines whether or not the text is editable. uiTableValueTypeInt TRUE to make text editable, FALSE otherwise. uiTableModelColumnNeverEditable to make all rows never editable. uiTableModelColumnAlwaysEditable to make all rows always editable.
textParams	Text display settings, NULL to use defaults.

uiTableColumnSetWidth()

void uiTableColumnSetWidth	(	uiTable *	t,
		int	column,
		int	width )

Sets the table column width.

Setting the width to -1 will restore automatic column sizing matching either the width of the content or column header (which ever one is bigger).

Note

Darwin currently only resizes to the column header width on -1.

Parameters

t	uiTable instance.
column	Column index.
width	Column width to set in pixels, -1 to restore automatic column sizing.

uiTableColumnWidth()

int uiTableColumnWidth	(	uiTable *	t,
		int	column )

Returns the table column width.

Parameters

t	uiTable instance.
column	Column index.

Returns

Column width in pixels.

uiTableGetSelection()

uiTableSelection * uiTableGetSelection

(

uiTable *

t

)

Returns the current table selection.

Parameters

t	uiTable instance.

Returns

The number of selected rows and corresponding row indices.
Caller is responsible for freeing the data with uiFreeTableSelection().

Note

For empty selections the Rows pointer will be NULL.

uiTableGetSelectionMode()

uiTableSelectionMode uiTableGetSelectionMode

(

uiTable *

t

)

Returns the table selection mode.

Parameters

t	uiTable instance.

Returns

The table selection mode. [Default uiTableSelectionModeZeroOrOne]

uiTableHeaderOnClicked()

void uiTableHeaderOnClicked	(	uiTable *	t,
		void(*	f )(uiTable *sender, int column, void *senderData),
		void *	data )

Registers a callback for when a table column header is clicked.

Parameters

t	uiTable instance.
f	Callback function. sender Back reference to the instance that triggered the callback. column Column index that was clicked. senderData User data registered with the sender instance.
data	User data to be passed to the callback.

Note

Only one callback can be registered at a time.

uiTableHeaderSetSortIndicator()

void uiTableHeaderSetSortIndicator	(	uiTable *	t,
		int	column,
		uiSortIndicator	indicator )

Sets the column's sort indicator displayed in the table header.

Use this to display appropriate arrows in the table header to indicate a sort direction.

Parameters

t	uiTable instance.
column	Column index.
indicator	Sort indicator.

Note

Setting the indicator is purely visual and does not perform any sorting.

uiTableHeaderSetVisible()

void uiTableHeaderSetVisible	(	uiTable *	t,
		int	visible )

Sets whether or not the table header is visible.

Parameters

t	uiTable instance.
visible	TRUE to show header, FALSE to hide header.

uiTableHeaderSortIndicator()

uiSortIndicator uiTableHeaderSortIndicator	(	uiTable *	t,
		int	column )

Returns the column's sort indicator displayed in the table header.

Parameters

t	uiTable instance.
column	Column index.

Returns

The current sort indicator. [Default: uiSortIndicatorNone]

uiTableHeaderVisible()

int uiTableHeaderVisible

(

uiTable *

t

)

Returns whether or not the table header is visible.

Parameters

t	uiTable instance.

Returns

TRUE if visible, FALSE otherwise. [Default TRUE]

uiTableOnRowClicked()

void uiTableOnRowClicked	(	uiTable *	t,
		void(*	f )(uiTable *t, int row, void *data),
		void *	data )

Registers a callback for when the user single clicks a table row.

Parameters

t	uiTable instance.
f	Callback function. sender Back reference to the instance that triggered the callback. row Row index that was clicked. senderData User data registered with the sender instance.
data	User data to be passed to the callback.

Note

Only one callback can be registered at a time.

uiTableOnRowDoubleClicked()

void uiTableOnRowDoubleClicked	(	uiTable *	t,
		void(*	f )(uiTable *t, int row, void *data),
		void *	data )

Registers a callback for when the user double clicks a table row.

Parameters

t	uiTable instance.
f	Callback function. sender Back reference to the instance that triggered the callback. row Row index that was double clicked. senderData User data registered with the sender instance.
data	User data to be passed to the callback.

Note

The double click callback is always preceded by one uiTableOnRowClicked() callback.

Bug

For unix systems linking against GTK < 3.14 the preceding uiTableOnRowClicked() callback will be triggered twice.

Note

Only one callback can be registered at a time.

uiTableOnSelectionChanged()

void uiTableOnSelectionChanged	(	uiTable *	t,
		void(*	f )(uiTable *t, void *data),
		void *	data )

Registers a callback for when the table selection changed.

Parameters

t	uiTable instance.
f	Callback function. sender Back reference to the instance that triggered the callback. senderData User data registered with the sender instance.
data	User data to be passed to the callback.

Note

The callback is not triggered when calling uiTableSetSelection() or when needing to clear the selection on uiTableSetSelectionMode().

Only one callback can be registered at a time.

uiTableSetSelection()

void uiTableSetSelection	(	uiTable *	t,
		uiTableSelection *	sel )

Sets the current table selection clearing any previous selection.

Parameters

t	uiTable instance.
sel	Table selection. Data is copied internally. Ownership is not transferred.

Note

Selecting more rows than the selection mode allows for results in nothing happening.

For empty selections the Rows pointer is never accessed.

uiTableSetSelectionMode()

void uiTableSetSelectionMode	(	uiTable *	t,
		uiTableSelectionMode	mode )

Sets the table selection mode.

Parameters

t	uiTable instance.
mode	Table selection mode to set.

Warning

All rows will be deselected if the existing selection is illegal in the new selection mode.

---

The documentation for this struct was generated from the following file:

• include/ui.h