rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Gantt Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvGanttSubNodeHook Class Reference

Gantt chart subnode hook class. More...

#include <ilviews/gantt/gantt.h>

List of all members.

Public Member Functions

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

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 ( IlvGanttChart gantt  ) 

Constructor.

This constructor initializes an IlvGanttSubNodeHook object.

Parameters:
gantt The Gantt chart on which you will install your subnode hook.

Member Function Documentation

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:
node The node of data.
i The index of data in node.
data The manipulated subnode.
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:
node The node of data.
i The index of data in node.
data The manipulated subnode.
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:
node The node of data.
i The index of data in node.
data The manipulated subnode.
Returns:
If IlTrue, the IlvGanttSelectInteractor will move the subnode. Otherwise, IlvGanttSelectInteractor will abort its operation and the subnode will not be moved.
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:
node The node to be reshaped.
i The index of the subnode in the node.
data The manipulated subnode.
Returns:
If IlTrue the IlvGanttSelectInteractor will reshape the subnode. Otherwise, IlvGanttSelectInteractor will abort its operation and the subnode will not be reshaped.
IlvGanttChart* IlvGanttSubNodeHook::getGanttChart (  )  const

Gets the Gantt chart on which the hook is installed.

Returns:
The Gantt chart on which the hook is installed.

© 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.