Rogue Wave Views
Grapher Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvLinkLabel Class Reference

Grapher link annotated with a label. More...

#include <ilviews/grapher/links.h>

Inheritance diagram for IlvLinkLabel:
IlvLinkImage IlvSimpleGraphic IlvGraphic IlvValueInterface

Public Member Functions

 IlvLinkLabel (IlvDisplay *display, const char *label, IlBoolean oriented, IlvGraphic *from, IlvGraphic *to, IlvPalette *palette=0)
 Constructor. More...
 
const char * getLabel () const
 Returns the text label of the link. More...
 
void setLabel (const char *label)
 Sets the text label of the link. More...
 
virtual IlBoolean zoomable () const
 Returns the zoomable property of the link. More...
 
- Public Member Functions inherited from IlvLinkImage
 IlvLinkImage (IlvDisplay *display, IlBoolean oriented, IlvGraphic *from, IlvGraphic *to, IlvPalette *palette=0)
 Constructor. More...
 
virtual void computePoints (IlvPoint &src, IlvPoint &dst, const IlvTransformer *t=0) const
 Computes the endpoints of the link when it is drawn as a straight line. More...
 
IlvGraphicgetFrom () const
 Returns the start node. More...
 
virtual IlvPointgetLinkPoints (IlUInt &nPoints, const IlvTransformer *t=0) const
 Returns the points defining the shape of the link. More...
 
IlvGraphicgetTo () const
 Returns the end node. More...
 
IlBoolean isOriented () const
 Indicates whether the link is oriented. More...
 
void setFrom (IlvGraphic *f)
 Sets the start node. More...
 
void setOriented (IlBoolean oriented)
 Changes the oriented mode. More...
 
void setTo (IlvGraphic *t)
 Sets the end node. More...
 

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
displayThe display connection that handles the drawing of this object.
labelThe label for the link.
orientedA Boolean indicating whether an arrowhead is to be drawn at the end of the link.
fromThe IlvGraphic object representing the start node of the link.
toThe IlvGraphic object representing the end node of the link.
paletteThe 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
labelThe 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.


© Copyright 2016, 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.