CopperSpice API  1.9.2
Public Typedefs | Public Types | Public Methods | List of all members
QScriptValue Class Reference
CsScript | Scriptable Applications

The QScriptValue class acts as a container for the CsScript data types. More...

Public Typedefs

using PropertyFlags = QFlags< PropertyFlag >
 
using ResolveFlags = QFlags< ResolveFlag >
 

Public Types

enum  PropertyFlag
 
enum  ResolveFlag
 
enum  SpecialValue
 

Public Methods

 QScriptValue ()
 
 QScriptValue (bool value)
 
 QScriptValue (const QScriptValue &other)
 
 QScriptValue (const QString &value)
 
 QScriptValue (int value)
 
 QScriptValue (QScriptEngine *engine, bool value)
 
 QScriptValue (QScriptEngine *engine, const QString &value)
 
 QScriptValue (QScriptEngine *engine, int value)
 
 QScriptValue (QScriptEngine *engine, qsreal value)
 
 QScriptValue (QScriptEngine *engine, SpecialValue value)
 
 QScriptValue (QScriptEngine *engine, uint value)
 
 QScriptValue (qsreal value)
 
 QScriptValue (SpecialValue value)
 
 QScriptValue (uint value)
 
 ~QScriptValue ()
 
QScriptValue call (const QScriptValue &thisObject, const QScriptValue &arguments)
 
QScriptValue call (const QScriptValue &thisObject=QScriptValue (), const QList< QScriptValue > &args=QList< QScriptValue >())
 
QScriptValue construct (const QList< QScriptValue > &args=QList< QScriptValue >())
 
QScriptValue construct (const QScriptValue &arguments)
 
QScriptValue data () const
 
QScriptEngine * engine () const
 
bool equals (const QScriptValue &other) const
 
bool instanceOf (const QScriptValue &other) const
 
bool isArray () const
 
bool isBool () const
 
bool isBoolean () const
 
bool isDate () const
 
bool isError () const
 
bool isFunction () const
 
bool isNull () const
 
bool isNumber () const
 
bool isObject () const
 
bool isQMetaObject () const
 
bool isQObject () const
 
bool isRegExp () const
 
bool isString () const
 
bool isUndefined () const
 
bool isValid () const
 
bool isVariant () const
 
bool lessThan (const QScriptValue &other) const
 
QScriptValue & operator= (const QScriptValue &other)
 
QScriptValue property (const QScriptString &name, const ResolveFlags &mode=ResolvePrototype) const
 
QScriptValue property (const QString &name, const ResolveFlags &mode=ResolvePrototype) const
 
QScriptValue property (quint32 arrayIndex, const ResolveFlags &mode=ResolvePrototype) const
 
QScriptValue::PropertyFlags propertyFlags (const QScriptString &name, const ResolveFlags &mode=ResolvePrototype) const
 
QScriptValue::PropertyFlags propertyFlags (const QString &name, const ResolveFlags &mode=ResolvePrototype) const
 
QScriptValue prototype () const
 
QScriptClass * scriptClass () const
 
void setData (const QScriptValue &data)
 
void setProperty (const QScriptString &name, const QScriptValue &value, const PropertyFlags &flags=KeepExistingFlags)
 
void setProperty (const QString &name, const QScriptValue &value, const PropertyFlags &flags=KeepExistingFlags)
 
void setProperty (quint32 arrayIndex, const QScriptValue &value, const PropertyFlags &flags=KeepExistingFlags)
 
void setPrototype (const QScriptValue &prototype)
 
void setScriptClass (QScriptClass *scriptClass)
 
bool strictlyEquals (const QScriptValue &other) const
 
bool toBool () const
 
bool toBoolean () const
 
QDateTime toDateTime () const
 
qint32 toInt32 () const
 
qsreal toInteger () const
 
qsreal toNumber () const
 
QScriptValue toObject () const
 
const QMetaObject * toQMetaObject () const
 
QObject * toQObject () const
 
QRegularExpression toRegExp () const
 
QString toString () const
 
quint16 toUInt16 () const
 
quint32 toUInt32 () const
 
QVariant toVariant () const
 

Detailed Description

The QScriptValue class acts as a container for the Script data types. QScriptValue supports the types defined in the ECMA-262 standard: The primitive types, which are Undefined, Null, Boolean, Number, and String; and the Object type. Additionally, the CsScript library has built-in support for QVariant, QObject and QMetaObject.

