Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/torch/qtlua.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeon Bottou <leon@bottou.org>2013-11-24 23:22:15 +0400
committerLeon Bottou <leon@bottou.org>2013-11-24 23:22:15 +0400
commit7972e39317776c624356568c87e76734a5618938 (patch)
tree8fda61e244fe4fa50a0d8da1c911bcad613a00bf
parent32de303572d8b06fc20f01e858d53df44ada440b (diff)
document conversions more precisely
-rw-r--r--packages/qt/doc/README.md21
1 files changed, 13 insertions, 8 deletions
diff --git a/packages/qt/doc/README.md b/packages/qt/doc/README.md
index 882b4d7..5439171 100644
--- a/packages/qt/doc/README.md
+++ b/packages/qt/doc/README.md
@@ -250,10 +250,13 @@ object. If the Lua interpreter runs in a different thread, a
[thread hopping](#qt.qcall) operation is performed for the duration
of the operation.
-Property values are always represented as Qt variant objects. They
-are automatically converted into Lua strings or Lua numbers when they
-are read. Conversely, Lua strings and Lua numbers are automatically
-converted into the desired type when a property is set.
+Property values are always represented as Qt variant objects.
+`QByteArray` variants and numerical variants are automatically
+converted into Lua strings or Lua numbers when they are read.
+However `QString` variants are left unchanges since such strings
+can contain non ASCII characters. Conversely, Lua strings and
+Lua numbers are automatically converted into the desired type
+when a property is set.
Property values with enumerated types registered using the Qt macro
[Q_ENUMS](http://doc.trolltech.com/4.4/qobject.html) are
@@ -302,10 +305,12 @@ thread owning the Qt object. If the Lua interpreter runs in a
different thread, a [thread hopping](#qt.qcall) operation is
performed for the duration of the operation.
-Argument types and return values are automatically converted. Lua
-strings can be specified when a `QByteArray` or a `QString` are
-expected. Lua numbers can be specified whenever numerical types are
-expected.
+A Lua string is automatically converted when a `QByteArray` or a `QString`
+argument is expected. A Lua number is automatically converted whenever a
+numerical type is expected. Return values with numerical types are
+converted into Lua numbers. Return values of type `QByteArray` are
+automatically converted into Lua strings. Return values of type `QString`
+are returned as string variants.
Inheritance ensures that all methods exposed by a class are also
exposed by its subclasses. Methods exposed by the `QObject` class,