class QMetaType#

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

概要#

方法#

静态函数#

注意

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

详细描述#

警告

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

此类用作在QVariant和排队中的信号和槽连接处进行类型序列化的辅助工具。它将类型名称与类型关联,以便在运行时动态创建和销毁。

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

以下代码通过其名称分配和销毁 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

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

signed char

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

这是一个无效的类型标识符。当类型未注册时,从 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

表示此类型的值不可变;例如,因为它们是指向const对象的指针。

注意

在Qt 6.5之前,如果复制构造函数或析构函数非平凡(即类型不是平凡的),则错误地设置了NeedsConstruction和NeedsDestruction标志。

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

__init__(arg__1)#
参数:

arg__1PyTypeObject

__init__()

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

__init__(type)
参数:

type – int

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

__init__(arg__1)
参数:

arg__1Type

alignOf()#
返回类型::

int

以字节为单位返回类型的对齐(即alignof(T),其中T为此QMetaType实例构建的实际类型T)。

该函数通常与construct()结合使用,以执行类型使用的内存的底层管理。

另请参阅

construct() sizeOf()

static canConvert(fromType, toType)#
参数:
返回类型::

bool

如果 convert 能够将 fromType 转换为 toType,则返回 true

Qt 支持以下转换:

支持对基本类型(int、float、bool等)之间的转换。

如果从由 fromType 描述的类型到由 toType 描述的类型进行 qobject_cast 会成功,则类型继承自 QObject 的指针之间的转换将返回 true。

如果 toTypeQVariantList ,则从顺序容器到该函数的转换也会返回 true。

类似地,如果 toTypeQVariantHashQVariantMap,则从关联容器到该函数的转换也会返回 true。

另请参阅

convert() QSequentialIterable Q_DECLARE_SEQUENTIAL_CONTAINER_METATYPE() QAssociativeIterable Q_DECLARE_ASSOCIATIVE_CONTAINER_METATYPE()

static canView(fromType, toType)#
参数:
返回类型::

bool

如果 view 能在类型为 fromType 的数据上创建一个可变的视图类型为 toType,则返回 true

在类型派生自 QObject 的指针之间进行转换,如果从描述为 fromType 的类型到描述为 toType 的类型的 qobject_cast 成功,则此函数将返回 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)#
参数:
  • lhsvoid

  • rhsvoid

  • typeId – int

  • result – int

返回类型::

bool

注意

此函数已弃用。

请使用非静态比较方法

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

static construct(type, where, copy)#
参数:
  • type – int

  • wherevoid

  • copyvoid

返回类型::

void

注意

此函数已弃用。

在由 where 指定的现有内存位置中构造给定 type 的值,即 copy 的副本,并返回 where。如果 copy 为零,则构造默认值。

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

您必须确保where指向一个可以存储type类型值的地址,并且where的封装适当。可以通过调用sizeOf()获取类型的尺寸。

对齐规则通常是:一个类型对齐到其自然边界,即大于类型的最小2的幂,除非该对齐大于平台的最大有用对齐值。为了实际目的,仅有特殊硬件指令(例如,x86上的对齐SSE加载和存储)才需要大于2 * sizeof(void*)的对齐。

另请参阅

destruct() sizeOf()

construct(where[, copy=None])
参数:
  • wherevoid

  • copyvoid

返回类型::

void

在该实例根据where构建的内存中构建该类型的值,作为copy的副本,并返回where。如果copy为零,则执行默认构建。

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

您必须确保where指向可以存储新值的地址,并且where的封装适当。可以通过调用sizeOf()获取类型的尺寸。

对齐规则通常是:一个类型对齐到其自然边界,即大于类型的最小2的幂,除非该对齐大于平台的最大有用对齐值。为了实际目的,仅有特殊硬件指令(例如,x86上的对齐SSE加载和存储)才需要大于2 * sizeof(void*)的对齐。

static convert(fromType, from, toType, to)#
参数:
返回类型::

bool

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

必须确保fromto都是合法的指针。

static convert(from, fromTypeId, to, toTypeId)
参数:
  • fromvoid

  • fromTypeId – int

  • tovoid

  • toTypeId – int

