Bitwig Studio Control Surface API  5.0.11
Cursor Interface Reference
+ Inheritance diagram for Cursor:

Public Member Functions

void selectPrevious ()
 
HardwareActionBindable selectPreviousAction ()
 
void selectNext ()
 
HardwareActionBindable selectNextAction ()
 
void selectFirst ()
 
void selectLast ()
 
BooleanValue hasNext ()
 
BooleanValue hasPrevious ()
 
void addCanSelectPreviousObserver (BooleanValueChangedCallback callback)
 
void addCanSelectNextObserver (BooleanValueChangedCallback callback)
 
- Public Member Functions inherited from RelativeHardwarControlBindable
default RelativeHardwareControlBinding addBinding (RelativeHardwareControl hardwareControl)
 
RelativeHardwareControlBinding addBindingWithSensitivity (RelativeHardwareControl hardwareControl, double sensitivity)
 

Detailed Description

A generic interface that provides the foundation for working with selections.

Implementations of this interface can either represent custom selection cursors that are created by controller scripts, or represent the cursor of user selections as shown in Bitwig Studio editors, such as the Arranger track selection cursor, the note editor event selection cursor and so on.

Since
API version 1

Member Function Documentation

◆ addCanSelectNextObserver()

void addCanSelectNextObserver ( BooleanValueChangedCallback  callback)

Registers a function with bool argument that gets called when the next item gains or remains selectable.

Since
API version 1
Deprecated:
Use hasNext() instead.

◆ addCanSelectPreviousObserver()

void addCanSelectPreviousObserver ( BooleanValueChangedCallback  callback)

Registers a function with bool argument that gets called when the previous item gains or remains selectable.

Since
API version 1
Deprecated:
Use hasPrevious() instead.

◆ hasNext()

BooleanValue hasNext ( )

Boolean value that reports whether there is an item after the current cursor position.

Since
API version 2

◆ hasPrevious()

BooleanValue hasPrevious ( )

Boolean value that reports whether there is an item before the current cursor position.

Since
API version 2

◆ selectFirst()

void selectFirst ( )

Select the first item.

Since
API version 1

◆ selectLast()

void selectLast ( )

Select the last item.

Since
API version 1

◆ selectNext()

void selectNext ( )

Select the next item.

Since
API version 1

◆ selectPrevious()

void selectPrevious ( )

Select the previous item.

Since
API version 1

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