Libksysguard

FormatterWrapper.h
1 /*
2  Copyright (C) 2020 Arjen Hiemstra <[email protected]>
3 
4  This library is free software; you can redistribute it and/or
5  modify it under the terms of the GNU Library General Public
6  License as published by the Free Software Foundation; either
7  version 2 of the License, or (at your option) any later version.
8 
9  This library is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  Library General Public License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to
16  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  Boston, MA 02110-1301, USA.
18 */
19 
20 #pragma once
21 
22 #include <QObject>
23 
24 #include "Unit.h"
25 
26 namespace KSysGuard {
27 
28 /**
29  * Tiny helper class to make Formatter usable from QML.
30  *
31  * An instance of this class will be exposed as a Singleton object to QML. It
32  * allows formatting of values from the QML side.
33  *
34  * This effectively wraps Formatter::formatValue, removing the FormatOptions flag
35  * that I couldn't get to work.
36  *
37  * It is accessible as `Formatter` inside the `org.kde.ksysguard.formatter` package
38  * @see Formatter
39  */
40 class FormatterWrapper : public QObject
41 {
42  Q_OBJECT
43 
44 public:
45  Q_INVOKABLE QString formatValue(const QVariant &value, KSysGuard::Unit unit,
46  KSysGuard::MetricPrefix targetPrefix = MetricPrefixAutoAdjust
47  );
48 
49  Q_INVOKABLE QString formatValueShowNull(const QVariant &value, KSysGuard::Unit unit,
50  KSysGuard::MetricPrefix targetPrefix = MetricPrefixAutoAdjust
51  );
52 };
53 
54 }
Tiny helper class to make Formatter usable from QML.
Q_OBJECTQ_OBJECT
Q_INVOKABLEQ_INVOKABLE
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Thu Mar 4 2021 23:09:25 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.