Skip to content

ableton.v3.control_surface.components.item_list (runtime)

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

Functions

clamp(val, minv, maxv)

liveobj_changed(obj, other)

liveobj_valid(obj)

Classes

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 ItemListComponent(ScrollComponent)

Properties

  • application
  • is_root
  • layer
  • parent
  • scrollable
  • song

Methods

__init__(self, item_provider=None, *a, **k)

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

_add_child(self, component)
_do_scroll_down(self)
_do_scroll_up(self)
_ensure_scroll_one_direction(self)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_make_scroll_task(self, scroll_step)
_on_scroll_pressed(self, button, scroll_step, scroll_task)
_on_scroll_released(self, scroll_task)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_is_enabled(self)
_update_scroll_controls(self)
add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)
add_children(self, *children)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
any_clipboard_has_content_has_listener(self, slot)
any_clipboard_has_content_listener_count(self)
can_scroll_down(self)
can_scroll_up(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_any_clipboard_has_content(self, *a, **k)
notify_enabled(self, *a, **k)
on_enabled_changed(self)
register_clipboard(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_any_clipboard_has_content_listener(self, slot)
remove_enabled_listener(self, slot)
scroll_down(self)
scroll_up(self)
set_enabled(self, enable)
set_next_button(self, button)
set_prev_button(self, button)
set_scroll_down_button(self, button)
set_scroll_encoder(self, encoder)
set_scroll_up_button(self, button)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _clipboard_component_instances = [] - Built-in mutable sequence.
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
  • any_clipboard_has_content = False - bool(x) -> bool
  • canonical_parent = None
  • num_layers = 0 - int([x]) -> integer
  • scroll_down_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163af0da0>
  • scroll_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x163af0d30>
  • scroll_up_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163af0d68>
  • scrolling_delay = 0.3 - Convert a string or number to a floating point number, if possible.
  • scrolling_step_delay = 0.1 - Convert a string or number to a floating point number, if possible.

class ItemProvider(EventObject, Scrollable)

Properties

  • has_valid_selection
  • items
  • selected_index
  • selected_item

Methods

__init__(self, *a, **k)

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

_on_items_changed(self)
_update_selected_index(self)
add_items_listener(self, slot, identify_sender=False, *a, **k)
add_selected_index_listener(self, slot, identify_sender=False, *a, **k)
add_selected_item_listener(self, slot, identify_sender=False, *a, **k)
can_scroll_down(self)
can_scroll_up(self)
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_index(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_index_listener(self, slot)
remove_selected_item_listener(self, slot)
scroll_down(self)
scroll_up(self)
selected_index_has_listener(self, slot)
selected_index_listener_count(self)
selected_item_has_listener(self, slot)
selected_item_listener_count(self)
unregister_disconnectable(self, slot)

class ScrollComponent(Component, Scrollable)

Properties

  • application
  • is_root
  • layer
  • parent
  • scrollable
  • song

Methods

__init__(self, scrollable=None, scroll_skin_name=None, *a, **k)

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

_add_child(self, component)
_do_scroll_down(self)
_do_scroll_up(self)
_ensure_scroll_one_direction(self)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_make_scroll_task(self, scroll_step)
_on_scroll_pressed(self, button, scroll_step, scroll_task)
_on_scroll_released(self, scroll_task)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_is_enabled(self)
_update_scroll_controls(self)
add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)
add_children(self, *children)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
any_clipboard_has_content_has_listener(self, slot)
any_clipboard_has_content_listener_count(self)
can_scroll_down(self)
can_scroll_up(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_any_clipboard_has_content(self, *a, **k)
notify_enabled(self, *a, **k)
on_enabled_changed(self)
register_clipboard(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_any_clipboard_has_content_listener(self, slot)
remove_enabled_listener(self, slot)
scroll_down(self)
scroll_up(self)
set_enabled(self, enable)
set_scroll_down_button(self, button)
set_scroll_encoder(self, encoder)
set_scroll_up_button(self, button)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _clipboard_component_instances = [] - Built-in mutable sequence.
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
  • any_clipboard_has_content = False - bool(x) -> bool
  • canonical_parent = None
  • num_layers = 0 - int([x]) -> integer
  • scroll_down_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163af0da0>
  • scroll_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x163af0d30>
  • scroll_up_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163af0d68>
  • scrolling_delay = 0.3 - Convert a string or number to a floating point number, if possible.
  • scrolling_step_delay = 0.1 - Convert a string or number to a floating point number, if possible.

class Scrollable

Methods

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

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

can_scroll_down()
can_scroll_up()

Attributes

  • scroll_down = NotImplemented
  • scroll_up = NotImplemented

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>