Gadget Class. More...

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

Inheritance diagram for IliDbGantt:

Public Member Functions
	IliDbGantt (IlvDisplay *display, const IlvRect &rect)
	This constructor initializes a Gantt chart can be connected to a set of data sources. More...

void	addDisplayColumnName (const char *name)
	Adds a column name to the list of displayed columns. More...

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

IlvGraphic *	createDefaultBreak ()
	Returns a new break graphic object. More...

IlvGraphic *	createDefaultConstraint ()
	Returns a new constraint graphic object. More...

IlvGraphic *	createDefaultLoad ()
	Returns a new work-load-curve item graphic object. More...

IlvGraphic *	createDefaultPrecedence ()
	Returns a new precedence graphic object. More...

virtual IlvGraphic *	createResourcesModel ()
	Called to create the resources model object. More...

void	enableDisplayFullName (IlBoolean flag)
	Enables or disables the full display of the name of the month or the name of the day of the week. More...

IlInt	getActColumnIndex (IliDbGanttActCols typ) const
	Returns an activity column index. More...

const char *	getActColumnName (IliDbGanttActCols typ) const
	Returns an activity column name. More...

IliDataSource *	getActDataSource () const
	Returns the activities data source. More...

const char *	getActDataSourceName () const
	Returns the activities data source name. More...

IlvColor *	getActivePeriodColor () const
	Returns the active period color. More...

IlInt	getActivePeriodInfo (IliDateInfo info) const
	Returns the desired information about the current period. More...

IlvColor *	getBreakColor () const
	Returns the break color. More...

IlInt	getBrkColumnIndex (IliDbGanttBrkCols typ) const
	Returns a break column index. More...

const char *	getBrkColumnName (IliDbGanttBrkCols typ) const
	Returns a break column name. More...

IliDataSource *	getBrkDataSource () const
	Returns the breaks data source. More...

const char *	getBrkDataSourceName () const
	Returns the breaks data source name. More...

const IliDbGanttInfo &	getCallbackInformation () const
	Returns the information about the internal Gantt chart event. More...

IlInt	getCntColumnIndex (IliDbGanttCntCols typ) const
	Returns a constraint column index. More...

const char *	getCntColumnName (IliDbGanttCntCols typ) const
	Returns a constraint column name. More...

IliDataSource *	getCntDataSource () const
	Returns the constraints data source. More...

const char *	getCntDataSourceName () const
	Returns the constraints data source name. More...

IlvColor *	getDelimiterColor () const
	Returns the activity delimiter color. More...

IlInt	getDisplayColumnCount () const
	Returns the displayed column count. More...

IlInt	getDisplayColumnIndex (IlInt pos) const
	Returns a displayed column index. More...

const char *	getDisplayColumnName (IlInt pos) const
	Returns a displayed column name. More...

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

IliDbGanttCallback	getGanttCallback (IliDbGanttCallbackName name) const
	Returns the callback associated with an internal Gantt chart event. More...

IlAny	getGanttCallbackData (IliDbGanttCallbackName name) const
	Returns the user data associated with an internal Gantt chart event. More...

IlvColor *	getInactivePeriodColor () const
	Returns the inactive period color. More...

IlInt	getLoaColumnIndex (IliDbGanttLoaCols typ) const
	Returns a work-load-curve column index. More...

const char *	getLoaColumnName (IliDbGanttLoaCols typ) const
	Returns a work-load-curve column name. More...

IliDataSource *	getLoaDataSource () const
	Returns the work-load-curve data source. More...

const char *	getLoaDataSourceName () const
	Returns the work-load-curve data source name. More...

IlvColor *	getLoadColor () const
	Returns the work-load-curve color. More...

IliDbGanttModel *	getModel () const
	Returns The data model. More...

const char *	getModelName () const
	Returns the data model name. More...

const char *	getObjectNameDoubleClicked () const
	Returns the object name that has been double-clicked. More...

IlvColor *	getPrecedenceColor () const
	Returns the default precedence color. More...

IlInt	getPreColumnIndex (IliDbGanttPreCols typ) const
	Returns a precedence column index. More...

const char *	getPreColumnName (IliDbGanttPreCols typ) const
	Returns a precedence column name. More...

IliDataSource *	getPreDataSource () const
	Returns the precedences data source. More...

const char *	getPreDataSourceName () const
	Returns the precedences data source name. More...

IlInt	getReferenceMonth () const
	Returns the reference month. More...

IlInt	getReferenceYear () const
	Returns the reference year. More...

IlInt	getResColumnIndex (IliDbGanttResCols typ) const
	Returns a resource column index. More...

const char *	getResColumnName (IliDbGanttResCols typ) const
	Returns a resource column name. More...

IliDataSource *	getResDataSource () const
	Returns the resources data source. More...

const char *	getResDataSourceName () const
	Returns the resources data source name. More...

IlInt	getScaleNumericValue () const
	Returns the numeric value of the current step of the scale. More...

IliDbScaleType	getScaleType () const
	Returns the scale type. More...

IliScaleUnit	getScaleUnit () const
	Returns the scale unit. More...

virtual IlBoolean	isActivePeriod (const IliDate &info)
	Returns `IlTrue` if the period is active. More...

IlBoolean	isActivePeriodWithRules (const IliDate &info)
	Returns `IlTrue` if the period is active when you use the rules that have been defined with the inspector. More...

IlBoolean	isDeletionEventPropagated () const
	Returns `IlTrue` if the option to propagate deletion events is enabled. More...

IlBoolean	isDisplayFullNameEnabled () const
	Returns `IlTrue` if the full display is enabled. More...

IlBoolean	isInteractionDataSourceToGantt () const
	Returns `IlTrue` if the option for interaction between data sources and Gantt chart is enabled. More...

IlBoolean	isReadOnly () const
	Returns `IlTrue` if the Gantt chart is read-only. More...

IlBoolean	isUpdateEventPropagated () const
	Returns `IlTrue` if the option to propagate update events is enabled. More...

