Bitwig Studio Control Surface API
5.0.11
|
Public Member Functions | |
int | getSize () |
BrowserItem | getItem (int index) |
void | scrollUp () |
void | scrollDown () |
void | scrollPageUp () |
void | scrollPageDown () |
void | addScrollPositionObserver (IntegerValueChangedCallback callback) |
void | addCanScrollUpObserver (BooleanValueChangedCallback callback) |
void | addCanScrollDownObserver (BooleanValueChangedCallback callback) |
![]() | |
int | getSizeOfBank () |
int | getCapacityOfBank () |
void | setSizeOfBank (int size) |
default void | scrollPageForwards () |
default void | scrollPageBackwards () |
ItemType | getItemAt (int index) |
IntegerValue | itemCount () |
SettableIntegerValue | cursorIndex () |
void | setSkipDisabledItems (boolean shouldSkip) |
Instances of this interface are used to navigate a column in the Bitwig Studio browser.
void addCanScrollDownObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the column entries can be scrolled further down.
callback | a callback function that receives a single boolean parameter |
void addCanScrollUpObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the column entries can be scrolled further up.
callback | a callback function that receives a single boolean parameter |
void addScrollPositionObserver | ( | IntegerValueChangedCallback | callback | ) |
Registers an observer that reports the current scroll position, more specifically the position of the first item within the underlying list of entries, that is shown as the first entry within the window.
callback | a callback function that receives a single integer number parameter. The parameter reflects the scroll position, or -1 in case the column has no content. |
BrowserItem getItem | ( | int | index | ) |
Returns the item for the given index.
index | the item index, must be in the range [0..getSize-1] |
int getSize | ( | ) |
Returns the window size that was used to configure the filter column during creation.
void scrollDown | ( | ) |
Scrolls the filter column entries one item down.
void scrollPageDown | ( | ) |
Scrolls the filter column entries one page up. For example if the column is configured with a window size of 8 entries and is currently showing items [9..16], calling this method would scroll the column to show items [1..8].
void scrollPageUp | ( | ) |
Scrolls the filter column entries one page up. For example if the column is configured with a window size of 8 entries and is currently showing items [1..8], calling this method would scroll the column to show items [9..16].
void scrollUp | ( | ) |
Scrolls the filter column entries one item up.