IliTableSelection Class Reference

Structure. More...

#include <ilviews/dataccess/tblsel.h>

Inherited by IliFloatingTableSelection.

Public Member Functions
	IliTableSelection (IliTableSelectionType type=IliSelectNone, IlInt rowno=0, IlInt colno=0)
	This constructor initializes the table selection. More...
void	addColumn (IlInt colno)
	Adds a column to the selection. More...
void	addRange (IlInt from, IlInt to)
	Adds a range in the selection. More...
void	addRow (IlInt rowno)
	Adds to the selection a row. More...
IlBoolean	contains (const IliTableSelection &sel) const
	Returns IlTrue if a selection is included in the selection. More...
IlBoolean	containsCell (IlInt rowno, IlInt colno) const
	Returns IlTrue if a cell is included in the selection. More...
IlBoolean	containsColumn (IlInt colno) const
	Returns IlTrue if a column is included in the selection. More...
IlBoolean	containsRange (IlInt from, IlInt to) const
	IlTrue if the range set of rows belongs to the selection. More...
IlBoolean	containsRow (IlInt rowno) const
	Returns IlTrue if a row is included in the selection. More...
IlInt	getColumn () const
	Returns the column position of the selected column or cell. More...
IlInt	getColumnAt (IlInt idx) const
	Returns a column position from the selection. More...
IlInt	getColumnsCount () const
	Returns the number of columns included in the selection. More...
void	getRangeAt (IlInt idx, IlInt &from, IlInt &to) const
	Returns a range from the selection. More...
IlInt	getRangesCount () const
	Returns the number of ranges included in the selection. More...
IlInt	getRow () const
	Returns the row position of the selected row or cell. More...
IlInt	getRowAt (IlInt idx) const
	Returns a row position from the selection. More...
IlInt	getRowsCount () const
	Returns the number of rows included in the selection. More...
IliTableSelectionType	getType () const
	Returns the selection type. More...
IlBoolean	isCell () const
	Returns IlTrue if one cell is selected. More...
IlBoolean	isColumn () const
	IlTrue if one column is selected. More...
IlBoolean	isColumnOrCell () const
	Returns IlTrue if one column or one cell is selected. More...
IlBoolean	isEmpty () const
	Returns IlTrue if the selection is empty. More...
IlBoolean	isFull () const
	Returns IlTrue if the table-gadget is selected in its entirety. More...
IlBoolean	isMulti () const
	Returns IlTrue if the selection contains more than one row or column. More...
IlBoolean	isRow () const
	Returns IlTrue if one row is selected. More...
IlBoolean	isRowOrCell () const
	Returns IlTrue if one row or one cell is selected. More...
void	removeColumn (IlInt colno)
	Removes a column from the selection. More...
void	removeRange (IlInt from, IlInt to)
	Removes a range from the selection. More...
void	removeRow (IlInt rowno)
	Removes a row from the selection. More...
void	setColumn (IlInt colno)
	Sets the column position of the selected column or cell. More...
void	setRow (IlInt rowno)
	Sets the row position of the selected row or cell. More...
void	setType (IliTableSelectionType type)
	Sets the selection type. More...

Detailed Description

Structure.

Library: dataccess

This class describes a selection in a table gadget.

See also

IliTableGadget, IliTableSelectionType.

Accessors

Accessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods IlvValueInterface::queryValue(), IlvValueInterface::queryValues(), IlvValueInterface::changeValue(), IlvValueInterface::changeValues(). This class defines the following accessors:

Data accessors

Name	Type	Equivalent methods
type	Object	getType()
row	Int	getRow(), setRow()
column	Int	getColumn(), setColumn()
rowsCount	Int	getRowsCount()
columnsCount	Int	getColumnsCount()

Method accessors

