TableT

The ATK interface implemented for UI components which contain tabular or row/column information.

#AtkTable should be implemented by components which present elements ordered via rows and columns. It may also be used to present tree-structured information if the nodes of the trees can be said to contain multiple "columns". Individual elements of an #AtkTable are typically referred to as "cells". Those cells should implement the interface #AtkTableCell, but #Atk doesn't require them to be direct children of the current #AtkTable. They can be grand-children, grand-grand-children etc. #AtkTable provides the API needed to get a individual cell based on the row and column numbers.

Children of #AtkTable are frequently "lightweight" objects, that is, they may not have backing widgets in the host UI toolkit. They are therefore often transient.

Since tables are often very complex, #AtkTable includes provision for offering simplified summary information, as well as row and column headers and captions. Headers and captions are #AtkObjects which may implement other interfaces (#AtkText, #AtkImage, etc.) as appropriate. #AtkTable summaries may themselves be (simplified) #AtkTables, etc.

Note for implementors: in the past, #AtkTable required that all the cells should be direct children of #AtkTable, and provided some index based methods to request the cells. The practice showed that that forcing made #AtkTable implementation complex, and hard to expose other kind of children, like rows or captions. Right now, index-based methods are deprecated.

template TableT () {}

Members

Functions

addColumnSelection
bool addColumnSelection(int column)

Adds the specified column to the selection.

addRowSelection
bool addRowSelection(int row)

Adds the specified row to the selection.

connectColumnDeleted
ulong connectColumnDeleted(T callback, Flag!"After" after)

Connect to ColumnDeleted signal.

connectColumnInserted
ulong connectColumnInserted(T callback, Flag!"After" after)

Connect to ColumnInserted signal.

connectColumnReordered
ulong connectColumnReordered(T callback, Flag!"After" after)

Connect to ColumnReordered signal.

connectModelChanged
ulong connectModelChanged(T callback, Flag!"After" after)

Connect to ModelChanged signal.

connectRowDeleted
ulong connectRowDeleted(T callback, Flag!"After" after)

Connect to RowDeleted signal.

connectRowInserted
ulong connectRowInserted(T callback, Flag!"After" after)

Connect to RowInserted signal.

connectRowReordered
ulong connectRowReordered(T callback, Flag!"After" after)

Connect to RowReordered signal.

getCaption
atk.object.ObjectAtk getCaption()

Gets the caption for the table.

getColumnAtIndex
int getColumnAtIndex(int index)

Gets a #gint representing the column at the specified index_.

getColumnDescription
string getColumnDescription(int column)

Gets the description text of the specified column in the table

getColumnExtentAt
int getColumnExtentAt(int row, int column)

Gets the number of columns occupied by the accessible object at the specified row and column in the table.

getColumnHeader
atk.object.ObjectAtk getColumnHeader(int column)

Gets the column header of a specified column in an accessible table.

getIndexAt
int getIndexAt(int row, int column)

Gets a #gint representing the index at the specified row and column.

getNColumns
int getNColumns()

Gets the number of columns in the table.

getNRows
int getNRows()

Gets the number of rows in the table.

getRowAtIndex
int getRowAtIndex(int index)

Gets a #gint representing the row at the specified index_.

getRowDescription
string getRowDescription(int row)

Gets the description text of the specified row in the table

getRowExtentAt
int getRowExtentAt(int row, int column)

Gets the number of rows occupied by the accessible object at a specified row and column in the table.

getRowHeader
atk.object.ObjectAtk getRowHeader(int row)

Gets the row header of a specified row in an accessible table.

getSelectedColumns
void getSelectedColumns(int[] selected)

Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller.

getSelectedRows
void getSelectedRows(int[] selected)

Gets the selected rows of the table by initializing **selected with the selected row numbers. This array should be freed by the caller.

getSummary
atk.object.ObjectAtk getSummary()

Gets the summary description of the table.

isColumnSelected
bool isColumnSelected(int column)

Gets a boolean value indicating whether the specified column is selected

isRowSelected
bool isRowSelected(int row)

Gets a boolean value indicating whether the specified row is selected

isSelected
bool isSelected(int row, int column)

Gets a boolean value indicating whether the accessible object at the specified row and column is selected

refAt
atk.object.ObjectAtk refAt(int row, int column)

Get a reference to the table cell at row, column. This cell should implement the interface #AtkTableCell

removeColumnSelection
bool removeColumnSelection(int column)

Adds the specified column to the selection.

removeRowSelection
bool removeRowSelection(int row)

Removes the specified row from the selection.

setCaption
void setCaption(atk.object.ObjectAtk caption)

Sets the caption for the table.

setColumnDescription
void setColumnDescription(int column, string description)

Sets the description text for the specified column of the table.

setColumnHeader
void setColumnHeader(int column, atk.object.ObjectAtk header)

Sets the specified column header to header.

setRowDescription
void setRowDescription(int row, string description)

Sets the description text for the specified row of table.

setRowHeader
void setRowHeader(int row, atk.object.ObjectAtk header)

Sets the specified row header to header.

setSummary
void setSummary(atk.object.ObjectAtk accessible)

Sets the summary description of the table.