Gadget class. More...

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

Inheritance diagram for IliDbTreeGadget:

Public Member Functions
	IliDbTreeGadget (IlvDisplay display, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette palette=0)
	This constructor creates a tree gadget that can be connected to a set of data sources. More...

void	addErrorSink (IliErrorSink *sink)
	Adds an error sink. More...

void	dontContinueProcess ()
	Stops the current process (deleting, inserting or editing).

void	enableItemDeletion (IlBoolean enable)
	Enables/disables the items deletion. More...

void	enableItemEdition (IlBoolean enable)
	Enables/disables the items editing. More...

void	enableItemInsertion (IlBoolean enable)
	Enables/disables the items insertion. More...

const char *	getBitmapColumnName (IlInt dsi) const
	Returns the bitmap item column name. More...

IlInt	getDeletedItemDataSourceIndex () const
	Returns the data source index of the deleted item. More...

const IliValue &	getDeletedItemIdentifier () const
	Returns the identifier of the deleted item. More...

IliErrorReporter *	getErrorReporter () const
	Returns the error reporter that is used by `reportErrors` member function. More...

const IliFormat &	getFormat (IlInt dsi=0) const
	Returns the format used to display the item. More...

const char *	getIdentifierColumnName (IlInt dsi) const
	Returns the identifier item column name. More...

IlInt	getItemDataSourceIndex (IlvTreeGadgetItem *) const
	Returns the data source index of the item. More...

const char *	getItemDialogModelName () const
	Returns the model that is used to create the item dialog. More...

IlInt	getItemRowIndex (IlvTreeGadgetItem *) const
	Returns the row index of the item. More...

const char *	getLabelColumnName (IlInt dsi) const
	Returns the label item column name. More...

const char *	getModel () const
	Returns the model that is used to build the tree gadget data. More...

const char *	getModelName () const
	Returns the model that is used to build the tree gadget data. More...

const char *	getNewItemBitmap () const
	Returns the bitmap of the new item. More...

IlInt	getNewItemDataSourceIndex () const
	Returns the data source index of the new item. More...

const IliValue &	getNewItemIdentifier () const
	Returns the identifier of the new item. More...

const char *	getNewItemLabel () const
	Returns the label of the new item. More...

const IliValue &	getNewItemParent () const
	Returns the parent identifier of the new item. More...

const char *	getParentColumnName (IlInt dsi) const
	Returns the parent item column name. More...

const char *	getPopupMenuModelName () const
	Returns the model that is used to create the item popup menu. More...

IlInt	getSelectedItemDataSourceIndex () const
	Returns the data source index of the selected item. More...

const IliValue &	getSelectedItemIdentifier () const
	Returns the identifier of the selected item. More...

IliDataSource *	getTreeDataSource (IlInt dsi) const
	Returns the data source for a tree. More...

IlInt	getTreeDataSourceCount () const
	Returns the data source count for a tree. More...

const char *	getTreeDataSourceName (IlInt dsi) const
	Returns the data source name for a tree. More...

IlBoolean	isConfirmOnDeleteRequired () const
	Returns `IlTrue` if the confirmation deletion is enabled. More...

IlBoolean	isItemDeletionEnabled () const
	Returns `IlTrue` if the items deletion is enabled. More...

IlBoolean	isItemDialogUsed () const
	Returns `IlTrue` if the item dialog is enabled. More...

IlBoolean	isItemEditionEnabled () const
	Returns `IlTrue` if the items editing is enabled. More...

IlBoolean	isItemInsertionEnabled () const
	Returns `IlTrue` if the items insertion is enabled. More...

IlBoolean	isItemPopupMenuUsed () const
	Returns `IlTrue` if the items popup menu is enabled. More...

IlBoolean	isItemsSorted () const
	Returns `IlTrue` if the items are sorted. More...

IlBoolean	isRecursiveDeletion () const
	Returns `IlTrue` if the recursive deletion is enabled. More...

