Класс QQmlExpression

Класс QQmlExpression вычисляет JavaScript в контексте QML. Подробнее...

• Список всех членов, включая унаследованные

Открытые функции

Сигналы

Подробное описание

Например, имея файл main.qml такой как:

import QtQuick 2.0

Item {
    width: 200; height: 200
}

Следующий код вычисляет выражение JavaScript в контексте вышеупомянутого QML:

QQmlEngine *engine = new QQmlEngine;
QQmlComponent component(engine, QUrl::fromLocalFile("main.qml"));

QObject *myObject = component.create();
QQmlExpression *expr = new QQmlExpression(engine->rootContext(), myObject, "width * 2");
int result = expr->evaluate().toInt();  // result = 400

Документация по функциям-членам

QQmlExpression::QQmlExpression(const QQmlScriptString &script, QQmlContext *ctxt = nullptr, QObject *scope = nullptr, QObject *parent = nullptr)

Создаёт объект QQmlExpression, являющийся потомком parent.

script предоставляет выражение для вычисления, контекст для его вычисления и объект области видимости для вычисления с ним. Если указаны, ctxt и scope переопределят контекст и объект области видимости, предоставленные script.

См. также QQmlScriptString.

QQmlExpression::QQmlExpression(QQmlContext *ctxt, QObject *scope, const QString &expression, QObject *parent = nullptr)

Создаёт объект QQmlExpression, являющийся потомком parent.

Выражение JavaScript expression будет выполнено в QQmlContext ctxt. Если указан, свойства объекта scope также будут доступны во время выполнения выражения.

QQmlExpression::QQmlExpression()

Создаёт недействительный QQmlExpression.

Так как у выражения не будет связанного QQmlContext, это будет объект-выражение null, и его значение всегда будет недействительным QVariant.

void QQmlExpression::valueChanged()

Издаётся каждый раз, когда значение выражения меняется с последнего его вычисления. Выражение должно быть вычислено хотя бы один раз (вызовом QQmlExpression::evaluate()), прежде чем этот сигнал будет издан.

QQmlExpression::~QQmlExpression()

Уничтожает экземпляр QQmlExpression.

void QQmlExpression::clearError()

Очищает любые ошибки выражения. Обращения к hasError() после этого вернут false.

См. также hasError() и error().

int QQmlExpression::columnNumber() const

Возвращает номер столбца файла исходного кода для данного выражения. Местоположение исходного кода должно быть предварительно установлено вызовом setSourceLocation().

QQmlContext *QQmlExpression::context() const

Возвращает QQmlContext, с которым связано это выражение, или 0, если нет связи или QQmlContext был уничтожен.

QQmlEngine *QQmlExpression::engine() const

Возвращает QQmlEngine, с которым связано это выражение, или 0, если нет связи или QQmlEngine был уничтожен.

QQmlError QQmlExpression::error() const

Возвращает любую ошибку из последнего вызова evaluate(). Если ошибок не было, возвращается недействительный экземпляр QQmlError.

См. также hasError() и clearError().

QVariant QQmlExpression::evaluate(bool *valueIsUndefined = nullptr)

Вычисляет выражение, возвращая результат вычисления или недействительный QVariant, если выражение недействительно или содержит ошибку.

valueIsUndefined устанавливается в true, если выражение привело к неопределённому значению.

См. также hasError() и error().

QString QQmlExpression::expression() const

Возвращает строку выражения.

См. также setExpression().

bool QQmlExpression::hasError() const

Возвращает true, если последний вызов evaluate() привёл к ошибке, иначе false.

См. также error() и clearError().

int QQmlExpression::lineNumber() const

Возвращает номер строки файла исходного кода для данного выражения. Местоположение исходного кода должно быть предварительно установлено вызовом setSourceLocation().

bool QQmlExpression::notifyOnValueChanged() const

Возвращает true, если сигнал valueChanged() издаётся, когда вычисленное значение выражения меняется.

См. также setNotifyOnValueChanged().

QObject *QQmlExpression::scopeObject() const

Возвращает объект области видимости выражения, если он задан, в противном случае 0.

В дополнение к данным, предоставленным контекстом выражения QQmlContext, свойства объекта области видимости также находятся в области видимости во время вычисления выражения.

void QQmlExpression::setExpression(const QString &expression)

Устанавливает выражение в expression.

См. также expression().

void QQmlExpression::setNotifyOnValueChanged(bool notifyOnChange)

Устанавливает, будет ли сигнал valueChanged() испускаться при изменении вычисленного значения выражения.

Если notifyOnChange имеет значение true, QQmlExpression будет отслеживать свойства, участвующие в вычислении выражения, и испускать QQmlExpression::valueChanged(), если они изменились. Это позволяет приложению гарантировать, что любое значение, связанное с результатом выражения, остается актуальным.

Если notifyOnChange имеет значение false (по умолчанию), QQmlExpression не будет отслеживать свойства, участвующие в вычислении выражения, и QQmlExpression::valueChanged() никогда не будет испускаться. Это более эффективно, если приложению требуется однократное вычисление выражения.

См. также notifyOnValueChanged().

void QQmlExpression::setSourceLocation(const QString &url, int line, int column = 0)

Устанавливает расположение этого выражения в строке line и столбце column файла url. Эта информация используется движком скриптов.

QString QQmlExpression::sourceFile() const

Возвращает URL исходного файла для этого выражения. Расположение источника должно быть предварительно установлено вызовом setSourceLocation().