<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qscxmlevent.cpp -->
<title>QScxmlEvent Class | Qt SCXML 5.12.6</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qtscxml-index.html">Qt SCXML</a></td><td ><a href="qtscxml-module.html">C++ Classes</a></td><td >QScxmlEvent</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtscxml-index.html">Qt 5.12.6 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QScxmlEvent Class</h1>
<!-- $$$QScxmlEvent-brief -->
<p>The <a href="qscxmlevent.html">QScxmlEvent</a> class is an event for a Qt SCXML state machine. <a href="#details">More...</a></p>
<!-- @@@QScxmlEvent -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QScxmlEvent></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += scxml</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.7</td></tr></table></div><ul>
<li><a href="qscxmlevent-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#EventType-enum">EventType</a></b> { PlatformEvent, InternalEvent, ExternalEvent }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qscxmlevent.html#data-prop">data</a></b> : QVariant</li>
<li class="fn"><b><a href="qscxmlevent.html#delay-prop">delay</a></b> : int</li>
<li class="fn"><b><a href="qscxmlevent.html#errorEvent-prop">errorEvent</a></b> : const bool</li>
<li class="fn"><b><a href="qscxmlevent.html#errorMessage-prop">errorMessage</a></b> : QString</li>
<li class="fn"><b><a href="qscxmlevent.html#eventType-prop">eventType</a></b> : EventType</li>
<li class="fn"><b><a href="qscxmlevent.html#invokeId-prop">invokeId</a></b> : QString</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qscxmlevent.html#name-prop">name</a></b> : QString</li>
<li class="fn"><b><a href="qscxmlevent.html#origin-prop">origin</a></b> : QString</li>
<li class="fn"><b><a href="qscxmlevent.html#originType-prop">originType</a></b> : QString</li>
<li class="fn"><b><a href="qscxmlevent.html#scxmlType-prop">scxmlType</a></b> : const QString</li>
<li class="fn"><b><a href="qscxmlevent.html#sendId-prop">sendId</a></b> : QString</li>
</ul>
</td></tr>
</table></div>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#QScxmlEvent">QScxmlEvent</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#QScxmlEvent-1">QScxmlEvent</a></b>(const QScxmlEvent &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#dtor.QScxmlEvent">~QScxmlEvent</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#clear">clear</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#data">data</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#delay">delay</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#errorMessage">errorMessage</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QScxmlEvent::EventType </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#eventType">eventType</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#invokeId">invokeId</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#isErrorEvent">isErrorEvent</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#name">name</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#origin">origin</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#originType">originType</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#scxmlType">scxmlType</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#sendId">sendId</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#setData">setData</a></b>(const QVariant &<i>data</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#setDelay">setDelay</a></b>(int <i>delayInMiliSecs</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#setErrorMessage">setErrorMessage</a></b>(const QString &<i>message</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#setEventType">setEventType</a></b>(const QScxmlEvent::EventType &<i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#setInvokeId">setInvokeId</a></b>(const QString &<i>invokeid</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#setName">setName</a></b>(const QString &<i>name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#setOrigin">setOrigin</a></b>(const QString &<i>origin</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#setOriginType">setOriginType</a></b>(const QString &<i>origintype</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#setSendId">setSendId</a></b>(const QString &<i>sendid</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QScxmlEvent &</td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#operator-eq">operator=</a></b>(const QScxmlEvent &<i>other</i>)</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qscxmlevent.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QScxmlEvent-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qscxmlevent.html">QScxmlEvent</a> class is an event for a Qt SCXML state machine.</p>
<p>SCXML <i>events</i> drive transitions. Most events are generated by using the <code><raise></code> and <code><send></code> elements in the application. The state machine automatically generates some mandatory events, such as errors.</p>
<p>For more information, see <a href="https://www.w3.org/TR/scxml/#InternalStructureofEvents">SCXML Specification - 5.10.1 The Internal Structure of Events</a>. For more information about how the Qt SCXML API differs from the specification, see <a href="qtscxml-scxml-compliance.html">SCXML Compliance</a>.</p>
</div>
<p><b>See also </b><a href="qscxmlstatemachine.html">QScxmlStateMachine</a>.</p>
<!-- @@@QScxmlEvent -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$EventType$$$PlatformEvent$$$InternalEvent$$$ExternalEvent -->
<h3 class="fn" id="EventType-enum"><a name="EventType-enum"></a>enum QScxmlEvent::<span class="name">EventType</span></h3>
<p>This enum type specifies the type of an SCXML event:</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QScxmlEvent::PlatformEvent</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">An event generated internally by the state machine. For example, errors.</td></tr>
<tr><td class="topAlign"><code>QScxmlEvent::InternalEvent</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">An event generated by a <code><raise></code> element.</td></tr>
<tr><td class="topAlign"><code>QScxmlEvent::ExternalEvent</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">An event generated by a <code><send></code> element.</td></tr>
</table></div>
<!-- @@@EventType -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$data-prop$$$data$$$setDataconstQVariant& -->
<h3 class="fn" id="data-prop"><a name="data-prop"></a><span class="name">data</span> : <span class="type">QVariant</span></h3>
<p>This property holds the data included by the sender.</p>
<p>When <code><param></code> elements are used in the <code><send></code> element, the data will contain a QVariantMap where the key is the <i>name</i> attribute, and the value is taken from the <i>expr</i> attribute or the <i>location</i> attribute.</p>
<p>When a <code><content></code> element is used, the data will contain a single item with either the value of the <i>expr</i> attribute of the <code><content></code> element or the child data of the <code><content></code> element.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QVariant </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#data">data</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#setData">setData</a></b></span>(const QVariant &<i>data</i>)</td></tr>
</table></div>
<!-- @@@data -->
<!-- $$$delay-prop$$$delay$$$setDelayint -->
<h3 class="fn" id="delay-prop"><a name="delay-prop"></a><span class="name">delay</span> : <span class="type">int</span></h3>
<p>This property holds the delay in milliseconds after which the event is to be delivered after processing the <code><send></code> element.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#delay">delay</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#setDelay">setDelay</a></b></span>(int <i>delayInMiliSecs</i>)</td></tr>
</table></div>
<!-- @@@delay -->
<!-- $$$errorEvent-prop$$$isErrorEvent -->
<h3 class="fn" id="errorEvent-prop"><a name="errorEvent-prop"></a><span class="name">errorEvent</span> : const <span class="type">bool</span></h3>
<p>This property holds whether the event represents an error.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#isErrorEvent">isErrorEvent</a></b></span>() const</td></tr>
</table></div>
<!-- @@@errorEvent -->
<!-- $$$errorMessage-prop$$$errorMessage$$$setErrorMessageconstQString& -->
<h3 class="fn" id="errorMessage-prop"><a name="errorMessage-prop"></a><span class="name">errorMessage</span> : <span class="type">QString</span></h3>
<p>This property holds an error message for an error event, or an empty QString.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#errorMessage">errorMessage</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#setErrorMessage">setErrorMessage</a></b></span>(const QString &<i>message</i>)</td></tr>
</table></div>
<!-- @@@errorMessage -->
<!-- $$$eventType-prop$$$eventType$$$setEventTypeconstQScxmlEvent::EventType& -->
<h3 class="fn" id="eventType-prop"><a name="eventType-prop"></a><span class="name">eventType</span> : <span class="type"><a href="qscxmlevent.html#EventType-enum">EventType</a></span></h3>
<p>This property holds the type of the event.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QScxmlEvent::EventType </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#eventType">eventType</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#setEventType">setEventType</a></b></span>(const QScxmlEvent::EventType &<i>type</i>)</td></tr>
</table></div>
<!-- @@@eventType -->
<!-- $$$invokeId-prop$$$invokeId$$$setInvokeIdconstQString& -->
<h3 class="fn" id="invokeId-prop"><a name="invokeId-prop"></a><span class="name">invokeId</span> : <span class="type">QString</span></h3>
<p>This property holds the ID of the invoked state machine if the event is generated by one.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#invokeId">invokeId</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#setInvokeId">setInvokeId</a></b></span>(const QString &<i>invokeid</i>)</td></tr>
</table></div>
<!-- @@@invokeId -->
<!-- $$$name-prop$$$name$$$setNameconstQString& -->
<h3 class="fn" id="name-prop"><a name="name-prop"></a><span class="name">name</span> : <span class="type">QString</span></h3>
<p>This property holds the name of the event.</p>
<p>If the event is generated inside the SCXML document, this property holds the value of the <i>event</i> attribute specified inside the <code><raise></code> or <code><send></code> element.</p>
<p>If the event is created in the C++ code and submitted to the <a href="qscxmlstatemachine.html">QScxmlStateMachine</a>, the value of this property is matched against the value of the <i>event</i> attribute specified inside the <code><transition></code> element in the SCXML document.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#name">name</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#setName">setName</a></b></span>(const QString &<i>name</i>)</td></tr>
</table></div>
<!-- @@@name -->
<!-- $$$origin-prop$$$origin$$$setOriginconstQString& -->
<h3 class="fn" id="origin-prop"><a name="origin-prop"></a><span class="name">origin</span> : <span class="type">QString</span></h3>
<p>This property holds the URI that points to the origin of an SCXML event.</p>
<p>The origin is equivalent to the <i>target</i> attribute of the <code><send></code> element.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#origin">origin</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#setOrigin">setOrigin</a></b></span>(const QString &<i>origin</i>)</td></tr>
</table></div>
<!-- @@@origin -->
<!-- $$$originType-prop$$$originType$$$setOriginTypeconstQString& -->
<h3 class="fn" id="originType-prop"><a name="originType-prop"></a><span class="name">originType</span> : <span class="type">QString</span></h3>
<p>This property holds the origin type of an SCXML event.</p>
<p>The origin type is equivalent to the <i>type</i> attribute of the <code><send></code> element.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#originType">originType</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#setOriginType">setOriginType</a></b></span>(const QString &<i>origintype</i>)</td></tr>
</table></div>
<!-- @@@originType -->
<!-- $$$scxmlType-prop$$$scxmlType -->
<h3 class="fn" id="scxmlType-prop"><a name="scxmlType-prop"></a><span class="name">scxmlType</span> : const <span class="type">QString</span></h3>
<p>This property holds the event type.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#scxmlType">scxmlType</a></b></span>() const</td></tr>
</table></div>
<!-- @@@scxmlType -->
<!-- $$$sendId-prop$$$sendId$$$setSendIdconstQString& -->
<h3 class="fn" id="sendId-prop"><a name="sendId-prop"></a><span class="name">sendId</span> : <span class="type">QString</span></h3>
<p>This property holds the ID of the event.</p>
<p>The ID is used by the <code><cancel></code> element to identify the event to be canceled.</p>
<p><b>Note: </b>The state machine generates a unique ID if the <i>id</i> attribute is not specified in the <code><send></code> element. The generated ID can be accessed through this property.</p><p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#sendId">sendId</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qscxmlevent.html#setSendId">setSendId</a></b></span>(const QString &<i>sendid</i>)</td></tr>
</table></div>
<!-- @@@sendId -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QScxmlEvent[overload1]$$$QScxmlEvent -->
<h3 class="fn" id="QScxmlEvent"><a name="QScxmlEvent"></a>QScxmlEvent::<span class="name">QScxmlEvent</span>()</h3>
<p>Creates a new external SCXML event.</p>
<!-- @@@QScxmlEvent -->
<!-- $$$QScxmlEvent$$$QScxmlEventconstQScxmlEvent& -->
<h3 class="fn" id="QScxmlEvent-1"><a name="QScxmlEvent-1"></a>QScxmlEvent::<span class="name">QScxmlEvent</span>(const <span class="type"><a href="qscxmlevent.html#QScxmlEvent">QScxmlEvent</a></span> &<i>other</i>)</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@QScxmlEvent -->
<!-- $$$~QScxmlEvent[overload1]$$$~QScxmlEvent -->
<h3 class="fn" id="dtor.QScxmlEvent"><a name="dtor.QScxmlEvent"></a>QScxmlEvent::<span class="name">~QScxmlEvent</span>()</h3>
<p>Destroys the SCXML event.</p>
<!-- @@@~QScxmlEvent -->
<!-- $$$clear[overload1]$$$clear -->
<h3 class="fn" id="clear"><a name="clear"></a><span class="type">void</span> QScxmlEvent::<span class="name">clear</span>()</h3>
<p>Clears the contents of the event.</p>
<p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p>
<!-- @@@clear -->
<!-- $$$data -->
<h3 class="fn" id="data"><a name="data"></a><span class="type">QVariant</span> QScxmlEvent::<span class="name">data</span>() const</h3>
<p>Returns the data included by the sender.</p>
<p><b>Note:</b> Getter function for property <a href="qscxmlevent.html#data-prop">data</a>. </p><p><b>See also </b><a href="qscxmlevent.html#setData">setData</a>().</p>
<!-- @@@data -->
<!-- $$$delay -->
<h3 class="fn" id="delay"><a name="delay"></a><span class="type">int</span> QScxmlEvent::<span class="name">delay</span>() const</h3>
<p>Returns the delay in milliseconds after which this event is to be delivered after processing the <code><send></code> element.</p>
<p><b>Note:</b> Getter function for property <a href="qscxmlevent.html#delay-prop">delay</a>. </p><p><b>See also </b><a href="qscxmlevent.html#setDelay">setDelay</a>().</p>
<!-- @@@delay -->
<!-- $$$errorMessage -->
<h3 class="fn" id="errorMessage"><a name="errorMessage"></a><span class="type">QString</span> QScxmlEvent::<span class="name">errorMessage</span>() const</h3>
<p>If this is an error event, returns the error message. Otherwise, returns an empty QString.</p>
<p><b>Note:</b> Getter function for property <a href="qscxmlevent.html#errorMessage-prop">errorMessage</a>. </p><p><b>See also </b><a href="qscxmlevent.html#setErrorMessage">setErrorMessage</a>().</p>
<!-- @@@errorMessage -->
<!-- $$$eventType -->
<h3 class="fn" id="eventType"><a name="eventType"></a><span class="type"><a href="qscxmlevent.html#EventType-enum">QScxmlEvent::EventType</a></span> QScxmlEvent::<span class="name">eventType</span>() const</h3>
<p>Returns the type of this event.</p>
<p><b>Note:</b> Getter function for property <a href="qscxmlevent.html#eventType-prop">eventType</a>. </p><p><b>See also </b><a href="qscxmlevent.html#setEventType">setEventType</a>() and <a href="qscxmlevent.html#EventType-enum">QScxmlEvent::EventType</a>.</p>
<!-- @@@eventType -->
<!-- $$$invokeId -->
<h3 class="fn" id="invokeId"><a name="invokeId"></a><span class="type">QString</span> QScxmlEvent::<span class="name">invokeId</span>() const</h3>
<p>If this event is generated by an invoked state machine, returns the ID of the <code><invoke></code> element. Otherwise, returns an empty value.</p>
<p><b>Note:</b> Getter function for property <a href="qscxmlevent.html#invokeId-prop">invokeId</a>. </p><p><b>See also </b><a href="qscxmlevent.html#setInvokeId">setInvokeId</a>().</p>
<!-- @@@invokeId -->
<!-- $$$isErrorEvent -->
<h3 class="fn" id="isErrorEvent"><a name="isErrorEvent"></a><span class="type">bool</span> QScxmlEvent::<span class="name">isErrorEvent</span>() const</h3>
<p>Returns <code>true</code> when this is an error event, <code>false</code> otherwise.</p>
<p><b>Note:</b> Getter function for property <a href="qscxmlevent.html#errorEvent-prop">errorEvent</a>. </p><!-- @@@isErrorEvent -->
<!-- $$$name -->
<h3 class="fn" id="name"><a name="name"></a><span class="type">QString</span> QScxmlEvent::<span class="name">name</span>() const</h3>
<p>Returns the name of the event.</p>
<p><b>Note:</b> Getter function for property <a href="qscxmlevent.html#name-prop">name</a>. </p><p><b>See also </b><a href="qscxmlevent.html#setName">setName</a>().</p>
<!-- @@@name -->
<!-- $$$origin -->
<h3 class="fn" id="origin"><a name="origin"></a><span class="type">QString</span> QScxmlEvent::<span class="name">origin</span>() const</h3>
<p>Returns a URI that points to the origin of an SCXML event.</p>
<p><b>Note:</b> Getter function for property <a href="qscxmlevent.html#origin-prop">origin</a>. </p><p><b>See also </b><a href="qscxmlevent.html#setOrigin">setOrigin</a>().</p>
<!-- @@@origin -->
<!-- $$$originType -->
<h3 class="fn" id="originType"><a name="originType"></a><span class="type">QString</span> QScxmlEvent::<span class="name">originType</span>() const</h3>
<p>Returns the origin type of an SCXML event.</p>
<p><b>Note:</b> Getter function for property <a href="qscxmlevent.html#originType-prop">originType</a>. </p><p><b>See also </b><a href="qscxmlevent.html#setOriginType">setOriginType</a>().</p>
<!-- @@@originType -->
<!-- $$$scxmlType -->
<h3 class="fn" id="scxmlType"><a name="scxmlType"></a><span class="type">QString</span> QScxmlEvent::<span class="name">scxmlType</span>() const</h3>
<p>Returns the event type.</p>
<p><b>Note:</b> Getter function for property <a href="qscxmlevent.html#scxmlType-prop">scxmlType</a>. </p><!-- @@@scxmlType -->
<!-- $$$sendId -->
<h3 class="fn" id="sendId"><a name="sendId"></a><span class="type">QString</span> QScxmlEvent::<span class="name">sendId</span>() const</h3>
<p>Returns the ID of the event.</p>
<p><b>Note:</b> Getter function for property <a href="qscxmlevent.html#sendId-prop">sendId</a>. </p><p><b>See also </b><a href="qscxmlevent.html#setSendId">setSendId</a>().</p>
<!-- @@@sendId -->
<!-- $$$setData -->
<h3 class="fn" id="setData"><a name="setData"></a><span class="type">void</span> QScxmlEvent::<span class="name">setData</span>(const <span class="type">QVariant</span> &<i>data</i>)</h3>
<p>Sets the payload data to <i>data</i>.</p>
<p><b>Note:</b> Setter function for property <a href="qscxmlevent.html#data-prop">data</a>. </p><p><b>See also </b><a href="qscxmlevent.html#data-prop">QScxmlEvent::data</a>.</p>
<!-- @@@setData -->
<!-- $$$setDelay -->
<h3 class="fn" id="setDelay"><a name="setDelay"></a><span class="type">void</span> QScxmlEvent::<span class="name">setDelay</span>(<span class="type">int</span> <i>delayInMiliSecs</i>)</h3>
<p>Sets the delay in milliseconds as the value of <i>delayInMiliSecs</i>.</p>
<p><b>Note:</b> Setter function for property <a href="qscxmlevent.html#delay-prop">delay</a>. </p><p><b>See also </b><a href="qscxmlevent.html#delay-prop">QScxmlEvent::delay</a>.</p>
<!-- @@@setDelay -->
<!-- $$$setErrorMessage -->
<h3 class="fn" id="setErrorMessage"><a name="setErrorMessage"></a><span class="type">void</span> QScxmlEvent::<span class="name">setErrorMessage</span>(const <span class="type">QString</span> &<i>message</i>)</h3>
<p>If this is an error event, the <i>message</i> is set as the error message.</p>
<p><b>Note:</b> Setter function for property <a href="qscxmlevent.html#errorMessage-prop">errorMessage</a>. </p><p><b>See also </b><a href="qscxmlevent.html#errorMessage">errorMessage</a>().</p>
<!-- @@@setErrorMessage -->
<!-- $$$setEventType -->
<h3 class="fn" id="setEventType"><a name="setEventType"></a><span class="type">void</span> QScxmlEvent::<span class="name">setEventType</span>(const <span class="type"><a href="qscxmlevent.html#EventType-enum">QScxmlEvent::EventType</a></span> &<i>type</i>)</h3>
<p>Sets the event type to <i>type</i>.</p>
<p><b>Note:</b> Setter function for property <a href="qscxmlevent.html#eventType-prop">eventType</a>. </p><p><b>See also </b><a href="qscxmlevent.html#eventType-prop">QScxmlEvent::eventType</a> and <a href="qscxmlevent.html#EventType-enum">QScxmlEvent::EventType</a>.</p>
<!-- @@@setEventType -->
<!-- $$$setInvokeId -->
<h3 class="fn" id="setInvokeId"><a name="setInvokeId"></a><span class="type">void</span> QScxmlEvent::<span class="name">setInvokeId</span>(const <span class="type">QString</span> &<i>invokeid</i>)</h3>
<p>Sets the ID of an invoked state machine to <i>invokeid</i>.</p>
<p><b>Note:</b> Setter function for property <a href="qscxmlevent.html#invokeId-prop">invokeId</a>. </p><p><b>See also </b><a href="qscxmlevent.html#invokeId-prop">QScxmlEvent::invokeId</a>.</p>
<!-- @@@setInvokeId -->
<!-- $$$setName -->
<h3 class="fn" id="setName"><a name="setName"></a><span class="type">void</span> QScxmlEvent::<span class="name">setName</span>(const <span class="type">QString</span> &<i>name</i>)</h3>
<p>Sets the name of the event to <i>name</i>.</p>
<p><b>Note:</b> Setter function for property <a href="qscxmlevent.html#name-prop">name</a>. </p><p><b>See also </b><a href="qscxmlevent.html#name">name</a>().</p>
<!-- @@@setName -->
<!-- $$$setOrigin -->
<h3 class="fn" id="setOrigin"><a name="setOrigin"></a><span class="type">void</span> QScxmlEvent::<span class="name">setOrigin</span>(const <span class="type">QString</span> &<i>origin</i>)</h3>
<p>Sets the origin of an SCXML event to <i>origin</i>.</p>
<p><b>Note:</b> Setter function for property <a href="qscxmlevent.html#origin-prop">origin</a>. </p><p><b>See also </b><a href="qscxmlevent.html#origin-prop">QScxmlEvent::origin</a>.</p>
<!-- @@@setOrigin -->
<!-- $$$setOriginType -->
<h3 class="fn" id="setOriginType"><a name="setOriginType"></a><span class="type">void</span> QScxmlEvent::<span class="name">setOriginType</span>(const <span class="type">QString</span> &<i>origintype</i>)</h3>
<p>Sets the origin type of an SCXML event to <i>origintype</i>.</p>
<p><b>Note:</b> Setter function for property <a href="qscxmlevent.html#originType-prop">originType</a>. </p><p><b>See also </b><a href="qscxmlevent.html#originType-prop">QScxmlEvent::originType</a>.</p>
<!-- @@@setOriginType -->
<!-- $$$setSendId -->
<h3 class="fn" id="setSendId"><a name="setSendId"></a><span class="type">void</span> QScxmlEvent::<span class="name">setSendId</span>(const <span class="type">QString</span> &<i>sendid</i>)</h3>
<p>Sets the ID <i>sendid</i> for this event.</p>
<p><b>Note:</b> Setter function for property <a href="qscxmlevent.html#sendId-prop">sendId</a>. </p><p><b>See also </b><a href="qscxmlevent.html#sendId">sendId</a>().</p>
<!-- @@@setSendId -->
<!-- $$$operator=[overload1]$$$operator=constQScxmlEvent& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qscxmlevent.html#QScxmlEvent">QScxmlEvent</a></span> &QScxmlEvent::<span class="name">operator=</span>(const <span class="type"><a href="qscxmlevent.html#QScxmlEvent">QScxmlEvent</a></span> &<i>other</i>)</h3>
<p>Assigns <i>other</i> to this SCXML event and returns a reference to this SCXML event.</p>
<!-- @@@operator= -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
6ed78e842caa17fd5c94d65d685685e0
>
files
>
59
