Loading...
Searching...
No Matches
DataProvider::DataProviderOptionInfo Struct Reference

Data provider option info. More...

`#include <AbstractDataProvider.qc.dox.h>`

## Public Attributes

*softlist< hash< Util::AllowedValueInfo > > | allowed_values
| List of allowed values (enum)
bool | allowed_values_creatable
| Does the option accept values not defined in allowed_values too?
*string | default_ref_data
| A tag allowing the default value for the option to be returned dynamically.
auto | default_value
| Any default value.
string | desc
| The option description.
string | display_name
| Option display name.
*softlist< hash< Util::AllowedValueInfo > > | element_allowed_values
| List of allowed values for elements of list types (enum)
bool | element_allowed_values_creatable
| Does the option accept values for elements not defined in element_allowed_values too?
*string | element_ref_data
| A tag allowing element allowed values to be returned dynamically as reference data.
auto | example_value
| Any optional example value for the option.
bool | multiselect
| Are allowed values elements of the list's element type that indicate what values the list can have?
*bool | preselected
| Should this option be preselected?
*string | ref_data
| A tag allowing allowed values to be returned dynamically as reference data.
bool | required = False
| Required flag.
*list< string > | required_groups
| Is the option part of a required group?
bool | sensitive = False
| Is the option value sensitive?
*string | short_desc
| Option short description in plain text.
softlist< AbstractDataProviderType > | type
| The option value type or types.

## Detailed Description

Data provider option info.

## Member Data Documentation

## element_ref_data

*string DataProvider::DataProviderOptionInfo::element_ref_data

A tag allowing element allowed values to be returned dynamically as reference data.

The value is the name of the reference data; if allowed_values are not present, calls will be made to AbstractDataProvider::getElementReferenceData() in the available DataProvider when resolving application actions if this attribute is set

## example_value

auto DataProvider::DataProviderOptionInfo::example_value

Any optional example value for the option.

This value must be in the one of the types in the `type` list

## ref_data

*string DataProvider::DataProviderOptionInfo::ref_data

A tag allowing allowed values to be returned dynamically as reference data.

The value is the name of the reference data; if allowed_values are not present, calls will be made to AbstractDataProvider::getReferenceData() in the available DataProvider when resolving application actions if this attribute is set

## required

bool DataProvider::DataProviderOptionInfo::required = False

Required flag.

Note
  This attribute is ignored for cases when multiple combinations of options may be valid such as for data provider constructor options

## required_groups

*list<string> DataProvider::DataProviderOptionInfo::required_groups

Is the option part of a required group?

A required group is a group of options of which at least one must be set; each group name is an arbitrary string that is used to mark membership in the group by different options