返回类型::

bool

注意

此函数已弃用。

将位于 from 的对象从 fromTypeId 转换到预设空间 totoTypeId 类型。如果转换成功,则返回 true,否则返回 false。

必须确保fromto都是合法的指针。

create([copy=None])#
参数:

copyvoid

返回类型::

void

返回 copy 的副本,假设其类型与创建此 QMetaType 实例的类型相同。如果 copyNone,则创建一个默认构造的实例。

另请参阅

destroy()

static create(type[, copy=None])
参数:
  • type – int

  • copyvoid

返回类型::

void

注意

此函数已弃用。

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

static destroy(type, data)#
参数:
  • type – int

  • datavoid

注意

此函数已弃用。

销毁 data,假设其类型是给定的 type

destroy(data)
参数:

datavoid

销毁 data,假设其类型与此 QMetaType 实例相同的类型。

另请参阅

create()

static destruct(type, where)#
参数:
  • type – int

  • wherevoid

注意

此函数已弃用。

销毁指定 typewhere 位置的值。

destroy() 不同,此函数只调用类型的析构函数,并不调用删除操作符。

另请参阅

construct()

destruct(data)
参数:

datavoid

假定值位于 data,销毁该值,假设它是为此 QMetaType 实例创建的类型。

与 destroy() 不同,此函数只调用类型的析构函数,不调用删除操作符。

另请参阅

construct()

equals(lhs, rhs)#
参数:
  • lhsvoid

  • rhsvoid

返回类型::

bool

比较 lhsrhs 位置的值是否相等。

两个对象必须为该元类型描述的类型。只有在该类型的比较运算符对元类型声明可见时,才能比较这两个对象。否则,元类型 never 考虑值相等。当比较运算符对元类型声明可见时,它是权威的;否则,如果可见 "小于",当两个值都不小于对方时,它们被认为是相等的。如果值是无序的(参见 compare() 了解详细信息),它们不相等。

如果两个对象相等则返回 true,否则返回 false。

static equals(lhs, rhs, typeId, result)
参数:
  • lhsvoid

  • rhsvoid

  • typeId – int

  • result – int

返回类型::

bool

注意

此函数已弃用。

flags()#
返回类型::

TypeFlag 的组合

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

static fromName(name)#
参数:

nameQByteArrayView

返回类型::

QMetaType

返回一个匹配 typeNameQMetaType。如果 typeName 未知,返回的对象无效。

static hasRegisteredConverterFunction(fromType, toType)#
参数:
返回类型::

bool

如果元类型系统已注册从元类型 ID fromTypetoType 的转换,则返回 true

hasRegisteredDataStreamOperators()#
返回类型::

bool

如果元类型系统已为此元类型注册数据流运算符,则返回 true

hasRegisteredDebugStreamOperator()#
返回类型::

bool

如果元类型系统已为此元类型注册调试流运算符,则返回 true

static hasRegisteredDebugStreamOperator(typeId)
参数:

typeId – int

返回类型::

bool

注意

此函数已弃用。

请使用 hasRegisteredDebugStreamOperator() 替代。

如果元类型系统已注册类型 ID typeId 的调试流运算符,则返回 true

static hasRegisteredMutableViewFunction(fromType, toType)#
参数:
返回类型::

bool

如果元类型系统已在元类型 ID fromType 的可变视图上注册了元类型 ID toType,则返回 true

id([arg__1=0])#
参数:

arg__1 – int

返回类型::

int

isCopyConstructible()#
返回类型::

bool

如果此类型可以进行复制构造,则返回 true。如果可以,则可以使用非 null 的 copy 参数调用 construct() 和 create()。

isDefaultConstructible()#
返回类型::

bool

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

isDestructible()#
返回类型::

bool

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

isEqualityComparable()#
返回类型::

bool

如果描述此元类型的类型有可见的小于或等于运算符,则返回 true,否则返回 false

另请参阅

equals() isOrdered()

isMoveConstructible()#
返回类型::

bool

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

isOrdered()#
返回类型::

bool