Name	Return type	Equivalent methods
isEmpty()	Boolean	isEmpty()
isFull()	Boolean	isFull()
isCell()	Boolean	isCell()
isRow()	Boolean	isRow()
isColumn()	Boolean	isColumn()
isRowOrCell()	Boolean	isRowOrCell()
isColumnOrCell()	Boolean	isColumnOrCell()
setCell(Int row, Int col)	Void	setRow(row) & setColumn(col)
setRow(Int row)	Void	setRow(IlInt)
setColumn(Int col)	Void	setColumn(col)
isMulti()	Boolean	isMulti()
getRowAt(Int row)	Int	getRowAt(row)
addRow(Int row)	Void	addRow(row)
removeRow(Int row)	Void	removeRow(row)
getColumnAt(Int col)	Int	getColumnAt(col)
addColumn(Int col)	Void	addColumn(col)
removeColumn(Int col)	Void	removeColumn(IlInt col)
containsCell(Int row, Int col)	Boolean	containsCell(row, col)
containsRow(Int row)	Boolean	containsRow(row)
containsColumn(Int col)	Boolean	containsColumn(col)

Constructor & Destructor Documentation

IliTableSelection()

IliTableSelection::IliTableSelection	(	IliTableSelectionType	type = IliSelectNone,
		IlInt	rowno = 0,
		IlInt	colno = 0
	)

This constructor initializes the table selection.

Parameters

type	The selection type.
rowno	The row position.
colno	The column position.

Member Function Documentation

addColumn()

void IliTableSelection::addColumn

(

IlInt

colno

)

Adds a column to the selection.

Parameters

colno

The column position in the table-gadget.

addRange()

void IliTableSelection::addRange	(	IlInt	from,
		IlInt	to
	)

Adds a range in the selection.

This range designates either a set of rows or a set of columns (depending on whether the type of the selection is IliSelectRow or IliSelectColumn.)

Parameters

from	The lower bound (inclusive) of the range.
to	The upper bound (inclusive) of the range.

addRow()

void IliTableSelection::addRow

(

IlInt

rowno

)

Adds to the selection a row.

Parameters

rowno

The row position in the table-gadget.

contains()

IlBoolean IliTableSelection::contains

(

const IliTableSelection &

sel

)

const

Returns IlTrue if a selection is included in the selection.

Parameters

sel	The selection.

Returns

IlTrue if a selection is included in the selection.

containsCell()

IlBoolean IliTableSelection::containsCell	(	IlInt	rowno,
		IlInt	colno
	)		const

Returns IlTrue if a cell is included in the selection.

This can happen if the type of the selection is IliSelectCell, IliSelectRow, IliSelectColumn, or IliSelectAll.

Parameters

rowno	The row position.
colno	The column position.

Returns

IlTrue if a cell is included in the selection.

containsColumn()

IlBoolean IliTableSelection::containsColumn

(

IlInt

colno

)

const

Returns IlTrue if a column is included in the selection.

This can only happen if the type of the selection is IliSelectColumn or IliSelectAll.

Parameters

colno

The column position.

Returns

IlTrue if a column is included in the selection.

containsRange()

IlBoolean IliTableSelection::containsRange	(	IlInt	from,
		IlInt	to
	)		const

IlTrue if the range set of rows belongs to the selection.

Parameters

from	The lower bound (inclusive) of the range.
to	The upper bound (inclusive) of the range.

Returns

IlTrue if the range set of rows belongs to the selection.

containsRow()

IlBoolean IliTableSelection::containsRow

(

IlInt

rowno

)

const

Returns IlTrue if a row is included in the selection.

This can only happen if the type of the selection is IliSelectRow or IliSelectAll.

Parameters

rowno

The row position.

Returns

IlTrue if a row is included in the selection.

getColumn()

IlInt IliTableSelection::getColumn

(

)

const

Returns the column position of the selected column or cell.

Returns

The position.

getColumnAt()

IlInt IliTableSelection::getColumnAt

(

IlInt

idx

)

const

Returns a column position from the selection.

Parameters

idx	The index in the selection. The value is between 0 and getColumnsCount().

Returns

The column position.

getColumnsCount()

IlInt IliTableSelection::getColumnsCount

