IliGadgetModel Class Reference

Model class. More...

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

Inheritance diagram for IliGadgetModel:

Public Member Functions
	IliGadgetModel ()
	The constructor initializes a new IliGadgetModel instance.
virtual void	allRowsDeleted (const IliModelHookInfo &info)
	Called when the IliTable::clearRows member function is called. More...
virtual void	cellChanged (const IliModelHookInfo &info)
	Called just after a cell has changed. More...
virtual void	columnChanged (const IliModelHookInfo &info)
	Called when a column has changed. More...
virtual void	columnDeleted (const IliModelHookInfo &info)
	Called just after a column deletion. More...
virtual void	columnInserted (const IliModelHookInfo &info)
	Called when a new column is inserted. More...
virtual void	columnMoved (const IliModelHookInfo &info)
	Called just after a column has moved. More...
virtual void	columnToBeDeleted (const IliModelHookInfo &info)
	Called just before a column deletion. More...
virtual void	currentRowChanged (const IliModelHookInfo &info)
	Called when the data source current row has been changed. More...
virtual void	endOfBatch ()
	Called to terminate a series of updates to the IliSchema or IliTable objects. More...
virtual const char *	getName () const
	Returns the model name. More...
virtual IlBoolean	refreshAll ()
	Called when a refresh of all the gadget is necessary.
virtual void	rowChanged (const IliModelHookInfo &info)
	Called just after a row has changed. More...
virtual void	rowDeleted (const IliModelHookInfo &info)
	Called just after a row has been deleted. More...
virtual void	rowFetched (const IliModelHookInfo &info)
	Called just after a new row has been fetched from a remote database and inserted. More...
virtual void	rowInserted (const IliModelHookInfo &info)
	Called just after a new row has been inserted. More...
virtual void	rowMoved (const IliModelHookInfo &info)
	Called just after a row has moved. More...
virtual void	rowsExchanged (const IliModelHookInfo &info)
	Called just after a row is exchanged with another row. More...
virtual void	rowsFetched (const IliModelHookInfo &info)
	Called when many consecutive rows are fetched at once. More...
virtual void	rowsInserted (const IliModelHookInfo &info)
	Called when many consecutive rows are inserted at once. More...
virtual void	rowToBeChanged (const IliModelHookInfo &info)
	Called just before a row is changed. More...
virtual void	rowToBeDeleted (const IliModelHookInfo &info)
	Called just before a row deletion. More...
virtual void	startOfBatch ()
	Called at the start of a series of updates to the IliSchema or IliTable object. More...
virtual void	tableChanged (const IliModelHookInfo &info)
	Called when the object has undergone a significant number of changes. More...
virtual void	tableDeleted (const IliModelHookInfo &info)
	Called when the IliSchema or IliTable object is deleted. More...
Public Member Functions inherited from IliModel
	IliModel ()
	The constructor initializes a new IliModel instance.
IlInt	declareProperty (const IliDatatype *typ, const char *name, const char *title, IlBoolean pub)
	Declares a new property. More...
virtual void	defineProperties ()
	Called to define the list of properties. More...
virtual const char *	getLabel () const =0
	Returns the model label, it is used by the gadget inspector. More...
virtual const char *	getMappingInspectorModelName () const
	Returns the mapping inspector model name. More...
IlInt	getPropertyCount () const
	Returns the property count. More...
IlInt	getPropertyIndex (const char *name) const
	Returns a property index. More...
const char *	getPropertyName (IlInt index) const
	Returns a property name. More...
const IliValue &	getPropertyValue (const char *name) const
	Returns a property value. More...
const IliValue &	getPropertyValue (IlInt index) const
	Returns a property value. More...
virtual IlBoolean	isPublic () const
	Returns the model visibility. More...
void	setPropertyValue (const char *name, const IliValue &val)
	Sets a property value. More...
void	setPropertyValue (IlInt index, const IliValue &val)
	Sets a property value. More...

Detailed Description

Model class.

Library: dbgadget

The IliGadgetModel class defines a model class to handle the data source event (or notification) received by a gadget. For each event type, there is a virtual function. When a gadget receive a data source event, the event is forwarded to the gadget model if the gadget batch mode is off. Some data source events are ignored by the gadget because they are not significant.

