aboutsummaryrefslogtreecommitdiffstats
path: root/src/ivicore/qivipropertyattribute.cpp
blob: 0e16ed054b9e8d33c60bd31e4a95da2a1c77aba1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/****************************************************************************
**
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtIvi module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite licenses may use
** this file in accordance with the commercial license agreement provided
** with the Software or, alternatively, in accordance with the terms
** contained in a written agreement between you and The Qt Company.  For
** licensing terms and conditions see https://www.qt.io/terms-conditions.
** For further information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: LGPL-3.0
**
****************************************************************************/

#include "qivipropertyattribute.h"

QT_BEGIN_NAMESPACE

QIviPropertyAttributeBase::QIviPropertyAttributeBase()
{
    registerTypes();
}

void QIviPropertyAttributeBase::registerTypes()
{
    qRegisterMetaType<QIviPropertyAttribute<int>>();
    qRegisterMetaType<QIviPropertyAttribute<bool>>();
    qRegisterMetaType<QIviPropertyAttribute<double>>();
#if defined(QT_COORD_TYPE)
    qRegisterMetaType<QIviPropertyAttribute<qreal>>();
#endif
    qRegisterMetaType<QIviPropertyAttribute<QString>>();
}


/*!
    \class QIviPropertyAttribute
    \obsolete
    \inmodule QtIviCore
    \brief The QIviPropertyAttribute encapsulates the attributes of a property

    QIviPropertyAttribute sets the boundaries for a property in Qt IVI. In a
    Qt IVI backend interface, the QIviPropertyAttributes are used to control
    which properties are implemented by a backend and to set the boundaries like
    the minimum or the maximum value of a property.

    By default a QIviPropertyAttribute is initialized with the "Invalid" type,
    which indicates that this property is not available. This could be the case
    when the backend doesn't support this property or the property is not available
    because the current backend configuration does not support it.
    For example, a property can be supported by a specific car configuration,
    but is not part of another.
*/

/*!
    \enum QIviPropertyAttributeBase::AttributeType

    \value Invalid
          The attribute is invalid and is not available.
    \value NoAttributes
          No additional attributes for the property are provided.
    \value MinimumMaximum
          The attribute defines the minimum and the maximum value of the property.
    \value AvailableValues
          The attribute defines a list of values that are available for the property.
*/

/*!
    \fn QIviPropertyAttribute::QIviPropertyAttribute()
    Constructs an invalid QIviPropertyAttribute.

    This constructor can be used to indicate that the property is not available.
    For example, because the backend doesn't support this property.
*/

/*!
    \fn QIviPropertyAttribute::QIviPropertyAttribute(bool available)
    Constructs an QIviPropertyAttribute of type NoAttributes.

    The argument \a available defines whether the property is supported by the backend.
*/

/*!
    \fn QIviPropertyAttribute::QIviPropertyAttribute(const T &minValue, const T &maxValue)
    Constructs an QIviPropertyAttribute of type MinimumMaximum.

    The arguments \a minValue and \a maxValue define the boundaries the value of the property.
*/

/*!
    \fn QIviPropertyAttribute::QIviPropertyAttribute(const QVector<T> &avValues)
    Constructs an QIviPropertyAttribute of type AvailableValues.

    The argument \a avValues defines the valid values for the property.
*/

/*!
    \fn AttributeType QIviPropertyAttribute::type() const

    Returns the type of the attribute.
*/

/*!
    \fn bool QIviPropertyAttribute::isAvailable() const

    Returns true if the property is available for this backend.
*/

/*!
    \fn T QIviPropertyAttribute::minimumValue() const

    Returns the minimum value of the property.
    If the attributeType is not MinimumMaximum, a default constructed value is returned.
*/

/*!
    \fn T QIviPropertyAttribute::maximumValue() const

    Returns the maximum value of the property.
    If the attributeType is not MinimumMaximum, a default constructed value is returned.
*/

/*!
    \fn QList<T> QIviPropertyAttribute::availableValues() const

    Returns a list of valid values for this property.
    If the attributeType is not AvailableValues an empty list is returned.
*/

/*!
    \fn QString QIviPropertyAttribute::toString() const

    Returns a QString with a string representation of the attribute.
*/

/*!
    \fn bool QIviPropertyAttribute::operator==(const QIviPropertyAttribute& other) const

    Returns \c true if this QIviPropertyAttribute is equal to the \a other QIviPropertyAttribute; otherwise returns \c false.

    All elements of QIviPropertyAttribute are used for the comparison.
*/

/*!
    \fn bool QIviPropertyAttribute::operator!=(const QIviPropertyAttribute& other) const

    Returns \c true if this QIviPropertyAttribute is NOT equal to the \a other QIviPropertyAttribute; otherwise returns \c false.

    All elements of QIviPropertyAttribute are used for the comparison.
*/

QT_END_NAMESPACE