For the object-based types use one of methods starting with new to create a QScriptValue of the desired type. For example, use newDate() to create a QScriptValue of data time Date. For the primitive types, use one of the QScriptValue constructor overloads.

The methods like isBool() or isUndefined()) can be used to test if a value is of a certain type.

The methods like toBool() and toString()) can be used to convert a QScriptValue to another data type. You can also use the generic qscriptvalue_cast() function.

Object values have zero or more properties which are themselves QScriptValues. Use setProperty() to set a property of an object, and call property() to retrieve the value of a property.

QScriptEngine myEngine;
QScriptValue myObject = myEngine.newObject();
QScriptValue myOtherObject = myEngine.newObject();
myObject.setProperty("myChild", myOtherObject);
myObject.setProperty("name", "John Doe");

Each property can have a set of attributes which are specified as the third (optional) argument to setProperty(). The attributes of a property can be queried by calling the propertyFlags() function. The following code creates a property that can not be modified by script code.

QScriptValue val(&myEngine, 123);
myObject.setProperty("myReadOnlyProperty", val, QScriptValue::ReadOnly);

If you want to iterate over the properties of a script object, use the QScriptValueIterator class.

Object values have an internal prototype property, which can be accessed with prototype() and setPrototype(). Properties added to a prototype are shared by all objects having that prototype; this is referred to as prototype-based inheritance. In practice, it means that (by default) the property() function will automatically attempt to look up look the property in the prototype() (and in the prototype of the prototype(), and so on), if the object itself does not have the requested property. Note that this prototype-based lookup is not performed by setProperty(); setProperty() will always create the property in the script object itself. For more information, refer to the CsScript documentation.

Function objects (objects for which isFunction() returns true) can be invoked by calling call(). Constructor functions can be used to construct new objects by calling construct().

Use equals(), strictlyEquals() and lessThan() to compare a QScriptValue to another.

Object values can have custom data associated with them; see the setData() and data() functions. By default, this data is not accessible to scripts; it can be used to store any data you want to associate with the script object. Typically this is used by custom class objects (see QScriptClass) to store a C++ type that contains the "native" object data.