virtual IlBoolean	onDeleteItem ()
	Called when an item is deleted.

virtual IlBoolean	onEditItem ()
	Called when an item is deleted.

virtual void	onIncoherentTreeData ()
	Called when an error occurs during the building of the tree.

virtual IlBoolean	onInsertChildItem ()
	Called when an child item is inserted.

virtual IlBoolean	onInsertSiblingItem ()
	Called when a sibling item is inserted.

virtual void	refreshAll ()
	Called to build and to display the tree. More...

void	removeErrorSink (IliErrorSink *sink)
	Removes an error sink from the tree gadget. More...

void	reportErrors (const IliErrorList &list) const
	Reports the errors that are contained in a list. More...

void	requireConfirmOnDelete (IlBoolean require)
	Enables/disables the deletion confirmation. More...

void	setBitmapColumnName (IlInt dsi, const char *name)
	Sets the bitmap item column name. More...

void	setErrorReporter (IliErrorReporter *reporter)
	Sets the error reporter. More...

void	setFormat (const IliFormat &fmt, IlInt dsi=-1)
	Sets the format used to display the item. More...

void	setIdentifierColumnName (IlInt dsi, const char *name)
	Sets the identifier item column name. More...

void	setItemDialogModelName (const char *name)
	Sets the model that is used to create the item dialog. More...

void	setLabelColumnName (IlInt dsi, const char *name)
	Sets the label item column name. More...

void	setModel (const char *name)
	Sets the model that is used to build the tree gadget data. More...

void	setModelName (const char *name)
	Sets the model that is used to build the tree gadget data. More...

void	setNewItemBitmap (const char *bitmap)
	Sets the bitmap of the new item. More...

void	setNewItemDataSourceIndex (IlInt dsi)
	Sets the data source index of the new item. More...

void	setNewItemIdentifier (const IliValue &id)
	Sets the identifier of the new item. More...

void	setNewItemLabel (const char *label)
	Sets the label of the new item. More...

void	setNewItemParent (const IliValue &id)
	Sets the parent identifier of the new item. More...

void	setParentColumnName (IlInt dsi, const char *name)
	Sets the parent item column name. More...

void	setPopupMenuModelName (const char *name)
	Sets the model that is used to create the item popup menu. More...

void	setRecursiveDeletion (IlBoolean enable)
	Enables/disables the recursive deletion. More...

void	setTreeDataSource (IlInt dsi, IliDataSource *ds)
	Sets a data source for a tree. More...

void	setTreeDataSourceCount (IlInt count)
	Sets the data source count for a tree. More...

void	setTreeDataSourceName (IlInt dsi, const char *name)
	Sets a data source name for a tree. More...

void	sortItems (IlBoolean enable)
	Enables/disables the items sort. More...

void	thereIsIncoherentTreeData ()
	Called to indicate that the tree is not valid.

virtual void	treeRowChanged (IlInt dsi, IlInt rowno)
	Called immediately after a row has been changed. More...

virtual void	treeRowDeleted (IlInt dsi, IlInt rowno)
	Called immediately after a row has been deleted. More...

virtual void	treeRowFetched (IlInt dsi, IlInt rowno)
	Called immediately after a new row has been fetched from a remote database and inserted. More...

virtual void	treeRowInserted (IlInt dsi, IlInt rowno)
	Called immediately after a new row has been inserted. More...

virtual void	treeRowMoved (IlInt dsi, IlInt from, IlInt to)
	Called immediately after a row has been moved. More...

virtual void	treeRowToBeChanged (IlInt dsi, IlInt rowno)
	Called just before a row is changed. More...

virtual void	treeRowToBeDeleted (IlInt dsi, IlInt rowno)
	Called just before a row is deleted. More...

virtual void	treeTableChanged (IlInt dsi)
	Called when the object has undergone a significant number of changes. More...

