/
parameter.h
100 lines (80 loc) · 3.34 KB
/
parameter.h
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
///////////////////////////////////////////////////////////////////////////////
// //
// This file is part of QtJack. //
// Copyright (C) 2014-2015 Jacob Dawid <jacob@omg-it.works> //
// //
// QtJack is free software: you can redistribute it and/or modify //
// it under the terms of the GNU General Public License as published by //
// the Free Software Foundation, either version 3 of the License, or //
// (at your option) any later version. //
// //
// QtJack is distributed in the hope that it will be useful, //
// but WITHOUT ANY WARRANTY; without even the implied warranty of //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
// GNU General Public License for more details. //
// //
// You should have received a copy of the GNU General Public License //
// along with QtJack. If not, see <http://www.gnu.org/licenses/>. //
// //
// It is possible to obtain a closed-source license of QtJack. //
// If you're interested, contact me at: jacob@omg-it.works //
// //
///////////////////////////////////////////////////////////////////////////////
#pragma once
// JACK includes
typedef struct jackctl_parameter jackctl_parameter_t;
// Qt includes
#include <QString>
#include <QMap>
#include <QVariant>
// Own includes
#include "global.h"
namespace QtJack {
class Parameter {
// Only those should be able to create valid parameter objects.
friend class Server;
friend class Driver;
public:
// We need this for compatibility with QMap.
Parameter() {
_jackParameter = 0;
}
/** A parameter type. */
enum ParameterType {
ParameterTypeInt,
ParameterTypeUInt,
ParameterTypeChar,
ParameterTypeString,
ParameterTypeBool
};
/** A parameter range. */
struct ParameterValueRange {
QVariant minimum;
QVariant maximum;
};
bool isValid() const { return _jackParameter != 0; }
QString name();
QString shortDescription();
QString longDescription();
char id();
ParameterType type();
/** @returns true, if this parameters has been set, false otherwise. */
bool isSet();
bool reset();
QVariant value();
bool setValue(QVariant value);
QVariant defaultValue();
bool hasRangeConstraint();
ParameterValueRange rangeConstraint();
bool constraintIsStrict();
bool constraintIsFakeValue();
bool hasEnumerationConstraint();
int enumerationConstraintsCount();
QVariant enumerationConstraintValue(int index);
QString enumerationConstraintDescription(int index);
private:
Parameter(jackctl_parameter_t *parameter);
jackctl_parameter_t *_jackParameter;
};
typedef QMap<QString, Parameter> ParameterMap;
} // namespace QtJack