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
IlvGanttLine Class Reference

Gantt chart line class. More...

Inheritance diagram for IlvGanttLine:
IlvGanttAbstractObject

Public Member Functions

 IlvGanttLine (const char *name, IlUShort capacity=1, IlBoolean copy=IlTrue, IlvGraphic *graphic=0)
 Constructor. More...
 
 ~IlvGanttLine ()
 Destructor. More...
 
IlUShort getCapacity () const
 Gets the capacity of the Gantt line. More...
 
void setCapacity (IlUShort capacity)
 Sets the capacity of the Gantt line to capacity. More...
 
- Public Member Functions inherited from IlvGanttAbstractObject
 IlvGanttAbstractObject (const char *name=0, IlBoolean copy=IlTrue, IlvGraphic *graphic=0)
 Constructor. More...
 
virtual ~IlvGanttAbstractObject ()
 Destructor. More...
 
IlAny getClientData () const
 Gets the client data if any has been set. More...
 
IlvGraphicgetGraphic () const
 Gets the graphic object stored in the Gantt object. More...
 
const char * getName () const
 Gets the name stored in the Gantt object. More...
 
void setClientData (IlAny data)
 Sets the new client data in this Gantt object. More...
 
virtual void setGraphic (IlvGraphic *graphic, IlBoolean destroyOld=IlTrue, IlBoolean redraw=IlTrue)
 Sets the graphic object displayed by this Gantt object to graphic. More...
 
void setName (const char *name, IlBoolean copy=IlTrue)
 Sets the name of the Gantt object. More...
 

Detailed Description

Gantt chart line class.

Library: ilvgantt

An IlvGanttLine object describes a Gantt resource.

See Also
IlvGanttChart.

Constructor & Destructor Documentation

IlvGanttLine::IlvGanttLine ( const char *  name,
IlUShort  capacity = 1,
IlBoolean  copy = IlTrue,
IlvGraphic graphic = 0 
)

Constructor.

The constructor initializes a new instance of IlvGanttLine with the parameters you provide. The object stores a copy of the string name if copy is IlTrue, and the string name itself if copy is IlFalse. You can set the graphic parameter to an IlvGraphic object to have a specific representation for this Gantt line.

Parameters
nameThe name of the Gantt line. This name must be unique in the scope of the Gantt chart.
capacityIndicates the capacity of this Gantt line.
copyIndicates whether the object stores a copy of name or the string name itself.
graphicThe IlvGraphic that represents the line.
IlvGanttLine::~IlvGanttLine ( )

Destructor.

The destructor deletes the graphic object and the string name stored in this Gantt line.

Member Function Documentation

IlUShort IlvGanttLine::getCapacity ( ) const

Gets the capacity of the Gantt line.

Returns the capacity of the Gantt line.

Returns
The capacity of the Gantt line.
void IlvGanttLine::setCapacity ( IlUShort  capacity)

Sets the capacity of the Gantt line to capacity.

Parameters
capacityThe capacity of the line.

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