QScriptable

Synopsis

Functions

• def argument (index)
• def argumentCount ()
• def context ()
• def engine ()
• def thisObject ()

Detailed Description

The PySide.QtScript.QScriptable class provides access to the Qt Script environment from Qt C++ member functions.

With QScriptEngine.newQObject() , you can expose the signals and slots and properties of any PySide.QtCore.QObject (or subclass) to script code. PySide.QtScript.QScriptable augments this functionality by giving your C++ members access to the Qt Script environment they are invoked in; conceptually, it is similar to QObject.sender() .

By subclassing PySide.QtScript.QScriptable , you get the following functions in your class: PySide.QtScript.QScriptable.thisObject() , PySide.QtScript.QScriptable.argumentCount() , PySide.QtScript.QScriptable.argument() , PySide.QtScript.QScriptable.context() and PySide.QtScript.QScriptable.engine() . With these functions, you have full access to the Qt Script environment from the slots and property access functions of your class, when they are invoked from script code.

For example, you can throw a Qt Script exception from a slot; manipulate the this’ object associated with the function call; inspect the arguments stored in the :class:`PySide.QtScript.QScriptContext to know the “real” arguments passed to the function from script code; and call script functions from your slot.

A typical use case of PySide.QtScript.QScriptable is to implement prototype objects for custom C++ types. You define the scriptable interface of your custom type in a PySide.QtScript.QScriptable subclass using properties and slots; then you wrap an instance of your class using QScriptEngine.newQObject() , and finally pass the result to QScriptEngine.setDefaultPrototype() . See the Default Prototypes Example to see how this can be done.

The following is what subclassing PySide.QtScript.QScriptable typically looks like:

class MyScriptableObject(QObject, QScriptable):
...
    def doSomething(self):
        ...
    def doSomethingElse(self):
        ...

The only difference from regular PySide.QtCore.QObject subclassing is that you also inherit from PySide.QtScript.QScriptable .

In the implementation of your slots, you can then use the functions inherited from PySide.QtScript.QScriptable :

def doSomething(self):
    self.context().throwError('Threw an error from a slot')

def doSomethingElse(self):
    return self.thisObject()

See also

Default Prototypes Example QScriptEngine.newFunction()

class PySide.QtScript.QScriptable

PySide.QtScript.QScriptable.argument(index)

Parameters:index – PySide.QtCore.int Return type:PySide.QtScript.QScriptValue

Returns the function argument at the given index , or an invalid PySide.QtScript.QScriptValue if the Qt function was not invoked from script code.

See also

PySide.QtScript.QScriptable.argumentCount()

PySide.QtScript.QScriptable.argumentCount()

Return type:PySide.QtCore.int

Returns the number of arguments passed to the function in this invocation, or -1 if the Qt function was not invoked from script code.

See also

PySide.QtScript.QScriptable.argument()

PySide.QtScript.QScriptable.context()

Return type:PySide.QtScript.QScriptContext

Returns a pointer to the PySide.QtScript.QScriptContext associated with the current Qt function call, or 0 if the Qt function was not invoked from script code.

PySide.QtScript.QScriptable.engine()

Return type:PySide.QtScript.QScriptEngine

Returns a pointer to the PySide.QtScript.QScriptEngine associated with the current Qt function call, or 0 if the Qt function was not invoked from script code.

PySide.QtScript.QScriptable.thisObject()

Return type:PySide.QtScript.QScriptValue

Returns the this’ object associated with the current Qt function call, or an invalid :class:`PySide.QtScript.QScriptValue if the Qt function was not invoked from script code.