1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/*
enumutil.h
This file is part of GammaRay, the Qt application inspection and manipulation tool.
SPDX-FileCopyrightText: 2016 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
Author: Volker Krause <volker.krause@kdab.com>
SPDX-License-Identifier: GPL-2.0-or-later
Contact KDAB at <info@kdab.com> for commercial licensing options.
*/
#ifndef GAMMARAY_ENUMUTIL_H
#define GAMMARAY_ENUMUTIL_H
#include "gammaray_core_export.h"
#include <qglobal.h>
QT_BEGIN_NAMESPACE
class QMetaEnum;
struct QMetaObject;
class QString;
class QVariant;
QT_END_NAMESPACE
namespace GammaRay {
/*! Enum conversion utility functions. */
namespace EnumUtil {
/*!
* Determine the QMetaEnum for a given enum/flag value.
* @param value A QVariant holding the enum/flag value, numerical or
* as actual enum/flag.
* @param typeName A type name hint, in case @p value holds a numeric value.
* @param metaObject A meta object hint holding the enum definition.
* @since 2.6
*/
GAMMARAY_CORE_EXPORT QMetaEnum metaEnum(const QVariant &value, const char *typeName = nullptr, const QMetaObject *metaObject = nullptr);
/*!
* Converts the given enum or flag value into its numerical representation.
* @param value A QVariant holding the enum/flag value, numerical or
* as actual enum/flag.
* @param metaEnum The QMetaEnum defining the enum/flag.
* @since 2.6
*/
GAMMARAY_CORE_EXPORT int enumToInt(const QVariant &value, const QMetaEnum &metaEnum);
/*!
* Translates an enum or flag value into a human readable text.
* @param value The numerical value. Type information from the QVariant
* are used to find the corresponding QMetaEnum.
* @param typeName Use this if the @p value has type int
* (e.g. the case for QMetaProperty::read).
* @param metaObject QMetaObject possibly containing the definition of the enum.
*
* @return a QString containing the string version of the specified @p value.
* @since 2.6
*/
GAMMARAY_CORE_EXPORT QString enumToString(const QVariant &value, const char *typeName = nullptr,
const QMetaObject *metaObject = nullptr);
}
}
#endif // GAMMARAY_ENUMUTIL_H
|
