Usine SDK
HH6
Create user modules for Usine Software
|
Usine parameter description. Contain all the properties to define a parameter. More...
Public Attributes | |
TParamType | ParamType |
parameter type | |
AnsiCharPtr | Caption |
displayed caption | |
LongBool | IsInput |
TRUE if the parameter has input port. | |
LongBool | IsOutput |
TRUE if the parameter has output port. | |
TScale | Scale |
scale, if the param is a fader | |
TUsineColor | Color |
front color of the fader or on Color of the switch | |
TUsineColor | OffColor |
off color only if the parameter is a switch | |
TPrecision | MinValue |
min param value | |
TPrecision | MaxValue |
max param value | |
TPrecision | DefaultValue |
default param value, when created | |
AnsiCharPtr | Symbol |
displayed symbol | |
AnsiCharPtr | Format |
format string of the displayed value | |
AnsiCharPtr | ListBoxStrings |
if listbox looks like '"item1","item2"' | |
AnsiCharPtr | TextValue |
default text value if param type = ptTextField | |
LongBool | ReadOnly |
TRUE if the user cant modify value. | |
TFastCallBackType | CallBackType |
see TFastCallBackType definition | |
LongBool | DontSave |
specifies if the parameter need to be save or not | |
int | DisplayOrder |
Deprecated Parameters are now ordered according to their param index choosen in onGetParamInfo | |
LongBool | IsSeparator |
optional, determines if the parameter add a blank line above him in the list | |
LongBool | IsInvisible |
set the parameter totally invisible | |
LongBool | IsStoredInPreset |
set the param stored in the preset (default false) | |
AnsiCharPtr | SavedName |
optional: ident used to save the value in inifiles. if NULL Caption is used | |
AnsiCharPtr | SeparatorCaption |
optional, if isSeparator, show a section name | |
NativeInt | CallBackId |
the id of the param for the callback, setEvent and param (choose a value up to 0x00000FFE) | |
LongBool | IsVisibleByDefault |
TRUE by default. | |
LongBool | NotUsed |
Not used anymore. | |
LongBool | Translate |
usine auto translate | |
UsineEventPtr * | EventPtr |
Pointer to Event set by Usine to acces to the value of the parameter, introduced < in HH3. Replace the deprecated SetEventAddress. | |
AnsiCharPtr | FileNameFilter |
optional: filter used to open file when ParamType = ptFileName < ie: "All files (*.*)|*.*" or "'All Images |*.png; *.jpg; *.jpeg; *.bmp; *.tiff; *.gif" | |
Usine parameter description. Contain all the properties to define a parameter.