QQmlExpression Class

The QQmlExpression class evaluates JavaScript in a QML context. 更多...

头：	#include <QQmlExpression>
CMake:	find_package(Qt6 REQUIRED COMPONENTS Qml) target_link_libraries(mytarget PRIVATE Qt6::Qml)
qmake:	QT += qml
继承：	QObject

所有成员列表，包括继承成员

公共函数

	QQmlExpression ()
	QQmlExpression (QQmlContext * ctxt , QObject * scope , const QString & 表达式 , QObject * parent = nullptr)
	QQmlExpression (const QQmlScriptString & script , QQmlContext * ctxt = nullptr, QObject * scope = nullptr, QObject * parent = nullptr)
virtual	~QQmlExpression () override
void	clearError ()
int	columnNumber () const
QQmlContext *	context () const
QQmlEngine *	engine () const
QQmlError	error () const
QVariant	evaluate (bool * valueIsUndefined = nullptr)
QString	表达式 () const
bool	hasError () const
int	lineNumber () const
bool	notifyOnValueChanged () const
QObject *	scopeObject () const
void	setExpression (const QString & 表达式 )
void	setNotifyOnValueChanged (bool notifyOnChange )
void	setSourceLocation (const QString & url , int line , int column = 0)
QString	sourceFile () const

信号

void	valueChanged ()

详细描述

For example, given a file main.qml 像这样：

import QtQuick 2.0
Item {
    width: 200; height: 200
}

The following code evaluates a JavaScript expression in the context of the above 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 ()

Create an invalid QQmlExpression.

As the expression will not have an associated QQmlContext , this will be a null expression object and its value will always be an invalid QVariant .

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

Create a QQmlExpression object that is a child of parent .

The 表达式 JavaScript will be executed in the ctxt QQmlContext . If specified, the scope object's properties will also be in scope during the expression's execution.

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

Create a QQmlExpression object that is a child of parent .

The script provides the expression to be evaluated, the context to evaluate it in, and the scope object to evaluate it with. If provided, ctxt and scope will override the context and scope object provided by script .

另请参阅 QQmlScriptString .

`[override virtual noexcept]` QQmlExpression:: ~QQmlExpression ()

Destroy the QQmlExpression 实例。

void QQmlExpression:: clearError ()

Clear any expression errors. Calls to hasError () following this will return false.

另请参阅 hasError () 和 error ().

int QQmlExpression:: columnNumber () const

Returns the source file column number for this expression. The source location must have been previously set by calling setSourceLocation ().

QQmlContext *QQmlExpression:: context () const

返回 QQmlContext this expression is associated with, or nullptr if there is no association or the QQmlContext 已经被销毁。

QQmlEngine *QQmlExpression:: engine () const

返回 QQmlEngine this expression is associated with, or nullptr if there is no association or the QQmlEngine 已经被销毁。

QQmlError QQmlExpression:: error () const

Return any error from the last call to evaluate (). If there was no error, this returns an invalid QQmlError 实例。

另请参阅 hasError () 和 clearError ().

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

Evaulates the expression, returning the result of the evaluation, or an invalid QVariant if the expression is invalid or has an error.

valueIsUndefined is set to true if the expression resulted in an undefined value.

另请参阅 hasError () 和 error ().

QString QQmlExpression:: 表达式 () const

Returns the expression string.

另请参阅 setExpression ().

bool QQmlExpression:: hasError () const

Returns true if the last call to evaluate () resulted in an error, otherwise false.

另请参阅 error () 和 clearError ().

int QQmlExpression:: lineNumber () const

Returns the source file line number for this expression. The source location must have been previously set by calling setSourceLocation ().

bool QQmlExpression:: notifyOnValueChanged () const

返回 true 若 valueChanged () signal is emitted when the expression's evaluated value changes.

另请参阅 setNotifyOnValueChanged ().

QObject *QQmlExpression:: scopeObject () const

Returns the expression's scope object, if provided, otherwise 0.

In addition to data provided by the expression's QQmlContext , the scope object's properties are also in scope during the expression's evaluation.

void QQmlExpression:: setExpression (const QString & 表达式 )

Set the expression to 表达式 .

另请参阅 表达式 ().

void QQmlExpression:: setNotifyOnValueChanged ( bool notifyOnChange )

Sets whether the valueChanged () signal is emitted when the expression's evaluated value changes.

若 notifyOnChange is true, the QQmlExpression will monitor properties involved in the expression's evaluation, and emit QQmlExpression::valueChanged () if they have changed. This allows an application to ensure that any value associated with the result of the expression remains up to date.

若 notifyOnChange is false (default), the QQmlExpression will not montitor properties involved in the expression's evaluation, and QQmlExpression::valueChanged () will never be emitted. This is more efficient if an application wants a "one off" evaluation of the expression.

另请参阅 notifyOnValueChanged ().

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

Set the location of this expression to line and column of url . This information is used by the script engine.

QString QQmlExpression:: sourceFile () const

Returns the source file URL for this expression. The source location must have been previously set by calling setSourceLocation ().

`[signal]` void QQmlExpression:: valueChanged ()

Emitted each time the expression value changes from the last time it was evaluated. The expression must have been evaluated at least once (by calling QQmlExpression::evaluate ()) before this signal will be emitted.