QIfConfiguration Class

// Create a class based on QIfAbstractFeature and set it's configuration id to "group1"
auto feature1 = new AbstractFeatureBasedClass;
feature1.setConfigurationId("group1");

// Create another one, but with configuration id "group2"
auto feature2 = new AbstractFeatureBasedClass;
feature2.setConfigurationId("group2");

// The discoveryMode of all feature based instances in "group1" should be LoadOnlyProductionBackends
QIfConfiguration::setDiscoveryMode("group1", QIfAbstractFeature::LoadOnlyProductionBackends);

qDebug() << feature1.discoveryMode() << feature2.discoveryMode();

QIfConfiguration config("group2");
config.setDiscoeryMode(QIfAbstractFeature::LoadOnlyProductionBackends);

qDebug() << feature1.discoveryMode() << feature2.discoveryMode();

[group1]
preferredBackends=backend1,backend2
serviceSettings/key1=value1
serviceSettings/key2=value2
[group2]
discoveryMode=LoadOnlySimulationBackends

[group1]
serviceSettings/key1/nested1=value1
serviceSettings/key1/nested2=value2

OVERRIDE=<CONFIGURATIONID>=<VALUE>[;<CONFIGURATIONID>=<VALUE>]

Member Function Documentation

[explicit] QIfConfiguration::QIfConfiguration(const QString &name = QString(), QObject *parent = nullptr)

Constructs a QIfConfiguration instance with a name and a parent

[static] bool QIfConfiguration::arePreferredBackendsSet(const QString &group)

Returns true when the preferred backends have been set in the configuration named group and false otherwise.

A value is considered as "set" when the corresponding setter was called, a valid value was set in the global ini file or the corresponding override is active.

See also Settings file.

[static] bool QIfConfiguration::areServiceSettingsSet(const QString &group)

Returns true when service settings have been set in the configuration named group and false otherwise.

A value is considered as "set" when the corresponding setter was called, a valid value was set in the global ini file or the corresponding override is active.

See also Settings file.

[static, since 6.8] bool QIfConfiguration::asynchronousBackendLoading(const QString &group)

Returns the current value of asynchronousBackendLoading setting of the configuration group.

This function was introduced in Qt 6.8.

See also setAsynchronousBackendLoading().

[static, since 6.8] bool QIfConfiguration::backendUpdatesEnabled(const QString &group)

Returns the current value of backendUpdatesEnabled setting of the configuration group.

This function was introduced in Qt 6.8.

See also setBackendUpdatesEnabled().

[static] QIfAbstractFeature::DiscoveryMode QIfConfiguration::discoveryMode(const QString &group)

Returns the current discovery mode of the configuration group.

See also setDiscoveryMode().

[static] bool QIfConfiguration::exists(const QString &group)

Returns true if the configuration group exists.

A configuration is created once a single value has been set in it.

[static, since 6.8] bool QIfConfiguration::isAsynchronousBackendLoadingSet(const QString &group)

Returns true when the asynchronousBackendLoading setting has been set in the configuration named group and false otherwise.

A value is considered as "set" when the corresponding setter was called, a valid value was set in the global ini file or the corresponding override is active.

This function was introduced in Qt 6.8.

See also Settings file.

[static, since 6.8] bool QIfConfiguration::isBackendUpdatesEnabledSet(const QString &group)

Returns true when the backendUpdatesEnabled setting has been set in the configuration named group and false otherwise.

A value is considered as "set" when the corresponding setter was called, a valid value was set in the global ini file or the corresponding override is active.

This function was introduced in Qt 6.8.

See also Settings file.

[static] bool QIfConfiguration::isDiscoveryModeSet(const QString &group)

Returns true when the discovery mode have been set in the configuration named group and false otherwise.

A value is considered as "set" when the corresponding setter was called, a valid value was set in the global ini file or the corresponding override is active.

See also Settings file.

[static] bool QIfConfiguration::isServiceObjectSet(const QString &group)

Returns true when the service object have been set in the configuration named group and false otherwise.

A value is considered as "set" when the corresponding setter was called, a valid value was set in the global ini file or the corresponding override is active.

See also Settings file.

[static] bool QIfConfiguration::isSimulationDataFileSet(const QString &group)

