IlvGanttAbstractObject Class Reference

Gantt chart abstract object class. More...

#include <ilviews/gantt/gantt.h>

Inheritance diagram for IlvGanttAbstractObject:

List of all members.

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

---

Detailed Description

Gantt chart abstract object class.

Library: ilvgantt

This abstract class is the base class for classes that implement the lines, nodes, subnodes, and links used in the Gantt library (libgantt library in the $ILVHOME/lib/<machine> directory).

See also:

IlvGanttChart, IlvGanttLine, IlvGanttSubNode, IlvGanttNode, IlvGanttLink.

---

Constructor & Destructor Documentation

IlvGanttAbstractObject::IlvGanttAbstractObject	(	const char *	name = 0,
		IlBoolean	copy = IlTrue,
		IlvGraphic *	graphic = 0
	)

Constructor.

The constructor initializes a new instance of the IlvGanttAbstractObject class with the parameters you provide. The object will store a copy of the string name.

Parameters:

	name	The name of the object. This name must be unique in the scope of the Gantt chart.
	copy	Set to IlFalse if you do not want the name of the object to be copied.
	graphic	Set to an IlvGraphic object if you want to have a specific representation for this Gantt object.

virtual IlvGanttAbstractObject::~IlvGanttAbstractObject

(

)

[virtual]

Destructor.

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

---

Member Function Documentation

IlAny IlvGanttAbstractObject::getClientData

(

)

const

Gets the client data if any has been set.

Returns:

The client data if any has been set.

IlvGraphic* IlvGanttAbstractObject::getGraphic

(

)

const

Gets the graphic object stored in the Gantt object.

Returns:

The graphic object stored in the Gantt object.

const char* IlvGanttAbstractObject::getName

(

)

const

Gets the name stored in the Gantt object.

Returns:

The name stored in the Gantt object.

void IlvGanttAbstractObject::setClientData

(

IlAny

data

)

Sets the new client data in this Gantt object.

Parameters:

data

The client data.

virtual void IlvGanttAbstractObject::setGraphic	(	IlvGraphic *	graphic,
		IlBoolean	destroyOld = IlTrue,
		IlBoolean	redraw = IlTrue
	)			[virtual]

Sets the graphic object displayed by this Gantt object to graphic.

The previous graphic object stored will be destroyed unless the parameter destroyOld is set to IlFalse.

Parameters:

	graphic	The graphic object to display.
	destroyOld	Set to IlTrue to destroy the previous graphic object.
	redraw	IlTrue if the subnode is to be redrawn.

Reimplemented in IlvGanttSubNode.

void IlvGanttAbstractObject::setName	(	const char *	name,
		IlBoolean	copy = IlTrue
	)

Sets the name of the Gantt object.

Calls delete for the current object name and then replaces it.

Parameters:

	name	The name to give the object. This name must be unique in the scope of the Gantt chart.
	copy	IlTrue to replace the name with a copy of name, or IlFalse to replace it with the name itself.