<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qscxmlerror.cpp --> <title>QScxmlError 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 >QScxmlError</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="#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">QScxmlError Class</h1> <!-- $$$QScxmlError-brief --> <p>The <a href="qscxmlerror.html">QScxmlError</a> class describes the errors returned by the Qt SCXML state machine when parsing an SCXML file. <a href="#details">More...</a></p> <!-- @@@QScxmlError --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QScxmlError></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="qscxmlerror-members.html">List of all members, including inherited members</a></li> </ul> <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="qscxmlerror.html#column-prop">column</a></b> : const int</li> <li class="fn"><b><a href="qscxmlerror.html#description-prop">description</a></b> : const QString</li> <li class="fn"><b><a href="qscxmlerror.html#fileName-prop">fileName</a></b> : const QString</li> </ul></td><td class="topAlign"><ul> <li class="fn"><b><a href="qscxmlerror.html#line-prop">line</a></b> : const int</li> <li class="fn"><b><a href="qscxmlerror.html#valid-prop">valid</a></b> : const bool</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="qscxmlerror.html#QScxmlError">QScxmlError</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qscxmlerror.html#QScxmlError-1">QScxmlError</a></b>(const QString &<i>fileName</i>, int <i>line</i>, int <i>column</i>, const QString &<i>description</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qscxmlerror.html#QScxmlError-2">QScxmlError</a></b>(const QScxmlError &<i>other</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qscxmlerror.html#dtor.QScxmlError">~QScxmlError</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qscxmlerror.html#column">column</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qscxmlerror.html#description">description</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qscxmlerror.html#fileName">fileName</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qscxmlerror.html#isValid">isValid</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qscxmlerror.html#line">line</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qscxmlerror.html#toString">toString</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QScxmlError &</td><td class="memItemRight bottomAlign"><b><a href="qscxmlerror.html#operator-eq">operator=</a></b>(const QScxmlError &<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="qscxmlerror.html#staticMetaObject-var">staticMetaObject</a></b></td></tr> </table></div> <a name="details"></a> <!-- $$$QScxmlError-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qscxmlerror.html">QScxmlError</a> class describes the errors returned by the Qt SCXML state machine when parsing an SCXML file.</p> </div> <p><b>See also </b><a href="qscxmlstatemachine.html">QScxmlStateMachine</a> and <a href="qscxmlcompiler.html">QScxmlCompiler</a>.</p> <!-- @@@QScxmlError --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$column-prop$$$column --> <h3 class="fn" id="column-prop"><a name="column-prop"></a><span class="name">column</span> : const <span class="type">int</span></h3> <p>This property holds the column number in which the SCXML error occurred.</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="qscxmlerror.html#column">column</a></b></span>() const</td></tr> </table></div> <!-- @@@column --> <!-- $$$description-prop$$$description --> <h3 class="fn" id="description-prop"><a name="description-prop"></a><span class="name">description</span> : const <span class="type">QString</span></h3> <p>This property holds a description of the SCXML error.</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="qscxmlerror.html#description">description</a></b></span>() const</td></tr> </table></div> <!-- @@@description --> <!-- $$$fileName-prop$$$fileName --> <h3 class="fn" id="fileName-prop"><a name="fileName-prop"></a><span class="name">fileName</span> : const <span class="type">QString</span></h3> <p>This property holds the name of the file in which the SCXML error occurred.</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="qscxmlerror.html#fileName">fileName</a></b></span>() const</td></tr> </table></div> <!-- @@@fileName --> <!-- $$$line-prop$$$line --> <h3 class="fn" id="line-prop"><a name="line-prop"></a><span class="name">line</span> : const <span class="type">int</span></h3> <p>This property holds the line number on which the SCXML error occurred.</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="qscxmlerror.html#line">line</a></b></span>() const</td></tr> </table></div> <!-- @@@line --> <!-- $$$valid-prop$$$isValid --> <h3 class="fn" id="valid-prop"><a name="valid-prop"></a><span class="name">valid</span> : const <span class="type">bool</span></h3> <p>This property holds whether the SCXML error is valid.</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="qscxmlerror.html#isValid">isValid</a></b></span>() const</td></tr> </table></div> <!-- @@@valid --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QScxmlError[overload1]$$$QScxmlError --> <h3 class="fn" id="QScxmlError"><a name="QScxmlError"></a>QScxmlError::<span class="name">QScxmlError</span>()</h3> <p>Creates a new invalid SCXML error.</p> <!-- @@@QScxmlError --> <!-- $$$QScxmlError$$$QScxmlErrorconstQString&intintconstQString& --> <h3 class="fn" id="QScxmlError-1"><a name="QScxmlError-1"></a>QScxmlError::<span class="name">QScxmlError</span>(const <span class="type">QString</span> &<i>fileName</i>, <span class="type">int</span> <i>line</i>, <span class="type">int</span> <i>column</i>, const <span class="type">QString</span> &<i>description</i>)</h3> <p>Creates a new valid SCXML error that contains the error message, <i>description</i>, as well as the <i>fileName</i>, <i>line</i>, and <i>column</i> where the error occurred.</p> <!-- @@@QScxmlError --> <!-- $$$QScxmlError$$$QScxmlErrorconstQScxmlError& --> <h3 class="fn" id="QScxmlError-2"><a name="QScxmlError-2"></a>QScxmlError::<span class="name">QScxmlError</span>(const <span class="type"><a href="qscxmlerror.html#QScxmlError">QScxmlError</a></span> &<i>other</i>)</h3> <p>Constructs a copy of <i>other</i>.</p> <!-- @@@QScxmlError --> <!-- $$$~QScxmlError[overload1]$$$~QScxmlError --> <h3 class="fn" id="dtor.QScxmlError"><a name="dtor.QScxmlError"></a>QScxmlError::<span class="name">~QScxmlError</span>()</h3> <p>Destroys the SCXML error.</p> <!-- @@@~QScxmlError --> <!-- $$$column --> <h3 class="fn" id="column"><a name="column"></a><span class="type">int</span> QScxmlError::<span class="name">column</span>() const</h3> <p>Returns the column in which the error occurred.</p> <p><b>Note:</b> Getter function for property <a href="qscxmlerror.html#column-prop">column</a>. </p><!-- @@@column --> <!-- $$$description --> <h3 class="fn" id="description"><a name="description"></a><span class="type">QString</span> QScxmlError::<span class="name">description</span>() const</h3> <p>Returns the error message.</p> <p><b>Note:</b> Getter function for property <a href="qscxmlerror.html#description-prop">description</a>. </p><!-- @@@description --> <!-- $$$fileName --> <h3 class="fn" id="fileName"><a name="fileName"></a><span class="type">QString</span> QScxmlError::<span class="name">fileName</span>() const</h3> <p>Returns the name of the file in which the error occurred.</p> <p><b>Note:</b> Getter function for property <a href="qscxmlerror.html#fileName-prop">fileName</a>. </p><!-- @@@fileName --> <!-- $$$isValid --> <h3 class="fn" id="isValid"><a name="isValid"></a><span class="type">bool</span> QScxmlError::<span class="name">isValid</span>() const</h3> <p>Returns <code>true</code> if the error is valid, <code>false</code> otherwise. An invalid error can only be created by calling the default constructor or by assigning an invalid error.</p> <p><b>Note:</b> Getter function for property <a href="qscxmlerror.html#valid-prop">valid</a>. </p><!-- @@@isValid --> <!-- $$$line --> <h3 class="fn" id="line"><a name="line"></a><span class="type">int</span> QScxmlError::<span class="name">line</span>() const</h3> <p>Returns the line on which the error occurred.</p> <p><b>Note:</b> Getter function for property <a href="qscxmlerror.html#line-prop">line</a>. </p><!-- @@@line --> <!-- $$$toString[overload1]$$$toString --> <h3 class="fn" id="toString"><a name="toString"></a><span class="type">QString</span> QScxmlError::<span class="name">toString</span>() const</h3> <p>This convenience method converts an error to a string. Returns the error message formatted as: <i>"filename:line:column: error: description"</i></p> <!-- @@@toString --> <!-- $$$operator=[overload1]$$$operator=constQScxmlError& --> <h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qscxmlerror.html#QScxmlError">QScxmlError</a></span> &QScxmlError::<span class="name">operator=</span>(const <span class="type"><a href="qscxmlerror.html#QScxmlError">QScxmlError</a></span> &<i>other</i>)</h3> <p>Assigns <i>other</i> to this SCXML error and returns a reference to this SCXML error.</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>