QScxmlError Class
The QScxmlError class describes the errors returned by the Qt SCXML state machine when parsing an SCXML file. More...
| Header: | #include <QScxmlError> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Scxml) target_link_libraries(mytarget PRIVATE Qt6::Scxml) |
| qmake: | QT += scxml |
Properties
|
Public Functions
| QScxmlError() | |
| QScxmlError(const QString &fileName, int line, int column, const QString &description) | |
| QScxmlError(const QScxmlError &other) | |
| ~QScxmlError() | |
| int | column() const |
| QString | description() const |
| QString | fileName() const |
| bool | isValid() const |
| int | line() const |
| QString | toString() const |
| QScxmlError & | operator=(const QScxmlError &other) |
See also QScxmlStateMachine and QScxmlCompiler.
Property Documentation
[read-only] column : const int
This property holds the column number in which the SCXML error occurred.
Access functions:
| int | column() const |
[read-only] description : const QString
This property holds a description of the SCXML error.
Access functions:
| QString | description() const |
[read-only] fileName : const QString
This property holds the name of the file in which the SCXML error occurred.
Access functions:
| QString | fileName() const |
[read-only] line : const int
This property holds the line number on which the SCXML error occurred.
Access functions:
| int | line() const |
[read-only] valid : const bool
This property holds whether the SCXML error is valid.
Access functions:
| bool | isValid() const |
Member Function Documentation
QScxmlError::QScxmlError()
Creates a new invalid SCXML error.
QScxmlError::QScxmlError(const QString &fileName, int line, int column, const QString &description)
Creates a new valid SCXML error that contains the error message, description, as well as the fileName, line, and column where the error occurred.
QScxmlError::QScxmlError(const QScxmlError &other)
Constructs a copy of other.
QScxmlError::~QScxmlError()
Destroys the SCXML error.
int QScxmlError::column() const
Returns the column in which the error occurred.
Note: Getter function for property column.
QString QScxmlError::description() const
Returns the error message.
Note: Getter function for property description.
QString QScxmlError::fileName() const
Returns the name of the file in which the error occurred.
Note: Getter function for property fileName.
bool QScxmlError::isValid() const
Returns true if the error is valid, false otherwise. An invalid error can only be created by calling the default constructor or by assigning an invalid error.
Note: Getter function for property valid.
int QScxmlError::line() const
Returns the line on which the error occurred.
Note: Getter function for property line.
QString QScxmlError::toString() const
This convenience method converts an error to a string. Returns the error message formatted as: "filename:line:column: error: description"
QScxmlError &QScxmlError::operator=(const QScxmlError &other)
Assigns other to this SCXML error and returns a reference to this SCXML error.
© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. 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.