rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Charts Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvRectangularScaleDisplayer Class Reference

Implementation of rectangular scales. More...

#include <ilviews/charts/scaledis.h>

Inheritance diagram for IlvRectangularScaleDisplayer:
IlvSingleScaleDisplayer IlvAbstractScaleDisplayer

List of all members.

Public Member Functions

 IlvRectangularScaleDisplayer (IlvCoordinateInfo *coordInfo, IlUInt nbSteps, const char *const *stepLabels, IlUInt nbSubStepsBetween, IlvPalette *defaultPalette)
 Constructor.
 IlvRectangularScaleDisplayer (IlvCoordinateInfo *coordInfo, IlvPalette *defaultPalette)
 Constructor.
virtual IlvAbstractScaleDisplayercopy () const
 Virtual copy constructor.
virtual IlvAbstractChartCursorcreateCursor (const IlvSingleScaleDisplayer *scaleRef=0) const
 Factory method to create a default cursor.
virtual IlvAbstractGridDisplayercreateGridDisplayer (const IlvSingleScaleDisplayer *scaleRef=0) const
 Factory method to create a default grid.

Detailed Description

Implementation of rectangular scales.

Library: ilvcharts

This class is a subclass of IlvSingleScaleDisplayer that allows you to display a scale with a straight-line axis.

See also:
IlvSingleScaleDisplayer.

Constructor & Destructor Documentation

IlvRectangularScaleDisplayer::IlvRectangularScaleDisplayer ( IlvCoordinateInfo coordInfo,
IlvPalette defaultPalette 
)

Constructor.

Initializes a new IlvRectangularScaleDisplayer object.

Parameters:
coordInfo The coordinate information to which the scale is connected.
defaultPalette The default palette used to draw the various parts of the scale (axis, step labels, axis label). Each individual part can be assigned a different palette afterwards.
IlvRectangularScaleDisplayer::IlvRectangularScaleDisplayer ( IlvCoordinateInfo coordInfo,
IlUInt  nbSteps,
const char *const *  stepLabels,
IlUInt  nbSubStepsBetween,
IlvPalette defaultPalette 
)

Constructor.

Initializes a new IlvRectangularScaleDisplayer object.

Parameters:
coordInfo The coordinate information to which the scale is connected.
nbsteps The number of major steps.
stepLabels The labels of the major steps.
nbSubStepsBetween The number of minor steps between two major steps.
defaultPalette The default palette used to draw the various parts of the scale (axis, step labels, axis label). Each individual part can be assigned a different palette afterwards.
See also:
IlvAbstractScaleDisplayer::setStepLabels.

Member Function Documentation

virtual IlvAbstractScaleDisplayer* IlvRectangularScaleDisplayer::copy (  )  const [virtual]

Virtual copy constructor.

Creates and returns a copy of the current object. This method must be overloaded in subclasses. It is automatically declared by the DeclareScaleDisplayerTypeInfo macro. The IlvPredefinedScaleDisplayerIOMembers macro lets you define a default implementation, which returns an instance initialized with the copy constructor.

Returns:
A copy of the current object.

Implements IlvAbstractScaleDisplayer.

virtual IlvAbstractChartCursor* IlvRectangularScaleDisplayer::createCursor ( const IlvSingleScaleDisplayer scaleRef = 0  )  const [virtual]

Factory method to create a default cursor.

The default implementation returns an instance of IlvRectangularChartCursor if the projector is Cartesian and an instance of IlvCircularChartCursor if the projector is polar.

Parameters:
scaleRef The scale that can be used as a reference for the created cursor to indicate where the cursor line must stop.
Returns:
The created cursor.
Warning:
[note] The reference scale is used by default only for circular cursors.

Implements IlvSingleScaleDisplayer.

virtual IlvAbstractGridDisplayer* IlvRectangularScaleDisplayer::createGridDisplayer ( const IlvSingleScaleDisplayer scaleRef = 0  )  const [virtual]

Factory method to create a default grid.

The default implementation returns an instance of IlvRectangularGridDisplayer if the projector is Cartesian and an instance of IlvCircularGridDisplayer if the projector is polar.

Parameters:
scaleRef The scale that can be used as a reference for the created grid to indicate where the grid lines must stop.
Returns:
The created grid.
Warning:
[note] The reference scale is used by default only for circular grids.

Implements IlvSingleScaleDisplayer.


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