Note that a QScriptValue for which isObject() is true only carries a reference to an actual object; copying the QScriptValue will only copy the object reference, not the object itself. If you want to clone an object (i.e. copy an object's properties to another object), you can do so with the help of a for-in statement in script code, or QScriptValueIterator in C++.

See also
QScriptEngine, QScriptValueIterator

Member Typedef Documentation

QScriptValue::PropertyFlags

Typedef for QFlags<PropertyFlag> which contains an OR combination of PropertyFlag values.

Refer to QScriptValue::PropertyFlag for the enum documentation.

QScriptValue::ResolveFlags

Typedef for QFlags<ResolveFlag> which contains an OR combination of ResolveFlag values.

Refer to QScriptValue::ResolveFlag for the enum documentation.

Member Enumeration Documentation

enum QScriptValue::PropertyFlag

This enum is used to indicate an existing property is a QObject member, property, or a method.

ConstantValueDescription
QScriptValue::ReadOnly 0x00000001 Property is Read Only. Attempts by CsScript code to write to the property will be ignored.
QScriptValue::Undeletable 0x00000002 Attempts by CsScript code to delete the property will be ignored.
QScriptValue::SkipInEnumeration 0x00000004 Property is not to be enumerated by a for-in enumeration.
QScriptValue::PropertyGetter 0x00000008 Property is defined by a function which will be called to get the property value.
QScriptValue::PropertySetter 0x00000010 Property is defined by a function which will be called to set the value.
QScriptValue::KeepExistingFlags 0x00000800 Value is used to indicate to setProperty() that the property's flags should be left unchanged. If the property does not exist, the default flags (0) will be used.
QScriptValue::UserRange 0xFF000000 Flags in this range are not used by CsScript and can be used for custom purposes.
enum QScriptValue::ResolveFlag

This enum specifies how to look up a property of an object.

ConstantValueDescription
QScriptValue::ResolveLocal0x00 Only check properties of the object
QScriptValue::ResolvePrototype0x01 Check properties in the object first, then search the prototype chain. This is the default.
enum QScriptValue::SpecialValue

This enum is used to specify a single-valued type.

ConstantValueDescription
QScriptValue::UndefinedValue1An undefined value.
QScriptValue::NullValue0A null value.

Constructor & Destructor Documentation

QScriptValue::QScriptValue ( )

Constructs an empty QScriptValue.

QScriptValue::QScriptValue ( const QScriptValue &  other)

Copy constructs a new QScriptValue from other.

QScriptValue::QScriptValue ( QScriptEngine *  engine,
SpecialValue  value 
)
deprecated
Deprecated:
Constructs a new QScriptValue with the special value and registers it with the script engine.
QScriptValue::QScriptValue ( QScriptEngine *  engine,
bool  value 
)
deprecated
Deprecated:
Constructs a new QScriptValue with the boolean value and registers it with the script engine.
QScriptValue::QScriptValue ( QScriptEngine *  engine,
int  value 
)
deprecated
Deprecated:
Constructs a new QScriptValue with the integer value and registers it with the script engine.
QScriptValue::QScriptValue ( QScriptEngine *  engine,
uint  value 
)
deprecated
Deprecated:
Constructs a new QScriptValue with the unsigned integer value and registers it with the script engine.
QScriptValue::QScriptValue ( QScriptEngine *  engine,
qsreal  value 
)
deprecated
Deprecated:
Constructs a new QScriptValue with the qsreal value and registers it with the script engine.
QScriptValue::QScriptValue ( QScriptEngine *  engine,
const QString &  value 
)
deprecated
Deprecated:
Constructs a new QScriptValue with the string value and registers it with the script engine.
QScriptValue::QScriptValue ( SpecialValue  value)

Constructs a new QScriptValue with the given value.

QScriptValue::QScriptValue ( bool  value)

Constructs a new QScriptValue with the given value.

QScriptValue::QScriptValue ( int  value)

Constructs a new QScriptValue with the given value.

QScriptValue::QScriptValue ( uint  value)

Constructs a new QScriptValue with the given value.

QScriptValue::QScriptValue ( qsreal  value)

Constructs a new QScriptValue with the given value.

QScriptValue::QScriptValue ( const QString &  value)

Constructs a new QScriptValue with the given value.

QScriptValue::~QScriptValue ( )

Destroys this QScriptValue.

Method Documentation

QScriptValue QScriptValue::call ( const QScriptValue &  thisObject,
const QScriptValue &  arguments 
)

Calls this QScriptValue as a function, using thisObject as the ‘this’ object in the function call, and passing arguments as arguments to the function. Returns the value returned from the function.

If this QScriptValue is not a function, call() does nothing and returns an invalid QScriptValue.

arguments can be an arguments object, an array, null or undefined; any other type will cause a TypeError to be thrown.

Note that if thisObject is not an object, the global object (see QScriptEngine::globalObject()) will be used as the ‘this’ object.

One common usage of this function is to forward native function calls to another function:

QScriptValue myNativeFunction(QScriptContext *ctx, QScriptEngine *)
{
QScriptValue otherFunction = ...;
return otherFunction.call(ctx->thisObject(), ctx->argumentsObject());
}
See also
construct(), QScriptContext::argumentsObject()
QScriptValue QScriptValue::call ( const QScriptValue &  thisObject = QScriptValue(),
const QList< QScriptValue > &  args = QList<QScriptValue>() 
)

Calls this QScriptValue as a function, using thisObject as the ‘this’ object in the function call, and passing args as arguments to the function. Returns the value returned from the function.

If this QScriptValue is not a function, call() does nothing and returns an invalid QScriptValue.

Note that if thisObject is not an object, the global object (see QScriptEngine::globalObject()) will be used as the ‘this’ object.

Calling call() can cause an exception to occur in the script engine; in that case, call() returns the value that was thrown (typically an Error object). You can call QScriptEngine::hasUncaughtException() to determine if an exception occurred.

QScriptEngine engine;
engine.evaluate("function fullName() { return this.firstName + ' ' + this.lastName; }");
engine.evaluate("somePerson = { firstName: 'John', lastName: 'Doe' }");
QScriptValue global = engine.globalObject();
QScriptValue fullName = global.property("fullName");
QScriptValue who = global.property("somePerson");
qDebug() << fullName.call(who).toString(); // "John Doe"
engine.evaluate("function cube(x) { return x * x * x; }");
QScriptValue cube = global.property("cube");
QList<QScriptValue> args;
args << 3;
qDebug() << cube.call(QScriptValue(), args).toNumber(); // 27
See also
construct()
QScriptValue QScriptValue::construct ( const QList< QScriptValue > &  args = QList<QScriptValue>())

Creates a new Object and calls this QScriptValue as a constructor, using the created object as the ‘this’ object and passing args as arguments. If the return value from the constructor call is an object, then that object is returned, otherwise the default constructed object is returned.

If this QScriptValue is not a function, construct() does nothing and returns an invalid QScriptValue.

Calling construct() can cause an exception to occur in the script engine; in that case, construct() returns the value that was thrown (typically an Error object). You can call QScriptEngine::hasUncaughtException() to determine if an exception occurred.

See also
call(), QScriptEngine::newObject()
QScriptValue QScriptValue::construct ( const QScriptValue &  arguments)

Creates a new Object and calls this QScriptValue as a constructor, using the created object as the ‘this’ object and passing arguments as arguments. If the return value from the constructor call is an object, then that object is returned, otherwise the default constructed object is returned.

If this QScriptValue is not a function, construct() does nothing and returns an invalid QScriptValue.

arguments can be an arguments object, an array, null or undefined. Any other type will cause a TypeError to be thrown.

See also
call(), QScriptEngine::newObject(), QScriptContext::argumentsObject()
QScriptValue QScriptValue::data ( ) const

Returns the internal data of this QScriptValue object. CsScript uses this property to store the primitive value of Date, String, Number and Boolean objects. For other types of object, custom data may be stored using setData().

See also
setData()
QScriptEngine * QScriptValue::engine ( ) const

Returns the QScriptEngine that created this QScriptValue or a nullptr if this QScriptValue is invalid or the value is not associated with a particular engine.

bool QScriptValue::equals ( const QScriptValue &  other) const

Returns true if this QScriptValue is equal to other, otherwise returns false. The comparison follows the behavior described in ECMA-262 section 11.9.3, "The Abstract Equality Comparison Algorithm".

This function can return true even if the type of this QScriptValue is different from the type of the other value; i.e. the comparison is not strict. For example, comparing the number 9 to the string "9" returns true; comparing an undefined value to a null value returns true; comparing a Number object whose primitive value is 6 to a String object whose primitive value is "6" returns true; and comparing the number 1 to the boolean value true returns true. If you want to perform a comparison without such implicit value conversion, use strictlyEquals().

Note that if this QScriptValue or the other value are objects, calling this function has side effects on the script engine, since the engine will call the object's valueOf() function (and possibly toString()) in an attempt to convert the object to a primitive value (possibly resulting in an uncaught script exception).

See also
strictlyEquals(), lessThan()
bool QScriptValue::instanceOf ( const QScriptValue &  other) const

Returns true if this QScriptValue is an instance of other, otherwise returns false.

This QScriptValue is considered to be an instance of other if other is a function and the value of the prototype property of other is in the prototype chain of this QScriptValue.

bool QScriptValue::isArray ( ) const

Returns true if this QScriptValue is an object of the Array class, otherwise returns false.

See also
QScriptEngine::newArray()
bool QScriptValue::isBool ( ) const

Returns true if this QScriptValue is of the primitive type Boolean, otherwise returns false.

See also
toBool()
bool QScriptValue::isBoolean ( ) const
deprecated
Deprecated:
Use isBool() instead.
bool QScriptValue::isDate ( ) const

Returns true if this QScriptValue is an object of the Date class, otherwise returns false.

See also
QScriptEngine::newDate()
bool QScriptValue::isError ( ) const

Returns true if this QScriptValue is an object of the Error class, otherwise returns false.

See also
QScriptContext::throwError()
bool QScriptValue::isFunction ( ) const

Returns true if this QScriptValue is a function, otherwise returns false.

See also
call()
bool QScriptValue::isNull ( ) const

Returns true if this QScriptValue is of the primitive type Null, otherwise returns false.

See also
QScriptEngine::nullValue()
bool QScriptValue::isNumber ( ) const

Returns true if this QScriptValue is of the primitive type Number, otherwise returns false.

See also
toNumber()
bool QScriptValue::isObject ( ) const

Returns true if this QScriptValue is of the Object type, otherwise returns false.

Note that function values, variant values, and QObject values are objects, so this function returns true for such values.

See also
toObject(), QScriptEngine::newObject()
bool QScriptValue::isQMetaObject ( ) const

Returns true if this QScriptValue is a QMetaObject, otherwise returns false.

See also
toQMetaObject(), QScriptEngine::newQMetaObject()
bool QScriptValue::isQObject ( ) const

Returns true if this QScriptValue is a QObject, otherwise returns false.

Note: This function returns true even if the QObject that this QScriptValue wraps has been deleted.

See also
toQObject(), QScriptEngine::newQObject()
bool QScriptValue::isRegExp ( ) const

Returns true if this QScriptValue is an object of the QRegularExpression class, otherwise returns false.

See also
QScriptEngine::newRegExp()
bool QScriptValue::isString ( ) const

Returns true if this QScriptValue is of the primitive type String, otherwise returns false.

See also
toString()
bool QScriptValue::isUndefined ( ) const

Returns true if this QScriptValue is of the primitive type Undefined, otherwise returns false.

See also
QScriptEngine::undefinedValue()
bool QScriptValue::isValid ( ) const

Returns true if this QScriptValue is valid, otherwise returns false.

bool QScriptValue::isVariant ( ) const

Returns true if this QScriptValue is a variant value, otherwise returns false.

See also
toVariant(), QScriptEngine::newVariant()
bool QScriptValue::lessThan ( const QScriptValue &  other) const

Returns true if this QScriptValue is less than other, otherwise returns false. The comparison follows the behavior described in ECMA-262 section 11.8.5, "The Abstract Relational Comparison Algorithm".

Note that if this QScriptValue or the other value are objects, calling this function has side effects on the script engine, since the engine will call the object's valueOf() function (and possibly toString()) in an attempt to convert the object to a primitive value (possibly resulting in an uncaught script exception).

See also
equals()
QScriptValue & QScriptValue::operator= ( const QScriptValue &  other)

Copy assigns from other and returns a reference to this object.

Note
If other is an object only a reference to the underlying object will be assigned, the object itself will not be copied.
QScriptValue QScriptValue::property ( const QScriptString &  name,
const ResolveFlags &  mode = ResolvePrototype 
) const

Returns the value of this QScriptValue's property with the given name, using the given mode to resolve the property.

This overload of property() is useful when you need to look up the same property repeatedly, since the lookup can be performed faster when the name is represented as an interned string.

See also
QScriptEngine::toStringHandle(), setProperty()
QScriptValue QScriptValue::property ( const QString &  name,
const ResolveFlags &  mode = ResolvePrototype 
) const

Returns the value of this QScriptValue's property with the given name, using the given mode to resolve the property.

If no such property exists, an invalid QScriptValue is returned.

If the property is implemented using a getter function (i.e. has the PropertyGetter flag set), calling property() has side-effects on the script engine, since the getter function will be called (possibly resulting in an uncaught script exception). If an exception occurred, property() returns the value that was thrown (typically an Error object).

See also
setProperty(), propertyFlags(), QScriptValueIterator
QScriptValue QScriptValue::property ( quint32  arrayIndex,
const ResolveFlags &  mode = ResolvePrototype 
) const

Returns the property at the given arrayIndex, using the given mode to resolve the property.

This function is provided for convenience and performance when working with array objects.

If this QScriptValue is not an Array object, this function behaves as if property() was called with the string representation of arrayIndex.

PropertyFlags QScriptValue::propertyFlags ( const QScriptString &  name,
const ResolveFlags &  mode = ResolvePrototype 
) const

Returns the flags of the property with the given name, using the given mode to resolve the property.

See also
property()
PropertyFlags QScriptValue::propertyFlags ( const QString &  name,
const ResolveFlags &  mode = ResolvePrototype 
) const

Returns the flags of the property with the given name, using the given mode to resolve the property.

See also
property()
QScriptValue QScriptValue::prototype ( ) const

If this QScriptValue is an object, returns the internal prototype (proto property) of this object, otherwise returns an invalid QScriptValue.

See also
setPrototype(), isObject()
QScriptClass * QScriptValue::scriptClass ( ) const

Returns the custom script class this script object is an instance of, or a nullptr if the object is not of a custom class.

See also
setScriptClass()
void QScriptValue::setData ( const QScriptValue &  data)

Sets the internal data of this QScriptValue object. You can use this function to set object-specific data that will not be directly accessible to scripts, but may be retrieved in C++ using the data() function.

See also
data(), QScriptEngine::reportAdditionalMemoryCost()
void QScriptValue::setProperty ( const QScriptString &  name,
const QScriptValue &  value,
const PropertyFlags &  flags = KeepExistingFlags 
)

Sets the value of this QScriptValue's property with the given name to the given value. The given flags specify how this property may be accessed by script code.

This overload of setProperty() is useful when you need to set the same property repeatedly, since the operation can be performed faster when the name is represented as an interned string.

See also
QScriptEngine::toStringHandle()
void QScriptValue::setProperty ( const QString &  name,
const QScriptValue &  value,
const PropertyFlags &  flags = KeepExistingFlags 
)

Sets the value of this QScriptValue's property with the given name to the given value. If this QScriptValue is not an object this method does nothing. If value is invalid the property is removed.

If this QScriptValue does not already have a property with name, a new property is created. The given flags then specify how this property may be accessed by script code.

If the property is implemented using a setter function (i.e. has the PropertySetter flag set), calling setProperty() has side-effects on the script engine, since the setter function will be called with the given value as argument (possibly resulting in an uncaught script exception).

Note that you can not specify custom getter or setter functions for built-in properties, such as the length property of Array objects or meta properties of QObject objects.

See also
property()
void QScriptValue::setProperty ( quint32  arrayIndex,
const QScriptValue &  value,
const PropertyFlags &  flags = KeepExistingFlags 
)

Sets the property at the given arrayIndex to the given value.

This function is provided for convenience and performance when working with array objects.

If this QScriptValue is not an Array object, this function behaves as if setProperty() was called with the string representation of arrayIndex.

void QScriptValue::setPrototype ( const QScriptValue &  prototype)

If this QScriptValue is an object, sets the internal prototype (proto property) of this object to be prototype, otherwise does nothing.

The internal prototype should not be confused with the public property with name "prototype"; the public prototype is usually only set on functions that act as constructors.

See also
prototype(), isObject()
void QScriptValue::setScriptClass ( QScriptClass *  scriptClass)

Sets the custom script class of this script object to scriptClass. This can be used to "promote" a plain script object (e.g. created by the "new" operator in a script, or by QScriptEngine::newObject() in C++) to an object of a custom type.

If scriptClass is 0, the object will be demoted to a plain script object.

See also
scriptClass(), setData()
bool QScriptValue::strictlyEquals ( const QScriptValue &  other) const

Returns true if this QScriptValue is equal to other using strict comparison (no conversion), otherwise returns false. The comparison follows the behavior described in ECMA-262 section 11.9.6, "The Strict Equality Comparison Algorithm".

If the type of this QScriptValue is different from the type of the other value, this function returns false. If the types are equal, the result depends on the type, as shown in the following table:

TypeResult
Undefinedtrue
Nulltrue
Booleantrue if both values are true, false otherwise
Numberfalse if either value is NaN (Not-a-Number); true if values are equal, false otherwise
Stringtrue if both values are exactly the same sequence of characters, false otherwise
Objecttrue if both values refer to the same object, false otherwise
See also
equals()
bool QScriptValue::toBool ( ) const

Returns the boolean value of this QScriptValue, using the conversion rules described in ECMA-262 section 9.2, "ToBoolean".

Note that if this QScriptValue is an object, calling this function has side effects on the script engine, since the engine will call the object's valueOf() function (and possibly toString()) in an attempt to convert the object to a primitive value (possibly resulting in an uncaught script exception).

See also
isBool()
bool QScriptValue::toBoolean ( ) const
deprecated
Deprecated:
Use toBool() instead.
QDateTime QScriptValue::toDateTime ( ) const

Returns a QDateTime representation of this value, in local time. If this QScriptValue is not a date, or the value of the date is NaN (Not-a-Number), an invalid QDateTime is returned.

See also
isDate()
qint32 QScriptValue::toInt32 ( ) const

Returns the signed 32-bit integer value of this QScriptValue, using the conversion rules described in ECMA-262 section 9.5, "ToInt32".

Note that if this QScriptValue is an object, calling this function has side effects on the script engine, since the engine will call the object's valueOf() function (and possibly toString()) in an attempt to convert the object to a primitive value (possibly resulting in an uncaught script exception).

See also
toNumber(), toUInt32()
qsreal QScriptValue::toInteger ( ) const

Returns the integer value of this QScriptValue, using the conversion rules described in ECMA-262 section 9.4, "ToInteger".

Note that if this QScriptValue is an object, calling this function has side effects on the script engine, since the engine will call the object's valueOf() function (and possibly toString()) in an attempt to convert the object to a primitive value (possibly resulting in an uncaught script exception).

See also
toNumber()
qsreal QScriptValue::toNumber ( ) const

Returns the number value of this QScriptValue, as defined in ECMA-262 section 9.3, "ToNumber".

Note that if this QScriptValue is an object, calling this function has side effects on the script engine, since the engine will call the object's valueOf() function (and possibly toString()) in an attempt to convert the object to a primitive value (possibly resulting in an uncaught script exception).

See also
isNumber(), toInteger(), toInt32(), toUInt32(), toUInt16()
QScriptValue QScriptValue::toObject ( ) const
deprecated
Deprecated:
This function is obsolete; use QScriptEngine::toObject() instead.
const QMetaObject * QScriptValue::toQMetaObject ( ) const

If this QScriptValue is a QMetaObject, returns the QMetaObject pointer that the QScriptValue represents, otherwise returns 0.

See also
isQMetaObject()
QObject * QScriptValue::toQObject ( ) const

If this QScriptValue is a QObject, returns the QObject pointer that the QScriptValue represents, otherwise returns 0.

If the QObject that this QScriptValue wraps has been deleted, this function returns 0 (i.e. it is possible for toQObject() to return 0 even when isQObject() returns true).

See also
isQObject()
QRegularExpression QScriptValue::toRegExp ( ) const

Returns the QRegularExpression representation of this value. If this QScriptValue is not a regular expression an empty QRegularExpression is returned.

See also
isRegExp()
QString QScriptValue::toString ( ) const

Returns the string value of this QScriptValue, as defined in ECMA-262 section 9.8, "ToString".

Note that if this QScriptValue is an object, calling this function has side effects on the script engine, since the engine will call the object's toString() function (and possibly valueOf()) in an attempt to convert the object to a primitive value (possibly resulting in an uncaught script exception).

See also
isString()
quint16 QScriptValue::toUInt16 ( ) const

Returns the unsigned 16-bit integer value of this QScriptValue, using the conversion rules described in ECMA-262 section 9.7, "ToUint16".

Note that if this QScriptValue is an object, calling this function has side effects on the script engine, since the engine will call the object's valueOf() function (and possibly toString()) in an attempt to convert the object to a primitive value (possibly resulting in an uncaught script exception).

See also
toNumber()
quint32 QScriptValue::toUInt32 ( ) const

Returns the unsigned 32-bit integer value of this QScriptValue, using the conversion rules described in ECMA-262 section 9.6, "ToUint32".

Note that if this QScriptValue is an object, calling this function has side effects on the script engine, since the engine will call the object's valueOf() function (and possibly toString()) in an attempt to convert the object to a primitive value (possibly resulting in an uncaught script exception).

See also
toNumber(), toInt32()
QVariant QScriptValue::toVariant ( ) const

Returns the QVariant value of this QScriptValue, if it can be converted to a QVariant, otherwise returns an invalid QVariant. The conversion is performed according to the following table:

Input TypeResult
UndefinedAn invalid QVariant.
NullAn invalid QVariant.
BooleanA QVariant containing the value of the boolean.
NumberA QVariant containing the value of the number.
StringA QVariant containing the value of the string.
QVariant ObjectThe result is the QVariant value of the object (no conversion).
QObject ObjectA QVariant containing a pointer to the QObject.
Date ObjectA QVariant containing the date value (toDateTime()).
RegularExpression ObjectA QVariant containing the regular expression value (toRegExp()).
Array ObjectThe array is converted to a QVariantList. Each element is converted to a QVariant, recursively; cyclic references are not followed.
ObjectThe object is converted to a QVariantMap. Each property is converted to a QVariant, recursively; cyclic references are not followed.
See also
isVariant()