Package com.bitwig.extension.controller.api

Interface Cursor

All Superinterfaces:
HardwareBindable, RelativeHardwarControlBindable
All Known Subinterfaces:
ChainSelector, CursorBrowserFilterColumn, CursorBrowserFilterItem, CursorBrowserItem, CursorBrowserResultItem, CursorBrowsingSession, CursorChannel, CursorClip, CursorDevice, CursorDeviceLayer, CursorRemoteControlsPage, CursorTrack, PinnableCursor, PinnableCursorClip, PinnableCursorDevice
public interface Cursor extends RelativeHardwarControlBindable
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

  • Method Details

    • selectPrevious

      void selectPrevious()
      Select the previous item.
      Since:
      API version 1

    • selectPreviousAction

      HardwareActionBindable selectPreviousAction()

    • selectNext

      void selectNext()
      Select the next item.
      Since:
      API version 1

    • selectNextAction

      HardwareActionBindable selectNextAction()

    • selectFirst

      void selectFirst()
      Select the first item.
      Since:
      API version 1

    • selectLast

      void selectLast()
      Select the last item.
      Since:
      API version 1

    • 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

    • addCanSelectPreviousObserver

      @Deprecated void addCanSelectPreviousObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use hasPrevious() instead.
      Registers a function with bool argument that gets called when the previous item gains or remains selectable.
      Since:
      API version 1

    • addCanSelectNextObserver

      @Deprecated void addCanSelectNextObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use hasNext() instead.
      Registers a function with bool argument that gets called when the next item gains or remains selectable.
      Since:
      API version 1