virtual void	onConstraintDoubleClicked ()
	Called when a constraint has been double-clicked.

virtual IlvGraphic *	onCreateBreak ()
	Called to create a new break graphic object. More...

virtual IlvGraphic *	onCreateConstraint ()
	Called to create a new constraint graphic object. More...

virtual IlvGraphic *	onCreateLoad ()
	Called to create a new work-load-curve item graphic object. More...

virtual IlvGraphic *	onCreatePrecedence ()
	Called to create a new precedence graphic object. More...

virtual void	onDeleteBreak ()
	Called when a break is deleted.

virtual void	onDeleteConstraint ()
	Called when a constraint is deleted.

virtual void	onDeleteLoad ()
	Called when a work-load-curve item is deleted.

virtual void	onDeletePrecedence ()
	Called when a precedence is deleted.

virtual void	onPrecedenceDoubleClicked ()
	Called when a precedence has been double-clicked.

virtual IlvGraphic *	onReplaceBreak (IlvGraphic *old)
	Called to replace a break. More...

virtual IlvGraphic *	onReplaceConstraint (IlvGraphic *old)
	Called to replace a constraint. More...

virtual IlvGraphic *	onReplaceLoad (IlvGraphic *old)
	Called to replace a work-load-curve item. More...

virtual IlvGraphic *	onReplacePrecedence (IlvGraphic *old)
	Called to replace a precedence. More...

void	propagateDeletionEvent (IlBoolean flag)
	Enables or disables the option to propagate deletion events. More...

void	propagateUpdateEvent (IlBoolean flag)
	Enables or disables the option to propagate update events. More...

void	refreshAll ()
	Refreshes the display of all Gantt chart objects.

void	removeAllDisplayColumns ()
	Removes all columns displayed by the Gantt chart. More...

void	removeErrorSink (IliErrorSink *sink, IliDbGanttWhichDs dsi)
	Removes an error sink from the Gantt chart. More...

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

void	setActColumnName (IliDbGanttActCols typ, const char *name)
	Sets an activity column name. More...

void	setActDataSource (IliDataSource *ds)
	Sets the activities data source. More...

void	setActDataSourceName (const char *name)
	Sets the activities data source name. More...

void	setActivePeriodColor (IlvColor *color)
	Sets the active period color. More...

void	setBreakColor (IlvColor *color)
	Sets the break color. More...

void	setBrkColumnName (IliDbGanttBrkCols typ, const char *name)
	Sets a break column name. More...

void	setBrkDataSource (IliDataSource *ds)
	Sets the breaks data source. More...

void	setBrkDataSourceName (const char *name)
	Sets the breaks data source name. More...

void	setCntColumnName (IliDbGanttCntCols typ, const char *name)
	Sets a constraint column name. More...

void	setCntDataSource (IliDataSource *ds)
	Sets the constraints data source. More...

void	setCntDataSourceName (const char *name)
	Sets the constraints data source name. More...

void	setDelimiterColor (IlvColor *color)
	Sets the constraint delimiter color. More...

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

void	setGanttCallback (IliDbGanttCallbackName name, IliDbGanttCallback cb, IlAny arg=0)
	Associates a callback with an internal Gantt chart event. More...

void	setInactivePeriod ()
	Indicates that the current period is inactive.

void	setInactivePeriodColor (IlvColor *color)
	Sets the inactive period color. More...

void	setInteractionDataSourceToGantt (IlBoolean flag)
	Enables or disables the interaction between data sources and Gantt chart. More...

void	setLoaColumnName (IliDbGanttLoaCols typ, const char *name)
	Sets the work-load-curve column name. More...

void	setLoaDataSource (IliDataSource *ds)
	Sets the work-load-curve data source. More...

void	setLoaDataSourceName (const char *name)
	Sets the work-load-curve data source name. More...

void	setLoadColor (IlvColor *color)
	Sets the work-load-curve color. More...

void	setModelName (const char *name)
	Sets the data model name. More...

void	setPrecedenceColor (IlvColor *color)
	Sets the default precedence color. More...

void	setPreColumnName (IliDbGanttPreCols typ, const char *name)
	Sets a precedence column name. More...

void	setPreDataSource (IliDataSource *ds)
	Sets the precedences data source. More...

void	setPreDataSourceName (const char *name)
	Sets the precedences data source name. More...

void	setReadOnly (IlBoolean flag)
	Enables or disable the read-only option. More...

void	setReferenceMonth (IlInt m)
	Sets the reference month. More...

void	setReferenceYear (IlInt y)
	Sets the reference year. More...

void	setResColumnName (IliDbGanttResCols typ, const char *name)
	Sets a resource column name. More...

void	setResDataSource (IliDataSource *ds)
	Sets the resources data source. More...

void	setResDataSourceName (const char *name)
	Sets the resources data source name. More...

void	setScaleNumericLabel (const char *label)
	Sets the label of the current step of the scale. More...

void	setScaleType (IliDbScaleType typ)
	Sets the scale type. More...

void	setScaleUnit (IliScaleUnit unit)
	Sets the scale unit. More...

Static Public Member Functions
static IlSymbol *	ConstraintDoubleClickedSymbol ()
	Returns the callback name for an event: a constraint double-clicked. More...

static IlvSymbol *	IsActivePeriodSymbol ()
	Returns the callback name that is called when the inactive periods are computed. More...

static IlSymbol *	PrecedenceDoubleClickedSymbol ()
	Returns the callback name for event: a precedence double-clicked. More...

static IlSymbol *	ScaleNumericLabelSymbol ()
	Returns the callback name that is called to define the labels of the scale if the scale type is `IliDbScaleTypeNumeric`. More...

Friends
class	IliDbGanttModel

Detailed Description

Gadget Class.

Library: dbgantt

The IliDbGantt class defines a Gantt chart connected to some data sources. The data of the Gantt chart are managed by a data model. Each data model has its data sources with its columns. There are two models:

The scales can range from 0 to n where n is an integer. You can use the functions for scales to change the display unit and the type of the scale.