virtual void	treeTableDeleted (IlInt dsi)
	Called when the schema or the table of the gadget data source is deleted. More...

void	useItemDialog (IlBoolean enable)
	Enables/disables the item dialog. More...

void	useItemPopupMenu (IlBoolean enable)
	Enables/disables the items popup menu. More...

Static Public Member Functions
static IlvSymbol *	DeleteItemSymbol ()
	Returns the name of the callback that will be called by the virtual `onDeleteItem` function. More...

static IlvSymbol *	EditItemSymbol ()
	Returns the name of the callback that will be called by the virtual `onEditItem` function. More...

static IlvSymbol *	IncoherentTreeDataSymbol ()
	Returns the name of the callback that will be called by the virtual `onIncoherentTreeData` function. More...

static IlvSymbol *	InsertChildItemSymbol ()
	Returns the name of the callback that will be called by the virtual `onInsertChildItem` function. More...

static IlvSymbol *	InsertSiblingItemSymbol ()
	Returns the name of the callback that will be called by the virtual `onInsertSiblingItem` function. More...

Friends
class	IliDbTreePopupMenuModel

Detailed Description

Gadget class.

Library: dbgadget

The IliDbTreeGadget class defines a tree gadget that works with a data source or several data sources (depending on the model). This gadget displays the links between the children and their parents. Each data source row defines a tree gadget item. To define a tree gadget, you have four columns:

Identifier-This is the identifier for the tree gadget. It must be unique.
Label-This is the label for the tree gadget item. If the column or value is null, the identifier is used as the label.
Parent-This is the parent identifier.
Bitmap-This is the bitmap for the tree gadget item.

To provide the data to the tree gadget, you can use the following models:

Recursive (IliDbTreeRecursiveModel)-All items of the tree gadget are defined by only one data source.
Structural (IliDbTreeStructuralModel)-Each tree gadget level has its own data source with its columns. The Parent column is not used for the first level.

About child - parent Each child has only one parent, but a parent may have several children. If there is not a root parent (a parent that is not in the children list), the tree gadget displays nothing. If there is a circular relation, it is broken. When an error occurs, the callback defined for the IncoherentTreeDataSymbol symbol is called.

Constructor & Destructor Documentation

§ IliDbTreeGadget()

IliDbTreeGadget::IliDbTreeGadget	(	IlvDisplay *	display,
		const IlvRect &	rect,
		IlUShort	thickness = `IlvDefaultGadgetThickness`,
		IlvPalette *	palette = `0`
	)

This constructor creates a tree gadget that can be connected to a set of data sources.

Parameters

display	The display.
rect	The location.
thickness	The border thickness.
palette	The palette.

Member Function Documentation

§ addErrorSink()

void IliDbTreeGadget::addErrorSink ( IliErrorSink * sink )

Adds an error sink.

All errors that occur on the tree gadget will be forwarded to this error sink. Note that the tree gadget will not delete the error sink at destruction time, so the same error sink can be shared safely by many tree gadgets.

Parameters

sink	The error sink.

§ DeleteItemSymbol()

static IlvSymbol* IliDbTreeGadget::DeleteItemSymbol ( )

static

Returns the name of the callback that will be called by the virtual onDeleteItem function.

Returns: The callback name.

§ EditItemSymbol()

static IlvSymbol* IliDbTreeGadget::EditItemSymbol ( )

static

Returns the name of the callback that will be called by the virtual onEditItem function.

Returns: The callback name.

§ enableItemDeletion()

void IliDbTreeGadget::enableItemDeletion ( IlBoolean enable )

Enables/disables the items deletion.

Parameters

enable If IlTrue the items deletion is enabled.

§ enableItemEdition()

void IliDbTreeGadget::enableItemEdition ( IlBoolean enable )

Enables/disables the items editing.

Parameters

enable If IlTrue the items editing is enabled.

§ enableItemInsertion()

