QIviAbstractFeatureListModel Class
The QIviAbstractFeatureListModel is the base class for QtIvi Features which should act as a model. More...
| Header: | #include <QIviAbstractFeatureListModel> |
| qmake: | QT += ivicore |
| Instantiated By: | AbstractFeatureListModel |
| Inherits: | QAbstractListModel and QQmlParserStatus |
| Inherited By: |
Properties
|
|
Public Functions
| QIviAbstractFeatureListModel(const QString &interfaceName, QObject *parent = nullptr) | |
| QIviAbstractFeature::DiscoveryMode | discoveryMode() const |
| QIviAbstractFeature::DiscoveryResult | discoveryResult() const |
| QIviAbstractFeature::Error | error() const |
| QString | errorMessage() const |
| bool | isInitialized() const |
| bool | isValid() const |
| QIviServiceObject * | serviceObject() const |
Public Slots
| void | setDiscoveryMode(QIviAbstractFeature::DiscoveryMode discoveryMode) |
| bool | setServiceObject(QIviServiceObject *so) |
| QIviAbstractFeature::DiscoveryResult | startAutoDiscovery() |
Signals
| void | discoveryModeChanged(QIviAbstractFeature::DiscoveryMode discoveryMode) |
| void | discoveryResultChanged(QIviAbstractFeature::DiscoveryResult discoveryResult) |
| void | errorChanged(QIviAbstractFeature::Error error, const QString &message) |
| void | isInitializedChanged(bool isInitialized) |
| void | isValidChanged(bool arg) |
| void | serviceObjectChanged() |
Protected Functions
| virtual bool | acceptServiceObject(QIviServiceObject *serviceObject) |
| virtual void | clearServiceObject() = 0 |
| virtual void | connectToServiceObject(QIviServiceObject *serviceObject) |
| virtual void | disconnectFromServiceObject(QIviServiceObject *serviceObject) |
| QString | errorText() const |
| QString | interfaceName() const |
| void | setError(QIviAbstractFeature::Error error, const QString &message = QString()) |
Protected Slots
| virtual void | onErrorChanged(QIviAbstractFeature::Error error, const QString &message = QString()) |
Detailed Description
This base class is necessary to avoid virtual inheritance from QAbstractListModel and QIviAbstractFeature.
For more details on how a Feature works, see QIviAbstractFeature. For more information about models in QtIvi, see Models.
Subclassing
Your QIviAbstractFeatureListModel subclass must provide implementations for all virtual functions from QIviAbstractFeature as well as the virtual functions from QAbstractListModel.
- For more details on how to integrate with the Dynamic Backend System, see QIviAbstractFeature.
- For more details on what you need to do to provide the model's required functionality, see QAbstractListModel - Subclassing.
- For a class that implements all the necessary QIviAbstractFeatureListModel functions to provide pagination functionality, see QIviPagingModel.
Property Documentation
discoveryMode : QIviAbstractFeature::DiscoveryMode
Holds the mode that is used for the autoDiscovery
Note: If you change this property after the Feature is instantiated you need to call startAutoDiscovery() to search for a new Service Object
Access functions:
| QIviAbstractFeature::DiscoveryMode | discoveryMode() const |
| void | setDiscoveryMode(QIviAbstractFeature::DiscoveryMode discoveryMode) |
Notifier signal:
| void | discoveryModeChanged(QIviAbstractFeature::DiscoveryMode discoveryMode) |
discoveryResult : const QIviAbstractFeature::DiscoveryResult
This property holds the result of the last autoDiscovery attempt
Access functions:
| QIviAbstractFeature::DiscoveryResult | discoveryResult() const |
Notifier signal:
| void | discoveryResultChanged(QIviAbstractFeature::DiscoveryResult discoveryResult) |
See also startAutoDiscovery().
error : const QString
Last error message of the feature. Empty if no error.
Access functions:
| QString | errorMessage() const |
Notifier signal:
| void | errorChanged(QIviAbstractFeature::Error error, const QString &message) |
isInitialized : const bool
Indicates whether the feature has been initialized with all the values from the backend.
The property is true once the backend sends the QIviFeatureInterface::initializationDone signal to indicate that all values have now been initialized with values from the backend.
Access functions:
| bool | isInitialized() const |
Notifier signal:
| void | isInitializedChanged(bool isInitialized) |
See also isValid and QIviFeatureInterface::initializationDone.
isValid : const bool
Indicates whether the feature is ready to 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.
Access functions:
| bool | isValid() const |
Notifier signal:
| void | isValidChanged(bool arg) |
See also QIviServiceObject, discoveryMode, and isInitialized.
serviceObject : QIviServiceObject*
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 Service Object is already set to exactly this instance or the Service Object doesn't get accepted by the feature.
Access functions:
| QIviServiceObject * | serviceObject() const |
| bool | setServiceObject(QIviServiceObject *so) |
Notifier signal:
| void | serviceObjectChanged() |
See also discoveryMode.
Member Function Documentation
QIviAbstractFeatureListModel::QIviAbstractFeatureListModel(const QString &interfaceName, QObject *parent = nullptr)
Constructs a QIviAbstractFeatureListModel.
The parent argument is passed on to the QAbstractListModel base class.
The interfaceName argument is used to locate suitable service objects.
[virtual protected slot] void QIviAbstractFeatureListModel::onErrorChanged(QIviAbstractFeature::Error error, const QString &message = QString())
Updates error and message from the backend.
This slot can be used when implementing a new Feature to report generic errors.
[slot] QIviAbstractFeature::DiscoveryResult QIviAbstractFeatureListModel::startAutoDiscovery()
Performs an automatic discovery attempt.
[virtual protected] bool QIviAbstractFeatureListModel::acceptServiceObject(QIviServiceObject *serviceObject)
This method is expected to be implemented by any class subclassing QIviAbstractFeature.
The method should return true if the given serviceObject is accepted and can be used, otherwise false.
If the object is accepted, connectToServiceObject is called to actually connect to the service object.
The default implementation accepts the serviceObject if it implements the interface returned by interfaceName();
See also connectToServiceObject(), disconnectFromServiceObject(), and clearServiceObject().
[pure virtual protected] void QIviAbstractFeatureListModel::clearServiceObject()
This method is expected to be implemented by any class subclassing QIviAbstractFeatureListModel.
Called when no service object is available. The implementation is expected to set all properties to safe defaults and forget all links to the previous service object.
Note: You must emit the corresponding change signals for these properties, so that the feature is informed about the state change. This makes it possible for the implemented class to connect to a new service object afterwards.
There is no need to disconnect from the service object. If it still exists, it is guaranteed that disconnectFromServiceObject is called first.
See also acceptServiceObject(), connectToServiceObject(), and disconnectFromServiceObject().
[virtual protected] void QIviAbstractFeatureListModel::connectToServiceObject(QIviServiceObject *serviceObject)
This method is expected to be implemented by any class subclassing QIviAbstractFeature.
The implementation should connect to the serviceObject, and set up all properties to reflect the state of the service object.
There is no previous service object connected, as this function call is always preceded by a call to disconnectFromServiceObject or clearServiceObject.
It is safe to assume that the serviceObject, has always been accepted through the acceptServiceObject method prior to being passed to this method.
The default implementation connects to the signals offered by QIviFeatureInterface and calls QIviFeatureInterface::initialize() afterwards.
When reimplementing please keep in mind to connect all signals before calling this function. e.g.
/code void SimpleFeature::connectToServiceObject(QIviServiceObject *serviceObject) { SimpleFeatureBackendInterface *backend = backend(serviceObject); if (!backend) return;
// connect your signals connect(backend, &SimpleFeatureBackendInterface::propertyChanged, this, &SimpleFeature::onPropertyChanged);
// connects the base signals and call initialize() QIviAbstractFeature::connectToServiceObject(serviceObject);
// Additional initialization functions can be added here } /endcode
See also acceptServiceObject(), disconnectFromServiceObject(), and clearServiceObject().
[virtual protected] void QIviAbstractFeatureListModel::disconnectFromServiceObject(QIviServiceObject *serviceObject)
This method is expected to be implemented by any class subclassing QIviAbstractFeature.
The implementation should disconnect all connections to the serviceObject.
There is no need to reset internal variables to safe defaults. A call to this function is always followed by a call to connectToServiceObject or clearServiceObject.
The default implementation disconnects all signals from the serviceObject to this instance.
See also acceptServiceObject(), connectToServiceObject(), and clearServiceObject().
QIviAbstractFeature::Error QIviAbstractFeatureListModel::error() const
Returns the last error code.
See also setError() and QIviAbstractFeature::Error.
[protected] QString QIviAbstractFeatureListModel::errorText() const
Returns the current error code converted from QIviAbstractFeature::Error to QString
See also error.
[protected] QString QIviAbstractFeatureListModel::interfaceName() const
Returns the interface name this Feature expect to be available from the Service Object and this Feature is implementing.
See Extending Qt IVI for more information.
[protected] void QIviAbstractFeatureListModel::setError(QIviAbstractFeature::Error error, const QString &message = QString())
Sets error with the message.
Emits errorChanged() signal.
See also error() and QIviAbstractFeature::Error.
© 2020 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.