With the inspector, you can define rules to specify the inactive periods for all resources. You can also use the IsActivePeriod callback to indicate if a period is inactive. This callback is called when the scales are built.

Accessors

Accessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods IlvValueInterface::queryValue(), IlvValueInterface::queryValues(), IlvValueInterface::changeValue(), IlvValueInterface::changeValues(). This class inherits the accessors of its superclass IlvGanttChartForm and adds the following ones:

Name	Type	Equivalent methods
`actDataSourceName`	String	`getActDataSourceName()`, `setActDataSourceName()`
`actEndMaxColumnName`	String	`getActColumnName(IliDbGanttActEndMax)`, `setActColumnName(IliDbGanttActEndMax, .)`
`actEndMinColumnName`	String	`getActColumnName(IliDbGanttActEndMin)`, `setActColumnName(IliDbGanttActEndMin, .)`
`actIdentifierColumnName`	String	`getActColumnName(IliDbGanttActIdentifier)`, `setActColumnName(IliDbGanttActIdentifier, .)`
`activePeriodColor`	Color	`getActivePeriodColor()`, `setActivePeriodColor()`
`actLabelColumnName`	String	`getActColumnName(IliDbGanttActLabel)`, `setActColumnName(IliDbGanttActLabel, .)`
`actStartMaxColumnName`	String	`getActColumnName(IliDbGanttActStartMax)`, `setActColumnName(IliDbGanttActStartMax, .)`
`actStartMinColumnName`	String	`getActColumnName(IliDbGanttActStartMin)`, `setActColumnName(IliDbGanttActStartMin, .)`
`breakColor`	Color	`getBreakColor()`, `setBreakColor()`
`brkDataSourceName`	String	`getBrkDataSourceName()`, `setBrkDataSourceName()`
`brkFromColumnName`	String	`getBrkColumnName(IliDbGanttBrkFrom)`, `setBrkColumnName(IliDbGanttBrkFrom, .)`
`brkIdentifierColumnName`	String	`getBrkColumnName(IliDbGanttBrkIdentifier)`, `setBrkColumnName(IliDbGanttBrkIdentifier, .)`
`brkResIdentifierColumnName`	String	`getBrkColumnName(IliDbGanttBrkResIdentifier)`, `setBrkColumnName(IliDbGanttBrkResIdentifier, .)`
`brkToColumnName`	String	`getBrkColumnName(IliDbGanttBrkTo)`, `setBrkColumnName(IliDbGanttBrkTo, .)`
`cntActIdentifierColumnName`	String	`getCntColumnName(IliDbGanttCntActIdentifier)`, `setCntColumnName(IliDbGanttCntActIdentifier, .)`
`cntBackgroundColumnName`	String	`getCntColumnName(IliDbGanttCntBackground)`, `setCntColumnName(IliDbGanttCntBackground, .)`
`cntCapacityColumnName`	String	`getCntColumnName(IliDbGanttCntCapacity)`, `setCntColumnName(IliDbGanttCntCapacity, .)`
`cntDataSourceName`	String	`getCntDataSourceName()`, `setCntDataSourceName()`
`cntForegroundColumnName`	String	`getCntColumnName(IliDbGanttCntForeground)`, `setCntColumnName(IliDbGanttCntForeground, .)`
`cntIdentifierColumnName`	String	`getCntColumnName(IliDbGanttCntIdentifier)`, `setCntColumnName(IliDbGanttCntIdentifier, .)`
`cntResIdentifierColumnName`	String	`getCntColumnName(IliDbGanttCntResIdentifier)`, `setCntColumnName(IliDbGanttCntResIdentifier, .)`
`delimiterColor`	Color	`getDelimiterColor()`, `setDelimiterColor()`
`inactivePeriodColor`	Color	`getInactivePeriodColor()`, `setInactivePeriodColor()`
`interactionDataSourceToGantt`	Boolean	`isInteractionDataSourceToGantt()`, `setInteractionDataSourceToGantt()`
`loaCapacityColumnName`	String	`getLoaColumnName(IliDbGanttLoaCapacity)`, `setLoaColumnName(IliDbGanttLoaCapacity, .)`
`loaDataSourceName`	String	`getLoaDataSourceName()`, `setLoaDataSourceName()`
`loadColor`	Color	`getLoadColor()`, `setLoadColor()`
`loaFromColumnName`	String	`getLoaColumnName(IliDbGanttLoaFrom)`, `setLoaColumnName(IliDbGanttLoaFrom, .)`
`loaResIdentifierColumnName`	String	`getLoaColumnName(IliDbGanttLoaResIdentifier)`, `setLoaColumnName(IliDbGanttLoaResIdentifier, .)`
`loaToColumnName`	String	`getLoaColumnName(IliDbGanttLoaTo)`, `setLoaColumnName(IliDbGanttLoaTo, .)`
`objectNameDoubleClicked`	String	`getObjectNameDoubleClicked()`
`periodInfoDay`	Int	`getActivePeriodInfo(IliDateInfoDay)`
`periodInfoHour`	Int	`getActivePeriodInfo(IliDateInfoHour)`
`periodInfoMinute`	Int	`getActivePeriodInfo(IliDateInfoMinute)`
`periodInfoMonth`	Int	`getActivePeriodInfo(IliDateInfoMonth)`
`periodInfoNumeric`	Int	`getActivePeriodInfo(IliDateInfoNumeric)`
`periodInfoSecond`	Int	`getActivePeriodInfo(IliDateInfoSecond)`
`periodInfoWeekDay`	Int	`getActivePeriodInfo(IliDateInfoWeekDay)`
`periodInfoYear`	Int	`getActivePeriodInfo(IliDateInfoYear)`
`precedenceColor`	Color	`getPrecedenceColor()`, `setPrecedenceColor()`
`preColorColumnName`	Color	`getPreColumnName(IliDbGanttPreColor)`, `setPreColumnName(IliDbGanttPreColor, .)`
`preDataSourceName`	String	`getPreDataSourceName()`, `setPreDataSourceName()`
`preDelayColumnName`	String	`getPreColumnName(IliDbGanttPreDelay)`, `setPreColumnName(IliDbGanttPreDelay, .)`
`preFromColumnName`	String	`getPreColumnName(IliDbGanttPreFrom)`, `setPreColumnName(IliDbGanttPreFrom, .)`
`preToColumnName`	String	`getPreColumnName(IliDbGanttPreTo)`, `setPreColumnName(IliDbGanttPreTo, .)`
`preTypeColumnName`	String	`getPreColumnName(IliDbGanttPreType)`, `setPreColumnName(IliDbGanttPreType, .)`
`propagateDeletionEvent`	Boolean	`isDeletionEventPropagated()`, `propagateDeletionEvent()`
`propagateUpdateEvent`	Boolean	`isUpdateEventPropagated()`, `propagateUpdateEvent()`
`readOnly`	Boolean	`isReadOnly()`, `setReadOnly()`
`referenceMonth`	Int	`getReferenceMonth()`, `setReferenceMonth()`
`referenceYear`	Int	`getReferenceYear()`, `setReferenceYear()`
`resDataSourceName`	String	`getResDataSourceName()`, `setResDataSourceName()`
`resHeightColumnName`	String	`getPreColumnName(IliDbGanttResHeight)`, `setResColumnName(IliDbGanttResHeight, .)`
`resIdentifierColumnName`	String	`getPreColumnName(IliDbGanttResIdentifier)`, `setResColumnName(IliDbGanttResIdentifier, .)`
`scaleDisplayFullName`	Boolean	`isDisplayFullNameEnabled()`, `enableDisplayFullName()`
`scaleNumericValue`	Int	`getScaleNumericValue()`
`scaleType`	Object	`getScaleType()`, `setScaleType()`
`scaleUnit`	Object	`getScaleUnit()`, `setScaleUnit()`

