Table
Object Hierarchy:
Atk.Table
Atk.Table
Atk.Table
GLib.Object
GLib.Object
GLib.Object->Atk.Table
Description:
[
CCode ( type_id =
"atk_table_get_type ()" ) ]
public interface Table :
Object
Table 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 Table are typically referred to as "cells". Those cells should implement the interface
TableCell , but Atk
doesn't require them to be direct children of the
current Table . They can be grand-children, grand-grand-children etc. Table
provides the API needed to get a individual cell based on the row and column numbers.
Children of Table 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, Table includes provision for offering simplified summary information, as
well as row and column headers and captions. Headers and captions are Object s which may
implement other interfaces (#AtkText, Image , etc.) as appropriate.
Table summaries may themselves be (simplified) Table s, etc.
Note for implementors: in the past, Table required that all the cells should be direct children of
Table , and provided some index based methods to request the cells. The practice showed that that forcing made
Table implementation complex, and hard to expose other kind of children, like rows or captions. Right now,
index-based methods are deprecated.
All known implementing classes:
Content:
Methods:
public abstract bool add_column_selection (int column)
Adds the specified column
to the selection.
public abstract bool add_row_selection (int row)
Adds the specified row
to the selection.
public abstract unowned Object ? get_caption ()
Gets the caption for the this .
public abstract int get_column_at_index (int index_)
Gets a int representing the
column at the specified index_
.
public abstract unowned string get_column_description (int column)
Gets the description text of the specified column
in the table
public abstract int get_column_extent_at (int row, int column)
Gets the number of columns occupied by the accessible object at the
specified row
and column
in the this .
public abstract unowned Object ? get_column_header (int column)
Gets the column header of a specified column in an accessible table.
public abstract int get_index_at (int row, int column)
Gets a int representing the
index at the specified row
and column
.
public abstract int get_n_columns ()
Gets the number of columns in the table.
public abstract int get_n_rows ()
Gets the number of rows in the table.
public abstract int get_row_at_index (int index_)
Gets a int representing the
row at the specified index_
.
public abstract unowned string ? get_row_description (int row)
Gets the description text of the specified row in the table
public abstract int get_row_extent_at (int row, int column)
Gets the number of rows occupied by the accessible object at a specified
row
and column
in the this .
public abstract unowned Object ? get_row_header (int row)
Gets the row header of a specified row in an accessible table.
public abstract int get_selected_columns (int selected)
Gets the selected columns of the table by initializing **selected with the
selected column numbers.
public abstract int get_selected_rows (int selected)
Gets the selected rows of the table by initializing **selected with the
selected row numbers.
public abstract Object get_summary ()
Gets the summary description of the table.
public abstract bool is_column_selected (int column)
Gets a boolean value indicating whether the specified column
is
selected
public abstract bool is_row_selected (int row)
Gets a boolean value indicating whether the specified row
is
selected
public abstract bool is_selected (int row, int column)
Gets a boolean value indicating whether the accessible object at the
specified row
and column
is selected
public abstract Object ref_at (int row, int column)
Get a reference to the table cell at row
, column
.
public abstract bool remove_column_selection (int column)
Adds the specified column
to the selection.
public abstract bool remove_row_selection (int row)
Removes the specified row
from the selection.
public abstract void set_caption (Object caption)
Sets the caption for the table.
public abstract void set_column_description (int column, string description)
Sets the description text for the specified column
of the
this .
public abstract void set_column_header (int column, Object header)
Sets the specified column header to header
.
public abstract void set_row_description (int row, string description)
Sets the description text for the specified row
of
this .
public abstract void set_row_header (int row, Object header)
Sets the specified row header to header
.
public abstract void set_summary (Object accessible)
Sets the summary description of the table.
Signals:
public virtual signal void column_deleted (int column, int num_deleted)
The "column-deleted" signal is emitted by an object which implements the
AtkTable interface when a column is deleted.
public virtual signal void column_inserted (int column, int num_inserted)
The "column-inserted" signal is emitted by an object which implements the
AtkTable interface when a column is inserted.
public virtual signal void column_reordered ()
The "column-reordered" signal is emitted by an object which implements the
AtkTable interface when the columns are reordered.
public virtual signal void model_changed ()
The "model-changed" signal is emitted by an object which implements the
AtkTable interface when the model displayed by the table changes.
public virtual signal void row_deleted (int row, int num_deleted)
The "row-deleted" signal is emitted by an object which implements the
AtkTable interface when a row is deleted.
public virtual signal void row_inserted (int row, int num_inserted)
The "row-inserted" signal is emitted by an object which implements the
AtkTable interface when a row is inserted.
public virtual signal void row_reordered ()
The "row-reordered" signal is emitted by an object which implements the
AtkTable interface when the rows are reordered.
Inherited Members:
All known members inherited from class GLib.Object