QGIS API Documentation
4.3.0-Master (4ecdf0f3f59)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
qgsvariantutils.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsvariantutils.h
3
------------------
4
Date : January 2022
5
Copyright : (C) 2022 Nyall Dawson
6
Email : nyall dot dawson at gmail dot com
7
***************************************************************************
8
* *
9
* This program is free software; you can redistribute it and/or modify *
10
* it under the terms of the GNU General Public License as published by *
11
* the Free Software Foundation; either version 2 of the License, or *
12
* (at your option) any later version. *
13
* *
14
***************************************************************************/
15
16
#ifndef QGSVARIANTUTILS_H
17
#define QGSVARIANTUTILS_H
18
19
#include "
qgis.h
"
20
#include "qgis_core.h"
21
#include "
qgis_sip.h
"
22
31
class
CORE_EXPORT
QgsVariantUtils
32
{
33
public
:
39
static
QString
typeToDisplayString
( QMetaType::Type type, QMetaType::Type subType = QMetaType::Type::UnknownType );
40
47
Q_DECL_DEPRECATED
static
QString
typeToDisplayString
( QVariant::Type type, QVariant::Type subType = QVariant::Type::Invalid )
SIP_DEPRECATED
;
48
57
static
bool
isNull
(
const
QVariant &variant,
bool
silenceNullWarnings
SIP_PYARGREMOVE
=
false
);
58
63
static
bool
isNumericType
( QMetaType::Type metaType );
64
70
static
QMetaType::Type
variantTypeToMetaType
( QVariant::Type variantType )
SIP_SKIP
;
71
84
static
QVariant::Type
metaTypeToVariantType
( QMetaType::Type metaType )
SIP_SKIP
;
85
91
static
bool
isUnsetAttributeValue
(
const
QVariant &variant )
SIP_SKIP
;
92
93
// TODO QGIS 5 remove this method
94
99
static
QVariant
createNullVariant
( QMetaType::Type metaType )
SIP_SKIP
;
100
115
static
QString
displayString
(
const
QVariant &variant,
int
precision = -1 );
116
123
static
QString
variantToHtml
(
const
QVariantMap &variant,
const
QString &title )
SIP_SKIP
;
124
};
125
126
#endif
// QGSVARIANTUTILS_H
QgsVariantUtils
Contains utility functions for working with QVariants and QVariant types.
Definition
qgsvariantutils.h:32
QgsVariantUtils::variantTypeToMetaType
static QMetaType::Type variantTypeToMetaType(QVariant::Type variantType)
Converts a QVariant::Type to a QMetaType::Type.
Definition
qgsvariantutils.cpp:501
QgsVariantUtils::displayString
static QString displayString(const QVariant &variant, int precision=-1)
Returns a localized representation of value with the given precision, if precision is -1 then precisi...
Definition
qgsvariantutils.cpp:633
QgsVariantUtils::isNull
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
Definition
qgsvariantutils.cpp:176
QgsVariantUtils::typeToDisplayString
static QString typeToDisplayString(QMetaType::Type type, QMetaType::Type subType=QMetaType::Type::UnknownType)
Returns a user-friendly translated string representing a QVariant type.
Definition
qgsvariantutils.cpp:44
QgsVariantUtils::createNullVariant
static QVariant createNullVariant(QMetaType::Type metaType)
Helper method to properly create a null QVariant from a metaType Returns the created QVariant.
Definition
qgsvariantutils.cpp:628
QgsVariantUtils::isNumericType
static bool isNumericType(QMetaType::Type metaType)
Returns true if the specified metaType is a numeric type.
Definition
qgsvariantutils.cpp:480
QgsVariantUtils::isUnsetAttributeValue
static bool isUnsetAttributeValue(const QVariant &variant)
Check if the variant is a QgsUnsetAttributeValue.
Definition
qgsvariantutils.cpp:623
QgsVariantUtils::metaTypeToVariantType
static QVariant::Type metaTypeToVariantType(QMetaType::Type metaType)
Converts a QMetaType::Type to a QVariant::Type.
Definition
qgsvariantutils.cpp:507
QgsVariantUtils::variantToHtml
static QString variantToHtml(const QVariantMap &variant, const QString &title)
Exports a variant map to a HTML formatted representation.
Definition
qgsvariantutils.cpp:738
qgis.h
qgis_sip.h
SIP_DEPRECATED
#define SIP_DEPRECATED
Definition
qgis_sip.h:113
SIP_SKIP
#define SIP_SKIP
Definition
qgis_sip.h:138
SIP_PYARGREMOVE
#define SIP_PYARGREMOVE
Definition
qgis_sip.h:163
Generated on
for QGIS API Documentation by
1.17.0