rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Grapher Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvGraphNodeSelection Class Reference

Selection objects for grapher nodes. More...

#include <ilviews/grapher/nodesel.h>

Inheritance diagram for IlvGraphNodeSelection:
IlvDrawSelection IlvSimpleGraphic IlvGraphic

Public Member Functions

IlUInt getActivePinIdx () const
 Returns the index of the active connection pin. More...
 
IlvGrapherPingetPin () const
 Returns the grapher pin of the associated object. More...
 
void setActivePinIdx (IlUInt idx)
 Sets the index of the active connection pin. More...
 

Detailed Description

Selection objects for grapher nodes.

Library: ilvgrapher

This class implements a selection object that displays the connection pins of a grapher node. Instances of this class can be associated with a selected node by using the IlvManager::setMakeSelection method. The selected node will then appear as in the following figure:


A selected node using the IlvGraphNodeSelection class

.

The class is used by the interactor of the pin editor, which is implemented by the IlvPinEditorInteractor class.

See Also
IlvGrapherPin, IlvGenericPin, IlvMakeLinkInteractor, IlvPinEditorInteractor.

Member Function Documentation

IlUInt IlvGraphNodeSelection::getActivePinIdx ( ) const

Returns the index of the active connection pin.

Returns
The active pin index.
See Also
setActivePinIdx, IlvPinEditorInteractor.
IlvGrapherPin* IlvGraphNodeSelection::getPin ( ) const

Returns the grapher pin of the associated object.

Returns
The grapher pin of the associated object.
void IlvGraphNodeSelection::setActivePinIdx ( IlUInt  idx)

Sets the index of the active connection pin.

For editing purposes, the selection object can store the index of one of the connection pins, referred to as the active or selected pin. This method lets you specify idx as the index of the pin.

Parameters
idxThe index of the new active pin.
See Also
IlvPinEditorInteractor.

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