(

)

const

Returns the number of columns included in the selection.

Returns

The count.

getRangeAt()

void IliTableSelection::getRangeAt	(	IlInt	idx,
		IlInt &	from,
		IlInt &	to
	)		const

Returns a range from the selection.

Parameters

idx	The range index in the selection. The value is between 0 and getRangesCount().
from	The lower bound (inclusive) of the range.
to	The upper bound (inclusive) of the range.

Returns

The range.

getRangesCount()

IlInt IliTableSelection::getRangesCount

(

)

const

Returns the number of ranges included in the selection.

Returns

The count.

getRow()

IlInt IliTableSelection::getRow

(

)

const

Returns the row position of the selected row or cell.

Returns

The position.

getRowAt()

IlInt IliTableSelection::getRowAt

(

IlInt

idx

)

const

Returns a row position from the selection.

Parameters

idx	The index in the selection. The value is between 0 and getRowsCount().

Returns

The row position.

getRowsCount()

IlInt IliTableSelection::getRowsCount

(

)

const

Returns the number of rows included in the selection.

Returns

The count.

getType()

IliTableSelectionType IliTableSelection::getType

(

)

const

Returns the selection type.

Returns

The type.

isCell()

IlBoolean IliTableSelection::isCell

(

)

const

Returns IlTrue if one cell is selected.

Returns

IlTrue if one cell is selected. In this case, the selected cell is identified by the getRow() and getColumn() member functions.

isColumn()

IlBoolean IliTableSelection::isColumn

(

)

const

IlTrue if one column is selected.

In this case, the selected column is identified by the getColumn() member function.

Returns

IlTrue if one column is selected.

isColumnOrCell()

IlBoolean IliTableSelection::isColumnOrCell

(

)

const

Returns IlTrue if one column or one cell is selected.

Returns

IlTrue if one column or one cell is selected.

isEmpty()

IlBoolean IliTableSelection::isEmpty

(

)

const

Returns IlTrue if the selection is empty.

Returns

IlTrue if the selection is empty.

isFull()

IlBoolean IliTableSelection::isFull

(

)

const

Returns IlTrue if the table-gadget is selected in its entirety.

Returns

IlTrue if the table-gadget is selected in its entirety.

isMulti()

IlBoolean IliTableSelection::isMulti

(

)

const

Returns IlTrue if the selection contains more than one row or column.

Returns

IlTrue if the selection contains more than one row or column.

isRow()

IlBoolean IliTableSelection::isRow

(

)

const

Returns IlTrue if one row is selected.

In this case, the selected row is identified by the getRow() member function.

Returns

() IlTrue if one row is selected.

isRowOrCell()

IlBoolean IliTableSelection::isRowOrCell

(

)

const

Returns IlTrue if one row or one cell is selected.

Returns

IlTrue if one row or one cell is selected.

removeColumn()

void IliTableSelection::removeColumn

(

IlInt

colno

)

Removes a column from the selection.

Parameters

colno

The column position in the table-gadget.

removeRange()

void IliTableSelection::removeRange	(	IlInt	from,
		IlInt	to
	)

Removes a range from the selection.

Depending on whether the type of the selection is IliSelectRow or IliSelectColumn, this member function will remove from the selection all rows, (or all columns) whose position falls within the range.

Parameters

from	The lower bound (inclusive) of the range.
to	The upper bound (inclusive) of the range.

removeRow()

void IliTableSelection::removeRow

(

IlInt

rowno

)

Removes a row from the selection.

Parameters

rowno

The row position in the table-gadget.

setColumn()

void IliTableSelection::setColumn

(

IlInt

colno

)

Sets the column position of the selected column or cell.

Parameters

colno

The column position.

setRow()

void IliTableSelection::setRow

(

IlInt

rowno

)

Sets the row position of the selected row or cell.

Parameters

rowno

The row position.

setType()

void IliTableSelection::setType

(

IliTableSelectionType

type

)

Sets the selection type.

Parameters

type	The selection type.