KCoreAddons

kformat.cpp
1/* This file is part of the KDE Frameworks
2
3 SPDX-FileCopyrightText: 2013 Alex Merry <alex.merry@kdemail.net>
4 SPDX-FileCopyrightText: 2013 John Layt <jlayt@kde.org>
5 SPDX-FileCopyrightText: 2010 Michael Leupold <lemma@confuego.org>
6 SPDX-FileCopyrightText: 2009 Michael Pyne <mpyne@kde.org>
7 SPDX-FileCopyrightText: 2008 Albert Astals Cid <aacid@kde.org>
8
9 SPDX-License-Identifier: LGPL-2.0-or-later
10*/
11
12#include "kformatprivate_p.h"
13
15 : d(new KFormatPrivate(locale))
16{
17}
18
20 : d(other.d)
21{
22}
23
24KFormat &KFormat::operator=(const KFormat &other)
25{
26 d = other.d;
27 return *this;
28}
29
33
35{
36 return d->formatByteSize(size, precision, dialect, units);
37}
38
39QString KFormat::formatValue(double value, KFormat::Unit unit, int precision, KFormat::UnitPrefix prefix, KFormat::BinaryUnitDialect dialect) const
40{
41 return d->formatValue(value, unit, QString(), precision, prefix, dialect);
42}
43
44QString KFormat::formatValue(double value, const QString &unit, int precision, KFormat::UnitPrefix prefix) const
45{
46 return d->formatValue(value, KFormat::Unit::Other, unit, precision, prefix, MetricBinaryDialect);
47}
48
49// TODO KF6 Merge both methods
50QString KFormat::formatValue(double value, const QString &unit, int precision, KFormat::UnitPrefix prefix, KFormat::BinaryUnitDialect dialect) const
51{
52 return d->formatValue(value, KFormat::Unit::Other, unit, precision, prefix, dialect);
53}
54
56{
57 return d->formatDuration(msecs, options);
58}
59
60QString KFormat::formatDecimalDuration(quint64 msecs, int decimalPlaces) const
61{
62 return d->formatDecimalDuration(msecs, decimalPlaces);
63}
64
66{
67 return d->formatSpelloutDuration(msecs);
68}
69
71{
72 return d->formatRelativeDate(date, format);
73}
74
76{
77 return d->formatRelativeDateTime(dateTime, format);
78}
79
80#include "moc_kformat.cpp"
KFormat provides support for formatting numbers and datetimes in formats that are not supported by QL...
Definition kformat.h:59
QString formatByteSize(double size, int precision=1, KFormat::BinaryUnitDialect dialect=KFormat::DefaultBinaryDialect, KFormat::BinarySizeUnits units=KFormat::DefaultBinaryUnits) const
Converts size from bytes to the appropriate string representation using the binary unit dialect diale...
Definition kformat.cpp:34
QString formatRelativeDateTime(const QDateTime &dateTime, QLocale::FormatType format) const
Returns a string formatted to a relative datetime style.
Definition kformat.cpp:75
~KFormat()
Destructor.
Definition kformat.cpp:30
QString formatDecimalDuration(quint64 msecs, int decimalPlaces=2) const
Given a number of milliseconds, converts that to a string containing the localized equivalent to the ...
Definition kformat.cpp:60
QString formatValue(double value, KFormat::Unit unit, int precision=1, KFormat::UnitPrefix prefix=KFormat::UnitPrefix::AutoAdjust, KFormat::BinaryUnitDialect dialect=KFormat::DefaultBinaryDialect) const
Converts value to the appropriate string representation.
Definition kformat.cpp:39
QString formatSpelloutDuration(quint64 msecs) const
Given a number of milliseconds, converts that to a spell-out string containing the localized equivale...
Definition kformat.cpp:65
QString formatDuration(quint64 msecs, KFormat::DurationFormatOptions options=KFormat::DefaultDuration) const
Given a number of milliseconds, converts that to a string containing the localized equivalent,...
Definition kformat.cpp:55
Unit
These units are used in KDE by the formatValue() function.
Definition kformat.h:107
KFormat(const QLocale &locale=QLocale())
Constructs a KFormat.
Definition kformat.cpp:14
UnitPrefix
These prefixes are used in KDE by the formatValue() function.
Definition kformat.h:126
QString formatRelativeDate(const QDate &date, QLocale::FormatType format) const
Returns a string formatted to a relative date style.
Definition kformat.cpp:70
BinaryUnitDialect
This enum chooses what dialect is used for binary units.
Definition kformat.h:171
@ MetricBinaryDialect
SI Units, kB, MB, etc. 10^(3*n)
Definition kformat.h:175
BinarySizeUnits
These binary units are used in KDE by the formatByteSize() function.
Definition kformat.h:84
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 7 2024 12:01:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.