Method accessors

Name	Return type	Equivalent methods
`addDisplayColumnName(String name)`	Void	`addDisplayColumnName(name)`
`getDisplayColumnCount()`	Int	`getDisplayColumnCount()`
`getDisplayColumnName(Int index)`	String	`getDisplayColumnName(index)`
`refreshAll()`	Void	`refreshAll()`
`removeAllDisplayColumns()`	Void	`removeAllDisplayColumns()`
`setInactivePeriod()`	Void	`setInactivePeriod()`
`setScaleNumericLabel(String label)`	Void	`setScaleNumericLabel(label)`

The data sources are as follows.

Resources with the following columns:
- Identifier
- Height (must be an integer and larger than 0)
Activities with the following columns:
- Start min (must be an integer and start at 0)
- Start max (must be an integer and start at 0)
- End min (must be an integer and start at 0)
- End max (must be an integer and start at 0)
- Identifier
- Label
Constraints (associates a resource with an activity) with the following columns:
- Identifier
- Resource identifier
- Activity identifier
- Capacity (must be an integer and larger than 0).
- Foreground (must be a string). This column is optional.
- Background (must be a string). This column is optional.
Precedences (link between constraints) with the following columns:
- Source constraint
- Destination constraint
- Type (must be an integer between 0 and 3)
- Delay (must be an integer)
- Color (must be a string). This column is optional.
Breaks (the inactive period for a specific resource) with the following columns:
- Identifier
- Resource identifier
- From (must be an integer and start at 0).
- To (must be an integer and start at 0).
Work load curve with the following columns:
- Resource identifier.
- From (must be an integer and start at 0).
- To (must be an integer and start at 0).
- Capacity (must be an integer and larger than 0).

The scales start from 0 to n where n is an integer. You can use the functions about scales to change the unit and type of scale.

With the inspector, you can define rules to specify the inactive periods for all resources. However, you can also use the IsActivePeriod callback to indicate if a period is inactive. This callback is called when the scales are built.

The identifiers of all objects (resources, activities, ...) must be unique.

Constructor & Destructor Documentation

§ IliDbGantt()

IliDbGantt::IliDbGantt	(	IlvDisplay *	display,
		const IlvRect &	rect
	)

This constructor initializes a Gantt chart can be connected to a set of data sources.

Parameters

display	The display.
rect	The location.

Member Function Documentation

§ addDisplayColumnName()

void IliDbGantt::addDisplayColumnName ( const char * name )

Adds a column name to the list of displayed columns.

Parameters

name	The column name.

§ addErrorSink()

void IliDbGantt::addErrorSink	(	IliErrorSink *	sink,
		IliDbGanttWhichDs	dsi
	)

Adds an error sink.

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

Parameters

sink	The error sink.
dsi	The data source index.

§ ConstraintDoubleClickedSymbol()

static IlSymbol* IliDbGantt::ConstraintDoubleClickedSymbol ( )

static

Returns the callback name for an event: a constraint double-clicked.

Returns: The callback name for an event: a constraint double-clicked.

§ createDefaultBreak()

IlvGraphic* IliDbGantt::createDefaultBreak ( )

Returns a new break graphic object.

Returns: A new break graphic object.

§ createDefaultConstraint()

IlvGraphic* IliDbGantt::createDefaultConstraint ( )

Returns a new constraint graphic object.

Returns: A new constraint graphic object.

§ createDefaultLoad()

IlvGraphic* IliDbGantt::createDefaultLoad ( )

Returns a new work-load-curve item graphic object.

Returns: A new work-load-curve item graphic object.

§ createDefaultPrecedence()

IlvGraphic* IliDbGantt::createDefaultPrecedence ( )

Returns a new precedence graphic object.

Returns: A new precedence graphic object.

§ createResourcesModel()

virtual IlvGraphic* IliDbGantt::createResourcesModel ( )

virtual

Called to create the resources model object.

This object inherits from IlMatrix.

Returns: The created object.

§ enableDisplayFullName()

void IliDbGantt::enableDisplayFullName ( IlBoolean flag )

