Xfce Foundation Classes
Main Page  | Index |  Namespace List  |  Alphabetical List  |  Class List  |  File List


Xfc::Atk::Table Class Reference

An AtkTable C++ wrapper class. More...

#include <xfc/atk/table.hh>

Inheritance diagram for Xfc::Atk::Table:

Xfc::G::TypeInterface Xfc::G::TypeInstance Xfc::Trackable List of all members.

Signals Prototypes

Public Member Functions

Accessors
Methods
Signal Proxies

Protected Member Functions

Constructors

Detailed Description

An AtkTable C++ wrapper class.

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

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

Member Function Documentation

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

Adds the specified column to the selection.

Parameters:
column An integer representing a column in the table.
Returns:
true if the column was successfully added to the selection, or false if the table does not implement this interface.

bool Xfc::Atk::Table::add_row_selection (  int  row  ) 
 

Adds the specified row to the selection.

Parameters:
row An integer representing a row in the table.
Returns:
true if the row was successfully added to the selection, or false if the table does not implement this interface.

Object* Xfc::Atk::Table::get_caption (   )  const
 

Gets the caption for the table.

Returns:
A pointer to an Atk::Object representing the table caption, or null if table does not implement this interface.

int Xfc::Atk::Table::get_column_at_index (  int  index  )  const
 

Gets an integer representing the column at the specified index.

Parameters:
index An integer representing an index in the table.
Returns:
An integer representing the column at the specified index, or or -1 if the table does not implement this interface.

String Xfc::Atk::Table::get_column_description (  int  column  )  const
 

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

Parameters:
column An integer representing a column in the table.
Returns:
A string representing the column description, or a null String if the table does not implement this interface.

int Xfc::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:
row An integer representing a row in the table.
column An integer representing a column in the table.
Returns:
An integer representing the column extent at specified position, or 0 if the table does not implement this interface.

Object* Xfc::Atk::Table::get_column_header (  int  column  )  const
 

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

Parameters:
column An integer representing a column in the table.
Returns:
A pointer to an Atk::Object representing the specified column header, or null if table does not implement this interface.

int Xfc::Atk::Table::get_index_at (  int  row,
int  column
)  const
 

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

Parameters:
row An integer representing a row in the table.
column An integer representing a column in the table.
Returns:
An integer representing the index at specified position.
The value -1 is returned if the object at row, column is not a child of the table or the table does not implement this interface.

int Xfc::Atk::Table::get_n_columns (   )  const
 

Gets the number of columns in the table.

Returns:
An integer representing the number of columns, or 0 if the table does not implement this interface.

int Xfc::Atk::Table::get_n_rows (   )  const
 

Gets the number of rows in the table.

Returns:
An integer representing the number of rows, or 0 if the table does not implement this interface.

int Xfc::Atk::Table::get_row_at_index (  int  index  )  const
 

Gets an integer representing the row at the specified index.

Parameters:
index An integer representing an index in the table.
Returns:
An integer representing the row at the specified index, or or -1 if the table does not implement this interface.

String Xfc::Atk::Table::get_row_description (  int  row  )  const
 

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

Parameters:
row An integer representing a row in the table.
Returns:
A string representing the row description, or null if the table does not implement this interface.

int Xfc::Atk::Table::get_row_extent_at (  int  row,
int  column
)  const
 

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

Parameters:
row An integer representing a row in the table.
column An integer representing a column in the table.
Returns:
An integer representing the row extent at specified position, or 0 if the table does not implement this interface.

Object* Xfc::Atk::Table::get_row_header (  int  row  )  const
 

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

Parameters:
row An integer representing a row in the table.
Returns:
A pointer to an Atk::Object representing the specified row header, or null if table does not implement this interface.

bool Xfc::Atk::Table::get_selected_columns (  std::vector< int > &  selected  )  const
 

Gets the selected columns of the table.

Parameters:
selected A vector of int that is to hold the selected columns numbers.
Returns:
true if the vector is not empty.

bool Xfc::Atk::Table::get_selected_rows (  std::vector< int > &  selected  )  const
 

Gets the selected rows of the table.

Parameters:
selected A vector of int that is to hold the selected rows numbers.
Returns:
true if the vector is not empty.

Object* Xfc::Atk::Table::get_summary (   )  const
 

Gets the summary description of the table.

Returns:
A pointer to an Atk::Object representing a summary description of the table, or null if table does not implement this interface.

bool Xfc::Atk::Table::is_column_selected (  int  column  )  const
 

Gets whether the specified column is selected.

