IlvLinkLabel Class Reference

Grapher link annotated with a label. More...

#include <ilviews/grapher/links.h>

Inheritance diagram for IlvLinkLabel:

List of all members.

Public Member Functions
	IlvLinkLabel (IlvDisplay *display, const char *label, IlBoolean oriented, IlvGraphic *from, IlvGraphic *to, IlvPalette *palette=0)
	Constructor.
const char *	getLabel () const
	Returns the text label of the link.
void	setLabel (const char *label)
	Sets the text label of the link.
virtual IlBoolean	zoomable () const
	Returns the zoomable property of the link.

---

Detailed Description

Grapher link annotated with a label.

Library: ilvgrapher

Links of the IlvLinkLabel class are labeled with a user-defined character string:

- IlvLinkLabel -

---

Constructor & Destructor Documentation

IlvLinkLabel::IlvLinkLabel	(	IlvDisplay *	display,
		const char *	label,
		IlBoolean	oriented,
		IlvGraphic *	from,
		IlvGraphic *	to,
		IlvPalette *	palette = 0
	)

Constructor.

Initializes a new instance of the IlvLinkLabel class. The string label is internally copied and appears next to the link.

Parameters:

	display	The display connection that handles the drawing of this object.
	label	The label for the link.
	oriented	A Boolean indicating whether an arrowhead is to be drawn at the end of the link.
	from	The IlvGraphic object representing the start node of the link.
	to	The IlvGraphic object representing the end node of the link.
	palette	The palette used to draw the link and its label.

---

Member Function Documentation

const char* IlvLinkLabel::getLabel

(

)

const

Returns the text label of the link.

Returns:

The text label of the link. You must not delete or modify the returned string.

void IlvLinkLabel::setLabel

(

const char *

label

)

Sets the text label of the link.

Creates a copy of the label parameter, which must be a pointer to a valid character string.

Parameters:

label

The new label.

virtual IlBoolean IlvLinkLabel::zoomable

(

)

const [virtual]

Returns the zoomable property of the link.

A link is considered zoomable if both its start and end nodes are zoomable.

Returns:

IlTrue if the link is zoomable and IlFalse otherwise.

Reimplemented from IlvLinkImage.