Bitwig Studio Control Surface API  5.0.11
EnumValueDefinition Interface Reference

Public Member Functions

EnumDefinition enumDefinition ()
 
int getValueIndex ()
 
String getId ()
 
String getDisplayName ()
 
String getLimitedDisplayName (int maxLength)
 

Detailed Description

Defines a single value from an enum.

Since
API version 11

Member Function Documentation

◆ enumDefinition()

EnumDefinition enumDefinition ( )

Gets the enum definition to which belongs this value.

Since
API version 11

◆ getDisplayName()

String getDisplayName ( )

This is a string that is suitable for display.

Since
API version 11

◆ getId()

String getId ( )

Identifier for this enum value. It will never change. This is the value to pass to SettableEnumValue#set(String).

Since
API version 11

◆ getLimitedDisplayName()

String getLimitedDisplayName ( int  maxLength)

This is a shorter version of getDisplayName().

Parameters
maxLengthMaximum number of characters
Since
API version 11

◆ getValueIndex()

int getValueIndex ( )

Index of this value in the enum definition.

Since
API version 11

The documentation for this interface was generated from the following file: