atk.table
Module for [Table] interface
Types 2
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.
bool addColumnSelection(int column)Adds the specified column to the selection.bool addRowSelection(int row)Adds the specified row to the selection.atk.object.ObjectWrap getCaption()Gets the caption for the table. Returns: a AtkObject* representing the table caption, or null if value does not implement this interface.int getColumnAtIndex(int index)Gets a #gint representing the column at the specified index_.string getColumnDescription(int column)Gets the description text of the specified column in the tableint getColumnExtentAt(int row, int column)Gets the number of columns occupied by the accessible object at the specified row and column in the table.atk.object.ObjectWrap getColumnHeader(int column)Gets the column header of a specified column in an accessible table.int getIndexAt(int row, int column)Gets a #gint representing the index at the specified row and column.int getNColumns()Gets the number of columns in the table. Returns: a gint representing the number of columns, or 0 if value does not implement this interface.int getNRows()Gets the number of rows in the table. Returns: a gint representing the number of rows, or 0 if value does not implement this interface.int getRowAtIndex(int index)Gets a #gint representing the row at the specified index_.string getRowDescription(int row)Gets the description text of the specified row in the tableint getRowExtentAt(int row, int column)Gets the number of rows occupied by the accessible object at a specified row and column in the table.atk.object.ObjectWrap getRowHeader(int row)Gets the row header of a specified row in an accessible table.void getSelectedColumns(out 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.void getSelectedRows(out 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.atk.object.ObjectWrap getSummary()Gets the summary description of the table. Returns: a AtkObject* representing a summary description of the table, or zero if value does not implement this interface.bool isColumnSelected(int column)Gets a boolean value indicating whether the specified column is selectedbool isRowSelected(int row)Gets a boolean value indicating whether the specified row is selectedbool isSelected(int row, int column)Gets a boolean value indicating whether the accessible object at the specified row and column is selectedatk.object.ObjectWrap refAt(int row, int column)Get a reference to the table cell at row, column. This cell should implement the interface #AtkTableCellbool removeColumnSelection(int column)Adds the specified column to the selection.bool removeRowSelection(int row)Removes the specified row from the selection.void setCaption(atk.object.ObjectWrap caption)Sets the caption for the table.void setColumnDescription(int column, string description)Sets the description text for the specified column of the table.void setColumnHeader(int column, atk.object.ObjectWrap header)Sets the specified column header to header.void setRowDescription(int row, string description)Sets the description text for the specified row of table.void setRowHeader(int row, atk.object.ObjectWrap header)Sets the specified row header to header.void setSummary(atk.object.ObjectWrap accessible)Sets the summary description of the table.gulong connectColumnDeleted(T)(T callback, Flag!"After" after = No.After)Connect to `ColumnDeleted` signal.gulong connectColumnInserted(T)(T callback, Flag!"After" after = No.After)Connect to `ColumnInserted` signal.gulong connectColumnReordered(T)(T callback, Flag!"After" after = No.After)Connect to `ColumnReordered` signal.gulong connectModelChanged(T)(T callback, Flag!"After" after = No.After)Connect to `ModelChanged` signal.gulong connectRowDeleted(T)(T callback, Flag!"After" after = No.After)Connect to `RowDeleted` signal.gulong connectRowInserted(T)(T callback, Flag!"After" after = No.After)Connect to `RowInserted` signal.gulong connectRowReordered(T)(T callback, Flag!"After" after = No.After)Connect to `RowReordered` signal.