Enables or disables the full display of the name of the month or the name of the day of the week.

Parameters

flag	if `IlTrue`, the full display is enabled.

§ getActColumnIndex()

IlInt IliDbGantt::getActColumnIndex ( IliDbGanttActCols typ ) const

Returns an activity column index.

The default value is -1.

Parameters

typ	The column type.

Returns: The column index.

§ getActColumnName()

const char* IliDbGantt::getActColumnName ( IliDbGanttActCols typ ) const

Returns an activity column name.

The default value is an empty string.

Parameters

typ	The column type.

Returns: The column name.

§ getActDataSource()

IliDataSource* IliDbGantt::getActDataSource ( ) const

Returns the activities data source.

The default value is 0.

Returns: The data source.

§ getActDataSourceName()

const char* IliDbGantt::getActDataSourceName ( ) const

Returns the activities data source name.

The default value is an empty string.

Returns: The data source name.

§ getActivePeriodColor()

IlvColor* IliDbGantt::getActivePeriodColor ( ) const

Returns the active period color.

The default value is white.

Returns: The color.

§ getActivePeriodInfo()

IlInt IliDbGantt::getActivePeriodInfo ( IliDateInfo info ) const

Returns the desired information about the current period.

Parameters

info	The information name.

Returns: The desired information about the current period.

§ getBreakColor()

IlvColor* IliDbGantt::getBreakColor ( ) const

Returns the break color.

The default value is green.

Returns: The color.

§ getBrkColumnIndex()

IlInt IliDbGantt::getBrkColumnIndex ( IliDbGanttBrkCols typ ) const

Returns a break column index.

The default value is -1.

Parameters

typ	The column type.

Returns: The column index.

§ getBrkColumnName()

const char* IliDbGantt::getBrkColumnName ( IliDbGanttBrkCols typ ) const

Returns a break column name.

The default value is an empty string.

Parameters

typ	The column type.

Returns: The column name.

§ getBrkDataSource()

IliDataSource* IliDbGantt::getBrkDataSource ( ) const

Returns the breaks data source.

The default value is 0.

Returns: The data source.

§ getBrkDataSourceName()

const char* IliDbGantt::getBrkDataSourceName ( ) const

Returns the breaks data source name.

The default value is an empty string.

Returns: The data source name.

§ getCallbackInformation()

const IliDbGanttInfo& IliDbGantt::getCallbackInformation ( ) const

Returns the information about the internal Gantt chart event.

Returns: The information about the internal Gantt chart event.

§ getCntColumnIndex()

IlInt IliDbGantt::getCntColumnIndex ( IliDbGanttCntCols typ ) const

Returns a constraint column index.

The default value is -1.

Parameters

typ	The column type.

Returns: The column index.

§ getCntColumnName()

const char* IliDbGantt::getCntColumnName ( IliDbGanttCntCols typ ) const

Returns a constraint column name.

The default value is an empty string.

Parameters

typ	The column type.

Returns: The column name.

§ getCntDataSource()

IliDataSource* IliDbGantt::getCntDataSource ( ) const

Returns the constraints data source.

The default value is 0.

Returns: The data source.

§ getCntDataSourceName()

const char* IliDbGantt::getCntDataSourceName ( ) const

Returns the constraints data source name.

The default value is an empty string.

Returns: The data source name.

§ getDelimiterColor()

IlvColor* IliDbGantt::getDelimiterColor ( ) const

Returns the activity delimiter color.

The default value is red.

Returns: The color.

§ getDisplayColumnCount()

IlInt IliDbGantt::getDisplayColumnCount ( ) const

Returns the displayed column count.

Returns: The displayed column count.

§ getDisplayColumnIndex()

IlInt IliDbGantt::getDisplayColumnIndex ( IlInt pos ) const

Returns a displayed column index.

The default value is -1.

Parameters

pos	The column position.

Returns: A displayed column index.

§ getDisplayColumnName()

const char* IliDbGantt::getDisplayColumnName ( IlInt pos ) const

Returns a displayed column name.

The default value is an empty string.

Parameters

pos	The column position.

Returns: A displayed column name.

§ getErrorReporter()

IliErrorReporter* IliDbGantt::getErrorReporter ( ) const

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

Initially, this property is 0.

Returns: The error reporter that is used by the reportErrors member function. When this property is 0, a default error reporter is used.

§ getGanttCallback()

IliDbGanttCallback IliDbGantt::getGanttCallback ( IliDbGanttCallbackName name ) const

Returns the callback associated with an internal Gantt chart event.

Parameters

name	The callback name.

Returns: The callback associated with an internal Gantt chart event. The default value is 0.

§ getGanttCallbackData()

IlAny IliDbGantt::getGanttCallbackData ( IliDbGanttCallbackName name ) const

Returns the user data associated with an internal Gantt chart event.

Parameters

name	The callback name.

Returns: The user data associated with an internal Gantt chart event. The default value is 0.

§ getInactivePeriodColor()

IlvColor* IliDbGantt::getInactivePeriodColor ( ) const

Returns the inactive period color.

The default value is gray.

Returns: The color.

§ getLoaColumnIndex()

IlInt IliDbGantt::getLoaColumnIndex ( IliDbGanttLoaCols typ ) const

Returns a work-load-curve column index.

The default value is -1.

Parameters

typ	The column type.

Returns: The column index.

§ getLoaColumnName()

const char* IliDbGantt::getLoaColumnName ( IliDbGanttLoaCols typ ) const

Returns a work-load-curve column name.

The default value is an empty string.

Parameters

typ	The column type.

Returns: The column name.

§ getLoaDataSource()

IliDataSource* IliDbGantt::getLoaDataSource ( ) const

Returns the work-load-curve data source.

The default value is 0.

Returns: The data source.

§ getLoaDataSourceName()

const char* IliDbGantt::getLoaDataSourceName ( ) const

Returns the work-load-curve data source name.

The default value is an empty string.

Returns: The data source name.

§ getLoadColor()

IlvColor* IliDbGantt::getLoadColor ( ) const

