diff options
Diffstat (limited to 'src/ivicore/doc/src/ivigenerator/filter-reference.qdoc')
| -rw-r--r-- | src/ivicore/doc/src/ivigenerator/filter-reference.qdoc | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/src/ivicore/doc/src/ivigenerator/filter-reference.qdoc b/src/ivicore/doc/src/ivigenerator/filter-reference.qdoc index ca11196..72e7151 100644 --- a/src/ivicore/doc/src/ivigenerator/filter-reference.qdoc +++ b/src/ivicore/doc/src/ivigenerator/filter-reference.qdoc @@ -74,6 +74,8 @@ Returns the default value for the passed symbol. Models are initialized as \c nu \target default_value(symbol, zone="=") \section2 default_value(symbol, zone="=") +\note This filter is deprecated and will be removed in future Qt versions. + Returns the default value for the passed symbol set by the \c @default annotation. If not set uses \c default_type_value instead. @@ -82,6 +84,8 @@ The zone parameter is used to identify different default values per zone. \target model_type(symbol) \section2 model_type(symbol) +\note This filter is deprecated and will be removed in future Qt versions. + Returns the C++ class name for this model. \target flag_type(symbol) @@ -115,11 +119,15 @@ Only lowers the first character of the given string. \target range_low(property) \section2 range_low(property) +\note This filter is deprecated and will be removed in future Qt versions. + Returns the minimum value for the passed property using the \c @range or \c @minimum annotations. \target range_high(property) \section2 range_high(property) +\note This filter is deprecated and will be removed in future Qt versions. + Returns the maximum value for the passed property using the \c @range or \c @maximum annotations. \target strip_QT(string) @@ -130,6 +138,8 @@ Removes the 'QT' at the beginning, if the string starts with it. \target domain_values(symbol) \section2 domain_values(symbol) +\note This filter is deprecated and will be removed in future Qt versions. + Returns the domain values for the passed property using the \c @domain annotation. \target enum_value(value, module_name) @@ -143,12 +153,16 @@ Also supports passing '|' connected values. \target tag_by_path(symbol, path, default_value=False) \section2 tag_by_path(symbol, path, default_value=False) +\note This filter is deprecated and will be removed in future Qt versions. + Find the tag given by its full path in the object hierarchy, like \c property.config_sim.zones.right. If some parts of the path are missing, return \c None. \target conf_sim_tag(symbol, path, default_value=False) \section2 conf_sim_tag(symbol, path, default_value=False) +\note This filter is deprecated and will be removed in future Qt versions. + Find the tag, given by its path, located under the "config_simulator" sub-object. Returns \c None, if parts of the path are missing. @@ -160,11 +174,15 @@ Returns a JSON representation of the given obj. \target has_domains(properties) \section2 has_domains(properties) +\note This filter is deprecated and will be removed in future Qt versions. + Returns \c true if any of the given properties has \c @range or \c @domain annotations. \target json_domain(properties) \section2 json_domain(properties) +\note This filter is deprecated and will be removed in future Qt versions. + Returns the property domains for the given properties formated in JSON. \target qml_type(interface) @@ -177,12 +195,16 @@ module_name is used. \target qml_control(symbol, backend_obj) \section2 qml_control(symbol, backend_obj) +\note This filter is deprecated and will be removed in future Qt versions. + Returns the QML code for the control (or group of controls) to represent the editing UI for the passed symbol. \target qml_binding_property(symbol) \section2 qml_binding_property(symbol) +\note This filter is deprecated and will be removed in future Qt versions. + Returns the name of the property of the QML control to be bound with. E.g. "value" for a Slider and "checked" for a CheckBox. @@ -190,6 +212,8 @@ E.g. "value" for a Slider and "checked" for a CheckBox. \target qml_control_signal_parameters(symbol) \section2 qml_control_signal_parameters(symbol) +\note This filter is deprecated and will be removed in future Qt versions + Returns the parameters for calling the signal using the values from the UI controls. \target struct_includes(symbol) |