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

Class for measurement system in points. More...

#include <ilviews/printing/units.h>

Inheritance diagram for IlvPrintPointUnit:
IlvPrintUnit

Public Member Functions

 IlvPrintPointUnit ()
 Default constructor. More...
 
 IlvPrintPointUnit (double units)
 Conversion constructor from a double. More...
 
 IlvPrintPointUnit (IlvPrintPointUnit const &other)
 Copy constructor. More...
 
 IlvPrintPointUnit (IlvPrintUnit const &other)
 Conversion constructor from a double. 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 (point). 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 (points). More...
 

Detailed Description

Class for measurement system in points.

Library: ilvprint

Constructor & Destructor Documentation

◆ IlvPrintPointUnit() [1/4]

IlvPrintPointUnit::IlvPrintPointUnit ( )

Default constructor.

It initializes the object in a coherent state.

◆ IlvPrintPointUnit() [2/4]

IlvPrintPointUnit::IlvPrintPointUnit ( IlvPrintPointUnit const &  other)

Copy constructor.

It creates an IlvPrintPointUnit from an IlvPrintPointUnit object.

Parameters
otherA const reference to an IlvPrintPointUnit.

◆ IlvPrintPointUnit() [3/4]

IlvPrintPointUnit::IlvPrintPointUnit ( IlvPrintUnit const &  other)

Conversion constructor from a double.

It creates an IlvPrintPointUnit from an IlvPrintUnit object.

Parameters
otherA const reference to an IlvPrintUnit.

◆ IlvPrintPointUnit() [4/4]

IlvPrintPointUnit::IlvPrintPointUnit ( 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 IlvPrintPointUnit::getPoints ( ) const
virtual

Returns the value expressed in points.

In fact it is equivalent to getUnits for this class.

Returns
A double, the value expressed in points.

Implements IlvPrintUnit.

◆ getUnitName()

virtual IlString IlvPrintPointUnit::getUnitName ( ) const
virtual

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

Returns
An IlString, the name of the unit.

Implements IlvPrintUnit.

◆ getUnitNamePlural()

virtual IlString IlvPrintPointUnit::getUnitNamePlural ( ) const
protectedvirtual

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

Returns
An IlString, the plural name unit.

Implements IlvPrintUnit.

◆ setPoints()

virtual void IlvPrintPointUnit::setPoints ( double  points)
virtual

Sets the value expressed in points.

In fact it is equivalent to setUnits for this class.

Parameters
pointsA double, the value expressed in points.

Implements IlvPrintUnit.