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

Public Member Functions

void addExistsObserver (BooleanValueChangedCallback callback)
 
IntegerValue entryCount ()
 
void addEntryCountObserver (IntegerValueChangedCallback callback)
 
BrowserItem createCursorItem ()
 
BrowserItemBank createItemBank (int size)
 
- Public Member Functions inherited from ObjectProxy
BooleanValue exists ()
 
BooleanValue createEqualsValue (ObjectProxy other)
 
- Public Member Functions inherited from Subscribable
boolean isSubscribed ()
 
void setIsSubscribed (boolean value)
 
void subscribe ()
 
void unsubscribe ()
 

Detailed Description

Instances of this interface are used to navigate a column in the Bitwig Studio browser.

Since
API version 1

Member Function Documentation

◆ addEntryCountObserver()

void addEntryCountObserver ( IntegerValueChangedCallback  callback)

Registers an observer that reports the underlying total count of column entries (not the size of the column window).

Parameters
callbacka callback function that receives a single integer parameter
Since
API version 1
Deprecated:
Use entryCount().addValueObserver(callback)

◆ addExistsObserver()

void addExistsObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the column exists.

Parameters
callbacka callback function that receives a single boolean parameter
Since
API version 1
Deprecated:
Use exists() instead.

◆ createCursorItem()

BrowserItem createCursorItem ( )

Returns the cursor item, which can be used to navigate over the list of entries.

Returns
the requested filter item object
Since
API version 1

Implemented in BrowserFilterColumn, and BrowserResultsColumn.

◆ createItemBank()

BrowserItemBank createItemBank ( int  size)

Returns an object that provides access to a bank of successive entries using a window configured with the given size, that can be scrolled over the list of entries.

Parameters
sizethe number of simultaneously accessible items
Returns
the requested item bank object

Implemented in BrowserFilterColumn, and BrowserResultsColumn.

◆ entryCount()

IntegerValue entryCount ( )

Value that reports the underlying total count of column entries (not the size of the column window).

Since
API version 2

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