rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gantt Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvGanttAddLinkInteractor Class Reference

Interactor to add links to a Gantt chart. More...

#include <ilviews/gantt/ganttint.h>

Inheritance diagram for IlvGanttAddLinkInteractor:
IlvMakeLinkInteractor IlvManagerViewInteractor

Public Member Functions

 IlvGanttAddLinkInteractor (IlvGanttChart *gantt, IlvView *view, IlBoolean oriented=IlTrue)
 Constructor. More...
 
virtual void doIt (IlvGraphic *gfrom, IlvGraphic *gto)
 Creates and adds the link. More...
 
IlvGanttChartgetGanttChart () const
 Returns the Gantt chart with which this interactor is associated. More...
 
virtual IlvGanttLinkmakeLink (IlvGanttNode *from, IlvGanttNode *to)
 Creates the link instance. More...
 

Detailed Description

Interactor to add links to a Gantt chart.

Library: ilvgantt

An IlvGanttAddLinkInteractor interactor lets you interactively add a Gantt link to the Gantt chart.

See Also
IlvGanttChart, IlvGanttLink, IlvGanttNode, IlvMakeLinkInteractor.

Constructor & Destructor Documentation

IlvGanttAddLinkInteractor::IlvGanttAddLinkInteractor ( IlvGanttChart gantt,
IlvView view,
IlBoolean  oriented = IlTrue 
)

Constructor.

Initializes a new instance of the IlvGanttAddLinkInteractor class that enables to interactively create links between two nodes of the Gantt chart gantt.

Parameters
ganttThe gantt to which the interactor is attached.
viewThe gantt chart view to which the interactor is attached. This view must be one of the Gantt grapher view where activities (nodes) are displayed.
orientedIlTrue if created links are oriented and IlFalse otherwise.

Member Function Documentation

virtual void IlvGanttAddLinkInteractor::doIt ( IlvGraphic gfrom,
IlvGraphic gto 
)
virtual

Creates and adds the link.

Retrieves the start and end Gantt nodes from the given graphic objects, before calling the member function IlvGanttAddLinkInteractor::makeLink.

Parameters
gfromThe graphic object representing the starting node of the link
gtoThe graphic object representing the ending node of the link.
IlvGanttChart* IlvGanttAddLinkInteractor::getGanttChart ( ) const

Returns the Gantt chart with which this interactor is associated.

Returns
The Gantt chart with which this interactor is associated.
virtual IlvGanttLink* IlvGanttAddLinkInteractor::makeLink ( IlvGanttNode from,
IlvGanttNode to 
)
virtual

Creates the link instance.

Returns an IlvGanttLink instance created from the Gantt node from to the Gantt node to. You can overload this method to create your own type of link.

Parameters
fromThe starting Gantt node.
toThe ending Gantt node.
Returns
The created link.

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