Returns the work-load-curve color.

The default value is red.

Returns: The color.

§ getModel()

IliDbGanttModel* IliDbGantt::getModel ( ) const

Returns The data model.

Returns: The model.

§ getModelName()

const char* IliDbGantt::getModelName ( ) const

Returns the data model name.

Returns: The model name.

§ getObjectNameDoubleClicked()

const char* IliDbGantt::getObjectNameDoubleClicked ( ) const

Returns the object name that has been double-clicked.

Returns: The object name that has been double-clicked.

§ getPrecedenceColor()

IlvColor* IliDbGantt::getPrecedenceColor ( ) const

Returns the default precedence color.

The default value is dark green.

Returns: The color.

§ getPreColumnIndex()

IlInt IliDbGantt::getPreColumnIndex ( IliDbGanttPreCols typ ) const

Returns a precedence column index.

The default value is -1.

Parameters

typ	The column type.

Returns: The column index.

§ getPreColumnName()

const char* IliDbGantt::getPreColumnName ( IliDbGanttPreCols typ ) const

Returns a precedence column name.

The default value is an empty string.

Parameters

typ	The column type.

Returns: The column name.

§ getPreDataSource()

IliDataSource* IliDbGantt::getPreDataSource ( ) const

Returns the precedences data source.

The default value is 0.

Returns: The data source.

§ getPreDataSourceName()

const char* IliDbGantt::getPreDataSourceName ( ) const

Returns the precedences data source name.

The default value is an empty string.

Returns: The data source name.

§ getReferenceMonth()

IlInt IliDbGantt::getReferenceMonth ( ) const

Returns the reference month.

The default value is 1.

Returns: The reference month.

§ getReferenceYear()

IlInt IliDbGantt::getReferenceYear ( ) const

Returns the reference year.

The default value is 1998.

Returns: The reference year.

§ getResColumnIndex()

IlInt IliDbGantt::getResColumnIndex ( IliDbGanttResCols typ ) const

Returns a resource column index.

The default value is -1.

Parameters

typ	The column type.

Returns: The column index.

§ getResColumnName()

const char* IliDbGantt::getResColumnName ( IliDbGanttResCols typ ) const

Returns a resource column name.

The default value is an empty string.

Parameters

typ	The column type.

Returns: The column name.

§ getResDataSource()

IliDataSource* IliDbGantt::getResDataSource ( ) const

Returns the resources data source.

The default value is 0.

Returns: The data source.

§ getResDataSourceName()

const char* IliDbGantt::getResDataSourceName ( ) const

Returns the resources data source name.

The default value is an empty string.

Returns: The data source name.

§ getScaleNumericValue()

IlInt IliDbGantt::getScaleNumericValue ( ) const

Returns the numeric value of the current step of the scale.

This function is used when a callback to define the labels of the numeric scale is added.

Returns: The numeric value of the current step of the scale.

§ getScaleType()

IliDbScaleType IliDbGantt::getScaleType ( ) const

Returns the scale type.

The default value is IliDbScaleTypeDate.

Returns: The scale type.

§ getScaleUnit()

IliScaleUnit IliDbGantt::getScaleUnit ( ) const

Returns the scale unit.

The default value is IliScaleUnitDay.

Returns: The scale unit.

§ isActivePeriod()

virtual IlBoolean IliDbGantt::isActivePeriod ( const IliDate & info )

virtual

Returns IlTrue if the period is active.

Returns: IlTrue if the period is active. If you have defined a callback, this function returns IlTrue if you do not call the setInactivePeriod() function. Otherwise, it returns IlFalse.

§ IsActivePeriodSymbol()

static IlvSymbol* IliDbGantt::IsActivePeriodSymbol ( )

static

Returns the callback name that is called when the inactive periods are computed.

Returns: The callback name that is called when the inactive periods are computed.

§ isActivePeriodWithRules()

IlBoolean IliDbGantt::isActivePeriodWithRules ( const IliDate & info )

Returns IlTrue if the period is active when you use the rules that have been defined with the inspector.

Parameters

info	The period information.

Returns: IlTrue if the period is active when you use the rules that have been defined with the inspector.

§ isDeletionEventPropagated()

IlBoolean IliDbGantt::isDeletionEventPropagated ( ) const

Returns IlTrue if the option to propagate deletion events is enabled.

The default value is IlTrue.

Returns: IlTrue if the option to propagate deletion events is enabled.

§ isDisplayFullNameEnabled()

IlBoolean IliDbGantt::isDisplayFullNameEnabled ( ) const

Returns IlTrue if the full display is enabled.

The default value is IlTrue.

Returns: IlTrue if the full display is enabled.

§ isInteractionDataSourceToGantt()

IlBoolean IliDbGantt::isInteractionDataSourceToGantt ( ) const

Returns IlTrue if the option for interaction between data sources and Gantt chart is enabled.

The default value is IlTrue.

Returns: IlTrue if the option for interaction between data sources and Gantt chart is enabled.

§ isReadOnly()

IlBoolean IliDbGantt::isReadOnly ( ) const

Returns IlTrue if the Gantt chart is read-only.

The default value is IlFalse.

Returns: IlTrue if the Gantt chart is read-only.

§ isUpdateEventPropagated()

IlBoolean IliDbGantt::isUpdateEventPropagated ( ) const

Returns IlTrue if the option to propagate update events is enabled.

The default value is IlTrue.

Returns: IlTrue if the option to propagate update events is enabled.

§ onCreateBreak()

virtual IlvGraphic* IliDbGantt::onCreateBreak ( )

virtual

Called to create a new break graphic object.

Returns: The created object.

§ onCreateConstraint()

virtual IlvGraphic* IliDbGantt::onCreateConstraint ( )

virtual

Called to create a new constraint graphic object.

Returns: The created object.

§ onCreateLoad()

virtual IlvGraphic* IliDbGantt::onCreateLoad ( )

virtual

Called to create a new work-load-curve item graphic object.