void IliDbTreeGadget::enableItemInsertion ( IlBoolean enable )

Enables/disables the items insertion.

Parameters

enable If IlTrue the items insertion is enabled.

§ getBitmapColumnName()

const char* IliDbTreeGadget::getBitmapColumnName ( IlInt dsi ) const

Returns the bitmap item column name.

Parameters

dsi	The tree level (starting at 0). If the model is recursive, the value must be `0`.

Returns: The column name.

§ getDeletedItemDataSourceIndex()

IlInt IliDbTreeGadget::getDeletedItemDataSourceIndex ( ) const

Returns the data source index of the deleted item.

Returns: The data source index.

§ getDeletedItemIdentifier()

const IliValue& IliDbTreeGadget::getDeletedItemIdentifier ( ) const

Returns the identifier of the deleted item.

Returns: The identifier.

§ getErrorReporter()

IliErrorReporter* IliDbTreeGadget::getErrorReporter ( ) const

Returns the error reporter that is used by reportErrors member function.

Initially, this property is NULL.

Returns: The error reporter. When this property is NULL, a default error reporter is used.

§ getFormat()

const IliFormat& IliDbTreeGadget::getFormat ( IlInt dsi = 0 ) const

Returns the format used to display the item.

Parameters

dsi	The tree level or data source index (starting at 0). If the model is `IliDbTreeRecursiveModel`, the value is always `0`.

Returns: The format.

§ getIdentifierColumnName()

const char* IliDbTreeGadget::getIdentifierColumnName ( IlInt dsi ) const

Returns the identifier item column name.

Parameters

dsi	The tree level (starting at 0). If the model is recursive, the value must be `0`.

Returns: The column name.

§ getItemDataSourceIndex()

IlInt IliDbTreeGadget::getItemDataSourceIndex ( IlvTreeGadgetItem * ) const

Returns the data source index of the item.

Returns: The data source index.

§ getItemDialogModelName()

const char* IliDbTreeGadget::getItemDialogModelName ( ) const

Returns the model that is used to create the item dialog.

Returns: The model name.

§ getItemRowIndex()

IlInt IliDbTreeGadget::getItemRowIndex ( IlvTreeGadgetItem * ) const

Returns the row index of the item.

Returns: The row index.

§ getLabelColumnName()

const char* IliDbTreeGadget::getLabelColumnName ( IlInt dsi ) const

Returns the label item column name.

Parameters

dsi	The tree level (starting at 0). If the model is recursive, the value must be `0`.

Returns: The column name.

§ getModel()

const char* IliDbTreeGadget::getModel ( ) const

Returns the model that is used to build the tree gadget data.

Obsolete function

Returns: The model that is used to build the tree gadget data.

§ getModelName()

const char* IliDbTreeGadget::getModelName ( ) const

Returns the model that is used to build the tree gadget data.

Returns: The model that is used to build the tree gadget data.

§ getNewItemBitmap()

const char* IliDbTreeGadget::getNewItemBitmap ( ) const

Returns the bitmap of the new item.

Returns: The bitmap file name.

§ getNewItemDataSourceIndex()

IlInt IliDbTreeGadget::getNewItemDataSourceIndex ( ) const

Returns the data source index of the new item.

Returns: The data source index.

§ getNewItemIdentifier()

const IliValue& IliDbTreeGadget::getNewItemIdentifier ( ) const

Returns the identifier of the new item.

Returns: The identifier.

§ getNewItemLabel()

const char* IliDbTreeGadget::getNewItemLabel ( ) const

Returns the label of the new item.

Returns: The label.

§ getNewItemParent()

const IliValue& IliDbTreeGadget::getNewItemParent ( ) const

Returns the parent identifier of the new item.

Returns: The parent identifier.

§ getParentColumnName()

const char* IliDbTreeGadget::getParentColumnName ( IlInt dsi ) const

Returns the parent item column name.

Parameters

