PySide6.QtScxml.QScxmlEvent

class QScxmlEvent

QScxmlEvent 类是用于 Qt SCXML 状态机的事件。更多…

概要

属性

方法

注意

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

详细描述

SCXML 事件 驱动状态转换。大多数事件是通过在应用程序中使用 和 元素生成的。状态机会自动生成一些强制性事件，例如错误。

欲了解更多信息，请参阅SCXML规范 - 5.10.1 事件的内部结构。有关Qt SCXML API与规范差异的更多信息，请参阅SCXML合规性。

另请参阅

QScxmlStateMachine

class EventType

此枚举类型指定了SCXML事件的类型：

常量

描述

QScxmlEvent.PlatformEvent

由状态机内部生成的事件。例如，错误。

QScxmlEvent.InternalEvent

由元素生成的事件。

QScxmlEvent.ExternalEvent

由元素生成的事件。

注意

当使用from __feature__ import true_property时，属性可以直接使用，否则通过访问器函数使用。

property dataᅟ: object

此属性包含发送者包含的数据。

当在元素中使用元素时，数据将包含一个QVariantMap，其中键是name属性，值取自expr属性或location属性。

当使用元素时，数据将包含一个单独的项目，该项目要么是元素的expr属性的值，要么是元素的子数据。

Access functions:
property delayᅟ: int

此属性保存处理元素后事件应传递的延迟时间（以毫秒为单位）。

Access functions:
property errorEventᅟ: bool

此属性表示事件是否代表错误。

Access functions:
property errorMessageᅟ: str

此属性保存错误事件的错误消息，或一个空的QString。

Access functions:
property eventTypeᅟ: QScxmlEvent.EventType

此属性保存事件的类型。

Access functions:
property invokeIdᅟ: str

如果事件是由状态机生成的，此属性保存调用状态机的ID。

Access functions:
property nameᅟ: str

此属性保存事件的名称。

如果事件是在SCXML文档内部生成的，此属性将保存或元素内指定的event属性的值。

如果事件是在C++代码中创建并提交给QScxmlStateMachine，则此属性的值与SCXML文档中元素内指定的event属性的值相匹配。

Access functions:
property originᅟ: str

此属性保存指向SCXML事件起源的URI。

原点相当于元素的target属性。

Access functions:
property originTypeᅟ: str

此属性保存SCXML事件的原始类型。

原始类型等同于元素的type属性。

Access functions:
property scxmlTypeᅟ: str

此属性保存事件类型。

Access functions:
property sendIdᅟ: str

此属性保存事件的ID。

ID由元素使用，用于标识要取消的事件。

注意

如果未在元素中指定id属性，状态机会生成一个唯一的ID。生成的ID可以通过此属性访问。

Access functions:
__init__()

创建一个新的外部SCXML事件。

__init__(other)
Parameters:

其他 – QScxmlEvent

构造other的副本。

clear()

清除事件的内容。

data()
Return type:

对象

返回发送者包含的数据。

另请参阅

setData()

属性 dataᅟ 的获取器。

delay()
Return type:

整数

返回以毫秒为单位的延迟，该延迟是在处理元素后此事件将被传递的时间。

另请参阅

setDelay()

属性 delayᅟ 的获取器。

errorMessage()
Return type:

字符串

如果这是一个错误事件，返回错误信息。否则，返回一个空的QString。

另请参阅

setErrorMessage()

属性 errorMessageᅟ 的获取器。

eventType()
Return type:

EventType

返回此事件的类型。

另请参阅

setEventType() EventType

属性 eventTypeᅟ 的获取器。

invokeId()
Return type:

字符串

如果此事件由调用的状态机生成，则返回元素的ID。否则，返回空值。

另请参阅

setInvokeId()

属性 invokeIdᅟ 的获取器。

isErrorEvent()
Return type:

布尔

当这是一个错误事件时返回true，否则返回false。

属性 errorEventᅟ 的获取器。

name()
Return type:

字符串

返回事件的名称。

另请参阅

setName()

获取属性 nameᅟ 的Getter。

origin()
Return type:

字符串

返回指向SCXML事件起源的URI。

另请参阅

setOrigin()

属性 originᅟ 的获取器。

originType()
Return type:

字符串

返回SCXML事件的原始类型。

另请参阅

setOriginType()

属性 originTypeᅟ 的获取器。

scxmlType()
Return type:

字符串

返回事件类型。

属性 scxmlTypeᅟ 的获取器。

sendId()
Return type:

字符串

返回事件的ID。

另请参阅

setSendId()

属性 sendIdᅟ 的获取器。

setData(data)
Parameters:

数据 – 对象

将有效载荷数据设置为 data。

另请参阅

data

属性 dataᅟ 的设置器。

setDelay(delayInMiliSecs)
Parameters:

delayInMiliSecs – int

将延迟时间（以毫秒为单位）设置为delayInMiliSecs的值。

另请参阅

delay

属性 delayᅟ 的设置器。

setErrorMessage(message)
Parameters:

消息 – str

如果这是一个错误事件，message 将被设置为错误信息。

另请参阅

errorMessage()

属性 errorMessageᅟ 的设置器。

setEventType(type)
Parameters:

类型 – EventType

将事件类型设置为 type。

另请参阅

eventType EventType

属性 eventTypeᅟ 的设置器。

setInvokeId(invokeId)
Parameters:

invokeId – str

将调用的状态机的ID设置为invokeid。

另请参阅

invokeId

属性 invokeIdᅟ 的设置器。

setName(name)
Parameters:

name – str

将事件的名称设置为name。

另请参阅

name()

属性 nameᅟ 的设置器。

setOrigin(origin)
Parameters:

origin – str

将SCXML事件的来源设置为origin。

另请参阅

origin

属性 originᅟ 的设置器。

setOriginType(originType)
Parameters:

originType – str

将SCXML事件的起源类型设置为origintype。

另请参阅

originType

属性 originTypeᅟ 的设置器。

setSendId(sendId)
Parameters:

sendId – str

设置此事件的ID sendid。

另请参阅

sendId()

属性 sendIdᅟ 的设置器。