Returns: The created object.

§ onCreatePrecedence()

virtual IlvGraphic* IliDbGantt::onCreatePrecedence ( )

virtual

Called to create a new precedence graphic object.

Returns: The created object.

§ onReplaceBreak()

virtual IlvGraphic* IliDbGantt::onReplaceBreak ( IlvGraphic * old )

virtual

Called to replace a break.

By default this function returns a new object. You can return the previous object (by using the old parameter) if you subclass this class.

Parameters

old	The object which will be replaced.

Returns: A created object or a modified object.

§ onReplaceConstraint()

virtual IlvGraphic* IliDbGantt::onReplaceConstraint ( IlvGraphic * old )

virtual

Called to replace a constraint.

By default, this function returns a new object. You can return the previous object by using the old parameter if you subclass this class.

Parameters

old	The object which will be replaced.

Returns: A created object or a modified object.

§ onReplaceLoad()

virtual IlvGraphic* IliDbGantt::onReplaceLoad ( IlvGraphic * old )

virtual

Called to replace a work-load-curve item.

By default, this function returns a new object. You can return the previous object by using the old parameter if you subclass this class.

Parameters

old	The object which will be replaced.

Returns: A created object or a modified object.

§ onReplacePrecedence()

virtual IlvGraphic* IliDbGantt::onReplacePrecedence ( IlvGraphic * old )

virtual

Called to replace a precedence.

By default this function returns a new object. You can return the previous object by using the old parameter if you subclass this class.

Parameters

old	The object which will be replaced.

Returns: A created object or a modified object.

§ PrecedenceDoubleClickedSymbol()

static IlSymbol* IliDbGantt::PrecedenceDoubleClickedSymbol ( )

static

Returns the callback name for event: a precedence double-clicked.

Returns: The callback name for event: a precedence double-clicked.

§ propagateDeletionEvent()

void IliDbGantt::propagateDeletionEvent ( IlBoolean flag )

Enables or disables the option to propagate deletion events.

Parameters

flag	If `IlTrue` the propagate deletion events is enabled.

§ propagateUpdateEvent()

void IliDbGantt::propagateUpdateEvent ( IlBoolean flag )

Enables or disables the option to propagate update events.

Parameters

flag	If `IlTrue` the propagate update events is enabled.

§ removeAllDisplayColumns()

void IliDbGantt::removeAllDisplayColumns ( )

Removes all columns displayed by the Gantt chart.

If you do not call the addDisplayColumnName() member function before the next refresh, the displayed columns are not refreshed because the Gantt chart needs at least one column displayed for resources.

§ removeErrorSink()

void IliDbGantt::removeErrorSink	(	IliErrorSink *	sink,
		IliDbGanttWhichDs	dsi
	)

Removes an error sink from the Gantt chart.

Parameters

sink	The error sink.
dsi	The data source index.

§ reportErrors()

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

Reports the errors that are contained in list.

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

Parameters

list	The error list.

§ ScaleNumericLabelSymbol()

static IlSymbol* IliDbGantt::ScaleNumericLabelSymbol ( )

static

Returns the callback name that is called to define the labels of the scale if the scale type is IliDbScaleTypeNumeric.

Returns: The callback name that is called to define the labels of the scale if the scale type is IliDbScaleTypeNumeric.

§ setActColumnName()

void IliDbGantt::setActColumnName	(	IliDbGanttActCols	typ,
		const char *	name
	)

Sets an activity column name.

Parameters

typ	The column type.
name	The column name.

§ setActDataSource()

void IliDbGantt::setActDataSource ( IliDataSource * ds )

Sets the activities data source.

Parameters

ds	The data source.

§ setActDataSourceName()

void IliDbGantt::setActDataSourceName ( const char * name )

Sets the activities data source name.

Parameters

name	The data source name.

§ setActivePeriodColor()

void IliDbGantt::setActivePeriodColor ( IlvColor * color )

Sets the active period color.

Parameters

color The new color.

§ setBreakColor()

void IliDbGantt::setBreakColor ( IlvColor * color )

Sets the break color.

Parameters

color The new color.

§ setBrkColumnName()

void IliDbGantt::setBrkColumnName	(	IliDbGanttBrkCols	typ,
		const char *	name
	)

Sets a break column name.

Parameters

typ	The column type.
name	The column name.

§ setBrkDataSource()

void IliDbGantt::setBrkDataSource ( IliDataSource * ds )

Sets the breaks data source.

Parameters

ds	The data source.

§ setBrkDataSourceName()

void IliDbGantt::setBrkDataSourceName ( const char * name )

Sets the breaks data source name.

Parameters

name	The data source name.

§ setCntColumnName()

void IliDbGantt::setCntColumnName	(	IliDbGanttCntCols	typ,
		const char *	name
	)

Sets a constraint column name.

Parameters

typ	The column type.
name	The column name.

§ setCntDataSource()

void IliDbGantt::setCntDataSource ( IliDataSource * ds )

Sets the constraints data source.

Parameters

ds	The data source.

§ setCntDataSourceName()

void IliDbGantt::setCntDataSourceName ( const char * name )

Sets the constraints data source name.

Parameters

name	The data source name.

§ setDelimiterColor()

void IliDbGantt::setDelimiterColor ( IlvColor * color )

Sets the constraint delimiter color.

Parameters

color The new color.

§ setErrorReporter()

void IliDbGantt::setErrorReporter ( IliErrorReporter * reporter )

Sets the error reporter.

Note that the Gantt chart will not delete the error reporter at destruction time, so the same error reporter can be safely shared by many Gantt charts.

Parameters

reporter The error reporter.

§ setGanttCallback()

void IliDbGantt::setGanttCallback	(	IliDbGanttCallbackName	name,
		IliDbGanttCallback	cb,
		IlAny	arg = `0`
	)

Associates a callback with an internal Gantt chart event.

Associates a callback with an internal Gantt chart event. See IliDbGanttCallbackName for the event list.

Parameters

name	The callback name.
cb	The callback.
arg	The user data.

