diff options
Diffstat (limited to 'src/interfaceframework/qifserviceobject.cpp')
| -rw-r--r-- | src/interfaceframework/qifserviceobject.cpp | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/src/interfaceframework/qifserviceobject.cpp b/src/interfaceframework/qifserviceobject.cpp index 8898520d..576c09e9 100644 --- a/src/interfaceframework/qifserviceobject.cpp +++ b/src/interfaceframework/qifserviceobject.cpp @@ -22,7 +22,18 @@ QT_BEGIN_NAMESPACE \sa QIfAbstractFeature */ +/*! + \qmltype ServiceObject + \instantiates QIfServiceObject + \inqmlmodule QtInterfaceFramework + + \brief Provides the connection point to a Backend Service. + ServiceObject provides you with a list of interfaces that the Backend implements. + + From QML the object is mainly used to assign it manually to a AbstractFeature derived object or + to update the service settings. +*/ /*! Constructor. @@ -36,6 +47,12 @@ QIfServiceObject::QIfServiceObject(QObject *parent) } /*! + \qmlproperty string ServiceObject::id + \brief A unique ID for the service object instance. + + Holds the unique ID of the service object +*/ +/*! \property QIfServiceObject::id \brief A unique ID for the service object instance. @@ -44,6 +61,33 @@ QIfServiceObject::QIfServiceObject(QObject *parent) */ /*! + \qmlproperty string ServiceObject::configurationId + \brief Holds the id to determine which configuration this service object belongs to. + \since 6.5 + + Once the id has been set, it is possible to change certain values using the + \l InterfaceFrameworkConfiguration API. + + \note Values set in the matching \l InterfaceFrameworkConfiguration can override the initial + values set during the component creation. + + \sa InterfaceFrameworkConfiguration +*/ +/*! + \property QIfServiceObject::configurationId + \brief Holds the id to determine which configuration this service object belongs to. + \since 6.5 + + Once the id has been set, it is possible to change certain values using the + \l QIfConfiguration API. + + \note Values set in the matching \l QIfConfiguration can override the initial values + set during the component creation. + + \sa QIfConfiguration +*/ + +/*! The id() function can be overloaded to modify how the unique ID is generated, for use by this service object. @@ -58,6 +102,24 @@ QString QIfServiceObject::id() const return m_id; } +/*! + \qmlproperty variant ServiceObject::serviceSettings + \brief The settings for the service object instance. + \since 6.5 + + The serviceSettings property contains a map of settings for the service object instance. + + \sa {Backend specific configuration option} +*/ +/*! + \property QIfServiceObject::serviceSettings + \brief The settings for the service object instance. + \since 6.5 + + The serviceSettings property contains a map of settings for the service object instance. + + \sa {Backend specific configuration option} +*/ const QVariantMap &QIfServiceObject::serviceSettings() const { return m_serviceSettings; |
