WindowControl QML Type

Provides an interface to the window control. More...

Import Statement: import QtInterfaceFramework.VehicleFunctions 1.0
Instantiates: QIfWindowControl
Inherits:

AbstractZonedFeature

Properties

Methods

Detailed Description

The QIfWindowControl provides an interface to control the physical windows of the vehicle.

All properties are exposed through zone objects. The zones are retrieved using the zoneAt method.

The QIfWindowControl expects a single backend to be available. It is recommended to use it with discoveryMode set to zoneAt.

Property Documentation

blindMode : QtIfVehicleFunctions::BlindMode

Holds the current mode of the window blind.

Available values are:

ConstantDescription
BlindOpenThe blind will be opened.
BlindClosedThe blind will be closed.
AutoBlindThe blind is opened or closed automatically.

blindState : QtIfVehicleFunctions::WindowState

Holds the current state of the window blind.

Available values are:

ConstantDescription
FullyOpenThe object is fully open.
OpenThe object is open, but not fully open yet.
ClosedThe object is closed.

discoveryMode : enumeration

Holds the mode that is used for the autoDiscovery

Available values are:

ConstantDescription
NoAutoDiscoveryNo auto discovery is done and the ServiceObject needs to be set manually.
AutoDiscoveryTries to find a production backend with a matching interface and falls back to a simulation backend if not found.
LoadOnlyProductionBackendsOnly tries to load a production backend with a matching interface.
LoadOnlySimulationBackendsOnly tries to load a simulation backend with a matching interface.

If necessary, auto discovery is started once the feature creation is completed.

Note: If you change this property after the feature is instantiated, make sure to call startAutoDiscovery() to search for a new service object.


discoveryResult : enumeration

The result of the last autoDiscovery

Available values are:

ConstantDescription
NoResultIndicates that no auto discovery was started because the feature has already assigned a valid ServiceObject.
ErrorWhileLoadingAn error has happened while searching for a backend with a matching interface.
ProductionBackendLoadedA production backend was loaded, as a result of auto discovery.
SimulationBackendLoadedA simulation backend was loaded, as a result of auto discovery.s

heater : bool

Indicates whether the window heater is currently running.


heaterMode : QtIfVehicleFunctions::HeaterMode

Holds the current mode of the window heater.

Available values are:

ConstantDescription
HeaterOnThe window heater is turned on.
HeaterOffThe window heater is turned off.
AutoHeaterThe window heater is turning off and on automatically.

isInitialized : bool

Indicates whether the feature has been initialized with all the values from the backend.

The property is true once the backend sends the QIfFeatureInterface::initializationDone signal to indicate that all values have now been initialized with values from the backend.

See also isValid and QIfFeatureInterface::initializationDone.


isValid : bool

Indicates whether the feature is ready for use.

The property is true if the feature is ready to be used, otherwise false. Not being ready usually indicates that no suitable service object could be found, or that automatic discovery has not been triggered.

The backend still might not have sent all properties yet and is not fully initialized. Use isInitialized instead to know when the feature holds all correct values.

See also QIfServiceObject, discoveryMode, and isInitialized.


serviceObject : ServiceObject

Sets the service object for the feature.

As Features only expose the front API facing the developer, a service object implementing the actual function is required. This is usually retrieved through the auto discovery mechanism.

The setter for this property returns false if the QIfServiceObject is already set to this particular instance or the QIfServiceObject isn't accepted by the feature.

See also discoveryMode.


state : QtIfVehicleFunctions::WindowState

Holds the current state of the window.

Available values are:

ConstantDescription
FullyOpenThe object is fully open.
OpenThe object is open, but not fully open yet.
ClosedThe object is closed.

Method Documentation

close()

Closes the window, if not already in the QIfWindowControl::Closed state.


open()

Opens the window, if not already in the QIfWindowControl::FullyOpen state.


enumeration startAutoDiscovery()

Performs an automatic discovery attempt.

The feature tries to locate a single ServiceObject that implements the required interface.

If no ServiceObject is found, the feature remains invalid. If more than one ServiceObject is found, the first instance is used.

This function returns either the type of the backend that was loaded; or an error.

If the discoveryMode is set to QIfAbstractFeature::NoAutoDiscovery, this function does nothing and returns QIfAbstractFeature::NoResult.

Return values are:

ConstantDescription
NoResultIndicates that no auto discovery was started because the feature already has a valid ServiceObject assigned.
ErrorWhileLoadingIndicates an error has occurred while searching for a backend with a matching interface.
ProductionBackendLoadedA production backend was loaded, as a result of auto discovery.
SimulationBackendLoadedA simulation backend was loaded, as a result of auto discovery.

See also Dynamic Backend System and QIfServiceManager.


© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.