 |
KUIML
Blue Cat's User Interface Programming Language
|
|
|
KUIML
Blue Cat's User Interface Programming Language
|
|
This element can be used to create custom parameters (literals).
See Attributes Common to All Elements.
| Name | Value Type | Default Value | Description | Comment | V. | Exp. |
|---|---|---|---|---|---|---|
|
name |
Empty. |
Displayed named of the parameter. |
|
1.1 |
1.9.2 | |
|
comment |
Empty. |
Comment about the parameter. |
|
1.1 |
No | |
|
unit |
Empty. |
Unit of the parameter |
|
1.1 |
1.9.2 | |
|
type |
'real' |
Type of the declared parameter |
|
1.1 |
No | |
|
min |
0 |
Parameter minimum value. |
|
1.1 |
1.6.2 | |
|
max |
0 |
Parameter maximum value. |
|
1.1 |
1.6.2 | |
|
default |
0 |
Parameter default value. |
|
1.1 |
1.6.2 | |
|
persistent |
false |
Sets the persistency of the parameter. |
When this property is set to 'true', the parameter will be saved when closing the user interface and the value will be restored next time the user interface is opened. |
1.3 |
No | |
|
enum_values |
list of strings separated by ';' |
Empty |
List of text values for an enumeration. When set, this automatically sets the range from 0 to the number of values in the list minus 1. |
Starting with v1.6.2, the start value for the enumeration is not necessarily 0, but the min value specified with the parameter if any. |
1.4.3 |
1.4.3 |
|
value_format |
' .2' |
Custom formatting used by default to display the parameter as text. |
See the {text_value} field in parameter text widgets. |
1.9.1 |
No | |
| Read Only Attributes | ||||||
|
capturing |
false |
true if user is changing the value. |
1.9.2 | |||
|
text_value |
string |
|
The value of the parameter as text. |
2.7.1 | ||
| Events | ||||||
|
value_changed |
the event is triggered anytime the value of the object has changed. |
2.0 | ||||
| Actions | ||||||
|
BeginCapture |
action |
Begin value edition (call when starting to modify the value from scripts, especially for parameters that are exposed to automation). |
Changes the value of the capturing attribute. |
2.4 | ||
|
EndCapture |
action |
End value edition (call when done with modifying the value from scripts, especially for parameters that are exposed to automation). |
Changes the value of the capturing attribute. |
2.4 | ||
The following example creates a single parameter used to manage the gain of the plug-in:
<?xml version="1.0" encoding="utf-8" ?> <SKIN language_version="1.1"> <PARAM name="gain" default="0" max="20" min="-20" unit="dB" comment="gain of the plug-in" /> </SKIN>