PySide6.QtCore.QMetaType

class QMetaType

QMetaType 类管理元对象系统中的命名类型。更多…

概要

方法

静态函数

注意

本文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译问题，您也可以通过在我们的https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们。

详细描述

警告

本节包含从C++自动翻译到Python的代码片段，可能包含错误。

该类用作在QVariant以及队列信号和槽连接中编组类型的辅助工具。它将类型名称与类型关联起来，以便在运行时动态创建和销毁。

类型名称可以通过使用qRegisterMetaType()或registerType()注册到QMetaType。大多数操作不需要注册；只有在尝试将字符串形式的类型名称解析回QMetaType对象或类型ID时才需要注册。这些操作包括使用connect()进行的一些旧式信号-槽连接、从QDataStream读取用户类型到QVariant，或绑定到其他语言和IPC机制，如QML、D-Bus、JavaScript等。

以下代码通过名称分配并销毁MyClass的实例，这要求MyClass之前已被注册：

type = QMetaType.fromName("MyClass")
if type.isValid():
    myClassPtr = type.create()
    ...
    type.destroy(myClassPtr)
    myClassPtr = None

如果我们希望流操作符 operator<<() 和 operator>>() 能够处理存储自定义类型的 QVariant 对象，自定义类型必须提供 operator<<() 和 operator>>() 操作符。

另请参阅

Q_DECLARE_METATYPE() setValue() value() fromValue()

class Type

(继承自 enum.IntEnum) 这些是 QMetaType 支持的内置类型：

常量

描述

QMetaType.Void

void

QMetaType.Bool

bool

QMetaType.Int

int

QMetaType.UInt

unsigned int

QMetaType.Double

double

QMetaType.QChar

QChar

QMetaType.QString

QString

QMetaType.QByteArray

QByteArray

QMetaType.Nullptr

std::nullptr_t

QMetaType.VoidStar

void *

QMetaType.Long

long

QMetaType.LongLong

长整型

QMetaType.Short

short

QMetaType.Char

char

QMetaType.Char16

char16_t

QMetaType.Char32

char32_t

QMetaType.ULong

unsigned long

QMetaType.ULongLong

ULongLong

QMetaType.UShort

unsigned short

QMetaType.SChar

有符号 字符

QMetaType.UChar

unsigned char

QMetaType.Float

float

QMetaType.Float16

qfloat16

QMetaType.QObjectStar

QObject *

QMetaType.QCursor

QCursor

QMetaType.QDate

QDate

QMetaType.QSize

QSize

QMetaType.QTime

QTime

QMetaType.QVariantList

QVariantList

QMetaType.QPolygon

QPolygon

QMetaType.QPolygonF

QPolygonF

QMetaType.QColor

QColor

QMetaType.QColorSpace

QColorSpace（在Qt 5.15中引入）

QMetaType.QSizeF

QSizeF

QMetaType.QRectF

QRectF

QMetaType.QLine

QLine

QMetaType.QTextLength

QTextLength

QMetaType.QStringList

QStringList

QMetaType.QVariantMap

QVariantMap

QMetaType.QVariantHash

QVariantHash

QMetaType.QVariantPair

QVariantPair

QMetaType.QIcon

QIcon

QMetaType.QPen

QPen

QMetaType.QLineF

QLineF

QMetaType.QTextFormat

QTextFormat

QMetaType.QRect

QRect

QMetaType.QPoint

QPoint

QMetaType.QUrl

QUrl

QMetaType.QRegularExpression

QRegularExpression

QMetaType.QDateTime

QDateTime

QMetaType.QPointF

QPointF

QMetaType.QPalette

QPalette

QMetaType.QFont

QFont

QMetaType.QBrush

QBrush

QMetaType.QRegion

QRegion

QMetaType.QBitArray

QBitArray

QMetaType.QImage

QImage

QMetaType.QKeySequence

QKeySequence

QMetaType.QSizePolicy

QSizePolicy

QMetaType.QPixmap

QPixmap

QMetaType.QLocale

QLocale

QMetaType.QBitmap

QBitmap

QMetaType.QTransform

QTransform

QMetaType.QMatrix4x4

QMatrix4x4

QMetaType.QVector2D

QVector2D

QMetaType.QVector3D

QVector3D

QMetaType.QVector4D

QVector4D

QMetaType.QQuaternion

QQuaternion

QMetaType.QEasingCurve