Returns true when the simulation data file have been set in the configuration named group and false otherwise.

A value is considered as "set" when the corresponding setter was called, a valid value was set in the global ini file or the corresponding override is active.

See also Settings file.

[static] bool QIfConfiguration::isSimulationFileSet(const QString &group)

Returns true when the simulation file have been set in the configuration named group and false otherwise.

A value is considered as "set" when the corresponding setter was called, a valid value was set in the global ini file or the corresponding override is active.

See also Settings file.

[static] QStringList QIfConfiguration::preferredBackends(const QString &group)

Returns the current preferred backends of the configuration group.

See also setPreferredBackends().

[static] QIfServiceObject *QIfConfiguration::serviceObject(const QString &group)

Returns the current service object of the configuration group.

See also setServiceObject().

[static] QVariantMap QIfConfiguration::serviceSettings(const QString &group)

Returns the current service settings of the configuration group.

See also setServiceSettings().

[slot, since 6.8] bool QIfConfiguration::setAsynchronousBackendLoading(bool asynchronousBackendLoading)

Sets the asynchronousBackendLoading setting of this configuration and applies it to all QIfAbstractFeature or QIfAbstractFeatureListModel instances with a matching configurationId.

Returns false if setting the value failed because an override was active, returns true otherwise.

This function was introduced in Qt 6.8.

See also asynchronousBackendLoading() and Environment Overrides.

[static, since 6.8] bool QIfConfiguration::setAsynchronousBackendLoading(const QString &group, bool asynchronousBackendLoading)

Sets the asynchronousBackendLoading setting of the configuration group and applies it to all QIfAbstractFeature or QIfAbstractFeatureListModel instances with a matching configurationId.

Returns false if setting the value failed because an override was active, returns true otherwise.

This function was introduced in Qt 6.8.

See also Environment Overrides.

[slot, since 6.8] bool QIfConfiguration::setBackendUpdatesEnabled(bool backendUpdatesEnabled)

Sets the backendUpdatesEnabled setting of this configuration and applies it to all QIfAbstractFeature or QIfAbstractFeatureListModel instances with a matching configurationId.

Returns false if setting the value failed because an override was active, returns true otherwise.

This function was introduced in Qt 6.8.

See also backendUpdatesEnabled() and Environment Overrides.

[static, since 6.8] bool QIfConfiguration::setBackendUpdatesEnabled(const QString &group, bool backendUpdatesEnabled)

Sets the backendUpdatesEnabled setting of the configuration group and applies it to all QIfAbstractFeature or QIfAbstractFeatureListModel instances with a matching configurationId.

Returns false if setting the value failed because an override was active, returns true otherwise.

This function was introduced in Qt 6.8.

See also Environment Overrides.

[slot] bool QIfConfiguration::setDiscoveryMode(QIfAbstractFeature::DiscoveryMode discoveryMode)

Sets the discoveryMode of this configuration and applies it to all QIfAbstractFeature or QIfAbstractFeatureListModel instances with a matching configurationId.

Returns false if setting the discoveryMode failed because an override was active, returns true otherwise.

See also discoveryMode() and Environment Overrides.

[static] bool QIfConfiguration::setDiscoveryMode(const QString &group, QIfAbstractFeature::DiscoveryMode discoveryMode)

Sets the discoveryMode of the configuration group and applies it to all QIfAbstractFeature or QIfAbstractFeatureListModel instances with a matching configurationId.

Returns false if setting the discoveryMode failed because an override was active, returns true otherwise.

See also Environment Overrides.

[slot] bool QIfConfiguration::setName(const QString &name)

Sets the name of the configuration.

The name is used to find objects with a matching configurationId in order to apply all settings of this configuration to them.

Returns false if setting the name failed e.g. when a instance with this name already exists or when the instance already has a name set. The name of an instance can't be changed once it has been set. Returns true otherwise.

See also name().

[slot] bool QIfConfiguration::setPreferredBackends(const QStringList &preferredBackends)

Sets the preferredBackends of this configuration and applies it to all QIfAbstractFeature or QIfAbstractFeatureListModel instances with a matching configurationId.

Returns false if setting the preferredBackends failed because an override was active, returns true otherwise.