dsi	The tree level (starting at 0). If the model is recursive, the value must be `0`.

Returns: The column name.

§ getPopupMenuModelName()

const char* IliDbTreeGadget::getPopupMenuModelName ( ) const

Returns the model that is used to create the item popup menu.

Returns: The model name.

§ getSelectedItemDataSourceIndex()

IlInt IliDbTreeGadget::getSelectedItemDataSourceIndex ( ) const

Returns the data source index of the selected item.

Returns: The data source index.

§ getSelectedItemIdentifier()

const IliValue& IliDbTreeGadget::getSelectedItemIdentifier ( ) const

Returns the identifier of the selected item.

Returns: The identifier.

§ getTreeDataSource()

IliDataSource* IliDbTreeGadget::getTreeDataSource ( IlInt dsi ) const

Returns the data source for a tree.

Parameters

dsi	The tree level (starting at 0). If the model is recursive, the value must be `0`.

Returns: The data source.

§ getTreeDataSourceCount()

IlInt IliDbTreeGadget::getTreeDataSourceCount ( ) const

Returns the data source count for a tree.

Returns: The count.

§ getTreeDataSourceName()

const char* IliDbTreeGadget::getTreeDataSourceName ( IlInt dsi ) const

Returns the data source name for a tree.

Parameters

dsi	The tree level (starting at 0). If the model is recursive, the value must be `0`.

Returns: The data source name.

§ IncoherentTreeDataSymbol()

static IlvSymbol* IliDbTreeGadget::IncoherentTreeDataSymbol ( )

static

Returns the name of the callback that will be called by the virtual onIncoherentTreeData function.

Returns: The callback name.

§ InsertChildItemSymbol()

static IlvSymbol* IliDbTreeGadget::InsertChildItemSymbol ( )

static

Returns the name of the callback that will be called by the virtual onInsertChildItem function.

Returns: The callback name.

§ InsertSiblingItemSymbol()

static IlvSymbol* IliDbTreeGadget::InsertSiblingItemSymbol ( )

static

Returns the name of the callback that will be called by the virtual onInsertSiblingItem function.

Returns: The callback name.

§ isConfirmOnDeleteRequired()

IlBoolean IliDbTreeGadget::isConfirmOnDeleteRequired ( ) const

Returns IlTrue if the confirmation deletion is enabled.

Returns: IlTrue if the confirmation deletion is enabled.

§ isItemDeletionEnabled()

IlBoolean IliDbTreeGadget::isItemDeletionEnabled ( ) const

Returns IlTrue if the items deletion is enabled.

Returns: IlTrue if the items deletion is enabled.

§ isItemDialogUsed()

IlBoolean IliDbTreeGadget::isItemDialogUsed ( ) const

Returns IlTrue if the item dialog is enabled.

Returns: IlTrue if the item dialog is enabled.

§ isItemEditionEnabled()

IlBoolean IliDbTreeGadget::isItemEditionEnabled ( ) const

Returns IlTrue if the items editing is enabled.

Returns: IlTrue if the items editing is enabled.

§ isItemInsertionEnabled()

IlBoolean IliDbTreeGadget::isItemInsertionEnabled ( ) const

Returns IlTrue if the items insertion is enabled.

Returns: IlTrue if the items insertion is enabled.

§ isItemPopupMenuUsed()

IlBoolean IliDbTreeGadget::isItemPopupMenuUsed ( ) const

Returns IlTrue if the items popup menu is enabled.

Returns: IlTrue if the items popup menu is enabled.

§ isItemsSorted()

IlBoolean IliDbTreeGadget::isItemsSorted ( ) const

Returns IlTrue if the items are sorted.

Returns: IlTrue if the items are sorted.

§ isRecursiveDeletion()

IlBoolean IliDbTreeGadget::isRecursiveDeletion ( ) const

Returns IlTrue if the recursive deletion is enabled.

