Qt 5.5 中Qt Script翻译 （四）

接着上一章

让C++类的属性在脚本中有效

在上一个例子当中，如果我们想在Qt脚本中set或get属性，我们需要像下面这样写代码：

var obj = new MyObject;
obj.setEnabled( true );
print( "obj is enabled: " + obj.isEnabled() );

为了使这成为可能，您必须定义C++ QObject子类中的属性。例如，下面的MyObject类声明声明了一个名为enabled的布尔属性，它使用函数setEnabled(bool)作为它的setter函数，使用isEnabled()作为它的getter函数：

class MyObject : public QObject
{
    Q_OBJECT
    // define the enabled property
    Q_PROPERTY( bool enabled WRITE setEnabled READ isEnabled )

public:
    MyObject( ... );

    void aNonScriptableFunction();

public slots: // these functions (slots) will be available in Qt Script
    void calculate( ... );
    void setEnabled( bool enabled );
    bool isEnabled() const;

private:
   ....

};

与原始代码的唯一区别是使用了宏Q_PROPERTY，它接受属性的类型和名称，以及setter和getter函数的名称作为参数。

如果不希望类的属性在Qt Script中可访问，则在声明属性时将SCRIPTABLE属性设置为false；默认情况下，SCRIPTABLE属性为true。例如：

Q_PROPERTY(int nonScriptableProperty READ foo WRITE bar SCRIPTABLE false)

在脚本中响应C++对象信号

在QT对象模型中，信号被用作QObjts之间的通知机制。这意味着一个对象可以将信号连接到另一个对象的slot，并且每当发出信号时，就调用slot。使用QObject::connet（）建立连接。

QT脚本程序也可以使用信号和槽机制。在C++中声明信号的代码是相同的，不管信号是否将连接到C++中的slot或QT脚本中。

class MyObject : public QObject
{
    Q_OBJECT
    // define the enabled property
    Q_PROPERTY( bool enabled WRITE setEnabled READ isEnabled )

public:
    MyObject( ... );

    void aNonScriptableFunction();

public slots: // these functions (slots) will be available in Qt Script
    void calculate( ... );
    void setEnabled( bool enabled );
    bool isEnabled() const;

signals: // the signals
    void enabledChanged( bool newState );

private:
   ....

};

我们对前一节中的代码所做的唯一更改是声明一个带有相关信号的信号部分。现在，脚本编写器可以定义一个函数并连接到这样的对象：

function enabledChangedHandler( b )
{
    print( "state changed to: " + b );
}

function init()
{
    var obj = new MyObject();
    // connect a script function to the signal
    obj["enabledChanged(bool)"].connect(enabledChangedHandler);
    obj.enabled = true;
    print( "obj is enabled: " + obj.enabled );
}

定义应用程序对象

之前的章节讲解的是怎样在脚本当中使用C++对象，应用程序对象是同一类对象，它们使应用的功能在脚本程序中可以使用，由于C++程序已经编写在Qt中，很多对象已经是QObject对象，最简单的方法是简单地将所有这些QObject作为应用程序对象添加到脚本引擎。对于小型应用程序，这可能就足够了，但是对于大型应用程序，这可能不是正确的方法，问题在于，这种方法暴露太多的内部API，并且让脚本程序访问不应该访问的内部属性。

通常，使应用程序功能对脚本程序可用的最佳方法是编写一些QObject，这些QObject使用信号、插槽和属性定义应用程序公共API。这使您完全可以控制应用程序提供的功能。这些对象的实现只是调用应用程序中执行实际工作的函数。因此，不要让脚本引擎可以使用所有的QObject，只需添加包装器QObjects。

返回QObject指针

如果有一个槽返回QObject指针，则应该注意，默认情况下，Qt Script只处理类型QObject*和QWidget*的转换。这意味着，如果用像“MyObject*getMyObject()”这样的签名声明插槽，Qt Script不会自动知道MyObject*应该以与QObject*和QWidget*相同的方式处理。解决这个问题的最简单的方法是只在脚本接口的方法签名中使用QObject*和QWidget*。

或者，可以使用qScriptRegisterMetaType()函数注册自定义类型的转换函数。这样，您就可以保留C++声明中的精确类型，同时仍然允许指向自定义对象的指针在C++和脚本之间无缝地流动。例子：

class MyObject : public QObject
  {
      Q_OBJECT
      ...
  };

  Q_DECLARE_METATYPE(MyObject*)

  QScriptValue myObjectToScriptValue(QScriptEngine *engine, MyObject* const &in)
  { return engine->newQObject(in); }

  void myObjectFromScriptValue(const QScriptValue &object, MyObject* &out)
  { out = qobject_cast<MyObject*>(object.toQObject()); }

  ...

  qScriptRegisterMetaType(&engine, myObjectToScriptValue, myObjectFromScriptValue);

函数对象和本地函数

在Qt脚本中，函数是第一类型，它们是对象可以有自己的属性，就像其他对象一样，它们可以存储在变量当中，也可以作为参数传递到其他函数中，当你想定义和使用自己的脚本函数时，了解Qt脚本中的函数行为是非常有用的。本节讨论这个问题，本解释怎样实现本机函数，也就是说，用c++编写的Qt脚本函数,而不是用脚本自己编写的脚本函数，即使您主要依赖于Qt Script提供的动态QObject绑定，了解这些强大的概念和技术对于理解在执行脚本函数时实际发生的情况也很重要。

在C++中调用一个Qt脚本函数

在C++中获取一个脚本函数并通过QScriptValue::call()调用该函数，一个典型的场景是评估一个定义函数的脚本，在某个时候，您希望从C++调用该函数，或者传递一些参数，然后处理结果。下面的脚本定义了一个具有ToKelVin（）函数的Qt脚本对象：

({ unitName: "Celsius",
     toKelvin: function(x) { return x + 273; }
   })

toKelvin()函数以Kelvin中的温度作为参数，并返回转换为摄氏度的温度。下面的代码片段显示了如何从C++中调用ToKelvin（）函数：

QScriptValue object = engine.evaluate("({ unitName: 'Celsius', toKelvin: function(x) { return x + 273; } })");
  QScriptValue toKelvin = object.property("toKelvin");
  QScriptValue result = toKelvin.call(object, QScriptValueList() << 100);
  qDebug() << result.toNumber(); // 373

如果脚本定义了一个全局函数，则可以访问该函数作为QScriptEngine::globalObject()的属性。例如，下面的脚本定义了一个全局函数add()：

 function add(a, b) {
      return a + b;
  }

C++代码可以像下面这样调用add()函数：

QScriptValue add = engine.globalObject().property("add");
  qDebug() << add.call(QScriptValue(), QScriptValueList() << 1 << 2).toNumber(); // 3

如前所述，函数只是Qt Script中的值；函数本身并不“绑定”特定的对象。这就是为什么您必须指定一个应用该函数的对象（QScriptValue::call()的第一个参数）。

如果函数应该充当一个方法（即，它只能应用于某一类对象，函数中有this），则由函数本身来检查它是否被与该对象兼容地调用。

将无效的QScriptValue()作为这个参数传递给QScriptValue::call()表明应该使用全局对象作为这个对象；换句话说，应该将函数作为全局函数调用。