diff options
author | Chris Adams <christopher.adams@nokia.com> | 2011-05-10 12:10:06 +1000 |
---|---|---|
committer | Chris Adams <christopher.adams@nokia.com> | 2011-05-11 14:26:43 +1000 |
commit | 4ff72975b6501a0003329bb8183479d4df5eda4d (patch) | |
tree | 9cea160e81cf0a04eb166c67e2807ceb3c7de6a1 /src/declarative/qml | |
parent | 67d5026372cf8a7c9319703fc58073910820b740 (diff) |
Add user documentation for scarce resource properties
Relates to commit 59ace5c5a666b1588560d2aeaa79a57da535e863.
Task-number: QMLNG-18
Reviewed-by: Aaron Kennedy
Change-Id: I216ced4c663ebab8003978999dc16ac809443a5f
Diffstat (limited to 'src/declarative/qml')
-rw-r--r-- | src/declarative/qml/qdeclarativescarceresourcescriptclass.cpp | 36 |
1 files changed, 31 insertions, 5 deletions
diff --git a/src/declarative/qml/qdeclarativescarceresourcescriptclass.cpp b/src/declarative/qml/qdeclarativescarceresourcescriptclass.cpp index 121d0a1a35..d94e2d9332 100644 --- a/src/declarative/qml/qdeclarativescarceresourcescriptclass.cpp +++ b/src/declarative/qml/qdeclarativescarceresourcescriptclass.cpp @@ -144,9 +144,22 @@ QDeclarativeScarceResourceScriptClass::property(Object *object, const Identifier } /* - The user explicitly wants to preserve the resource. - We remove the scarce resource from the engine's linked list - of resources to release after evaluation completes. + This method is called when the user explicitly calls the "preserve" method of a scarce resource in JavaScript + within the specified evaluation context \a context of the script engine \a engine. + Calling this function signifies that the user explicitly wants to preserve the resource rather than let it + be automatically released once evaluation of the expression is complete. + This function removes the internal scarce resource from the declarative engine's linked list of scarce resources + to release after evaluation of the expression completes. This means that the resource will only be truly + released when the JavaScript engine's garbage collector is run. + + Example: + \qml + function getIcon(model) { + var icon = model.avatar; // a pixmap property + icon.preserve(); // explicitly preserves the resource + return icon; // a valid variant will be returned + } + \endqml */ QScriptValue QDeclarativeScarceResourceScriptClass::preserve(QScriptContext *context, QScriptEngine *engine) { @@ -168,8 +181,21 @@ QScriptValue QDeclarativeScarceResourceScriptClass::preserve(QScriptContext *con } /* - The user explicitly wants to release the resource. - We set the internal scarce resource variant to the invalid variant. + This method is called when the user explicitly calls the "destroy" method of a scarce resource in JavaScript + within the specified evaluation context \a context of the script engine \a engine. + Calling this function signifies that the user explicitly wants to release the resource. + This function sets the internal scarce resource variant to the invalid variant, in order to release the original resource, + and then removes the resource from the declarative engine's linked-list of scarce resources to + to release after evaluation of the expression completes, as it has already been released. + + Example: + \qml + function getIcon(model) { + var icon = model.avatar; // a pixmap property + icon.destroy(); // explicitly releases the resource + return icon; // an invalid variant will be returned + } + \endqml */ QScriptValue QDeclarativeScarceResourceScriptClass::destroy(QScriptContext *context, QScriptEngine *engine) { |