rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Charts Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvRectangularChartCursor Class Reference

Cursor subclass for Cartesian charts. More...

#include <ilviews/charts/cursor.h>

Inheritance diagram for IlvRectangularChartCursor:
IlvAbstractChartCursor

List of all members.

Public Member Functions

 IlvRectangularChartCursor (IlDouble value, IlvPalette *palette=0)
 Constructor.
virtual void delimiterBBox (const IlvSingleScaleDisplayer *scale, const IlvPoint &cursorPoint, IlDouble cursorAngle, const IlvRect &scaleDataDisplayArea, IlvRect &bbox) const
 Returns the bounding box of the delimiter.
virtual void drawDelimiter (const IlvSingleScaleDisplayer *scale, const IlvPoint &cursorPoint, IlDouble cursorAngle, const IlvRect &scaleDataDisplayArea, IlvPort *dst, const IlvRegion *clip) const
 Draws the cursor delimiter.

Detailed Description

Cursor subclass for Cartesian charts.

Library: ilvcharts

This class is a subclass of IlvAbstractChartCursor that allows you to define a rectangular cursor. A rectangular cursor associated with a given scale is a line orthogonal to the axis of this scale. This kind of cursor is used only for Cartesian charts. A Cartesian chart is a chart that displays data expressed in Cartesian coordinates with abscissa and ordinate scales that are orthogonal.

You can see an example of rectangular cursor on the figure below where a cursor is added to the ordinate scale of the displayed chart.

img_rectangular_cursor.gif
See also:
IlvAbstractChartCursor.

Constructor & Destructor Documentation

IlvRectangularChartCursor::IlvRectangularChartCursor ( IlDouble  value,
IlvPalette palette = 0 
)

Constructor.

Initializes a new IlvRectangularChartCursor object.

Parameters:
value The cursor value.
palette The palette used to draw the cursor.

Member Function Documentation

virtual void IlvRectangularChartCursor::delimiterBBox ( const IlvSingleScaleDisplayer scale,
const IlvPoint cursorPoint,
IlDouble  cursorAngle,
const IlvRect scaleDataDisplayArea,
IlvRect bbox 
) const [virtual]

Returns the bounding box of the delimiter.

This method must be defined in subclasses.

Parameters:
scale The scale to which the cursor is attached.
cursorpoint The point in view coordinates on the scale axis.
cursorAngle The direction angle of the cursor from the scale axis.
scaleDataDisplayArea The data display area of the corresponding scale.
bbox The returned bounding box.

Implements IlvAbstractChartCursor.

virtual void IlvRectangularChartCursor::drawDelimiter ( const IlvSingleScaleDisplayer scale,
const IlvPoint cursorPoint,
IlDouble  cursorAngle,
const IlvRect scaleDataDisplayArea,
IlvPort dst,
const IlvRegion clip 
) const [virtual]

Draws the cursor delimiter.

This method must be defined in subclasses. The defined method should take into account the ghost drawing property of the delimiter (see the IlvAbstractChartCursor::isDrawingGhost method).

Parameters:
scale The scale to which the cursor is attached.
cursorpoint The point in view coordinates on the scale axis.
cursorAngle The direction angle of the cursor from the scale axis.
scaleDataDisplayArea The data display area of the corresponding scale.
dst The drawing port.
clip The drawing clip.

Implements IlvAbstractChartCursor.


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