Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvPrintInchUnit Class Reference

Class for measurement system in inches. More...

#include <ilviews/printing/units.h>

Inheritance diagram for IlvPrintInchUnit:
IlvPrintUnit

Public Member Functions

 IlvPrintInchUnit ()
 Default constructor. More...
 
 IlvPrintInchUnit (double units)
 Conversion constructor from a double. More...
 
 IlvPrintInchUnit (IlvPrintInchUnit const &other)
 Copy constructor. More...
 
 IlvPrintInchUnit (IlvPrintUnit const &other)
 Conversion constructor from an IlvPrintUnit. More...
 
virtual double getPoints () const
 Returns the value expressed in points. More...
 
virtual IlString getUnitName () const
 Returns a string that is the name of the unit (in). More...
 
virtual void setPoints (double points)
 Sets the value expressed in points. More...
 
- Public Member Functions inherited from IlvPrintUnit
 IlvPrintUnit ()
 Default constructor. More...
 
 IlvPrintUnit (double units)
 Conversion constructor from a double. More...
 
virtual ~IlvPrintUnit ()
 Destructor. More...
 
double getUnits () const
 Returns the value expressed in units. More...
 
IlBoolean operator!= (IlvPrintUnit const &other) const
 InEquality test. More...
 
IlvPrintUnitoperator*= (double units)
 Multiplies the current object by the value expressed in units given as parameter. More...
 
IlvPrintUnitoperator+= (double units)
 Adds to the current object the value expressed in units given as parameter. More...
 
IlvPrintUnitoperator+= (IlvPrintUnit const &other)
 Adds to the current object the value of the object given as parameter. More...
 
IlvPrintUnitoperator-= (double units)
 Subtracts from the current object the value expressed in units given as parameter. More...
 
IlvPrintUnitoperator-= (IlvPrintUnit const &other)
 Subtracts from the current object the value of the object given as parameter. More...
 
IlvPrintUnitoperator/= (double units)
 Divides the current object by the value expressed in units given as parameter. More...
 
IlvPrintUnitoperator= (double units)
 Assignment operator. More...
 
IlvPrintUnitoperator= (IlvPrintUnit const &other)
 Assignment operator. More...
 
IlBoolean operator== (IlvPrintUnit const &other) const
 Equality test. More...
 
void setUnits (double units)
 Sets the value expressed in units. More...
 
IlString toString () const
 Returns a string representation of the value expressed in units. More...
 

Protected Member Functions

virtual IlString getUnitNamePlural () const
 Returns a string that is the plural name of the unit (in). More...
 

Detailed Description

Class for measurement system in inches.

Library: ilvprint

Constructor & Destructor Documentation

◆ IlvPrintInchUnit() [1/4]

IlvPrintInchUnit::IlvPrintInchUnit ( )

Default constructor.

It initializes the object in a coherent state.

◆ IlvPrintInchUnit() [2/4]

IlvPrintInchUnit::IlvPrintInchUnit ( IlvPrintInchUnit const &  other)

Copy constructor.

It creates an IlvPrintInchUnit from another IlvPrintInchUnit object.

Parameters
otherA const reference to an IlvPrintInchUnit.

◆ IlvPrintInchUnit() [3/4]

IlvPrintInchUnit::IlvPrintInchUnit ( IlvPrintUnit const &  other)

Conversion constructor from an IlvPrintUnit.

It creates an IlvPrintInchUnit from an IlvPrintUnit object.

Parameters
otherA const reference to an IlvPrintUnit.

◆ IlvPrintInchUnit() [4/4]

IlvPrintInchUnit::IlvPrintInchUnit ( double  units)

Conversion constructor from a double.

This constructor creates an IlvPrint from a double.

Parameters
unitsA double, the number of units of the IlvPrintUnit.

Member Function Documentation

◆ getPoints()

virtual double IlvPrintInchUnit::getPoints ( ) const
virtual

Returns the value expressed in points.

It translates the value returned by getUnits, expressed in inches, into a value expressed in points.

Returns
A double, the value expressed in points.

Implements IlvPrintUnit.

◆ getUnitName()

virtual IlString IlvPrintInchUnit::getUnitName ( ) const
virtual

Returns a string that is the name of the unit (in).

Returns
An IlString, the name of the unit.

Implements IlvPrintUnit.

◆ getUnitNamePlural()

virtual IlString IlvPrintInchUnit::getUnitNamePlural ( ) const
protectedvirtual

Returns a string that is the plural name of the unit (in).

Returns
An IlString, the plural name unit.

Implements IlvPrintUnit.

◆ setPoints()

virtual void IlvPrintInchUnit::setPoints ( double  points)
virtual

Sets the value expressed in points.

It translates the value given as parameter, expressed in points, into inches and then stores it (through setUnits).

Parameters
pointsA double, the value expressed in points.

Implements IlvPrintUnit.