See Also

IliModelHookInfo, IliModel.

Member Function Documentation

virtual void IliGadgetModel::allRowsDeleted ( const IliModelHookInfo &  info )

virtual

Called when the IliTable::clearRows member function is called.

Parameters

info	It contains the data source index.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::cellChanged ( const IliModelHookInfo &  info )

virtual

Called just after a cell has changed.

If more than one value has changed in a row, it is likely that the rowChanged member function will be called, instead of this member function.

Parameters

info	It contains the cell position (row and column).

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::columnChanged ( const IliModelHookInfo &  info )

virtual

Called when a column has changed.

Parameters

info	It contains the column position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::columnDeleted ( const IliModelHookInfo &  info )

virtual

Called just after a column deletion.

Parameters

info	It contains the column position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::columnInserted ( const IliModelHookInfo &  info )

virtual

Called when a new column is inserted.

Parameters

info	It contains the column position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::columnMoved ( const IliModelHookInfo &  info )

virtual

Called just after a column has moved.

Parameters

info	It contains the from and to position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::columnToBeDeleted ( const IliModelHookInfo &  info )

virtual

Called just before a column deletion.

Parameters

info	It contains the column position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::currentRowChanged ( const IliModelHookInfo &  info )

virtual

Called when the data source current row has been changed.

This event is notified if the gadget supports the current row notifications (for example, IliXML).

Parameters

info	It contains the row position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::endOfBatch ( )

virtual

Called to terminate a series of updates to the IliSchema or IliTable objects.

Calls to startOfBatch and endOfBatch may be nested.

virtual const char* IliGadgetModel::getName ( ) const

virtual

Returns the model name.

Returns

The name.

Reimplemented from IliModel.

Reimplemented in IliDbGanttModel.

virtual void IliGadgetModel::rowChanged ( const IliModelHookInfo &  info )

virtual

Called just after a row has changed.

Parameters

info	It contains the row position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::rowDeleted ( const IliModelHookInfo &  info )

virtual

Called just after a row has been deleted.

Parameters

info	It contains the row position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::rowFetched ( const IliModelHookInfo &  info )

virtual

Called just after a new row has been fetched from a remote database and inserted.

The rowInserted member function will also be called.

Parameters

info	It contains the from and to position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::rowInserted ( const IliModelHookInfo &  info )

virtual

Called just after a new row has been inserted.

Parameters

info	It contains the row position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::rowMoved ( const IliModelHookInfo &  info )

virtual

Called just after a row has moved.

Parameters

info	It contains the from and to position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::rowsExchanged ( const IliModelHookInfo &  info )

virtual

Called just after a row is exchanged with another row.

Parameters

info	It contains the first row position (from) and the second row position (to).

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::rowsFetched ( const IliModelHookInfo &  info )

virtual

Called when many consecutive rows are fetched at once.

The fetched rows appear between the from position and the to position, inclusive. By default, this virtual member function repeatedly calls rowsFetched with each index between from and to.

Parameters

info	It contains the first row position (from) and the second row position (to).

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::rowsInserted ( const IliModelHookInfo &  info )

virtual

Called when many consecutive rows are inserted at once.

The inserted rows appear between the from position and the to position, inclusive. By default, this virtual member function repeatedly calls rowInserted with each index between from and to.

Parameters

info	It contains the from and to position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::rowToBeChanged ( const IliModelHookInfo &  info )

virtual

Called just before a row is changed.

Parameters

info	It contains the row position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::rowToBeDeleted ( const IliModelHookInfo &  info )

virtual

Called just before a row deletion.

Parameters

info	It contains the row position.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::startOfBatch ( )

virtual

Called at the start of a series of updates to the IliSchema or IliTable object.

A call to this virtual member function will be followed by a call to the endOfBatch virtual member function.

virtual void IliGadgetModel::tableChanged ( const IliModelHookInfo &  info )

virtual

Called when the object has undergone a significant number of changes.

Parameters

info	It contains the data source index.

Reimplemented in IliChartDataModel.

virtual void IliGadgetModel::tableDeleted ( const IliModelHookInfo &  info )

virtual

Called when the IliSchema or IliTable object is deleted.

Parameters

info	It contains the data source index.

Reimplemented in IliChartDataModel.