gui::Units Class Reference

Units conversion. More...

#include <units.h>

List of all members.

Public Member Functions
	Units (const QString _defaultUnit=QString::null)
virtual	~Units ()
bool	setDefaultUnits (const QString dunits=QString::null)
QString	getDefaultUnits () const
QString	getDescriptionForUnit (const QString _unit) const
QString	getUnitFromAlias (const QString _unit) const
double	convertUnits (double num, const QString fromUnits=QString::null, const QString toUnits=QString::null) const
double	convertFromUnitsToPoint (double num, const QString &fromUnits) const
double	convertFromPointToUnits (double num, const QString &toUnits) const
QStringList	getAllUnits () const
QStringList	getAllUnitIds () const
Protected Attributes
QMap< QString, double >	units
QMap< QString, QString >	aliases
QMap< QString, QString >	description
QString	defaultUnit

---

Detailed Description

Units conversion.

Class for conversion between various length units

---

Constructor & Destructor Documentation

gui::Units::Units

(

const QString

_defaultUnit = QString::null

)

Implicit constructor.

Parameters:

_defaultUnit

Unit for set as default. Default is set "pt".

References aliases, defaultUnit, description, setDefaultUnits(), and units.

gui::Units::~Units

(

)

[virtual]

Implicit destructor.

---

Member Function Documentation

double gui::Units::convertFromPointToUnits	(	double	num,
		const QString &	toUnits
	)			const

Conver value from points ("pt") to some unite.

Parameters:

	num	Value for conversion.
	toUnits	To which unit is required conversion of value num.

If toUnits is not set, then default unit use.

Returns:

Return value num conversed from points to units toUnits.

References aliases, defaultUnit, description, and units.

Referenced by gui::PageSpace::convertFromPointToUnits(), and convertUnits().

double gui::Units::convertFromUnitsToPoint	(	double	num,
		const QString &	fromUnits
	)			const

Conver value to point ("pt").

Parameters:

	num	Value for conversion.
	fromUnits	Unit of value num.

If fromUnits is not set, then default unit use.

Returns:

Return value num conversed to points.

References aliases, defaultUnit, description, and units.

Referenced by gui::PageSpace::convertFromUnitsToPoint(), and convertUnits().

double gui::Units::convertUnits	(	double	num,
		const QString	fromUnits = QString::null,
		const QString	toUnits = QString::null
	)			const

Convert value from one unit to other.

Parameters:

	num	Value for conversion.
	fromUnits	Unit of value num.
	toUnits	To which unit is required conversion of value num.

If fromUnits or toUnits is not set, then default unit use.

Returns:

Return value num conversed to unit toUnits.

References convertFromPointToUnits(), and convertFromUnitsToPoint().

Referenced by gui::PageSpace::convertUnits().

QStringList gui::Units::getAllUnitIds

(

)

const

Function return identifiers of all units internal defined.

Returns:

Return identifiers of units.

References units.

Referenced by gui::PageSpace::getAllUnitIds().

QStringList gui::Units::getAllUnits

(

)

const

Function return description of all units internal defined.

Returns:

Return description of units.

References description, and units.

Referenced by gui::PageSpace::getAllUnits().

QString gui::Units::getDefaultUnits

(

)

const

Method return default conversion unit.

Returns:

Return defualt unit.

References defaultUnit.

Referenced by gui::PageSpace::getDefaultUnits(), gui::PageSpace::PageSpace(), and gui::PageSpace::showMousePosition().

QString gui::Units::getDescriptionForUnit

(

const QString

_unit

)

const

Method return description for unit.

Parameters:

_unit

Which unit is required description.

Returns:

Description for _unit. If nothing description found for _unit, return _unit.

References description, and getUnitFromAlias().

Referenced by gui::PageSpace::getDescriptionForUnit().

QString gui::Units::getUnitFromAlias

(

const QString

_unit

)

const

Function return unit from its aliases or description.

Parameters:

_unit

Alias or description of unit.

Returns:

Return unit for alias _unit. If alias _unit is not find in internal aliases or descrition, return _unit.

References aliases, description, and units.

Referenced by getDescriptionForUnit(), gui::PageSpace::getUnitFromAlias(), and setDefaultUnits().

bool gui::Units::setDefaultUnits

(

const QString

dunits = QString::null

)

Method set default unit for conversion.

Parameters:

dunits

Unit for set as default. Nothing chenage, if not find in internal units.

Returns:

Return true if default unit is change to dunits. Otherwise return false.

References defaultUnit, and getUnitFromAlias().

Referenced by gui::PageSpace::PageSpace(), gui::PageSpace::setDefaultUnits(), and Units().

---

Member Data Documentation

QMap<QString, QString> gui::Units::aliases [protected]

Aliases defined for units. aliases[ alias ] = unit

See also:

getUnitFromAlias

Referenced by convertFromPointToUnits(), convertFromUnitsToPoint(), getUnitFromAlias(), and Units().

QString gui::Units::defaultUnit [protected]

Default unit for conversion of values.

See also:

setDefaultUnits

Referenced by convertFromPointToUnits(), convertFromUnitsToPoint(), getDefaultUnits(), setDefaultUnits(), and Units().

QMap<QString, QString> gui::Units::description [protected]

Description for units defined in units. description[ unit ] = description

See also:

getAllUnits

getDescriptionForUnit

Referenced by convertFromPointToUnits(), convertFromUnitsToPoint(), getAllUnits(), getDescriptionForUnit(), getUnitFromAlias(), and Units().

QMap<QString, double> gui::Units::units [protected]

Units with its multipltiplicator for conversion to points.

Referenced by convertFromPointToUnits(), convertFromUnitsToPoint(), getAllUnitIds(), getAllUnits(), getUnitFromAlias(), and Units().

---

The documentation for this class was generated from the following files:

• src/gui/units.h
• src/gui/units.cc