如果此元类型描述的类型可见于元类型声明中的小于(less than)运算符,则返回 true;否则返回 false

isRegistered()#
返回类型::

bool

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

另请参阅

qRegisterMetaType() isValid()

static isRegistered(type)
参数:

type – int

返回类型::

bool

如果具有 ID type 的数据类型已注册,则返回 true;否则返回 false

另请参阅

type() typeName() Type

isValid()#
返回类型::

bool

如果这个QMetaType对象包含有关类型的有效信息,则返回 true,否则返回 false

另请参阅

isRegistered()

静态 load(stream, type, data)#
参数:
返回类型::

bool

注意

此函数已弃用。

这是一个重载函数。

load(stream, data)
参数:
返回类型::

bool

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

通常,您不需要直接调用此函数。相反,使用QVariantoperator>>(),它依赖于load()以流式传输自定义类型。

另请参阅

save()

静态 metaObjectForType(type)#
参数:

type – int

返回类型::

QMetaObject

注意

此函数已弃用。

返回类型typemetaObject

另请参阅

metaObject()

name()#
返回类型::

字符串

返回与此QMetaType关联的类型名称,或者在找不到匹配类型时返回空指针。返回的指针不得删除。

另请参阅

typeName()

__ne__(b)#
参数:

bQMetaType

返回类型::

bool

这是一个重载函数。

如果QMetaType a表示的类型与QMetaType b不同,则返回true,否则返回false

__eq__(b)#
参数:

bQMetaType

返回类型::

bool

这是一个重载函数。

如果 QMetaType a 表示与 QMetaType b 相同的类型,则返回 true,否则返回 false.

静态registerNormalizedTypedef(normalizedTypeName, type)#
参数:
registerType()#

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

另请参阅

qRegisterMetaType()

save(stream, data)#
参数:
返回类型::

bool

data 所指的对象写入给定的 stream。如果对象成功保存,则返回 true,否则返回 false.

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

另请参阅

load()

静态save(stream, type, data)
参数:
返回类型::

bool

注意

此函数已弃用。

这是一个重载函数。

sizeOf()#
返回类型::

int

返回类型的字节大小(即 sizeof(T),其中 T 是为该 QMetaType 实例构造的实际类型)。

该函数通常与construct()结合使用,以执行类型使用的内存的底层管理。

另请参阅

construct() alignOf()

静态 sizeOf(type)
参数:

type – int

返回类型::

int

注意

此函数已弃用。

返回给定 type 的大小(以字节为单位)(即 sizeof(T),其中 T 是 type 参数指明的实际类型)。

此函数通常与 construct() 一起使用,以对类型使用的内存进行底层管理。

另请参阅

construct() alignOf()

静态 type(typeName)#
参数:

typeNameQByteArray

返回类型::

int

注意

此函数已弃用。

这是一个重载函数。

返回名为 typeName 的类型的句柄,如果没有此类类型,则返回 0。

另请参阅

isRegistered() typeName()

静态 type(typeName)
参数:

typeName – str

返回类型::

int

注意

此函数已弃用。

返回名为 typeName 的类型的句柄,如果没有此类类型,则返回 UnknownType

静态 typeFlags(type)#
参数:

type – int

返回类型::

TypeFlag 的组合

注意

此函数已弃用。

返回给定 type 的标志。

另请参阅

TypeFlags

静态 typeName(type)#
参数:

type – int

返回类型::

字符串

注意

此函数已弃用。

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

underlyingType()#
返回类型::

QMetaType

如果这种元类型代表枚举,则此方法返回与枚举基础类型相同的有符号性和大小的数值类元类型。如果它表示 QFlags 类型,则返回 Int 。在所有其他情况下,返回一个无效的 QMetaType

静态 unregisterConverterFunction(from, to)#
参数:
静态 unregisterMetaType(type)#
参数:

typeQMetaType

静态 unregisterMutableViewFunction(from, to)#
参数:
静态 view(fromType, from, toType, to)#
参数:
返回类型::

bool

to 预留的空间中对 from 的对象创建一个 fromType 可变视图。如果转换成功,则返回 true,否则返回 false