§ setInactivePeriodColor()

void IliDbGantt::setInactivePeriodColor ( IlvColor * color )

Sets the inactive period color.

Parameters

color The new color.

§ setInteractionDataSourceToGantt()

void IliDbGantt::setInteractionDataSourceToGantt ( IlBoolean flag )

Enables or disables the interaction between data sources and Gantt chart.

Parameters

flag	If `IlTrue` the interaction between data sources and Gantt chart is enabled.

§ setLoaColumnName()

void IliDbGantt::setLoaColumnName	(	IliDbGanttLoaCols	typ,
		const char *	name
	)

Sets the work-load-curve column name.

Parameters

typ	The column type.
name	The column name.

§ setLoaDataSource()

void IliDbGantt::setLoaDataSource ( IliDataSource * ds )

Sets the work-load-curve data source.

Parameters

ds	The data source.

§ setLoaDataSourceName()

void IliDbGantt::setLoaDataSourceName ( const char * name )

Sets the work-load-curve data source name.

Parameters

name	The data source name.

§ setLoadColor()

void IliDbGantt::setLoadColor ( IlvColor * color )

Sets the work-load-curve color.

Parameters

color The new color.

§ setModelName()

void IliDbGantt::setModelName ( const char * name )

Sets the data model name.

Parameters

name	The model name.

§ setPrecedenceColor()

void IliDbGantt::setPrecedenceColor ( IlvColor * color )

Sets the default precedence color.

Parameters

color The new color.

§ setPreColumnName()

void IliDbGantt::setPreColumnName	(	IliDbGanttPreCols	typ,
		const char *	name
	)

Sets a precedence column name.

Parameters

typ	The column type.
name	The column name.

§ setPreDataSource()

void IliDbGantt::setPreDataSource ( IliDataSource * ds )

Sets the precedences data source.

Parameters

ds	The data source.

§ setPreDataSourceName()

void IliDbGantt::setPreDataSourceName ( const char * name )

Sets the precedences data source name.

Parameters

name	The data source name.

§ setReadOnly()

void IliDbGantt::setReadOnly ( IlBoolean flag )

Enables or disable the read-only option.

Parameters

flag	If `IlTrue`, the Gantt chart is read-only.

§ setReferenceMonth()

void IliDbGantt::setReferenceMonth ( IlInt m )

Sets the reference month.

Parameters

m	The reference month.

§ setReferenceYear()

void IliDbGantt::setReferenceYear ( IlInt y )

Sets the reference year.

Parameters

y	The reference year.

§ setResColumnName()

void IliDbGantt::setResColumnName	(	IliDbGanttResCols	typ,
		const char *	name
	)

Sets a resource column name.

Parameters

typ	The column type.
name	The column name.

§ setResDataSource()

void IliDbGantt::setResDataSource ( IliDataSource * ds )

Sets the resources data source.

Parameters

ds	The data source.

§ setResDataSourceName()

void IliDbGantt::setResDataSourceName ( const char * name )

Sets the resources data source name.

Parameters

name	The data source name.

§ setScaleNumericLabel()

void IliDbGantt::setScaleNumericLabel ( const char * label )

Sets the label of the current step of the scale.

This function is used to define the labels of the scale if the scale type is IliDbScaleTypeNumeric.

Parameters

label The label.

§ setScaleType()

void IliDbGantt::setScaleType ( IliDbScaleType typ )

Sets the scale type.

You must call the refreshAll() member function to display the new scale.

Parameters

typ	The scale type.

§ setScaleUnit()

void IliDbGantt::setScaleUnit ( IliScaleUnit unit )

Sets the scale unit.

Parameters

unit	The scale unit.

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Accessors

Method accessors

Constructor & Destructor Documentation

§ IliDbGantt()

Member Function Documentation

§ addDisplayColumnName()

§ addErrorSink()

§ ConstraintDoubleClickedSymbol()

§ createDefaultBreak()

§ createDefaultConstraint()

§ createDefaultLoad()

§ createDefaultPrecedence()

§ createResourcesModel()

§ enableDisplayFullName()

§ getActColumnIndex()

§ getActColumnName()

§ getActDataSource()

§ getActDataSourceName()

§ getActivePeriodColor()

§ getActivePeriodInfo()

§ getBreakColor()

§ getBrkColumnIndex()

§ getBrkColumnName()

§ getBrkDataSource()

§ getBrkDataSourceName()

§ getCallbackInformation()

§ getCntColumnIndex()

§ getCntColumnName()

§ getCntDataSource()

§ getCntDataSourceName()

§ getDelimiterColor()

§ getDisplayColumnCount()

§ getDisplayColumnIndex()

§ getDisplayColumnName()

§ getErrorReporter()

§ getGanttCallback()

§ getGanttCallbackData()

§ getInactivePeriodColor()

§ getLoaColumnIndex()

§ getLoaColumnName()

§ getLoaDataSource()

§ getLoaDataSourceName()

§ getLoadColor()

§ getModel()

§ getModelName()

§ getObjectNameDoubleClicked()

§ getPrecedenceColor()

§ getPreColumnIndex()

§ getPreColumnName()

§ getPreDataSource()

§ getPreDataSourceName()

§ getReferenceMonth()

§ getReferenceYear()

§ getResColumnIndex()

§ getResColumnName()

§ getResDataSource()

§ getResDataSourceName()

§ getScaleNumericValue()

§ getScaleType()

§ getScaleUnit()

§ isActivePeriod()

§ IsActivePeriodSymbol()

§ isActivePeriodWithRules()

§ isDeletionEventPropagated()

§ isDisplayFullNameEnabled()

§ isInteractionDataSourceToGantt()

§ isReadOnly()

§ isUpdateEventPropagated()

§ onCreateBreak()

§ onCreateConstraint()

§ onCreateLoad()

§ onCreatePrecedence()

§ onReplaceBreak()

§ onReplaceConstraint()

§ onReplaceLoad()

§ onReplacePrecedence()