rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvPrintableComposite::RelativePositionCoordinate Class Reference

This abstract class is used to represent the concept of the end point of a segment relatively to the bounding box of an IlvPrintableComposite. More...

#include <ilviews/printing/composite.h>

Inheritance diagram for IlvPrintableComposite::RelativePositionCoordinate:
IlvPrintableComposite::PositionCoordinate IlvPrintableComposite::DeltaRelativePositionCoordinate IlvPrintableComposite::RatioRelativePositionCoordinate

Public Member Functions

 RelativePositionCoordinate (IlvPos position, IlBoolean isRelativeToFirst=IlTrue)
 The constructor. More...
 
 RelativePositionCoordinate (RelativePositionCoordinate const &other)
 The copy constructor. More...
 
IlvPos getPosition () const
 Gets the value of the position. More...
 
IlBoolean isRelativeToFirstReferencePosition () const
 Returns whether the position is relative to the first position of the reference. More...
 
RelativePositionCoordinateoperator= (RelativePositionCoordinate const &other)
 The assignment operator. More...
 
void setPosition (IlvPos newPosition)
 Sets the internal value of the position. More...
 
void setRelativeToFirstReferencePosition (IlBoolean isRelativeToFirst)
 Sets whether the position is relative to the first position of the reference. More...
 
- Public Member Functions inherited from IlvPrintableComposite::PositionCoordinate
 PositionCoordinate ()
 The constructor. More...
 
virtual PositionCoordinateclone () const =0
 This function returns a new object allocated on the heap, this object is a copy of the current object. More...
 

Detailed Description

This abstract class is used to represent the concept of the end point of a segment relatively to the bounding box of an IlvPrintableComposite.

Library: ilvprint

Constructor & Destructor Documentation

IlvPrintableComposite::RelativePositionCoordinate::RelativePositionCoordinate ( IlvPos  position,
IlBoolean  isRelativeToFirst = IlTrue 
)

The constructor.

Parameters
positionThe position.
isRelativeToFirstFlag to specify whether the position is relative to the first or the last position of the reference segment.
IlvPrintableComposite::RelativePositionCoordinate::RelativePositionCoordinate ( RelativePositionCoordinate const &  other)

The copy constructor.

Parameters
otherAnother instance of this class.

Member Function Documentation

IlvPos IlvPrintableComposite::RelativePositionCoordinate::getPosition ( ) const

Gets the value of the position.

This is the value given as parameter of the constructor or set by setPosition.

Returns
The value of the position.
See Also
setPosition
IlBoolean IlvPrintableComposite::RelativePositionCoordinate::isRelativeToFirstReferencePosition ( ) const

Returns whether the position is relative to the first position of the reference.

Returns
IlTrue when it is relative to the first position of the reference, IlFalse otherwise.
See Also
setRelativeToFirstReferencePosition
RelativePositionCoordinate& IlvPrintableComposite::RelativePositionCoordinate::operator= ( RelativePositionCoordinate const &  other)

The assignment operator.

Parameters
otherAnother instance of this class.
Returns
A reference to the current object.
void IlvPrintableComposite::RelativePositionCoordinate::setPosition ( IlvPos  newPosition)

Sets the internal value of the position.

Parameters
Thenew value of the position.
See Also
getPosition()
void IlvPrintableComposite::RelativePositionCoordinate::setRelativeToFirstReferencePosition ( IlBoolean  isRelativeToFirst)

Sets whether the position is relative to the first position of the reference.

Parameters
isRelativeToFirstIlTrue when it is relative to the first position of the reference, IlFalse otherwise.
See Also
isRelativeToFirstReferencePosition

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