See also preferredBackends() and Environment Overrides.

[static] bool QIfConfiguration::setPreferredBackends(const QString &group, const QStringList &preferredBackends)

Sets the preferredBackends of the configuration group and applies it to all QIfAbstractFeature or QIfAbstractFeatureListModel instances with a matching configurationId.

Returns false if setting the preferredBackends failed because an override was active, returns true otherwise.

See also Environment Overrides.

[slot] bool QIfConfiguration::setServiceObject(QIfServiceObject *serviceObject)

Sets the serviceObject of this configuration and applies it to all QIfAbstractFeature or QIfAbstractFeatureListModel instances with a matching configurationId.

Returns false if setting the serviceObject failed because an override was active, returns true otherwise.

See also serviceObject() and Environment Overrides.

[static] bool QIfConfiguration::setServiceObject(const QString &group, QIfServiceObject *serviceObject)

Sets the serviceObject of the configuration group and applies it to all QIfAbstractFeature or QIfAbstractFeatureListModel instances with a matching configurationId.

Returns false if setting the serviceObject failed because an override was active, returns true otherwise.

See also Environment Overrides.

[slot] bool QIfConfiguration::setServiceSettings(const QVariantMap &serviceSettings)

Sets the serviceSettings of this configuration and applies it to all QIfServiceObject instances with a matching configurationId.

Returns false if setting the serviceSettings failed because an override was active, returns true otherwise.

See also serviceSettings() and Environment Overrides.

[static] bool QIfConfiguration::setServiceSettings(const QString &group, const QVariantMap &serviceSettings)

Sets the serviceSettings of the configuration group and applies it to all QIfServiceObject instances with a matching configurationId.

Returns false if setting the serviceSettings failed because an override was active, returns true otherwise.

See also Environment Overrides.

[slot] bool QIfConfiguration::setSimulationDataFile(const QString &simulationDataFile)

Sets the simulationDataFile of this configuration and applies it to all QIfSimulationEngine instances with a matching configurationId.

Returns false if setting the simulationDataFile failed because an override was active, returns true otherwise.

See also simulationDataFile() and Environment Overrides.

[static] bool QIfConfiguration::setSimulationDataFile(const QString &group, const QString &simulationDataFile)

Sets the simulationDataFile of the configuration group and applies it to all QIfSimulationEngine instances with a matching configurationId.

Returns false if setting the simulationDataFile failed because an override was active, returns true otherwise.

See also Environment Overrides.

[slot] bool QIfConfiguration::setSimulationFile(const QString &simulationFile)

Sets the simulationFile of this configuration and applies it to all QIfSimulationEngine instances with a matching configurationId.

Returns false if setting the simulationFile failed because an override was active, returns true otherwise.

See also simulationFile() and Environment Overrides.

[static] bool QIfConfiguration::setSimulationFile(const QString &group, const QString &simulationFile)

Sets the simulationFile of the configuration group and applies it to all QIfSimulationEngine instances with a matching configurationId.

Returns false if setting the simulationFile failed because an override was active, returns true otherwise.

See also Environment Overrides.

[static] QString QIfConfiguration::simulationDataFile(const QString &group)

Returns the current simulation data file of the configuration group.

See also setSimulationDataFile().

[static] QString QIfConfiguration::simulationFile(const QString &group)

Returns the current simulation file of the configuration group.

See also setSimulationFile().

[slot, since 6.8] bool QIfConfiguration::startAutoDiscovery()

Starts the auto discovery of all QIfAbstractFeature or QIfAbstractFeatureListModel instances of this configuration.

Returns false if starting the auto discovery failed because an override was active, returns true otherwise.

This function was introduced in Qt 6.8.

See also QIfAbstractFeature::startAutoDiscovery and Environment Overrides.

[static, since 6.8] bool QIfConfiguration::startAutoDiscovery(const QString &group)

Starts the auto discovery of all QIfAbstractFeature or QIfAbstractFeatureListModel instances in the configuration group.

Returns false if starting the auto discovery failed because an override was active, returns true otherwise.

This function was introduced in Qt 6.8.

See also QIfAbstractFeature::startAutoDiscovery and Environment Overrides.