aboutsummaryrefslogtreecommitdiffstats
path: root/doc/typesystem_specifying_types.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/typesystem_specifying_types.rst')
-rw-r--r--doc/typesystem_specifying_types.rst14
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/typesystem_specifying_types.rst b/doc/typesystem_specifying_types.rst
index e94873834..ec16a59a6 100644
--- a/doc/typesystem_specifying_types.rst
+++ b/doc/typesystem_specifying_types.rst
@@ -170,7 +170,8 @@ value-type
<typesystem>
<value-type name="..."
copyable="yes | no"
- hash-function="..." />
+ hash-function="..."
+ stream="yes | no" />
</typesystem>
The **name** attribute is the fully qualified C++ class name, such as
@@ -178,6 +179,10 @@ value-type
force or not specify if this type is copyable. The *optional* **hash-function**
attribute informs the function name of a hash function for the type.
+ The *optional* attribute **stream** specifies whether this type will be able to
+ use externally defined operators, like QDataStream << and >>. If equals to **yes**,
+ these operators will be called as normal methods within the current class.
+
.. _object-type:
@@ -193,7 +198,8 @@ object-type
<typesystem>
<object-type name="..."
copyable="yes | no"
- hash-function="..." />
+ hash-function="..."
+ stream="yes | no" />
</typesystem>
The **name** attribute is the fully qualified C++ class name. If there is no
@@ -202,6 +208,10 @@ object-type
**copyable** and **hash-function** attributes are the same as described for
:ref:`value-type`.
+ The *optional* attribute **stream** specifies whether this type will be able to
+ use externally defined operators, like QDataStream << and >>. If equals to **yes**,
+ these operators will be called as normal methods within the current class.
+
interface-type
^^^^^^^^^^^^^^