• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KUnitConversion

  • KUnitConversion
  • UnitCategory
Public Member Functions | Protected Member Functions | List of all members
KUnitConversion::UnitCategory Class Reference

#include <unitcategory.h>

Inheritance diagram for KUnitConversion::UnitCategory:
Acceleration Angle Area Currency Density Energy Force Frequency FuelEfficiency Length Mass Power Pressure Temperature Time Velocity Volume

Public Member Functions

 UnitCategory (int id)
 
virtual ~UnitCategory ()
 
QStringList allUnits () const
 
Value convert (const Value &value, const QString &toUnit=QString())
 
Value convert (const Value &value, int toUnit)
 
virtual Value convert (const Value &value, UnitPtr toUnit)
 
UnitPtr defaultUnit () const
 
QString description () const
 
bool hasUnit (const QString &unit) const
 
int id () const
 
QList< UnitPtr > mostCommonUnits () const
 
QString name () const
 
UnitPtr unit (const QString &s) const
 
UnitPtr unit (int unitId) const
 
QList< UnitPtr > units () const
 
KUrl url () const
 

Protected Member Functions

void addIdMapValue (UnitPtr unit, int id)
 
void addUnitMapValues (UnitPtr unit, const QString &names)
 
void addUnitName (const QString &name)
 
void setDefaultUnit (UnitPtr defaultUnit)
 
void setDescription (const QString &desc)
 
void setMostCommonUnits (const QList< int > &units)
 
void setName (const QString &name)
 
void setSymbolStringFormat (const KLocalizedString &symbolStringFormat)
 
void setUrl (const KUrl &url)
 
KLocalizedString symbolStringFormat () const
 

Detailed Description

Definition at line 33 of file unitcategory.h.

Constructor & Destructor Documentation

◆ UnitCategory()

KUnitConversion::UnitCategory::UnitCategory ( int  id)

Definition at line 49 of file unitcategory.cpp.

◆ ~UnitCategory()

KUnitConversion::UnitCategory::~UnitCategory ( )
virtual

Definition at line 55 of file unitcategory.cpp.

Member Function Documentation

◆ addIdMapValue()

void KUnitConversion::UnitCategory::addIdMapValue ( UnitPtr  unit,
int  id 
)
protected

Definition at line 132 of file unitcategory.cpp.

◆ addUnitMapValues()

void KUnitConversion::UnitCategory::addUnitMapValues ( UnitPtr  unit,
const QString &  names 
)
protected

Definition at line 124 of file unitcategory.cpp.

◆ addUnitName()

void KUnitConversion::UnitCategory::addUnitName ( const QString &  name)
protected

◆ allUnits()

QStringList KUnitConversion::UnitCategory::allUnits ( ) const

Return all unit names, short names and unit synonyms in this category.

Returns
list of units.

Definition at line 88 of file unitcategory.cpp.

◆ convert() [1/3]

Value KUnitConversion::UnitCategory::convert ( const Value &  value,
const QString &  toUnit = QString() 
)

Convert value to another unit.

Parameters
valuevalue to convert
toUnitunit to convert to. If empty default unit is used.
Returns
converted value

Definition at line 98 of file unitcategory.cpp.

◆ convert() [2/3]

Value KUnitConversion::UnitCategory::convert ( const Value &  value,
int  toUnit 
)

Definition at line 107 of file unitcategory.cpp.

◆ convert() [3/3]

Value KUnitConversion::UnitCategory::convert ( const Value &  value,
UnitPtr  toUnit 
)
virtual

Reimplemented in Currency.

Definition at line 115 of file unitcategory.cpp.

◆ defaultUnit()

UnitPtr KUnitConversion::UnitCategory::defaultUnit ( ) const

Returns default unit.

Returns
default unit.

Definition at line 166 of file unitcategory.cpp.

◆ description()

QString KUnitConversion::UnitCategory::description ( ) const
Returns
unit category description

Definition at line 171 of file unitcategory.cpp.

◆ hasUnit()

bool KUnitConversion::UnitCategory::hasUnit ( const QString &  unit) const

Check if unit category has a unit.

Returns
True if unit is found

Definition at line 93 of file unitcategory.cpp.

◆ id()

int KUnitConversion::UnitCategory::id ( ) const
Returns
category id.

Definition at line 191 of file unitcategory.cpp.

◆ mostCommonUnits()

QList< UnitPtr > KUnitConversion::UnitCategory::mostCommonUnits ( ) const

Return most common units in this category.

Returns
list of units.

Definition at line 75 of file unitcategory.cpp.

◆ name()

QString KUnitConversion::UnitCategory::name ( ) const

Returns name for the unit category.

Returns
Translated name for category.

Definition at line 151 of file unitcategory.cpp.

◆ setDefaultUnit()

void KUnitConversion::UnitCategory::setDefaultUnit ( UnitPtr  defaultUnit)
protected

Definition at line 161 of file unitcategory.cpp.

◆ setDescription()

void KUnitConversion::UnitCategory::setDescription ( const QString &  desc)
protected

Definition at line 176 of file unitcategory.cpp.

◆ setMostCommonUnits()

void KUnitConversion::UnitCategory::setMostCommonUnits ( const QList< int > &  units)
protected

Definition at line 80 of file unitcategory.cpp.

◆ setName()

void KUnitConversion::UnitCategory::setName ( const QString &  name)
protected

Definition at line 156 of file unitcategory.cpp.

◆ setSymbolStringFormat()

void KUnitConversion::UnitCategory::setSymbolStringFormat ( const KLocalizedString &  symbolStringFormat)
protected

Definition at line 60 of file unitcategory.cpp.

◆ setUrl()

void KUnitConversion::UnitCategory::setUrl ( const KUrl &  url)
protected

Definition at line 186 of file unitcategory.cpp.

◆ symbolStringFormat()

KLocalizedString KUnitConversion::UnitCategory::symbolStringFormat ( ) const
protected

Definition at line 65 of file unitcategory.cpp.

◆ unit() [1/2]

UnitPtr KUnitConversion::UnitCategory::unit ( const QString &  s) const

Return unit for string.

Returns
Pointer to unit class.

Definition at line 138 of file unitcategory.cpp.

◆ unit() [2/2]

UnitPtr KUnitConversion::UnitCategory::unit ( int  unitId) const

Return unit for unit enum.

Returns
Pointer to unit class.

Definition at line 143 of file unitcategory.cpp.

◆ units()

QList< UnitPtr > KUnitConversion::UnitCategory::units ( ) const

Return units in this category.

Returns
list of units.

Definition at line 70 of file unitcategory.cpp.

◆ url()

KUrl KUnitConversion::UnitCategory::url ( ) const
Returns
unit category url for description

Definition at line 181 of file unitcategory.cpp.


The documentation for this class was generated from the following files:
  • unitcategory.h
  • unitcategory.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KUnitConversion

Skip menu "KUnitConversion"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal