Module: Atk::Table

Defined in:

(unknown)

Overview

Atk::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 Atk::Table are typically referred to as “cells”. Those cells should implement the interface Atk::TableCell, but #Atk doesn’t require them to be direct children of the current Atk::Table. They can be grand-children, grand-grand-children etc. Atk::Table provides the API needed to get a individual cell based on the row and column numbers.

Children of Atk::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, Atk::Table includes provision for offering simplified summary information, as well as row and column headers and captions. Headers and captions are Atk::Objects which may implement other interfaces (Atk::Text, #AtkImage, etc.) as appropriate. Atk::Table summaries may themselves be (simplified) Atk::Tables, etc.

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

Instance Method Summary

• #add_column_selection(table, column) ⇒ TrueClass

  the selection, or 0 if value does not implement this interface.

• #add_row_selection(table, row) ⇒ TrueClass

  or 0 if value does not implement this interface.

• #caption ⇒ Atk::Object

  Gets the caption for the table.

• #caption=(caption) ⇒ nil

  Sets the caption for the table.

• #column_deleted(table, column, num_deleted) ⇒ nil
• #column_inserted(table, column, num_inserted) ⇒ nil
• #column_reordered(table) ⇒ nil
• #get_caption(table) ⇒ Atk::Object

  table caption, or nil if value does not implement this interface.

• #get_column_at_index(table, index_) ⇒ Integer

  or -1 if the table does not implement this method.

• #get_column_description(table, column) ⇒ String

  if value does not implement this interface.

• #get_column_extent_at(table, row, column) ⇒ Integer

  if value does not implement this interface.

• #get_column_header(table, column) ⇒ Atk::Object

  specified column header, or nil if value does not implement this interface.

• #get_index_at(table, row, column) ⇒ Integer

  The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface.

• #get_n_columns(table) ⇒ Integer

  if value does not implement this interface.

• #get_n_rows(table) ⇒ Integer

  if value does not implement this interface.

• #get_row_at_index(table, index_) ⇒ Integer

  or -1 if the table does not implement this method.

• #get_row_description(table, row) ⇒ String

  nil if value does not implement this interface.

• #get_row_extent_at(table, row, column) ⇒ Integer

  if value does not implement this interface.

• #get_row_header(table, row) ⇒ Atk::Object

  specified row header, or nil if value does not implement this interface.

• #get_selected_columns(table, selected) ⇒ Integer

  or %0 if value does not implement this interface.

• #get_selected_rows(table, selected) ⇒ Integer

  or zero if value does not implement this interface.

• #get_summary(table) ⇒ Atk::Object

  of the table, or zero if value does not implement this interface.

• #is_column_selected(table, column) ⇒ TrueClass

  if value does not implement this interface.

• #is_row_selected(table, row) ⇒ TrueClass

  if value does not implement this interface.

• #is_selected(table, row, column) ⇒ TrueClass

  if value does not implement this interface.

• #model_changed(table) ⇒ nil
• #n_columns ⇒ Integer

  Gets the number of columns in the table.

• #n_rows ⇒ Integer

  Gets the number of rows in the table.

• #ref_at(table, row, column) ⇒ Atk::Object

  to accessible.

• #remove_column_selection(table, column) ⇒ TrueClass

  the selection, or 0 if value does not implement this interface.

• #remove_row_selection(table, row) ⇒ TrueClass

  the selection, or 0 if value does not implement this interface.

• #row_deleted(table, row, num_deleted) ⇒ nil
• #row_inserted(table, row, num_inserted) ⇒ nil
• #row_reordered(table) ⇒ nil
• #set_caption(table, caption) ⇒ nil
• #set_column_description(table, column, description) ⇒ nil

  to set for the specified column of the table.

• #set_column_header(table, column, header) ⇒ nil
• #set_row_description(table, row, description) ⇒ nil

  to set for the specified row of table.

• #set_row_header(table, row, header) ⇒ nil
• #set_summary(table, accessible) ⇒ nil

  to set for table.

• #summary ⇒ Atk::Object

  Gets the summary description of the table.

• #summary=(accessible) ⇒ nil

  Sets the summary description of the table.

Instance Method Details

#add_column_selection(table, column) ⇒ TrueClass

the selection, or 0 if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• column (Integer) —

  a #gint representing a column in table

Returns:

• (TrueClass) —

  a gboolean representing if the column was successfully added to

#add_row_selection(table, row) ⇒ TrueClass

or 0 if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• row (Integer) —

  a #gint representing a row in table

Returns:

• (TrueClass) —

  a gboolean representing if row was successfully added to selection,

#caption ⇒ Atk::Object

Gets the caption for the table. table caption, or nil if value does not implement this interface.

Returns:

• (Atk::Object) —

  a AtkObject* representing the

#caption=(caption) ⇒ nil

Sets the caption for the table.

Parameters:

• caption (Atk::Object) —

  a Atk::Object representing the caption to set for table

Returns:

• (nil)

#column_deleted(table, column, num_deleted) ⇒ nil

Parameters:

• table (Atk::Table)
• column (Integer)
• num_deleted (Integer)

Returns:

• (nil)

#column_inserted(table, column, num_inserted) ⇒ nil

Parameters:

• table (Atk::Table)
• column (Integer)
• num_inserted (Integer)

Returns:

• (nil)

#column_reordered(table) ⇒ nil

Parameters:

• table (Atk::Table)

Returns:

• (nil)

#get_caption(table) ⇒ Atk::Object

table caption, or nil if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableInterface

Returns:

• (Atk::Object) —

  a AtkObject* representing the

#get_column_at_index(table, index_) ⇒ Integer

or -1 if the table does not implement this method.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableInterface

• index_ (Integer) —

  a #gint representing an index in table

Returns:

• (Integer) —

  a gint representing the column at the specified index,

#get_column_description(table, column) ⇒ String

if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• column (Integer) —

  a #gint representing a column in table

Returns:

• (String) —

  a gchar* representing the column description, or nil

#get_column_extent_at(table, row, column) ⇒ Integer

if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• row (Integer) —

  a #gint representing a row in table

• column (Integer) —

  a #gint representing a column in table

Returns:

• (Integer) —

  a gint representing the column extent at specified position, or 0

#get_column_header(table, column) ⇒ Atk::Object

specified column header, or nil if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• column (Integer) —

  a #gint representing a column in the table

Returns:

• (Atk::Object) —

  a AtkObject* representing the

#get_index_at(table, row, column) ⇒ Integer

The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• row (Integer) —

  a #gint representing a row in table

• column (Integer) —

  a #gint representing a column in table

Returns:

• (Integer) —

  a #gint representing the index at specified position.

#get_n_columns(table) ⇒ Integer

if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

Returns:

• (Integer) —

  a gint representing the number of columns, or 0

#get_n_rows(table) ⇒ Integer

if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

Returns:

• (Integer) —

  a gint representing the number of rows, or 0

#get_row_at_index(table, index_) ⇒ Integer

or -1 if the table does not implement this method.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableInterface

• index_ (Integer) —

  a #gint representing an index in table

Returns:

• (Integer) —

  a gint representing the row at the specified index,

#get_row_description(table, row) ⇒ String

nil if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• row (Integer) —

  a #gint representing a row in table

Returns:

• (String) —

  a gchar* representing the row description, or

#get_row_extent_at(table, row, column) ⇒ Integer

if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• row (Integer) —

  a #gint representing a row in table

• column (Integer) —

  a #gint representing a column in table

Returns:

• (Integer) —

  a gint representing the row extent at specified position, or 0

#get_row_header(table, row) ⇒ Atk::Object

specified row header, or nil if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• row (Integer) —

  a #gint representing a row in the table

Returns:

• (Atk::Object) —

  a AtkObject* representing the

#get_selected_columns(table, selected) ⇒ Integer

or %0 if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• selected (Integer) —

  a #gint** that is to contain the selected columns numbers

Returns:

• (Integer) —

  a gint representing the number of selected columns,

#get_selected_rows(table, selected) ⇒ Integer

or zero if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• selected (Integer) —

  a #gint** that is to contain the selected row numbers

Returns:

• (Integer) —

  a gint representing the number of selected rows,

#get_summary(table) ⇒ Atk::Object

of the table, or zero if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

Returns:

• (Atk::Object) —

  a AtkObject* representing a summary description

#is_column_selected(table, column) ⇒ TrueClass

if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• column (Integer) —

  a #gint representing a column in table

Returns:

• (TrueClass) —

  a gboolean representing if the column is selected, or 0

#is_row_selected(table, row) ⇒ TrueClass

if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• row (Integer) —

  a #gint representing a row in table

Returns:

• (TrueClass) —

  a gboolean representing if the row is selected, or 0

#is_selected(table, row, column) ⇒ TrueClass

if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• row (Integer) —

  a #gint representing a row in table

• column (Integer) —

  a #gint representing a column in table

Returns:

• (TrueClass) —

  a gboolean representing if the cell is selected, or 0

#model_changed(table) ⇒ nil

Parameters:

• table (Atk::Table)

Returns:

• (nil)

#n_columns ⇒ Integer

Gets the number of columns in the table. if value does not implement this interface.

Returns:

• (Integer) —

  a gint representing the number of columns, or 0

#n_rows ⇒ Integer

Gets the number of rows in the table. if value does not implement this interface.

Returns:

• (Integer) —

  a gint representing the number of rows, or 0

#ref_at(table, row, column) ⇒ Atk::Object

to accessible

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• row (Integer) —

  a #gint representing a row in table

• column (Integer) —

  a #gint representing a column in table

Returns:

• (Atk::Object) —

  an Atk::Object representing the referred

#remove_column_selection(table, column) ⇒ TrueClass

the selection, or 0 if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• column (Integer) —

  a #gint representing a column in table

Returns:

• (TrueClass) —

  a gboolean representing if the column was successfully removed from

#remove_row_selection(table, row) ⇒ TrueClass

the selection, or 0 if value does not implement this interface.

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• row (Integer) —

  a #gint representing a row in table

Returns:

• (TrueClass) —

  a gboolean representing if the row was successfully removed from

#row_deleted(table, row, num_deleted) ⇒ nil

Parameters:

• table (Atk::Table)
• row (Integer)
• num_deleted (Integer)

Returns:

• (nil)

#row_inserted(table, row, num_inserted) ⇒ nil

Parameters:

• table (Atk::Table)
• row (Integer)
• num_inserted (Integer)

Returns:

• (nil)

#row_reordered(table) ⇒ nil

Parameters:

• table (Atk::Table)

Returns:

• (nil)

#set_caption(table, caption) ⇒ nil

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• caption (Atk::Object) —

  a Atk::Object representing the caption to set for table

Returns:

• (nil)

#set_column_description(table, column, description) ⇒ nil

to set for the specified column of the table

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• column (Integer) —

  a #gint representing a column in table

• description (String) —

  a #gchar representing the description text

Returns:

• (nil)

#set_column_header(table, column, header) ⇒ nil

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• column (Integer) —

  a #gint representing a column in table

• header (Atk::Object) —

  an Atk::Table

Returns:

• (nil)

#set_row_description(table, row, description) ⇒ nil

to set for the specified row of table

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• row (Integer) —

  a #gint representing a row in table

• description (String) —

  a #gchar representing the description text

Returns:

• (nil)

#set_row_header(table, row, header) ⇒ nil

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• row (Integer) —

  a #gint representing a row in table

• header (Atk::Object) —

  an Atk::Table

Returns:

• (nil)

#set_summary(table, accessible) ⇒ nil

to set for table

Parameters:

• table (Atk::Table) —

  a GObject instance that implements AtkTableIface

• accessible (Atk::Object) —

  an Atk::Object representing the summary description

Returns:

• (nil)

#summary ⇒ Atk::Object

Gets the summary description of the table. of the table, or zero if value does not implement this interface.

Returns:

• (Atk::Object) —

  a AtkObject* representing a summary description

#summary=(accessible) ⇒ nil

Sets the summary description of the table. to set for table

Parameters:

• accessible (Atk::Object) —

  an Atk::Object representing the summary description

Returns:

• (nil)