IliTablePropertyManager Class Reference

Table class. More...

#include <ilviews/dataccess/tblprop.h>

Inheritance diagram for IliTablePropertyManager:

List of all members.

Public Member Functions
void	addObserver (IliTablePropertyObserver *observer)
	Adds an observer to the property manager.
const char *	getName () const
	Returns the property manager name.
virtual IlBoolean	getProperty (IlInt rowno, IlInt colno, const IlvSymbol *propName, IliValue &propVal) const =0
	Returns a property value from one part of the table.
virtual IlInt	getPropertyCount (IlInt rowno, IlInt colno) const =0
	Returns the number of properties attached to the part of the table.
virtual const IlvSymbol *	getPropertyNameAt (IlInt rowno, IlInt colno, IlInt propIndex) const =0
	Returns a property name.
virtual IlBoolean	getScopedProperty (IlInt rowno, IlInt colno, const IlvSymbol *propName, IliValue &propVal) const =0
	Returns a scoped property value from one part of the table.
IliTable *	getTable () const
	Returns the table to which this property manager belongs.
virtual IlBoolean	hasProperty (IlInt rowno, IlInt colno, const IlvSymbol *propName) const
	Returns IlTrue if the part of the table has a specific property.
virtual IlBoolean	hasScopedProperty (IlInt rowno, IlInt colno, const IlvSymbol *propName) const
	Returns IlTrue if the part of the table has a scoped property.
void	removeObserver (IliTablePropertyObserver *observer)
	Removes an observer from the property manager.
virtual void	removeProperty (IlInt rowno, IlInt colno, const IlvSymbol *propName)=0
	Removes a property from one part of the table.
virtual void	setProperty (IlInt rowno, IlInt colno, const IlvSymbol *propName, const IliValue &propVal)=0
	Attaches a property with a value to a part of the table.
virtual void	tidy ()=0
	Removes all properties from all objects in this property manager.
Friends
class	IliTable

---

Detailed Description

Table class.

Library: dataccess

The IliTablePropertyManager class defines objects that manage properties attached to parts of a table. A property is identified by the property name and the part of the table to which it is attached. The part of the table can be one of the following:

• The whole table (rowno == -1 and colno == -1)
• A whole column (rowno == -1 and colno >= 0)
• A whole row (rowno >= 0 and colno == -1)
• A given cell (rowno >= 0 and colno >= 0)

Each property has a value represented as an IliValue object. In addition to the member functions that manage the properties that are attached to a given part, there are member functions that access so-called scoped properties. A given part of the table has a given scoped property if it has the property of the same name or if it falls within another part of the table that has this property. For example, if a given row has a property called "background" and a cell in that row has no property of that name, the cell still has a scoped property named "background" that it inherits from its row. The order in which scoped properties are searched is cell/row/column/table.

See also:

IliTable, IliTablePropertyObserver

---

Member Function Documentation

void IliTablePropertyManager::addObserver

(

IliTablePropertyObserver *

observer

)

Adds an observer to the property manager.

Parameters:

observer

The observer.

const char * IliTablePropertyManager::getName

(

)

const

Returns the property manager name.

Returns:

The name of the property manager or the empty string if the property manager has no name.

virtual IlBoolean IliTablePropertyManager::getProperty	(	IlInt	rowno,
		IlInt	colno,
		const IlvSymbol *	propName,
		IliValue &	propVal
	)			const [pure virtual]

Returns a property value from one part of the table.

Parameters:

	rowno	The row position.
	colno	The column position.
	propName	The property name.
	propVal	The property value.

Returns:

IlTrue if successful.

virtual IlInt IliTablePropertyManager::getPropertyCount	(	IlInt	rowno,
		IlInt	colno
	)			const [pure virtual]

Returns the number of properties attached to the part of the table.

Parameters:

	rowno	The row position.
	colno	The column position.

Returns:

The property count.

virtual const IlvSymbol* IliTablePropertyManager::getPropertyNameAt	(	IlInt	rowno,
		IlInt	colno,
		IlInt	propIndex
	)			const [pure virtual]

Returns a property name.

Parameters:

	rowno	The row position.
	colno	The column position.
	propIndex	The property index.

Returns:

The property name or NULL if the index is out of bound.

virtual IlBoolean IliTablePropertyManager::getScopedProperty	(	IlInt	rowno,
		IlInt	colno,
		const IlvSymbol *	propName,
		IliValue &	propVal
	)			const [pure virtual]

Returns a scoped property value from one part of the table.

Parameters:

	rowno	The row position.
	colno	The column position.
	propName	The property name.
	propVal	The property value.

Returns:

IlTrue if successful.

IliTable* IliTablePropertyManager::getTable

(

)

const

Returns the table to which this property manager belongs.

Returns:

The table.

virtual IlBoolean IliTablePropertyManager::hasProperty	(	IlInt	rowno,
		IlInt	colno,
		const IlvSymbol *	propName
	)			const [virtual]

Returns IlTrue if the part of the table has a specific property.

Parameters:

	rowno	The row position.
	colno	The column position.
	propName	The property name.

Returns:

IlTrue if the property is defined.

virtual IlBoolean IliTablePropertyManager::hasScopedProperty	(	IlInt	rowno,
		IlInt	colno,
		const IlvSymbol *	propName
	)			const [virtual]

Returns IlTrue if the part of the table has a scoped property.

Parameters:

	rowno	The row position.
	colno	The column position.
	propName	The property name.

Returns:

IlTrue if the scoped property is defined.

void IliTablePropertyManager::removeObserver

(

IliTablePropertyObserver *

observer

)

Removes an observer from the property manager.

Parameters:

observer

The observer.

virtual void IliTablePropertyManager::removeProperty	(	IlInt	rowno,
		IlInt	colno,
		const IlvSymbol *	propName
	)			[pure virtual]

Removes a property from one part of the table.

Parameters:

	rowno	The row position.
	colno	The column position.
	propName	The property name.

virtual void IliTablePropertyManager::setProperty	(	IlInt	rowno,
		IlInt	colno,
		const IlvSymbol *	propName,
		const IliValue &	propVal
	)			[pure virtual]

Attaches a property with a value to a part of the table.

Parameters:

	rowno	The row position.
	colno	The column position.
	propName	The property name.
	propVal	The property value.