diff options
author | Sze Howe Koh <szehowe.koh@gmail.com> | 2013-01-25 20:40:36 +0800 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-01-26 00:36:00 +0100 |
commit | 19550797aa16ee60fc19fdaf90832b4895612226 (patch) | |
tree | a64ff6780e4d0162173065e7bfcebe6e81b57ff1 /src/script | |
parent | aaddb67d074dcf1965e6c07a7232dd688deac416 (diff) | |
download | qtscript-19550797aa16ee60fc19fdaf90832b4895612226.tar.gz |
Doc: Fix module name format
Follow the conventions at
http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation
QtScript -> Qt Script
QtScriptTools -> Qt Script Tools
Change-Id: Icf6b2ea3829247475f8902334b615f9a9206cc51
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/script')
-rw-r--r-- | src/script/api/qscriptclass.cpp | 2 | ||||
-rw-r--r-- | src/script/api/qscriptcontext.cpp | 2 | ||||
-rw-r--r-- | src/script/api/qscriptengine.cpp | 52 | ||||
-rw-r--r-- | src/script/api/qscriptextensionplugin.cpp | 2 | ||||
-rw-r--r-- | src/script/api/qscriptstring.cpp | 2 | ||||
-rw-r--r-- | src/script/api/qscriptvalue.cpp | 4 | ||||
-rw-r--r-- | src/script/bridge/qscriptqobject.cpp | 2 | ||||
-rw-r--r-- | src/script/doc/snippets/code/doc_src_qtscript.cpp | 6 | ||||
-rw-r--r-- | src/script/doc/src/ecmascript.qdoc | 4 | ||||
-rw-r--r-- | src/script/doc/src/qtscript-index.qdoc | 88 | ||||
-rw-r--r-- | src/script/doc/src/qtscript-module.qdoc | 12 | ||||
-rw-r--r-- | src/script/doc/src/qtscriptextensions.qdoc | 6 |
12 files changed, 91 insertions, 91 deletions
diff --git a/src/script/api/qscriptclass.cpp b/src/script/api/qscriptclass.cpp index 2fc2d0a..8e286c8 100644 --- a/src/script/api/qscriptclass.cpp +++ b/src/script/api/qscriptclass.cpp @@ -179,7 +179,7 @@ QScriptEngine *QScriptClass::engine() const your class, then return it in this function. See the "Making Use of Prototype-Based Inheritance" section in the - QtScript documentation for more information on how prototypes are + Qt Script documentation for more information on how prototypes are used. */ QScriptValue QScriptClass::prototype() const diff --git a/src/script/api/qscriptcontext.cpp b/src/script/api/qscriptcontext.cpp index 6ea2b34..cbded31 100644 --- a/src/script/api/qscriptcontext.cpp +++ b/src/script/api/qscriptcontext.cpp @@ -179,7 +179,7 @@ QScriptValue QScriptContext::throwValue(const QScriptValue &value) The error object will be initialized to contain information about the location where the error occurred; specifically, it will have properties \c{lineNumber}, \c{fileName} and \c{stack}. These - properties are described in \l {QtScript Extensions to ECMAScript}. + properties are described in \l {Qt Script Extensions to ECMAScript}. \sa throwValue(), state() */ diff --git a/src/script/api/qscriptengine.cpp b/src/script/api/qscriptengine.cpp index 0b09f43..cefcd50 100644 --- a/src/script/api/qscriptengine.cpp +++ b/src/script/api/qscriptengine.cpp @@ -98,7 +98,7 @@ QT_BEGIN_NAMESPACE \ingroup script \mainclass - See the \l{QtScript} documentation for information about the Qt Script language, + See the \l{Qt Script} documentation for information about the Qt Script language, and how to get started with scripting your C++ application. \section1 Evaluating Scripts @@ -1262,7 +1262,7 @@ void QScriptEnginePrivate::setContextFlags(JSC::ExecState *exec, uint flags) // This function is called by JSC after all objects reachable by JSC itself // have been processed (see JSC::Heap::markRoots()). -// Here we should mark additional objects managed by QtScript. +// Here we should mark additional objects managed by Qt Script. void QScriptEnginePrivate::mark(JSC::MarkStack& markStack) { Q_Q(QScriptEngine); @@ -2183,7 +2183,7 @@ QScriptValue QScriptEngine::newFunction(QScriptEngine::FunctionSignature fun, #ifndef QT_NO_REGEXP /*! - Creates a QtScript object of class RegExp with the given + Creates a Qt Script object of class RegExp with the given \a regexp. \sa QScriptValue::toRegExp() @@ -2198,7 +2198,7 @@ QScriptValue QScriptEngine::newRegExp(const QRegExp ®exp) #endif // QT_NO_REGEXP /*! - Creates a QtScript object holding the given variant \a value. + Creates a Qt Script object holding the given variant \a value. If a default prototype has been registered with the meta type id of \a value, then the prototype of the created object will be that @@ -2251,13 +2251,13 @@ QScriptValue QScriptEngine::newVariant(const QScriptValue &object, #ifndef QT_NO_QOBJECT /*! - Creates a QtScript object that wraps the given QObject \a + Creates a Qt Script object that wraps the given QObject \a object, using the given \a ownership. The given \a options control various aspects of the interaction with the resulting script object. Signals and slots, properties and children of \a object are available as properties of the created QScriptValue. For more - information, see the \l{QtScript} documentation. + information, see the \l{Qt Script} documentation. If \a object is a null pointer, this function returns nullValue(). @@ -2265,8 +2265,8 @@ QScriptValue QScriptEngine::newVariant(const QScriptValue &object, (or its superclass, recursively), the prototype of the new script object will be set to be that default prototype. - If the given \a object is deleted outside of QtScript's control, any - attempt to access the deleted QObject's members through the QtScript + If the given \a object is deleted outside of Qt Script's control, any + attempt to access the deleted QObject's members through the Qt Script wrapper object (either by script code or C++) will result in a script exception. @@ -2337,7 +2337,7 @@ QScriptValue QScriptEngine::newQObject(const QScriptValue &scriptObject, #endif // QT_NO_QOBJECT /*! - Creates a QtScript object of class Object. + Creates a Qt Script object of class Object. The prototype of the created object will be the Object prototype object. @@ -2355,7 +2355,7 @@ QScriptValue QScriptEngine::newObject() \since 4.4 \overload - Creates a QtScript Object of the given class, \a scriptClass. + Creates a Qt Script Object of the given class, \a scriptClass. The prototype of the created object will be the Object prototype object. @@ -2467,7 +2467,7 @@ QScriptValue QScriptEngine::newFunction(QScriptEngine::FunctionWithArgSignature } /*! - Creates a QtScript object of class Array with the given \a length. + Creates a Qt Script object of class Array with the given \a length. \sa newObject() */ @@ -2479,7 +2479,7 @@ QScriptValue QScriptEngine::newArray(uint length) } /*! - Creates a QtScript object of class RegExp with the given + Creates a Qt Script object of class RegExp with the given \a pattern and \a flags. The legal flags are 'g' (global), 'i' (ignore case), and 'm' @@ -2493,7 +2493,7 @@ QScriptValue QScriptEngine::newRegExp(const QString &pattern, const QString &fla } /*! - Creates a QtScript object of class Date with the given + Creates a Qt Script object of class Date with the given \a value (the number of milliseconds since 01 January 1970, UTC). */ @@ -2505,7 +2505,7 @@ QScriptValue QScriptEngine::newDate(qsreal value) } /*! - Creates a QtScript object of class Date from the given \a value. + Creates a Qt Script object of class Date from the given \a value. \sa QScriptValue::toDateTime() */ @@ -2518,7 +2518,7 @@ QScriptValue QScriptEngine::newDate(const QDateTime &value) #ifndef QT_NO_QOBJECT /*! - Creates a QtScript object that represents a QObject class, using the + Creates a Qt Script object that represents a QObject class, using the the given \a metaObject and constructor \a ctor. Enums of \a metaObject (declared with Q_ENUMS) are available as @@ -2591,7 +2591,7 @@ QScriptValue QScriptEngine::newQMetaObject( valid, and so on. A typical usage of canEvaluate() is to implement an interactive - interpreter for QtScript. The user is repeatedly queried for + interpreter for Qt Script. The user is repeatedly queried for individual lines of code; the lines are concatened internally, and only when canEvaluate() returns true for the resulting program is it passed to evaluate(). @@ -2599,7 +2599,7 @@ QScriptValue QScriptEngine::newQMetaObject( The following are some examples to illustrate the behavior of canEvaluate(). (Note that all example inputs are assumed to have an explicit newline as their last character, since otherwise the - QtScript parser would automatically insert a semi-colon character at + Qt Script parser would automatically insert a semi-colon character at the end of the input, and this could cause canEvaluate() to produce different results.) @@ -2620,7 +2620,7 @@ QScriptValue QScriptEngine::newQMetaObject( Given the input \snippet code/src_script_qscriptengine.cpp 17 canEvaluate() will return true, even though the code is clearly not - syntactically valid QtScript code. evaluate() will throw a + syntactically valid Qt Script code. evaluate() will throw a SyntaxError when this code is evaluated. Given the input @@ -3607,7 +3607,7 @@ void QScriptEngine::installTranslatorFunctions(const QScriptValue &object) once; subsequent calls to importExtension() with the same extension name will do nothing and return undefinedValue(). - \sa availableExtensions(), QScriptExtensionPlugin, {Creating QtScript Extensions} + \sa availableExtensions(), QScriptExtensionPlugin, {Creating Qt Script Extensions} */ QScriptValue QScriptEngine::importExtension(const QString &extension) { @@ -3876,10 +3876,10 @@ QStringList QScriptEngine::importedExtensions() const Note that the template type \c{T} must be known to QMetaType. - See \l{Conversion Between QtScript and C++ Types} for a + See \l{Conversion Between Qt Script and C++ Types} for a description of the built-in type conversion provided by - QtScript. By default, the types that are not specially handled by - QtScript are represented as QVariants (e.g. the \a value is passed + Qt Script. By default, the types that are not specially handled by + Qt Script are represented as QVariants (e.g. the \a value is passed to newVariant()); you can change this behavior by installing your own type conversion functions with qScriptRegisterMetaType(). @@ -3892,9 +3892,9 @@ QStringList QScriptEngine::importedExtensions() const Note that \c{T} must be known to QMetaType. - See \l{Conversion Between QtScript and C++ Types} for a + See \l{Conversion Between Qt Script and C++ Types} for a description of the built-in type conversion provided by - QtScript. + Qt Script. \sa toScriptValue(), qScriptRegisterMetaType() */ @@ -3947,7 +3947,7 @@ QStringList QScriptEngine::importedExtensions() const Additionally, the type of each element in the sequence should be suitable for conversion to a QScriptValue. See - \l{Conversion Between QtScript and C++ Types} for more information + \l{Conversion Between Qt Script and C++ Types} for more information about the restrictions on types that can be used with QScriptValue. \sa QScriptEngine::fromScriptValue() @@ -3967,7 +3967,7 @@ QStringList QScriptEngine::importedExtensions() const Additionally, the type of each element in the sequence must be suitable for conversion to a C++ type from a QScriptValue. See - \l{Conversion Between QtScript and C++ Types} for more information + \l{Conversion Between Qt Script and C++ Types} for more information about the restrictions on types that can be used with QScriptValue. diff --git a/src/script/api/qscriptextensionplugin.cpp b/src/script/api/qscriptextensionplugin.cpp index 425c15c..a3e6fe7 100644 --- a/src/script/api/qscriptextensionplugin.cpp +++ b/src/script/api/qscriptextensionplugin.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE functions, and exporting the class using the Q_PLUGIN_METADATA() macro. See \l {How to Create Qt Plugins} for details. - \sa QScriptEngine::importExtension(), {Creating QtScript Extensions} + \sa QScriptEngine::importExtension(), {Creating Qt Script Extensions} */ /*! diff --git a/src/script/api/qscriptstring.cpp b/src/script/api/qscriptstring.cpp index aceda42..34767ac 100644 --- a/src/script/api/qscriptstring.cpp +++ b/src/script/api/qscriptstring.cpp @@ -156,7 +156,7 @@ bool QScriptString::operator!=(const QScriptString &other) const /*! \since 4.6 - Attempts to convert this QScriptString to a QtScript array index, + Attempts to convert this QScriptString to a Qt Script array index, and returns the result. If a conversion error occurs, *\a{ok} is set to false; otherwise diff --git a/src/script/api/qscriptvalue.cpp b/src/script/api/qscriptvalue.cpp index cfffea2..3e307a2 100644 --- a/src/script/api/qscriptvalue.cpp +++ b/src/script/api/qscriptvalue.cpp @@ -94,7 +94,7 @@ 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, see the \l{QtScript} documentation. + information, see the \l{Qt Script} documentation. Function objects (objects for which isFunction() returns true) can be invoked by calling call(). Constructor functions can be used to @@ -2014,7 +2014,7 @@ bool QScriptValue::isValid() const /*! \since 4.4 - Returns the internal data of this QScriptValue object. QtScript uses + Returns the internal data of this QScriptValue object. Qt Script 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(). diff --git a/src/script/bridge/qscriptqobject.cpp b/src/script/bridge/qscriptqobject.cpp index a8076bb..1df0264 100644 --- a/src/script/bridge/qscriptqobject.cpp +++ b/src/script/bridge/qscriptqobject.cpp @@ -2317,7 +2317,7 @@ int QObjectData::markConnections(JSC::MarkStack& markStack) // This function assumes all objects reachable elsewhere in the JS environment // (stack, heap) have been marked already (see QScriptEnginePrivate::mark()). -// This determines whether any of QtScript's internal QObject wrappers are only +// This determines whether any of Qt Script's internal QObject wrappers are only // weakly referenced and can be discarded. void QObjectData::markWrappers(JSC::MarkStack& markStack) { diff --git a/src/script/doc/snippets/code/doc_src_qtscript.cpp b/src/script/doc/snippets/code/doc_src_qtscript.cpp index bb58400..6cbb5de 100644 --- a/src/script/doc/snippets/code/doc_src_qtscript.cpp +++ b/src/script/doc/snippets/code/doc_src_qtscript.cpp @@ -65,7 +65,7 @@ public: void aNonScriptableFunction(); -public slots: // these functions (slots) will be available in QtScript +public slots: // these functions (slots) will be available in Qt Script void calculate( ... ); void setEnabled( bool enabled ); bool isEnabled() const; @@ -103,7 +103,7 @@ public: void aNonScriptableFunction(); -public slots: // these functions (slots) will be available in QtScript +public slots: // these functions (slots) will be available in Qt Script void calculate( ... ); void setEnabled( bool enabled ); bool isEnabled() const; @@ -132,7 +132,7 @@ public: void aNonScriptableFunction(); -public slots: // these functions (slots) will be available in QtScript +public slots: // these functions (slots) will be available in Qt Script void calculate( ... ); void setEnabled( bool enabled ); bool isEnabled() const; diff --git a/src/script/doc/src/ecmascript.qdoc b/src/script/doc/src/ecmascript.qdoc index c4b8797..84116c7 100644 --- a/src/script/doc/src/ecmascript.qdoc +++ b/src/script/doc/src/ecmascript.qdoc @@ -28,10 +28,10 @@ /*! \page ecmascript.html \title ECMAScript Reference - \brief A list of objects, functions and properties supported by QtScript. + \brief A list of objects, functions and properties supported by Qt Script. This reference contains a list of built-in objects, functions and - properties supported by QtScript. For a detailed description, see + properties supported by Qt Script. For a detailed description, see the \l{ECMA-262} specification. \tableofcontents diff --git a/src/script/doc/src/qtscript-index.qdoc b/src/script/doc/src/qtscript-index.qdoc index 05005e9..7e5af4c 100644 --- a/src/script/doc/src/qtscript-index.qdoc +++ b/src/script/doc/src/qtscript-index.qdoc @@ -182,7 +182,7 @@ When the argument is a QObject slot, the argument types of the signal and slot do not necessarily have to be compatible; - QtScript will, if necessary, perform conversion of the signal + Qt Script will, if necessary, perform conversion of the signal arguments to match the argument types of the slot. To disconnect from a signal, you invoke the signal's @@ -254,7 +254,7 @@ \section3 Overloaded Signals and Slots - When a signal or slot is overloaded, QtScript will attempt to + When a signal or slot is overloaded, Qt Script will attempt to pick the right overload based on the actual types of the QScriptValue arguments involved in the function invocation. For example, if your class has slots \c{myOverloadedSlot(int)} and \c{myOverloadedSlot(QString)}, the following @@ -268,7 +268,7 @@ \snippet code/doc_src_qtscript.js 12 - If the overloads have different number of arguments, QtScript will + If the overloads have different number of arguments, Qt Script will pick the overload with the argument count that best matches the actual number of arguments passed to the slot. @@ -279,7 +279,7 @@ \section2 Accessing Properties The properties of the QObject are available as properties - of the corresponding QtScript object. When you manipulate + of the corresponding Qt Script object. When you manipulate a property in script code, the C++ get/set method for that property will automatically be invoked. For example, if your C++ class has a property declared as follows: @@ -294,7 +294,7 @@ Every named child of the QObject (that is, for which QObject::objectName() is not an empty string) is by default available as - a property of the QtScript wrapper object. For example, + a property of the Qt Script wrapper object. For example, if you have a QDialog with a child widget whose \c{objectName} property is \c{"okButton"}, you can access this object in script code through the expression @@ -366,7 +366,7 @@ With QScriptEngine::AutoOwnership the ownership is based on whether the QObject has a parent or not. - If the QtScript garbage collector finds that the QObject is no + If the Qt Script garbage collector finds that the QObject is no longer referenced within the script environment, the QObject will be deleted \e{only} if it does not have a parent. @@ -390,7 +390,7 @@ QScriptEngine::newQObject() can take a third argument which allows you to control various aspects of the access to the QObject through - the QtScript wrapper object it returns. + the Qt Script wrapper object it returns. QScriptEngine::ExcludeChildObjects specifies that child objects of the QObject should not appear as properties of the wrapper object. @@ -405,7 +405,7 @@ QScriptEngine::AutoCreateDynamicProperties specifies that properties that don't already exist in the QObject should be created as dynamic - properties of the QObject, rather than as properties of the QtScript + properties of the QObject, rather than as properties of the Qt Script wrapper object. If you want new properties to truly become persistent properties of the QObject, rather than properties that are destroyed along with the wrapper object (and that aren't shared if the QObject @@ -442,14 +442,14 @@ properties of the QMetaObject wrapper object that can be created with QScriptEngine::newQMetaObject(). - \section1 Conversion Between QtScript and C++ Types + \section1 Conversion Between Qt Script and C++ Types - QtScript will perform type conversion when a value needs to be + Qt Script will perform type conversion when a value needs to be converted from the script side to the C++ side or vice versa; for instance, when a C++ signal triggers a script function, when you access a QObject property in script code, or when you call QScriptEngine::toScriptValue() or - QScriptEngine::fromScriptValue() in C++. QtScript provides default + QScriptEngine::fromScriptValue() in C++. Qt Script provides default conversion operations for many of the built-in Qt types. You can change the conversion operation for a type (including your custom C++ types) by registering your own conversion functions with @@ -511,7 +511,7 @@ the result is an empty QList<int>. \endtable - Additionally, QtScript will handle the following cases: + Additionally, Qt Script will handle the following cases: \list \li If the QScriptValue is a QObject and the target type name ends with @@ -592,7 +592,7 @@ This section explains how to implement application objects and provides the necessary technical background material. - \section2 Making a C++ object available to Scripts Written in QtScript + \section2 Making a C++ object available to Scripts Written in Qt Script Making C++ classes and objects available to a scripting language is not trivial because scripting languages tend to be more dynamic than @@ -608,7 +608,7 @@ (Meta-Object Compiler). Classes that wish to take advantage of the meta-object facilities are either subclasses of QObject, or use the \c{Q_OBJECT} macro. Qt has used this approach for many years and it has - proven to be solid and reliable. QtScript uses this meta-object + proven to be solid and reliable. Qt Script uses this meta-object technology to provide scripters with dynamic access to C++ classes and objects. @@ -619,14 +619,14 @@ how to implement application objects. However, this knowledge is not essential in the simplest cases. - To make an object available in QtScript, it must derive from + To make an object available in Qt Script, it must derive from QObject. All classes which derive from QObject can be introspected and can provide the information needed by the scripting engine at run-time; e.g., class name, functions, signatures. Because we obtain the information we need about classes dynamically at run-time, there is no need to write wrappers for QObject derived classes. - \section2 Making C++ Class Member Functions Available in QtScript + \section2 Making C++ Class Member Functions Available in Qt Script The meta-object system also makes information about signals and slots dynamically available at run-time. By default, for QObject subclasses, @@ -634,7 +634,7 @@ This is very convenient because, in practice, we normally only want to make specially chosen functions available to scripters. When you create a QObject subclass, make sure that the functions you want to expose to - QtScript are public slots. + Qt Script are public slots. For example, the following class definition enables scripting only for certain functions: @@ -642,8 +642,8 @@ \snippet code/doc_src_qtscript.cpp 19 In the example above, aNonScriptableFunction() is not declared as a - slot, so it will not be available in QtScript. The other three - functions will automatically be made available in QtScript because + slot, so it will not be available in Qt Script. The other three + functions will automatically be made available in Qt Script because they are declared in the \c{public slots} section of the class definition. @@ -653,7 +653,7 @@ \snippet code/doc_src_qtscript.cpp 20 Once declared with \c{Q_INVOKABLE}, the method can be invoked from - QtScript code just as if it were a slot. Although such a method is + Qt Script code just as if it were a slot. Although such a method is not a slot, you can still specify it as the target function in a call to \c{connect()} in script code; \c{connect()} accepts both native and non-native functions as targets. @@ -664,10 +664,10 @@ to supply conversion functions. This is done using the qScriptRegisterMetaType() function. - \section2 Making C++ Class Properties Available in QtScript + \section2 Making C++ Class Properties Available in Qt Script In the previous example, if we wanted to get or set a property using - QtScript we would have to write code like the following: + Qt Script we would have to write code like the following: \snippet code/doc_src_qtscript.js 21 @@ -691,7 +691,7 @@ the names of the setter and getter functions as arguments. If you don't want a property of your class to be accessible in - QtScript, you set the \c{SCRIPTABLE} attribute to \c false when + Qt Script, you set the \c{SCRIPTABLE} attribute to \c false when declaring the property; by default, the \c{SCRIPTABLE} attribute is \c true. For example: @@ -705,10 +705,10 @@ is called. This connection is established using the QObject::connect() function. - The signals and slots mechanism is also available to QtScript + The signals and slots mechanism is also available to Qt Script programmers. The code to declare a signal in C++ is the same, regardless of whether the signal will be connected to a slot in C++ - or in QtScript. + or in Qt Script. \snippet code/doc_src_qtscript.cpp 25 @@ -722,9 +722,9 @@ \section2 Design of Application Objects The previous section described how to implement C++ objects which - can be used in QtScript. Application objects are the same kind of + can be used in Qt Script. Application objects are the same kind of objects, and they make your application's functionality available to - QtScript scripters. Since the C++ application is already written + Qt Script scripters. Since the C++ application is already written in Qt, many objects are already QObjects. The easiest approach would be to simply add all these QObjects as application objects to the scripting engine. For small applications this might be sufficient, @@ -747,7 +747,7 @@ If you have a slot that returns a QObject pointer, you should note that, by default, Qt Script only handles conversion of the types QObject* and QWidget*. This means that if your slot is declared - with a signature like "MyObject* getMyObject()", QtScript doesn't + with a signature like "MyObject* getMyObject()", Qt Script doesn't automatically know that MyObject* should be handled in the same way as QObject* and QWidget*. The simplest way to solve this is to only use QObject* and QWidget* in the method signatures of your scripting @@ -1285,10 +1285,10 @@ In ECMAScript, inheritance is based on the concept of \e{shared prototype objects}; this is quite different from the class-based - inheritance familiar to C++ programmers. With QtScript, you can + inheritance familiar to C++ programmers. With Qt Script, you can associate a custom prototype object with a C++ type using QScriptEngine::setDefaultPrototype(); this is the key to providing - a script interface to that type. Since the QtScript module is built + a script interface to that type. Since the Qt Script module is built on top of Qt's meta-type system, this can be done for any C++ type. You might be wondering when exactly you would need to use this @@ -1314,25 +1314,25 @@ This section explains the underlying concepts of prototype-based inheritance. Once these concepts are understood, the associated - practices can be applied throughout the QtScript API in order to + practices can be applied throughout the Qt Script API in order to create well-behaved, consistent bindings to C++ that will fit nicely into the ECMAScript universe. - When experimenting with QtScript objects and inheritance, it can be + When experimenting with Qt Script objects and inheritance, it can be helpful to use the interactive interpreter included with the \l{Qt Script Examples}, located in \c{examples/script/qscript}. \section2 Prototype Objects and Shared Properties - The purpose of a QtScript \e{prototype object} is to define - behavior that should be shared by a set of other QtScript + The purpose of a Qt Script \e{prototype object} is to define + behavior that should be shared by a set of other Qt Script objects. We say that objects which share the same prototype object belong to the same \e{class} (again, on the technical side this should not to be confused with the class constructs of languages like C++ and Java; ECMAScript has no such construct). The basic prototype-based inheritance mechanism works as follows: Each - QtScript object has an internal link to another object, its + Qt Script object has an internal link to another object, its \e{prototype}. When a property is looked up in an object, and the object itself does not have the property, the property is looked up in the prototype object instead; if the prototype has the property, @@ -1365,7 +1365,7 @@ \section2 Defining Classes in a Prototype-Based Universe - In QtScript, a class is not defined explicitly; there is no + In Qt Script, a class is not defined explicitly; there is no \c{class} keyword. Instead, you define a new class in two steps: \list 1 @@ -1393,10 +1393,10 @@ Next, you want to set up \c{Person.prototype} as your prototype object; i.e., define the interface that should be common to all - \c{Person} objects. QtScript automatically creates a default + \c{Person} objects. Qt Script automatically creates a default prototype object (by the expression \c{new Object()}) for every script function; you can add properties to this object, or you can - assign your own custom object. (Generally speaking, any QtScript + assign your own custom object. (Generally speaking, any Qt Script object can act as prototype for any other object.) Here's an example of how you might want to override the @@ -1445,7 +1445,7 @@ same as that of \c{Person} objects, but with \c{Employee.prototype} added to the front of the chain. - \section2 Prototype-Based Programming with the QtScript C++ API + \section2 Prototype-Based Programming with the Qt Script C++ API You can use QScriptEngine::newFunction() to wrap native functions. When implementing a constructor function, @@ -1472,7 +1472,7 @@ You associate a prototype object with a C++ type by calling QScriptEngine::setDefaultPrototype(). Once this mapping is - established, QtScript will automatically assign the correct + established, Qt Script will automatically assign the correct prototype when a value of such a type is wrapped in a QScriptValue; either when you explicitly call QScriptEngine::toScriptValue(), or when a value of such a type is returned from a C++ slot and @@ -1661,7 +1661,7 @@ of the script function itself, so that it can be retrieved when the function is called. - \section1 Using QtScript Extensions + \section1 Using Qt Script Extensions The QScriptEngine::importExtension() function can be used to load plugins into a script engine. Plugins typically add some extra functionality to @@ -1670,7 +1670,7 @@ scripts. There are currently no script plugins shipped with Qt. If you are implementing some Qt Script functionality that you want other - Qt application developers to be able to use, \l{Creating QtScript Extensions} + Qt application developers to be able to use, \l{Creating Qt Script Extensions} {developing an extension} (e.g. by subclassing QScriptExtensionPlugin) is worth looking into. @@ -1798,11 +1798,11 @@ \section1 ECMAScript Compatibility - QtScript implements all the built-in objects and properties defined + Qt Script implements all the built-in objects and properties defined in the \l{ECMA-262} standard; see the \l{ECMAScript Reference}{ECMAScript reference} for an overview. - \section1 QtScript Extensions to ECMAScript + \section1 Qt Script Extensions to ECMAScript \list \li \c{__proto__} \br diff --git a/src/script/doc/src/qtscript-module.qdoc b/src/script/doc/src/qtscript-module.qdoc index 675b759..5f19fd9 100644 --- a/src/script/doc/src/qtscript-module.qdoc +++ b/src/script/doc/src/qtscript-module.qdoc @@ -31,10 +31,10 @@ \since 4.3 \ingroup modules - \brief The QtScript module provides classes for making Qt applications scriptable. + \brief The Qt Script module provides classes for making Qt applications scriptable. - The QtScript module only provides core scripting facilities; the - QtScriptTools module provides additional Qt Script-related + The Qt Script module only provides core scripting facilities; the + Qt Script Tools module provides additional Qt Script-related components that application developers may find useful. This module is mainly provided for backwards compatibility reasons @@ -52,13 +52,13 @@ \snippet code/doc_src_qtscript.pro 1 For detailed information on how to make your application - scriptable with QtScript, see \l{Making Applications + scriptable with Qt Script, see \l{Making Applications Scriptable}. \section1 License Information Qt Commercial Edition licensees that wish to distribute applications that - use the QtScript module need to be aware of their obligations under the + use the Qt Script module need to be aware of their obligations under the GNU Library General Public License (LGPL). Developers using the Open Source Edition can choose to redistribute @@ -70,7 +70,7 @@ sufficient for most use cases and is not dependent on LGPL code. \legalese - QtScript is licensed under the GNU Library General Public License. + Qt Script is licensed under the GNU Library General Public License. Individual contributor names and copyright dates can be found inline in the code. diff --git a/src/script/doc/src/qtscriptextensions.qdoc b/src/script/doc/src/qtscriptextensions.qdoc index 2a7c27e..294513f 100644 --- a/src/script/doc/src/qtscriptextensions.qdoc +++ b/src/script/doc/src/qtscriptextensions.qdoc @@ -27,10 +27,10 @@ /*! \page qtscriptextensions.html - \title Creating QtScript Extensions - \brief A guide to creating and using QtScript extensions. + \title Creating Qt Script Extensions + \brief A guide to creating and using Qt Script extensions. - QtScript extensions can make additional functionality available to scripts + Qt Script extensions can make additional functionality available to scripts evaluated by a QScriptEngine. Extensions are imported by calling the QScriptEngine::importExtension() function. |