QEasingCurve

QMetaType.QJsonValue

QJsonValue

QMetaType.QJsonObject

QJsonObject

QMetaType.QJsonArray

QJsonArray

QMetaType.QJsonDocument

QJsonDocument

QMetaType.QCborValue

QCborValue

QMetaType.QCborArray

QCborArray

QMetaType.QCborMap

QCborMap

QMetaType.QCborSimpleType

QCborSimpleType

QMetaType.QModelIndex

QModelIndex

QMetaType.QPersistentModelIndex

QPersistentModelIndex（在Qt 5.5中引入）

QMetaType.QUuid

QUuid

QMetaType.QByteArrayList

QByteArrayList

QMetaType.QVariant

QVariant

QMetaType.User

用户类型的基础值

QMetaType.UnknownType

这是一个无效的类型ID。它由QMetaType返回，用于未注册的类型

可以使用qRegisterMetaType()或通过调用registerType()来注册其他类型。

另请参阅

type() typeName()

class TypeFlag

(继承自 enum.Flag) 该枚举描述了由 QMetaType 支持的类型的属性。

常量

描述

QMetaType.NeedsConstruction

此类型具有默认构造函数。如果未设置此标志，则可以使用memset安全地将实例初始化为0。

QMetaType.NeedsCopyConstruction

(自6.5版本起) 此类型具有非平凡的复制构造函数。如果未设置此标志，则可以使用memcpy复制实例。

QMetaType.NeedsMoveConstruction

(自6.5版本起) 此类型具有非平凡的移动构造函数。如果未设置此标志，实例可以通过memcpy移动。

QMetaType.NeedsDestruction

此类型具有非平凡的析构函数。如果未设置此标志，则在丢弃对象之前不需要调用析构函数。

QMetaType.RelocatableType

具有此属性的类型的实例可以使用memcpy安全地移动到不同的内存位置。

QMetaType.IsEnumeration

此类型是一个枚举。

QMetaType.IsUnsignedEnumeration

如果类型是枚举类型，其基础类型是无符号的。

QMetaType.PointerToQObject

此类型是指向从QObject派生的类的指针。

QMetaType.IsPointer

此类型是指向另一种类型的指针。

QMetaType.IsConst

表示此类型的值是不可变的；例如，因为它们是指向常量对象的指针。

注意

在 Qt 6.5 之前，如果复制构造函数或析构函数是非平凡的（即类型不是平凡的），则 NeedsConstruction 和 NeedsDestruction 标志都会被错误地设置。

请注意，Needs 标志可能已设置，但元类型可能没有相关类型的公开可访问构造函数或公开可访问析构函数。

__init__()

构造一个默认的、无效的QMetaType对象。

__init__(py_type)
Parameters:

py_type – PyTypeObject

__init__(type)
Parameters:

类型 – Type

__init__(type)
Parameters:

类型 – int

构造一个QMetaType对象，该对象包含有关类型typeId的所有信息。

alignOf()
Return type:

整数

返回类型的对齐方式（以字节为单位）（即alignof(T)，其中T是此QMetaType实例所构造的实际类型）。

此函数通常与construct()一起使用，以执行对类型使用的内存的低级管理。

另请参阅

construct() sizeOf()

static canConvert(fromType, toType)
Parameters:
Return type:

布尔

如果convert可以从fromType转换为toType，则返回true。

Qt支持以下转换：

类型

自动转换为

Bool

QChar , Double , Int , LongLong , QString , UInt , ULongLong

QByteArray

Double , Int , LongLong , QString , UInt , ULongLong , QUuid

QChar

Bool , Int , UInt , LongLong , ULongLong

QColor

QString

QDate

QDateTime , QString

QDateTime

QDate , QString , QTime

Double

Bool , Int , LongLong , QString , UInt , ULongLong

QFont

QString

Int

Bool , QChar , Double , LongLong , QString , UInt , ULongLong

QKeySequence

Int , QString

QVariantList

QStringList（如果列表的项可以转换为QStrings）

LongLong

Bool , QByteArray , QChar , Double , Int , QString , UInt , ULongLong

QPoint

QPointF

QRect

QRectF

QString

Bool , QByteArray , QChar , QColor , QDate , QDateTime , Double , QFont , Int , QKeySequence , LongLong , QStringList , QTime , UInt , ULongLong , QUuid

QStringList

