Table gadget class. More...

#include <ilviews/dataccess/gadgets/tablegad.h>

Public Member Functions
IlvPalette *	getFillPalette () const
	Returns a palette whose foreground color is used to fill the cell. More...

IlInt	getRowno () const
	Returns the row position of the cell. More...

IlInt	getTableColno () const
	Returns the column position of the cell (relative to the underlying table). More...

IlvPalette *	getTextPalette () const
	Returns a palette whose foreground color is used to draw the cell text. More...

IlBoolean	isSelected ()
	Returns `IlTrue` if the cell is selected (highlighted) and `IlFalse` otherwise. More...

void	setFillPalette (IlvPalette *pal)
	Sets the palette used to fill the cell. More...

void	setTextPalette (IlvPalette *pal)
	Sets the palette used to draw the cell text. More...

Friends
class	IliTableGadget

Detailed Description

Table gadget class.

Library: dbgadget

This class defines the fill palette and text palette used to draw a cell in a table gadget. During execution of the GetCellPalette table gadget callback, this structure can be obtained by calling the IliTableGadget::getCellPaletteStruct() member function.

About Clipboard

The table gadget can copy the contents of a given selection to the clipboard in the form of a character string. Each value in the selection is formatted according to the format and input mask of the column to which this column belongs. If the selection contains more than one column or more than one row, then each row is separated by a new line character and each column is separated by a tab character.

See also: IliTableGadget.

Accessors\nAccessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods <tt>IlvValueInterface::queryValue()</tt>, <tt>IlvValueInterface::queryValues()</tt>, <tt>IlvValueInterface::changeValue()</tt>, <tt>IlvValueInterface::changeValues()</tt>.\n\nThis class defines the following accessors:

Data accessors

Name	Type	Equivalent methods
`row`	Int	`getRowno()`
`column`	Int	`-`
`tableColumn`	Int	`getTableColno()`
`selected`	Boolean	`isSelected()`
`foreground`	Color	`getTextPalette()->getForeground()`, `setTextPalette(...)`
`background`	Color	`getFillPalette()->getForeground()`, `setFillPalette(...)`
`font`	Font	`getTextPalette()->getFont()`, `setTextPalette(...)`

Member Function Documentation

◆ getFillPalette()

IlvPalette* IliCellPaletteStruct::getFillPalette ( ) const

Returns a palette whose foreground color is used to fill the cell.

Returns: The palette.

◆ getRowno()

IlInt IliCellPaletteStruct::getRowno ( ) const

Returns the row position of the cell.

Returns: The row position.

◆ getTableColno()

IlInt IliCellPaletteStruct::getTableColno ( ) const

Returns the column position of the cell (relative to the underlying table).

Returns: The column position.

◆ getTextPalette()

IlvPalette* IliCellPaletteStruct::getTextPalette ( ) const

Returns a palette whose foreground color is used to draw the cell text.

Returns: A palette.

◆ isSelected()

IlBoolean IliCellPaletteStruct::isSelected ( )

Returns IlTrue if the cell is selected (highlighted) and IlFalse otherwise.

Returns: The cell state.

◆ setFillPalette()

void IliCellPaletteStruct::setFillPalette ( IlvPalette * pal )

Sets the palette used to fill the cell.

Parameters

pal	The palette.

◆ setTextPalette()

void IliCellPaletteStruct::setTextPalette ( IlvPalette * pal )

Sets the palette used to draw the cell text.