Doc: Fix builtin value type documentation
date was miscategorized, and variant and void were missing. list was confusing. Pick-to: 6.4 Fixes: QTBUG-96779 Change-Id: I8398a1a4ff7f0dff12b626d5a2a7d182e1386bcb Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
This commit is contained in:
parent
f66d0bfebe
commit
d183606126
|
@ -40,7 +40,7 @@ the client to import the module which provides them.
|
||||||
All of the value types listed below may be used as a \c property type in a QML
|
All of the value types listed below may be used as a \c property type in a QML
|
||||||
document, with the following exceptions:
|
document, with the following exceptions:
|
||||||
\list
|
\list
|
||||||
\li \c list must be used in conjunction with a QML object type
|
\li \c list must be used in conjunction with an object or value type as element
|
||||||
\li \c enumeration cannot be used directly as the enumeration must be defined by a registered QML object type
|
\li \c enumeration cannot be used directly as the enumeration must be defined by a registered QML object type
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
|
@ -293,17 +293,6 @@ property is only invoked when the property is reassigned to a different object v
|
||||||
|
|
||||||
Properties of type \c list are empty by default.
|
Properties of type \c list are empty by default.
|
||||||
|
|
||||||
A list value can be accessed in a similar way to a JavaScript array:
|
|
||||||
|
|
||||||
\list
|
|
||||||
\li Values are assigned using the \c[] square bracket syntax with comma-separated values
|
|
||||||
\li The \c length property provides the number of items in the list
|
|
||||||
\li Values in the list are accessed using the \c [index] syntax
|
|
||||||
\endlist
|
|
||||||
|
|
||||||
Values can be dynamically added to the list by using the \c push method,
|
|
||||||
as if it were a JavaScript Array
|
|
||||||
|
|
||||||
A \c list can store QML objects or \l{QML Value Types}{value type} values.
|
A \c list can store QML objects or \l{QML Value Types}{value type} values.
|
||||||
|
|
||||||
When integrating with C++, note that any QQmlListProperty value
|
When integrating with C++, note that any QQmlListProperty value
|
||||||
|
@ -319,7 +308,7 @@ property is only invoked when the property is reassigned to a different object v
|
||||||
can be assigned to and used as follows:
|
can be assigned to and used as follows:
|
||||||
|
|
||||||
\qml
|
\qml
|
||||||
import QtQuick 2.0
|
import QtQuick
|
||||||
|
|
||||||
Item {
|
Item {
|
||||||
width: 100; height: 100
|
width: 100; height: 100
|
||||||
|
@ -343,7 +332,7 @@ property is only invoked when the property is reassigned to a different object v
|
||||||
If the list only contains one object, the square brackets may be omitted:
|
If the list only contains one object, the square brackets may be omitted:
|
||||||
|
|
||||||
\qml
|
\qml
|
||||||
import QtQuick 2.0
|
import QtQuick
|
||||||
|
|
||||||
Item {
|
Item {
|
||||||
width: 100; height: 100
|
width: 100; height: 100
|
||||||
|
@ -351,17 +340,38 @@ property is only invoked when the property is reassigned to a different object v
|
||||||
}
|
}
|
||||||
\endqml
|
\endqml
|
||||||
|
|
||||||
Objects and values in a list can be replaced with the \c{[]} operator, just
|
You can also declare your own list properties in QML:
|
||||||
like entries of JavaScript arrays. You can also use \c{push()} to append
|
|
||||||
entries, or you can set the \c length property of the list to truncate or
|
\qml
|
||||||
extend it. You can not automatically extend the list by assigning to an
|
import QtQml
|
||||||
index currently out of range, though. Furthermore, if you insert \c null
|
|
||||||
values into a list of objects, those are converted to \c nullptr entries in
|
QtObject {
|
||||||
|
property list<int> intList: [1, 2, 3, 4]
|
||||||
|
property list<QtObject> objectList
|
||||||
|
}
|
||||||
|
\endqml
|
||||||
|
|
||||||
|
Lists can be used much like JavaScript arrays. For example:
|
||||||
|
|
||||||
|
\list
|
||||||
|
\li Values are assigned using the \c[] square bracket syntax with comma-separated values
|
||||||
|
\li The \c length property provides the number of items in the list
|
||||||
|
\li Values in the list are accessed using the \c [index] syntax
|
||||||
|
\li You can use \c{push()} to append entries
|
||||||
|
\li You can set the \c length property of the list to truncate or extend it.
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
However, you can \e{not} automatically extend the list by assigning to an
|
||||||
|
index currently out of range. Furthermore, if you insert \c null values
|
||||||
|
into a list of objects, those are converted to \c nullptr entries in
|
||||||
the underlying QQmlListProperty.
|
the underlying QQmlListProperty.
|
||||||
|
|
||||||
A list of value types is different from a JavaScript array in one important
|
A list of value types is different from a JavaScript array in one further
|
||||||
aspect: Growing it by setting its length does not produce undefined entries,
|
important aspect: Growing it by setting its length does not produce undefined
|
||||||
but rather default-constructed instances of the value type.
|
entries, but rather default-constructed instances of the value type.
|
||||||
|
|
||||||
|
Similarly, growing a list of object types this way produces null entries,
|
||||||
|
rather than undefined entries.
|
||||||
|
|
||||||
This value type is provided by the QML language.
|
This value type is provided by the QML language.
|
||||||
|
|
||||||
|
@ -470,6 +480,36 @@ property is only invoked when the property is reassigned to a different object v
|
||||||
\sa {QML Value Types}
|
\sa {QML Value Types}
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\qmlvaluetype variant
|
||||||
|
\ingroup qmlvaluetypes
|
||||||
|
\brief a generic property type.
|
||||||
|
|
||||||
|
The \c variant type is the same as the \c var type. Use \c var instead.
|
||||||
|
|
||||||
|
\sa {QML Value Types}
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\qmlvaluetype void
|
||||||
|
\ingroup qmlvaluetypes
|
||||||
|
\brief The empty value type.
|
||||||
|
|
||||||
|
The \c void type is exclusively used to type-annotate JavaScript functions
|
||||||
|
returning \c undefined. For example:
|
||||||
|
|
||||||
|
\qml
|
||||||
|
function doThings() : void { console.log("hello") }
|
||||||
|
\endqml
|
||||||
|
|
||||||
|
This is to help tooling analyze calls to such functions and compile them and
|
||||||
|
their callers to C++.
|
||||||
|
|
||||||
|
You cannot declare \c void properties in QML.
|
||||||
|
|
||||||
|
\sa {QML Value Types}
|
||||||
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\qmlvaluetype enumeration
|
\qmlvaluetype enumeration
|
||||||
\ingroup qmlvaluetypes
|
\ingroup qmlvaluetypes
|
||||||
|
|
|
@ -60,8 +60,7 @@ provided:
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\qmlvaluetype date
|
\qmlvaluetype date
|
||||||
\ingroup qtqmlvaluetypes
|
\ingroup qmlvaluetypes
|
||||||
\ingroup qtquickvaluetypes
|
|
||||||
\brief a date value.
|
\brief a date value.
|
||||||
|
|
||||||
The \c date type refers to a date value, including the time of the day.
|
The \c date type refers to a date value, including the time of the day.
|
||||||
|
|
Loading…
Reference in New Issue