Parameters:
column An integer representing a column in the table.
Returns:
true if the column is selected, or false if the table does not implement this interface. bool is_row_selected(int row);

bool Xfc::Atk::Table::is_row_selected (  int  row  )  const
 

Gets whether the specified row is selected.

Parameters:
row An integer representing a row in the table.
Returns:
true if the row is selected, or false if the table does not implement this interface.

bool Xfc::Atk::Table::is_selected (  int  row,
int  column
)  const
 

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

Parameters:
row An integer representing a row in the table.
column An integer representing a column in the table.
Returns:
true if the cell is selected, or false if the table does not implement this interface.

Object* Xfc::Atk::Table::ref_at (  int  row,
int  column
)  const
 

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

Parameters:
row An integer representing a row in table.
column an integer representing a column in the table.
Returns:
A pointer to Atk::Object representing the referred to accessible.

bool Xfc::Atk::Table::remove_column_selection (  int  column  ) 
 

Removes the specified column from the selection.

Parameters:
column An integer representing a column in the table.
Returns:
true if the column was successfully removed from the selection, or false if the table does not implement this interface.

bool Xfc::Atk::Table::remove_row_selection (  int  row  ) 
 

Removes the specified row from the selection.

Parameters:
row An integer representing a row in the table.
Returns:
true if the row was successfully removed from the selection, or false if the table does not implement this interface.

void Xfc::Atk::Table::set_caption (  const Object *  caption  ) 
 

Sets the caption for the table.

Parameters:
caption An Atk::Object representing the caption to set for the table.

void Xfc::Atk::Table::set_column_description (  int  column,
const String &  description
) 
 

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

Parameters:
column An integer representing a column in the table.
description A string representing the description text to set for the specified column of the table.

void Xfc::Atk::Table::set_column_header (  int  column,
const Object *  header
) 
 

Sets the specified column header to header.

Parameters:
column An integer representing a column in the table.
header An Atk::Object representing the specified column header.

void Xfc::Atk::Table::set_row_description (  int  row,
const String &  description
) 
 

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

Parameters:
row An integer representing a row in the table.
description A string representing the description text to set for the specified row of the table.

void Xfc::Atk::Table::set_row_header (  int  row,
const Object *  header
) 
 

Sets the specified row header to header.

Parameters:
row An integer representing a row in the table.
header An Atk::Object representing the specified row header.

void Xfc::Atk::Table::set_summary (  const Object *  accessible  ) 
 

Sets the summary description of the table.

Parameters:
accessible An Atk::Object representing the summary description to set for table.

Member Data Documentation

const ColumnDeletedSignalType Xfc::Atk::Table::column_deleted_signal [static, protected]
 

Columnn deleted signal (see signal_column_deleted()).

Calls a slot with the signature: 

             void function(int column, int num_deleted);
             // column: The index of the first column deleted.
             // num_deleted: The number of columns deleted.

const ColumnInsertedSignalType Xfc::Atk::Table::column_inserted_signal [static, protected]
 

Column inserted signal (see signal_column_inserted()).

Calls a slot with the signature: 

             void function(int column, int num_inserted);
             // column: The index of the first column inserted.
             // num_inserted: The number of columns inserted.

const ColumnReorderedSignalType Xfc::Atk::Table::column_reordered_signal [static, protected]
 

Column reordered signal (see signal_column_reordered()).

Calls a slot with the signature: 

             void function();

const ModelChangedSignalType Xfc::Atk::Table::model_changed_signal [static, protected]
 

Model changed signal (see signal_model_changed()).

Calls a slot with the signature: 

             void function();

const RowDeletedSignalType Xfc::Atk::Table::row_deleted_signal [static, protected]
 

Row deleted signal (see signal_row_deleted()).

Calls a slot with the signature: 

             void function(int row, int num_deleted);
             // row: The index of the first row deleted.
             // num_deleted: The number of rows deleted.

const RowInsertedSignalType Xfc::Atk::Table::row_inserted_signal [static, protected]
 

Row inserted signal (see signal_row_inserted()).

Calls a slot with the signature: 

             void function(int row, int num_inserted);
             // row: The index of the first row inserted.
             // num_inserted: The number of rows inserted.

const RowReorderedSignalType Xfc::Atk::Table::row_reordered_signal [static, protected]
 

Row reordered signal (see signal_row_reordered()).

Calls a slot with the signature: 

             void function();

The documentation for this class was generated from the following file: Xfce Foundation Classes
Copyright © 2004-2005 The XFC Development Team XFC 4.3