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

Public Member Functions

BrowserFilterItem getWildcardItem ()
 
BrowserFilterItem createCursorItem ()
 
BrowserFilterItemBank createItemBank (int size)
 
StringValue name ()
 
void addNameObserver (int maxCharacters, String textWhenUnassigned, StringValueChangedCallback callback)
 
- Public Member Functions inherited from BrowserColumn
void addExistsObserver (BooleanValueChangedCallback callback)
 
IntegerValue entryCount ()
 
void addEntryCountObserver (IntegerValueChangedCallback callback)
 
- 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 filter column in the Bitwig Studio browser.

Since
API version 1

Member Function Documentation

◆ addNameObserver()

void addNameObserver ( int  maxCharacters,
String  textWhenUnassigned,
StringValueChangedCallback  callback 
)

Registers an observer that reports the name of the filter column.

Parameters
callbacka callback function that receives a single string argument.
Since
API version 1
Deprecated:
Use name() instead.

◆ createCursorItem()

BrowserFilterItem createCursorItem ( )

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

Returns
the requested filter item object
Since
API version 1

Implements BrowserColumn.

◆ createItemBank()

BrowserFilterItemBank 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

Implements BrowserColumn.

◆ getWildcardItem()

BrowserFilterItem getWildcardItem ( )

Returns the filter item that represents the top-level all/any/everything wildcard item.

Returns
the requested filter item object
Since
API version 1

◆ name()

StringValue name ( )

Value that reports the name of the filter column.

Since
API version2

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