QVariantList , QString (如果列表恰好包含一个项目)

QTime

QString

UInt

Bool , QChar , Double , Int , LongLong , QString , ULongLong

ULongLong

Bool , QChar , Double , Int , LongLong , QString , UInt

QUuid

QByteArray , QString

支持在基本类型（int, float, bool 等）之间进行转换。

如果从fromType描述的类型到toType描述的类型的qobject_cast成功，那么对于从QObject派生的类型的指针之间的转换，此函数也将返回true。

如果toType是QVariantList，那么从顺序容器的转换也会对此函数返回true。

同样地，当toType是QVariantHash或QVariantMap时，从关联容器的转换也会对此函数返回true。

另请参阅

convert() QSequentialIterable Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE() QAssociativeIterable Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE()

static canView(fromType, toType)
Parameters:
Return type:

布尔

如果view可以在类型fromType上创建类型toType的可变视图，则返回true。

如果从fromType描述的类型到toType描述的类型的qobject_cast成功，则对于从QObject派生的类型的指针之间的转换，此函数将返回true。

你可以在任何使用Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE()注册的容器上创建一个QSequentialIterable类型的可变视图。

同样，你可以在任何使用Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE()注册的容器上创建一个QAssociativeIterable类型的可变视图。

另请参阅

convert() QSequentialIterable Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE() QAssociativeIterable Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE()

static compare(lhs, rhs, typeId, result)
Parameters:

  • lhs – void

  • rhs – void

  • typeId – int

  • result – int

Return type:

布尔

注意

此函数已弃用。

请使用非静态的compare方法代替

比较lhs和rhs处的对象。两个对象都需要是typeId类型。如果lhs小于、等于或大于rhs，则result被设置为小于、等于或大于零。如果比较成功，则返回true，否则返回false。

construct(where[, copy=None])
Parameters:

  • where – void

  • 复制 – void

Return type:

void

构造一个类型值，该类型值由QMetaType实例在where所指向的现有内存中构造，该值是copy的副本，并返回where。如果copy为零，则该值将默认构造。

这是一个用于显式管理用于存储类型的内存底层函数。如果您不需要这种级别的控制（即使用“new”而不是“placement new”），请考虑调用create()。

你必须确保where指向一个可以存储新值的位置，并且where是适当对齐的。可以通过调用sizeOf()来查询类型的大小。

对齐的经验法则是，类型对齐到其自然边界，这是大于该类型的最小2的幂，除非该对齐大于平台的最大有用对齐。出于实际目的，大于2 * sizeof(void*)的对齐仅对特殊硬件指令（例如，x86上的对齐SSE加载和存储）是必要的。

static construct(type, where, copy)
Parameters:

  • type – int

  • where – void

  • copy – void

Return type:

void

注意

此函数已弃用。

在由where指定的现有内存中构造给定type的值，该值是copy的副本，并返回where。如果copy为零，则该值将默认构造。

这是一个用于显式管理用于存储类型的内存低级函数。如果您不需要这种级别的控制（即使用“new”而不是“placement new”），请考虑调用create()。

您必须确保where指向一个可以存储type类型值的位置，并且where是适当对齐的。可以通过调用sizeOf()来查询类型的大小。

对齐的经验法则是，类型对齐到其自然边界，这是大于该类型的最小2的幂，除非该对齐大于平台的最大有用对齐。出于实际目的，大于2 * sizeof(void*)的对齐仅对特殊硬件指令（例如，x86上的对齐SSE加载和存储）是必要的。

另请参阅

destruct() sizeOf()

static convert(fromType, from, toType, to)
Parameters:
Return type:

布尔

将位于from的对象从fromType转换为预分配的空间to，类型为toType。如果转换成功，则返回true，否则返回false。

两个 from 和 to 都必须是有效的指针。

static convert(from, fromTypeId, to, toTypeId)
Parameters:

  • from – void

  • fromTypeId – int

  • to – void

  • toTypeId – int

Return type:

布尔

注意

此函数已弃用。

将位于 from 的对象从 fromTypeId 转换为位于 to 的预分配空间，类型为 toTypeId。如果转换成功，则返回 true，否则返回 false。

两个 from 和 to 都必须是有效的指针。

create([copy=None])
Parameters:

复制 – void

Return type:

void

返回copy的副本，假设它是为此QMetaType实例创建的类型。如果copy是None，则创建一个默认构造的实例。

另请参阅