Returns: IlTrue if the recursive deletion is enabled.

§ refreshAll()

virtual void IliDbTreeGadget::refreshAll ( )

virtual

Called to build and to display the tree.

If the tree is not valid, it calls the onIncoherentTreeData function.

§ removeErrorSink()

void IliDbTreeGadget::removeErrorSink ( IliErrorSink * sink )

Removes an error sink from the tree gadget.

Parameters

sink	The error sink.

§ reportErrors()

void IliDbTreeGadget::reportErrors ( const IliErrorList & list ) const

Reports the errors that are contained in a list.

This member function makes use of the error reporter returned by getErrorReporter, if any. Otherwise, it uses a default error reporter.

Parameters

list	The error list.

§ requireConfirmOnDelete()

void IliDbTreeGadget::requireConfirmOnDelete ( IlBoolean require )

Enables/disables the deletion confirmation.

Parameters

require If IlTrue the deletion confirmation is enabled.

§ setBitmapColumnName()

void IliDbTreeGadget::setBitmapColumnName	(	IlInt	dsi,
		const char *	name
	)

Sets the bitmap item column name.

Parameters

dsi	The tree level (starting at 0). If the model is recursive, the value must be `0`.
name	The column name.

§ setErrorReporter()

void IliDbTreeGadget::setErrorReporter ( IliErrorReporter * reporter )

Sets the error reporter.

Note that the tree gadget will not delete the error reporter at destruction time, so the same error reporter can be shared safely by many tree gadgets.

Parameters

reporter The error reporter.

§ setFormat()

void IliDbTreeGadget::setFormat	(	const IliFormat &	fmt,
		IlInt	dsi = `-1`
	)

Sets the format used to display the item.

Parameters

fmt	The format.
dsi	The tree level or data source index (starting at 0). If the model is `IliDbTreeRecursiveModel`, the value is always `0`.If the `dsi` parameter is equal to `-1`, the format is applied to all levels.

§ setIdentifierColumnName()

void IliDbTreeGadget::setIdentifierColumnName	(	IlInt	dsi,
		const char *	name
	)

Sets the identifier item column name.

Parameters

dsi	The tree level (starting at 0). If the model is recursive, the value must be `0`.
name	The column name.

§ setItemDialogModelName()

void IliDbTreeGadget::setItemDialogModelName ( const char * name )

Sets the model that is used to create the item dialog.

Parameters

name	The model name.

§ setLabelColumnName()

void IliDbTreeGadget::setLabelColumnName	(	IlInt	dsi,
		const char *	name
	)

Sets the label item column name.

Parameters

dsi	The tree level (starting at 0). If the model is recursive, the value must be `0`.
name	The column name.

§ setModel()

void IliDbTreeGadget::setModel ( const char * name )

Sets the model that is used to build the tree gadget data.

Obsolete function

Parameters

name	The model name, the possible models are: `IliDbTreeRecursiveModel` `IliDbTreeStructuralModel`

§ setModelName()

void IliDbTreeGadget::setModelName ( const char * name )

Sets the model that is used to build the tree gadget data.

Parameters

name	The model name, the possible models are: `IliDbTreeRecursiveModel` `IliDbTreeStructuralModel`

§ setNewItemBitmap()

void IliDbTreeGadget::setNewItemBitmap ( const char * bitmap )

Sets the bitmap of the new item.

Parameters

bitmap The bitmap file name.

§ setNewItemDataSourceIndex()

void IliDbTreeGadget::setNewItemDataSourceIndex ( IlInt dsi )

Sets the data source index of the new item.

Parameters

dsi	The data source index.

§ setNewItemIdentifier()

void IliDbTreeGadget::setNewItemIdentifier ( const IliValue & id )

Sets the identifier of the new item.

Parameters

id	The identifier.

§ setNewItemLabel()

void IliDbTreeGadget::setNewItemLabel ( const char * label )

Sets the label of the new item.

