Skip to content

ableton.v2.control_surface.components.item_lister (runtime)

Live 11 — Live Object Model & framework reference (descriptions and signatures).

Functions

control_list(control_type, *a, **k)

forward_property(member)

listens(event_path, *a, **k)

liveobj_valid(obj)

Classes

class ButtonControl(ButtonControlBase)

Properties

  • double_clicked
  • pressed
  • pressed_delayed
  • released
  • released_delayed
  • released_immediately
  • value

Methods

State(color='DefaultButton.On', *a, **k)
__init__(self, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_clear_state(self, manager)
_get_state(self, manager, state_factory=None)
_make_control_state(self, manager)

Attributes

  • DELAY_TIME = 0.3 - Convert a string or number to a floating point number, if possible.
  • DOUBLE_CLICK_TIME = 0.5 - Convert a string or number to a floating point number, if possible.
  • REPEAT_RATE = 0.1 - Convert a string or number to a floating point number, if possible.
  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class Component(ControlManager)

Properties

  • application
  • is_root
  • layer
  • parent
  • song

Methods

__init__(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=True, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_add_child(self, component)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_is_enabled(self)
add_children(self, *a)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
notify_enabled(self, *a, **k)
on_enabled_changed(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_enabled_listener(self, slot)
set_enabled(self, enable)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _has_task_group = False - bool(x) -> bool
  • _layer = None
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
  • canonical_parent = None
  • is_private = False - bool(x) -> bool
  • name = '' - str(object='') -> str

class EventObject(CompoundDisconnectable)

Methods

__init__(self, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
unregister_disconnectable(self, slot)

class ItemListerComponent(ItemListerComponentBase)

Properties

  • application
  • is_root
  • item_offset
  • item_provider
  • items
  • layer
  • parent
  • song

Methods

__init__(self, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_add_child(self, component)
_adjust_offset(self)
_color_for_button(self, button_index, is_selected)
_create_slot(self, index, item, nesting_level)
_create_slots(self)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_items_equal(self, item, selected_item)
_on_items_changed(self)
_on_select_button_pressed(self, button)
_on_select_button_pressed_delayed(self, button)
_on_select_button_released(self, button)
_on_select_button_released_immediately(self, button)
_on_selection_changed(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_button_colors(self)
_update_is_enabled(self)
add_children(self, *a)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
add_items_listener(self, slot, identify_sender=False, *a, **k)
can_scroll_left(self)
can_scroll_right(self)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
items_has_listener(self, slot)
items_listener_count(self)
notify_enabled(self, *a, **k)
notify_items(self, *a, **k)
on_enabled_changed(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_enabled_listener(self, slot)
remove_items_listener(self, slot)
reset_offset(self)
scroll_left(self)
scroll_right(self)
set_enabled(self, enable)
unregister_disconnectable(self, slot)
update(self)
update_items(self)

Attributes

  • _ItemListerComponentBase__on_items_changed = None
  • _ItemListerComponent__on_items_changed = None
  • _ItemListerComponent__on_selection_changed = None
  • _has_task_group = False - bool(x) -> bool
  • _layer = None
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
  • canonical_parent = None
  • color_class_name = 'ItemNavigation' - str(object='') -> str
  • is_private = False - bool(x) -> bool
  • name = '' - str(object='') -> str
  • scroll_left_layer = <ableton.v2.base.util.forward_property.<locals>.Descriptor object at 0x1634e7be0>
  • scroll_right_layer = <ableton.v2.base.util.forward_property.<locals>.Descriptor object at 0x1634e7cc0>
  • select_buttons = <ableton.v2.base.util.Mixin_ControlList_ButtonControl object at 0x1634e7b00>

class ItemListerComponentBase(Component)

Properties

  • application
  • is_root
  • item_offset
  • item_provider
  • items
  • layer
  • parent
  • song

Methods

__init__(self, item_provider=<ableton.v2.control_surface.components.item_lister.ItemProvider object at 0x1634e1f60>, num_visible_items=8, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_add_child(self, component)
_adjust_offset(self)
_create_slot(self, index, item, nesting_level)
_create_slots(self)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_on_items_changed(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_is_enabled(self)
add_children(self, *a)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
add_items_listener(self, slot, identify_sender=False, *a, **k)
can_scroll_left(self)
can_scroll_right(self)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
items_has_listener(self, slot)
items_listener_count(self)
notify_enabled(self, *a, **k)
notify_items(self, *a, **k)
on_enabled_changed(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_enabled_listener(self, slot)
remove_items_listener(self, slot)
reset_offset(self)
scroll_left(self)
scroll_right(self)
set_enabled(self, enable)
unregister_disconnectable(self, slot)
update(self)
update_items(self)

Attributes

  • _ItemListerComponentBase__on_items_changed = None
  • _has_task_group = False - bool(x) -> bool
  • _layer = None
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
  • canonical_parent = None
  • is_private = False - bool(x) -> bool
  • name = '' - str(object='') -> str

class ItemProvider(EventObject)

Properties

  • items
  • selected_item

Methods

__init__(self, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

add_items_listener(self, slot, identify_sender=False, *a, **k)
add_selected_item_listener(self, slot, identify_sender=False, *a, **k)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
items_has_listener(self, slot)
items_listener_count(self)
notify_items(self, *a, **k)
notify_selected_item(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_items_listener(self, slot)
remove_selected_item_listener(self, slot)
selected_item_has_listener(self, slot)
selected_item_listener_count(self)
unregister_disconnectable(self, slot)

class ItemSlot(SimpleItemSlot)

Properties

  • color_index
  • item
  • name
  • nesting_level

Methods

__init__(self, item=None, nesting_level=0, **k)

Initialize self. See help(type(self)) for accurate signature.

add_color_index_listener(self, slot, identify_sender=False, *a, **k)
add_name_listener(self, slot, identify_sender=False, *a, **k)
color_index_has_listener(self, slot)
color_index_listener_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
name_has_listener(self, slot)
name_listener_count(self)
notify_color_index(self, *a, **k)
notify_name(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_color_index_listener(self, slot)
remove_name_listener(self, slot)
unregister_disconnectable(self, slot)

Attributes

  • _SimpleItemSlot__on_color_index_changed = None
  • _SimpleItemSlot__on_name_changed = None
  • _live_ptr = <ableton.v2.base.util.forward_property.<locals>.Descriptor object at 0x1634e1eb8>

class ScrollComponent(Component)

Properties

  • application
  • is_root
  • layer
  • parent
  • song

Methods

__init__(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=True, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_add_child(self, component)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_is_enabled(self)
add_children(self, *a)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
add_scroll_listener(self, slot, identify_sender=False, *a, **k)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
notify_enabled(self, *a, **k)
notify_scroll(self, *a, **k)
on_enabled_changed(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_enabled_listener(self, slot)
remove_scroll_listener(self, slot)
scroll_has_listener(self, slot)
scroll_listener_count(self)
set_enabled(self, enable)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _has_task_group = False - bool(x) -> bool
  • _layer = None
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
  • button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x1634e73c8>
  • canonical_parent = None
  • is_private = False - bool(x) -> bool
  • name = '' - str(object='') -> str

class ScrollOverlayComponent(Component)

Properties

  • application
  • is_root
  • layer
  • parent
  • song

Methods

__init__(self, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_add_child(self, component)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_is_enabled(self)
add_children(self, *a)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
can_scroll_left(self)
can_scroll_right(self)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
notify_enabled(self, *a, **k)
on_enabled_changed(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_enabled_listener(self, slot)
scroll_left(self)
scroll_right(self)
set_enabled(self, enable)
unregister_disconnectable(self, slot)
update(self)
update_scroll_buttons(self)

Attributes

  • _ScrollOverlayComponent__on_scroll_left = None
  • _ScrollOverlayComponent__on_scroll_right = None
  • _has_task_group = False - bool(x) -> bool
  • _layer = None
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
  • canonical_parent = None
  • is_private = False - bool(x) -> bool
  • name = '' - str(object='') -> str
  • scroll_left_layer = <ableton.v2.base.util.forward_property.<locals>.Descriptor object at 0x1634e77b8>
  • scroll_right_layer = <ableton.v2.base.util.forward_property.<locals>.Descriptor object at 0x1634e7898>

class SimpleItemSlot(EventObject)

Properties

  • color_index
  • item
  • name
  • nesting_level

Methods

__init__(self, item=None, name='', nesting_level=-1, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

add_color_index_listener(self, slot, identify_sender=False, *a, **k)
add_name_listener(self, slot, identify_sender=False, *a, **k)
color_index_has_listener(self, slot)
color_index_listener_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
name_has_listener(self, slot)
name_listener_count(self)
notify_color_index(self, *a, **k)
notify_name(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_color_index_listener(self, slot)
remove_name_listener(self, slot)
unregister_disconnectable(self, slot)

Attributes

  • _SimpleItemSlot__on_color_index_changed = None
  • _SimpleItemSlot__on_name_changed = None

class listenable_property(listenable_property_base, property)

Property attribute.

fget function to be used for getting an attribute value fset function to be used for setting an attribute value fdel function to be used for del'ing an attribute doc docstring

Typical use is to define a managed attribute x:

class C(object): def getx(self): return self._x def setx(self, value): self._x = value def delx(self): del self._x x = property(getx, setx, delx, "I'm the 'x' property.")

Decorators make defining new properties or modifying existing ones easy:

class C(object): @property def x(self): "I am the 'x' property." return self._x @x.setter def x(self, value): self._x = value @x.deleter def x(self): del self._x

Methods

__init__(self, /, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

deleter(...)

Descriptor to change the deleter on a property.

getter(...)

Descriptor to change the getter on a property.

managed(default_value)
set_property_name(self, name)
setter(...)

Descriptor to change the setter on a property.

Attributes

  • fdel = <member 'fdel' of 'property' objects>
  • fget = <member 'fget' of 'property' objects>
  • fset = <member 'fset' of 'property' objects>