destroy()

static create(type[, copy=None])
Parameters:

  • type – int

  • copy – void

Return type:

void

注意

此函数已弃用。

返回copy的副本，假设它是type类型。如果copy为零，则创建一个默认构造的实例。

destroy(data)
Parameters:

数据 – void

销毁data，假设它是为此QMetaType实例创建的类型。

另请参阅

create()

static destroy(type, data)
Parameters:

  • type – int

  • data – void

注意

此函数已弃用。

销毁data，假设它是给定的type。

destruct(data)
Parameters:

数据 – void

销毁位于data的值，假设它是为此QMetaType实例构造的类型。

与destroy()不同，此函数仅调用类型的析构函数，而不调用delete操作符。

另请参阅

construct()

static destruct(type, where)
Parameters:

  • type – int

  • where – void

注意

此函数已弃用。

销毁位于 where 的给定 type 的值。

与destroy()不同，此函数仅调用类型的析构函数，而不调用delete操作符。

另请参阅

construct()

equals(lhs, rhs)
Parameters:

  • lhs – void

  • rhs – void

Return type:

布尔

比较lhs和rhs处的对象是否相等。

两个对象必须属于此元类型所描述的类型。只有当元类型声明中可见该类型的小于或等于运算符时，才能比较这两个对象。否则，元类型永远不会认为值相等。当元类型声明中可见等于运算符时，它是权威的；否则，如果可见小于运算符，当两个值都不小于对方时，则认为它们相等。如果值是无序的（详见compare()），则它们不相等。

如果两个对象比较相等，则返回 true，否则返回 false。

static equals(lhs, rhs, typeId, result)
Parameters:

  • lhs – void

  • rhs – void

  • typeId – int

  • result – int

Return type:

布尔

注意

此函数已弃用。

flags()
Return type:

TypeFlag的组合

返回此QMetaType实例构造的类型的标志。要检查特定的类型特性，建议使用“is-”函数之一，而不是直接使用标志。

static fromName(name)
Parameters:

name – QByteArrayView

Return type:

QMetaType

返回一个与typeName匹配的QMetaType。如果QMetaType不知道typeName，则返回的对象无效。

static hasRegisteredConverterFunction(fromType, toType)
Parameters:
Return type:

布尔

如果元类型系统具有从元类型ID fromType到toType的注册转换，则返回true

hasRegisteredDataStreamOperators()
Return type:

布尔

如果元类型系统已为此元类型注册了数据流操作符，则返回true。

hasRegisteredDebugStreamOperator()
Return type:

布尔

如果元类型系统为此元类型注册了调试流操作符，则返回 true。

static hasRegisteredDebugStreamOperator(typeId)
Parameters:

typeId – int

Return type:

布尔

注意

此函数已弃用。

请使用 hasRegisteredDebugStreamOperator() 代替。

如果元类型系统为类型ID typeId 注册了调试流操作符，则返回 true。

static hasRegisteredMutableViewFunction(fromType, toType)
Parameters:
Return type:

布尔

如果元类型系统在元类型ID fromType 到元类型ID toType 上注册了可变视图，则返回 true。

id([arg__1=0])
Parameters:

arg__1 – 整数

Return type:

整数

isCopyConstructible()
Return type:

布尔

如果此类型可以复制构造，则返回true。如果可以，则construct()和create()可以与不为空的copy参数一起使用。

isDefaultConstructible()
Return type:

布尔

如果此类型可以默认构造，则返回true。如果可以，则construct()和create()可以与为null的copy参数一起使用。

isDestructible()
Return type:

布尔

如果此类型可以被销毁，则返回true。如果可以，则可以调用destroy()和destruct()。

isEqualityComparable()
Return type:

布尔

如果此元类型描述的类型的“小于或等于”运算符对元类型声明可见，则返回true，否则返回false。

另请参阅

equals() isOrdered()

isMoveConstructible()
Return type:

布尔

如果此类型可以移动构造，则返回true。QMetaType目前没有API可以利用此特性。

isOrdered()
Return type:

布尔

如果此元类型描述的类型的小于运算符对元类型声明可见，则返回true，否则返回false。

isRegistered()
Return type:

布尔

如果此QMetaType对象已在Qt全局元类型注册表中注册，则返回true。注册允许通过其名称（使用fromName()）或其ID（使用构造函数）找到该类型。

另请参阅

qRegisterMetaType() isValid()