Parameters

label The label.

§ setNewItemParent()

void IliDbTreeGadget::setNewItemParent ( const IliValue & id )

Sets the parent identifier of the new item.

Parameters

id	The parent identifier.

§ setParentColumnName()

void IliDbTreeGadget::setParentColumnName	(	IlInt	dsi,
		const char *	name
	)

Sets the parent item column name.

Parameters

dsi	The tree level (starting at 0). If the model is recursive, the value must be `0`.
name	The column name.

§ setPopupMenuModelName()

void IliDbTreeGadget::setPopupMenuModelName ( const char * name )

Sets the model that is used to create the item popup menu.

Parameters

name	The model name.

§ setRecursiveDeletion()

void IliDbTreeGadget::setRecursiveDeletion ( IlBoolean enable )

Enables/disables the recursive deletion.

Parameters

enable If IlTrue the recursive deletion is enabled.

§ setTreeDataSource()

void IliDbTreeGadget::setTreeDataSource	(	IlInt	dsi,
		IliDataSource *	ds
	)

Sets a data source for a tree.

Parameters

dsi	The tree level (starting at 0). If the model is recursive, the value must be `0`.
ds	The data source.

§ setTreeDataSourceCount()

void IliDbTreeGadget::setTreeDataSourceCount ( IlInt count )

Sets the data source count for a tree.

Parameters

count The data source count.

§ setTreeDataSourceName()

void IliDbTreeGadget::setTreeDataSourceName	(	IlInt	dsi,
		const char *	name
	)

Sets a data source name for a tree.

Parameters

dsi	The tree level (starting at 0). If the model is recursive, the value must be `0`.
name	The data source name.

§ sortItems()

void IliDbTreeGadget::sortItems ( IlBoolean enable )

Enables/disables the items sort.

Parameters

enable If IlTrue the items are sorted.

§ treeRowChanged()

virtual void IliDbTreeGadget::treeRowChanged	(	IlInt	dsi,
		IlInt	rowno
	)

virtual

Called immediately after a row has been changed.

Parameters

dsi	The tree level or data source index (starting at 0). If the model is `IliDbTreeRecursiveModel`, the value is always `0`.
rowno	The row position.

§ treeRowDeleted()

virtual void IliDbTreeGadget::treeRowDeleted	(	IlInt	dsi,
		IlInt	rowno
	)

virtual

Called immediately after a row has been deleted.

Parameters

dsi	The tree level or data source index (starting at 0). If the model is `IliDbTreeRecursiveModel`, the value is always `0`.
rowno	The row position.

§ treeRowFetched()

virtual void IliDbTreeGadget::treeRowFetched	(	IlInt	dsi,
		IlInt	rowno
	)

virtual

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

Parameters

dsi	The tree level or data source index (starting at 0). If the model is `IliDbTreeRecursiveModel`, the value is always `0`.
rowno	The row position.

§ treeRowInserted()

virtual void IliDbTreeGadget::treeRowInserted	(	IlInt	dsi,
		IlInt	rowno
	)

virtual

Called immediately after a new row has been inserted.

Parameters

dsi	The tree level or data source index (starting at 0). If the model is `IliDbTreeRecursiveModel`, the value is always `0`.
rowno	The row position.

§ treeRowMoved()

virtual void IliDbTreeGadget::treeRowMoved	(	IlInt	dsi,
		IlInt	from,
		IlInt	to
	)

virtual

Called immediately after a row has been moved.

Parameters

dsi	The tree level or data source index (starting at 0). If the model is `IliDbTreeRecursiveModel`, the value is always `0`.
from	The source row position.
to	The destination row position.

§ treeRowToBeChanged()

virtual void IliDbTreeGadget::treeRowToBeChanged	(	IlInt	dsi,
		IlInt	rowno
	)

virtual

Called just before a row is changed.

Parameters

