atkmm  2.22.7
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Atk::Table Class Reference

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

#include <atkmm/table.h>

Inheritance diagram for Atk::Table:
Inheritance graph
[legend]

Public Member Functions

AtkTable* gobj ()
 Provides access to the underlying C GObject.
 
const AtkTable* gobj () const
 Provides access to the underlying C GObject.
 
Glib::RefPtr< Atk::Objectget_at (int row, int column)
 Get a reference to the table cell at row, column. More...
 
int get_index_at (int row, int column) const
 Gets a int representing the index at the specified row and column. More...
 
int get_column_at_index (int index) const
 Gets a int representing the column at the specified index. More...
 
int get_row_at_index (int index) const
 Gets a int representing the row at the specified index. More...
 
int get_n_columns () const
 Gets the number of columns in the table. More...
 
int get_n_rows () const
 Gets the number of rows in the table. More...
 
int get_column_extent_at (int row, int column) const
 Gets the number of columns occupied by the accessible object at the specified row and column in the table. More...
 
int get_row_extent_at (int row, int column) const
 Gets the number of rows occupied by the accessible object at a specified row and column in the table. More...
 
Glib::RefPtr< Atk::Objectget_caption ()
 Gets the caption for the table. More...
 
Glib::RefPtr< const Atk::Objectget_caption () const
 Gets the caption for the table. More...
 
Glib::ustring get_column_description (int column) const
 Gets the description text of the specified column in the table. More...
 
Glib::RefPtr< Atk::Objectget_column_header (int column)
 Gets the column header of a specified column in an accessible table. More...
 
Glib::RefPtr< const Atk::Objectget_column_header (int column) const
 Gets the column header of a specified column in an accessible table. More...
 
Glib::ustring get_row_description (int row) const
 Gets the description text of the specified row in the table. More...
 
Glib::RefPtr< Atk::Objectget_row_header (int row)
 Gets the row header of a specified row in an accessible table. More...
 
Glib::RefPtr< const Atk::Objectget_row_header (int row) const
 Gets the row header of a specified row in an accessible table. More...
 
Glib::RefPtr< Atk::Objectget_summary ()
 Gets the summary description of the table. More...
 
Glib::RefPtr< const Atk::Objectget_summary () const
 Gets the summary description of the table. More...
 
void set_caption (const Glib::RefPtr< Atk::Object >& caption)
 Sets the caption for the table. More...
 
void set_column_description (int column, const Glib::ustring& description)
 Sets the description text for the specified column of the table. More...
 
void set_column_header (int column, const Glib::RefPtr< Atk::Object >& header)
 Sets the specified column header to header. More...
 
void set_row_description (int row, const Glib::ustring& description)
 Sets the description text for the specified row of table. More...
 
void set_row_header (int row, const Glib::RefPtr< Atk::Object >& header)
 Sets the specified row header to header. More...
 
void set_summary (const Glib::RefPtr< Atk::Object >& accessible)
 Sets the summary description of the table. More...
 
bool is_column_selected (int column) const
 Gets a boolean value indicating whether the specified column is selected. More...
 
bool is_row_selected (int row) const
 Gets a boolean value indicating whether the specified row is selected. More...
 
bool is_selected (int row, int column) const
 Gets a boolean value indicating whether the accessible object at the specified row and column is selected. More...
 
bool add_row_selection (int row)
 Adds the specified row to the selection. More...
 
bool remove_row_selection (int row)
 Removes the specified row from the selection. More...
 
bool add_column_selection (int column)
 Adds the specified column to the selection. More...
 
bool remove_column_selection (int column)
 Adds the specified column to the selection. More...
 
Glib::SignalProxy2< void, int,
int > 
signal_row_inserted ()
 
Glib::SignalProxy2< void, int,
int > 
signal_column_inserted ()
 
Glib::SignalProxy2< void, int,
int > 
signal_row_deleted ()
 
Glib::SignalProxy2< void, int,
int > 
signal_column_deleted ()
 
Glib::SignalProxy0< void > signal_row_reordered ()
 
Glib::SignalProxy0< void > signal_column_reordered ()
 
Glib::SignalProxy0< void > signal_model_changed ()
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
 

Protected Member Functions

 Table ()
 You should derive from this class to use it.
 
virtual void on_row_inserted (int row, int num_inserted)
 This is a default handler for the signal signal_row_inserted().
 
