rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Prototypes Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvSlideYAccessor Class Reference

Translates a node horizontally. More...

#include <ilviews/protos/graphacc.h>

Inheritance diagram for IlvSlideYAccessor:
IlvAbstractEventAccessor IlvUserAccessor IlvAccessor

List of all members.

Public Member Functions

 IlvSlideYAccessor (const char *name, const char *nodename, const char *minY, const char *deltaY, const char *minVal, const char *deltaVal, IlBoolean allowInteraction=IlFalse)
 Creates an IlvSlideYAccessor.
virtual IlBoolean changeValue (IlvAccessorHolder *object, const IlvValue &val)
 Called by the method IlvAccessible::changeValue for each IlvAccessor attached to the IlvAccessorHolder.
virtual IlBoolean handleEvent (IlvAccessorHolder *object, IlvGraphic *g, IlvEvent &, IlvView *, IlvTransformer *t)
 Event handling method, to be derived in subclasses.
virtual void initialize (const IlvAccessorHolder *object)
 Attachment method to an IlvAccessorHolder.
virtual IlvValuequeryValue (const IlvAccessorHolder *object, IlvValue &val) const
 Called by the method IlvAccessible::queryValue for each IlvAccessor attached to the IlvAccessorHolder.

Detailed Description

Translates a node horizontally.

Library: ilvproto

IlvSlideYAccessor translates a node vertically to a position defined by a minimum position, a position range, a minimum value, and a value range. The new position is computed from the value assigned to the IlvSlideXAccessor with the following formula: y = ymin + ((v - vmin) * yrange / vrange)

The user can slide the node interactively by dragging it with the mouse. Using this flag may produce modularization difficulties in the design of your prototype. It is meant to implement very simple prototypes that do not exceed a few accessors.


Constructor & Destructor Documentation

IlvSlideYAccessor::IlvSlideYAccessor ( const char *  name,
const char *  nodename,
const char *  minY,
const char *  deltaY,
const char *  minVal,
const char *  deltaVal,
IlBoolean  allowInteraction = IlFalse 
)

Creates an IlvSlideYAccessor.

This accessor includes an IlvValueAccessor of type float that holds the current translation factor of the node. It is therefore implicitly typed to IlvFloatValueType. minY, deltaY, minVal, and deltaVal can contain a constant value, the name of another accessor, or an arithmetic expression that can contain accessor names and/or constants (see IlvUserAccessor::getValue).

Parameters:
name Name of the attribute.
nodename Name of the graphic node to be moved.
minY Minimum y coordinate of the graphic node.
deltaY Defines the range within which the node should be translated.
minVal The minimum input value.
deltaVal The range within which the input value varies.
allowInteraction If this flag is set to IlTrue, the user can slide the node interactively by clicking on it and dragging it with the mouse. Otherwise, no interaction is allowed.

Member Function Documentation

virtual IlBoolean IlvSlideYAccessor::handleEvent ( IlvAccessorHolder object,
IlvGraphic g,
IlvEvent ,
IlvView ,
IlvTransformer t 
) [virtual]

Event handling method, to be derived in subclasses.

Called for every event received by one of the nodes specified by the nodeName argument of the constructor. It must be redefined by subclasses to implement the effect of the accessor.

Parameters:
object Group to which the accessor is attached.
g Graphic object that received the event.
event Event received.
view View in which the event was received.
t Transformer associated with the view, or 0 if the view has no transformer.

Reimplemented from IlvAbstractEventAccessor.

virtual void IlvSlideYAccessor::initialize ( const IlvAccessorHolder object  )  [virtual]

Attachment method to an IlvAccessorHolder.

This method is called when the accessor object is attached to a group. You can redefine it in subclasses of IlvUserAccessor to perform any kind of initialization.

Parameters:
object The object the accessor is attached to.

Reimplemented from IlvAbstractEventAccessor.


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