dsi	The tree level or data source index (starting at 0). If the model is `IliDbTreeRecursiveModel`, the value is always `0`.
rowno	The row position.

§ treeRowToBeDeleted()

virtual void IliDbTreeGadget::treeRowToBeDeleted	(	IlInt	dsi,
		IlInt	rowno
	)

virtual

Called just before a row is deleted.

Parameters

dsi	The tree level or data source index (starting at 0). If the model is `IliDbTreeRecursiveModel`, the value is always `0`.
rowno	The row position.

§ treeTableChanged()

virtual void IliDbTreeGadget::treeTableChanged ( IlInt dsi )

virtual

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

Parameters

dsi	The tree level or data source index (starting at 0). If the model is `IliDbTreeRecursiveModel`, the value is always `0`.

§ treeTableDeleted()

virtual void IliDbTreeGadget::treeTableDeleted ( IlInt dsi )

virtual

Called when the schema or the table of the gadget data source is deleted.

Parameters

dsi	The tree level or data source index (starting at 0). If the model is `IliDbTreeRecursiveModel`, the value is always `0`.

§ useItemDialog()

void IliDbTreeGadget::useItemDialog ( IlBoolean enable )

Enables/disables the item dialog.

Parameters

enable If IlTrue the item dialog is enabled.

§ useItemPopupMenu()

void IliDbTreeGadget::useItemPopupMenu ( IlBoolean enable )

Enables/disables the items popup menu.

Parameters

enable If IlTrue the items popup menu is enabled.

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

§ IliDbTreeGadget()

Member Function Documentation

§ addErrorSink()

§ DeleteItemSymbol()

§ EditItemSymbol()

§ enableItemDeletion()

§ enableItemEdition()

§ enableItemInsertion()

§ getBitmapColumnName()

§ getDeletedItemDataSourceIndex()

§ getDeletedItemIdentifier()

§ getErrorReporter()

§ getFormat()

§ getIdentifierColumnName()

§ getItemDataSourceIndex()

§ getItemDialogModelName()

§ getItemRowIndex()

§ getLabelColumnName()

§ getModel()

§ getModelName()

§ getNewItemBitmap()

§ getNewItemDataSourceIndex()

§ getNewItemIdentifier()

§ getNewItemLabel()

§ getNewItemParent()

§ getParentColumnName()

§ getPopupMenuModelName()

§ getSelectedItemDataSourceIndex()

§ getSelectedItemIdentifier()

§ getTreeDataSource()

§ getTreeDataSourceCount()

§ getTreeDataSourceName()

§ IncoherentTreeDataSymbol()

§ InsertChildItemSymbol()

§ InsertSiblingItemSymbol()

§ isConfirmOnDeleteRequired()

§ isItemDeletionEnabled()

§ isItemDialogUsed()

§ isItemEditionEnabled()

§ isItemInsertionEnabled()

§ isItemPopupMenuUsed()

§ isItemsSorted()

§ isRecursiveDeletion()

§ refreshAll()

§ removeErrorSink()

§ reportErrors()

§ requireConfirmOnDelete()

§ setBitmapColumnName()

§ setErrorReporter()

§ setFormat()

§ setIdentifierColumnName()

§ setItemDialogModelName()

§ setLabelColumnName()

§ setModel()

§ setModelName()

§ setNewItemBitmap()

§ setNewItemDataSourceIndex()

§ setNewItemIdentifier()

§ setNewItemLabel()

§ setNewItemParent()

§ setParentColumnName()

§ setPopupMenuModelName()

§ setRecursiveDeletion()

§ setTreeDataSource()

§ setTreeDataSourceCount()

§ setTreeDataSourceName()

§ sortItems()

§ treeRowChanged()

§ treeRowDeleted()

§ treeRowFetched()

§ treeRowInserted()

§ treeRowMoved()

§ treeRowToBeChanged()

§ treeRowToBeDeleted()

§ treeTableChanged()