virtual void on_column_inserted (int column, int num_inserted)
 This is a default handler for the signal signal_column_inserted().
 
virtual void on_row_deleted (int row, int num_deleted)
 This is a default handler for the signal signal_row_deleted().
 
virtual void on_column_deleted (int column, int num_deleted)
 This is a default handler for the signal signal_column_deleted().
 
virtual void on_row_reordered ()
 This is a default handler for the signal signal_row_reordered().
 
virtual void on_column_reordered ()
 This is a default handler for the signal signal_column_reordered().
 
virtual void on_model_changed ()
 This is a default handler for the signal signal_model_changed().
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Atk::Tablewrap (AtkTable* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

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

This 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", and these cells are exposed by Atk::Table as child Atk::Objects of the Atk::Table. Both row/column and child-index-based access to these children is provided.

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 AtkObjects which may implement other interfaces (Atk::Text, Atk::Image, etc.) as appropriate. Atk::Table summaries may themselves be (simplified) Atk::Tables, etc.

Member Function Documentation

bool Atk::Table::add_column_selection ( int  column)

Adds the specified column to the selection.

Parameters
columnA int representing a column in table.
Returns
A bool representing if the column was successfully added to the selection, or 0 if value does not implement this interface.
bool Atk::Table::add_row_selection ( int  row)

Adds the specified row to the selection.

Parameters
rowA int representing a row in table.
Returns
A bool representing if row was successfully added to selection, or 0 if value does not implement this interface.
Glib::RefPtr<Atk::Object> Atk::Table::get_at ( int  row,
int  column 
)

Get a reference to the table cell at row, column.

Parameters
rowA int representing a row in table.
columnA int representing a column in table.
Returns
A AtkObject* representing the referred to accessible.
Glib::RefPtr<Atk::Object> Atk::Table::get_caption ( )

Gets the caption for the table.

Returns
A AtkObject* representing the table caption, or 0 if value does not implement this interface.
Glib::RefPtr<const Atk::Object> Atk::Table::get_caption ( ) const

Gets the caption for the table.

Returns
A AtkObject* representing the table caption, or 0 if value does not implement this interface.
int Atk::Table::get_column_at_index ( int  index) const

Gets a int representing the column at the specified index.

Parameters
indexA int representing an index in table.
Returns
A int representing the column at the specified index, or -1 if the table does not implement this interface.
Glib::ustring Atk::Table::get_column_description ( int  column) const

Gets the description text of the specified column in the table.

Parameters
columnA int representing a column in table.
Returns
A gchar* representing the column description, or 0 if value does not implement this interface.
int Atk::Table::get_column_extent_at ( int  row,
int  column 
) const

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

Parameters
rowA int representing a row in table.
columnA int representing a column in table.
Returns
A int representing the column extent at specified position, or 0 if value does not implement this interface.
Glib::RefPtr<Atk::Object> Atk::Table::get_column_header ( int  column)

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

Parameters
columnA int representing a column in the table.
Returns
A AtkObject* representing the specified column header, or 0 if value does not implement this interface.
Glib::RefPtr<const Atk::Object> Atk::Table::get_column_header ( int  column) const

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

Parameters
columnA int representing a column in the table.
Returns
A AtkObject* representing the specified column header, or 0 if value does not implement this interface.
int Atk::Table::get_index_at ( int  row,
int  column 
) const

Gets a int representing the index at the specified row and column.

Parameters
rowA int representing a row in table.
columnA int representing a column in table.
Returns
A int representing the index at specified position. The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface.
int Atk::Table::get_n_columns ( ) const

Gets the number of columns in the table.

Returns
A int representing the number of columns, or 0 if value does not implement this interface.
int Atk::Table::get_n_rows ( ) const

Gets the number of rows in the table.

Returns
A int representing the number of rows, or 0 if value does not implement this interface.
int Atk::Table::get_row_at_index ( int  index) const

Gets a int representing the row at the specified index.

Parameters
indexA int representing an index in table.
Returns
A int representing the row at the specified index, or -1 if the table does not implement this interface.
Glib::ustring Atk::Table::get_row_description ( int  row) const

Gets the description text of the specified row in the table.

Parameters
rowA int representing a row in table.
Returns
A gchar* representing the row description, or 0 if value does not implement this interface.
int Atk::Table::get_row_extent_at ( int  row,
int  column 
) const

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

Parameters
rowA int representing a row in table.
columnA int representing a column in table.
Returns
A int representing the row extent at specified position, or 0 if value does not implement this interface.
Glib::RefPtr<Atk::Object> Atk::Table::get_row_header ( int  row)

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

Parameters
rowA int representing a row in the table.
Returns
A AtkObject* representing the specified row header, or 0 if value does not implement this interface.
Glib::RefPtr<const Atk::Object> Atk::Table::get_row_header ( int  row) const

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

Parameters
rowA int representing a row in the table.
Returns
A AtkObject* representing the specified row header, or 0 if value does not implement this interface.
Glib::RefPtr<Atk::Object> Atk::Table::get_summary ( )

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.
Glib::RefPtr<const Atk::Object> Atk::Table::get_summary ( ) const

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 Atk::Table::is_column_selected ( int  column) const

Gets a boolean value indicating whether the specified column is selected.

Parameters
columnA int representing a column in table.
Returns
A bool representing if the column is selected, or 0 if value does not implement this interface.
bool Atk::Table::is_row_selected ( int  row) const

Gets a boolean value indicating whether the specified row is selected.

Parameters
rowA int representing a row in table.
Returns
A bool representing if the row is selected, or 0 if value does not implement this interface.
bool Atk::Table::is_selected ( int  row,
int  column 
) const

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

Parameters
rowA int representing a row in table.
columnA int representing a column in table.
Returns
A bool representing if the cell is selected, or 0 if value does not implement this interface.
bool Atk::Table::remove_column_selection ( int  column)

Adds the specified column to the selection.

Parameters
columnA int representing a column in table.
Returns
A bool representing if the column was successfully removed from the selection, or 0 if value does not implement this interface.
bool Atk::Table::remove_row_selection ( int  row)

Removes the specified row from the selection.

Parameters
rowA int representing a row in table.
Returns
A bool representing if the row was successfully removed from the selection, or 0 if value does not implement this interface.
void Atk::Table::set_caption ( const Glib::RefPtr< Atk::Object >&  caption)

Sets the caption for the table.

Parameters
captionA Atk::Object representing the caption to set for table.
void Atk::Table::set_column_description ( int  column,
const Glib::ustring description 
)

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

Parameters
columnA int representing a column in table.
descriptionA #gchar representing the description text to set for the specified column of the table.
void Atk::Table::set_column_header ( int  column,
const Glib::RefPtr< Atk::Object >&  header 
)

Sets the specified column header to header.

Parameters
columnA int representing a column in table.
headerAn Atk::Table.
void Atk::Table::set_row_description ( int  row,
const Glib::ustring description 
)

Sets the description text for the specified row of table.

Parameters
rowA int representing a row in table.
descriptionA #gchar representing the description text to set for the specified row of table.
void Atk::Table::set_row_header ( int  row,
const Glib::RefPtr< Atk::Object >&  header 
)

Sets the specified row header to header.

Parameters
rowA int representing a row in table.
headerAn Atk::Table.
void Atk::Table::set_summary ( const Glib::RefPtr< Atk::Object >&  accessible)

Sets the summary description of the table.

Parameters
accessibleAn Atk::Object representing the summary description to set for table.
Glib::SignalProxy2< void,int,int > Atk::Table::signal_column_deleted ( )
Slot Prototype:
void on_my_column_deleted(int column, int num_deleted)
Glib::SignalProxy2< void,int,int > Atk::Table::signal_column_inserted ( )
Slot Prototype:
void on_my_column_inserted(int column, int num_inserted)
Glib::SignalProxy0< void > Atk::Table::signal_column_reordered ( )
Slot Prototype:
void on_my_column_reordered()
Glib::SignalProxy0< void > Atk::Table::signal_model_changed ( )
Slot Prototype:
void on_my_model_changed()
Glib::SignalProxy2< void,int,int > Atk::Table::signal_row_deleted ( )
Slot Prototype:
void on_my_row_deleted(int row, int num_deleted)
Glib::SignalProxy2< void,int,int > Atk::Table::signal_row_inserted ( )
Slot Prototype:
void on_my_row_inserted(int row, int num_inserted)
Glib::SignalProxy0< void > Atk::Table::signal_row_reordered ( )
Slot Prototype:
void on_my_row_reordered()

Friends And Related Function Documentation

Glib::RefPtr< Atk::Table > wrap ( AtkTable *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.