static isRegistered(type)
Parameters:

类型 – int

Return type:

布尔

如果ID为type的数据类型已注册，则返回true；否则返回false。

另请参阅

type() typeName() Type

isValid()
Return type:

布尔

如果此QMetaType对象包含有关类型的有效信息，则返回true，否则返回false。

另请参阅

isRegistered()

load(stream, data)
Parameters:
Return type:

布尔

从给定的stream中读取此类型的对象到data中。如果对象成功加载，则返回true；否则返回false。

通常情况下，您不需要直接调用此函数。相反，请使用QVariant的operator>>()，它依赖于load()来流式传输自定义类型。

另请参阅

save()

static load(stream, type, data)
Parameters:
Return type:

布尔

注意

此函数已弃用。

这是一个重载函数。

static metaObjectForType(type)
Parameters:

类型 – int

Return type:

QMetaObject

注意

此函数已弃用。

返回 metaObject 用于 type

另请参阅

metaObject()

name()
Return type:

字符串

返回与此QMetaType关联的类型名称，如果未找到匹配的类型，则返回空指针。返回的指针不得删除。

另请参阅

typeName()

__ne__(rhs)
Parameters:

rhs – QMetaType

Return type:

布尔

这是一个重载函数。

如果QMetaType lhs表示的类型与QMetaType rhs不同，则返回true，否则返回false。

__eq__(rhs)
Parameters:

rhs – QMetaType

Return type:

布尔

这是一个重载函数。

如果 QMetaType lhs 表示的类型与 QMetaType rhs 相同，则返回 true，否则返回 false。

static registerNormalizedTypedef(normalizedTypeName, type)
Parameters:
registerType()

将此QMetaType注册到类型注册表中，以便可以通过名称找到它，使用fromName()。

另请参阅

qRegisterMetaType()

save(stream, data)
Parameters:
Return type:

布尔

将data指向的对象写入给定的stream。如果对象成功保存，则返回true；否则返回false。

通常，您不需要直接调用此函数。相反，使用QVariant的operator<<()，它依赖于save()来流式传输自定义类型。

另请参阅

load()

static save(stream, type, data)
Parameters:
Return type:

布尔

注意

此函数已弃用。

这是一个重载函数。

sizeOf()
Return type:

整数

返回类型的大小（以字节为单位）（即sizeof(T)，其中T是此QMetaType实例所构建的实际类型）。

此函数通常与construct()一起使用，以执行对类型使用的内存的低级管理。

另请参阅

construct() alignOf()

static sizeOf(type)
Parameters:

类型 – int

Return type:

整数

注意

此函数已弃用。

返回给定type的大小，以字节为单位（即sizeof(T)，其中T是由type参数标识的实际类型）。

此函数通常与construct()一起使用，以执行对类型使用的内存的低级管理。

另请参阅

construct() alignOf()

static type(typeName)
Parameters:

typeName – QByteArray

Return type:

整数

注意

此函数已弃用。

这是一个重载函数。

返回一个名为typeName的类型的句柄，如果没有这样的类型则返回0。

另请参阅

isRegistered() typeName()

static type(typeName)
Parameters:

typeName – str

Return type:

整数

注意

此函数已弃用。

返回名为typeName的类型的句柄，如果没有这样的类型，则返回UnknownType。

static typeFlags(type)
Parameters:

类型 – int

Return type:

TypeFlag的组合

注意

此函数已弃用。

返回给定type的标志。

另请参阅

TypeFlags

static typeName(type)
Parameters:

类型 – int

Return type:

字符串

注意

此函数已弃用。

返回与给定typeId关联的类型名称，如果未找到匹配的类型，则返回空指针。返回的指针不得删除。

underlyingType()
Return type:

QMetaType

如果此元类型表示一个枚举，此方法返回一个与枚举底层类型具有相同符号和大小数值类的元类型。如果它表示一个QFlags类型，它返回Int。在所有其他情况下，返回一个无效的QMetaType。

static unregisterConverterFunction(from, to)
Parameters:
static unregisterMetaType(type)
Parameters:

类型 – QMetaType

static unregisterMutableViewFunction(from, to)
Parameters:
static view(fromType, from, toType, to)
Parameters:
Return type:

布尔

在预分配的空间中，在from处的fromType类型的对象上创建一个可变视图，类型为toType。如果转换成功，则返回true，否则返回false。