Views
Gantt Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvGanttSubNodeHook Class Reference

Gantt chart subnode hook class. More...

#include <ilviews/gantt/gantt.h>

Public Member Functions

 IlvGanttSubNodeHook (IlvGanttChart *gantt)
 Constructor. More...
 
virtual IlBoolean afterMove (IlvGanttNode *node, IlUShort i, IlvGanttSubNode *data)
 Called when a user of a Gantt chart has moved a subnode. More...
 
virtual IlBoolean afterReshape (IlvGanttNode *node, IlUShort i, IlvGanttSubNode *data)
 Called when a user of a Gantt chart has reshaped a subnode. More...
 
virtual IlBoolean beforeMove (IlvGanttNode *node, IlUShort i, IlvGanttSubNode *data)
 Called when a user of a Gantt chart moves a subnode. More...
 
virtual IlBoolean beforeReshape (IlvGanttNode *node, IlUShort i, IlvGanttSubNode *data)
 Called when a user of a Gantt chart reshapes a subnode. More...
 
IlvGanttChartgetGanttChart () const
 Gets the Gantt chart on which the hook is installed. More...
 

Detailed Description

Gantt chart subnode hook class.

Library: ilvgantt

The IlvGanttSubNodeHook class is used to capture the modifications on a subnode when users use IlvGanttSelectInteractor to manipulate the subnode.

It is recommended that you use this class in the following manner:

See also
IlvGanttChart, IlvGanttChartForm.

Constructor & Destructor Documentation

◆ IlvGanttSubNodeHook()

IlvGanttSubNodeHook::IlvGanttSubNodeHook ( IlvGanttChart gantt)

Constructor.

This constructor initializes an IlvGanttSubNodeHook object.

Parameters
ganttThe Gantt chart on which you will install your subnode hook.

Member Function Documentation

◆ afterMove()

virtual IlBoolean IlvGanttSubNodeHook::afterMove ( IlvGanttNode node,
IlUShort  i,
IlvGanttSubNode data 
)
virtual

Called when a user of a Gantt chart has moved a subnode.

This virtual method is called when a user of the Gantt chart has moved a subnode.

Parameters
nodeThe node of data.
iThe index of data in node.
dataThe manipulated subnode.

◆ afterReshape()

virtual IlBoolean IlvGanttSubNodeHook::afterReshape ( IlvGanttNode node,
IlUShort  i,
IlvGanttSubNode data 
)
virtual

Called when a user of a Gantt chart has reshaped a subnode.

This virtual method is called when a user of the Gantt chart has reshaped a subnode.

Parameters
nodeThe node of data.
iThe index of data in node.
dataThe manipulated subnode.

◆ beforeMove()

virtual IlBoolean IlvGanttSubNodeHook::beforeMove ( IlvGanttNode node,
IlUShort  i,
IlvGanttSubNode data 
)
virtual

Called when a user of a Gantt chart moves a subnode.

This virtual method is called when a user of a Gantt chart moves a subnode using IlvGanttSelectInteractor.

Parameters
nodeThe node of data.
iThe index of data in node.
dataThe manipulated subnode.
Returns
If IlTrue, the IlvGanttSelectInteractor will move the subnode. Otherwise, IlvGanttSelectInteractor will abort its operation and the subnode will not be moved.

◆ beforeReshape()

virtual IlBoolean IlvGanttSubNodeHook::beforeReshape ( IlvGanttNode node,
IlUShort  i,
IlvGanttSubNode data 
)
virtual

Called when a user of a Gantt chart reshapes a subnode.

This virtual method is called when a user of a Gantt chart reshapes a subnode using IlvGanttSelectInteractor.

Parameters
nodeThe node to be reshaped.
iThe index of the subnode in the node.
dataThe manipulated subnode.
Returns
If IlTrue the IlvGanttSelectInteractor will reshape the subnode. Otherwise, IlvGanttSelectInteractor will abort its operation and the subnode will not be reshaped.

◆ getGanttChart()

IlvGanttChart* IlvGanttSubNodeHook::getGanttChart ( ) const

Gets the Gantt chart on which the hook is installed.

Returns
The Gantt chart on which the hook is installed.