rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Data Access Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IliGadgetModel Class Reference

Model class. More...

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

Inheritance diagram for IliGadgetModel:
IliModel IliChartDataModel IliDbGanttModel IliDbGanttFullModel IliDbGanttLightModel

List of all members.

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.
virtual void cellChanged (const IliModelHookInfo &info)
 Called just after a cell has changed.
virtual void columnChanged (const IliModelHookInfo &info)
 Called when a column has changed.
virtual void columnDeleted (const IliModelHookInfo &info)
 Called just after a column deletion.
virtual void columnInserted (const IliModelHookInfo &info)
 Called when a new column is inserted.
virtual void columnMoved (const IliModelHookInfo &info)
 Called just after a column has moved.
virtual void columnToBeDeleted (const IliModelHookInfo &info)
 Called just before a column deletion.
virtual void currentRowChanged (const IliModelHookInfo &info)
 Called when the data source current row has been changed.
virtual void endOfBatch ()
 Called to terminate a series of updates to the IliSchema or IliTable objects.
virtual const char * getName () const
 Returns the model name.
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.
virtual void rowDeleted (const IliModelHookInfo &info)
 Called just after a row has been deleted.
virtual void rowFetched (const IliModelHookInfo &info)
 Called just after a new row has been fetched from a remote database and inserted.
virtual void rowInserted (const IliModelHookInfo &info)
 Called just after a new row has been inserted.
virtual void rowMoved (const IliModelHookInfo &info)
 Called just after a row has moved.
virtual void rowsExchanged (const IliModelHookInfo &info)
 Called just after a row is exchanged with another row.
virtual void rowsFetched (const IliModelHookInfo &info)
 Called when many consecutive rows are fetched at once.
virtual void rowsInserted (const IliModelHookInfo &info)
 Called when many consecutive rows are inserted at once.
virtual void rowToBeChanged (const IliModelHookInfo &info)
 Called just before a row is changed.
virtual void rowToBeDeleted (const IliModelHookInfo &info)
 Called just before a row deletion.
virtual void startOfBatch ()
 Called at the start of a series of updates to the IliSchema or IliTable object.
virtual void tableChanged (const IliModelHookInfo &info)
 Called when the object has undergone a significant number of changes.
virtual void tableDeleted (const IliModelHookInfo &info)
 Called when the IliSchema or IliTable object is deleted.

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.


© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.