_Framework.Control

Module constants

• _DYNAMIC_CONTROL_COUNT = None
• _DYNAMIC_MATRIX_DIMENSIONS = (None, None)
• _control_list_classes
• _control_matrix_classes

Classes

class ControlManager(SlotManager)

Bases: SlotManager

__init__(self, *a, **k)

_tasks(self)

control_notifications_enabled(self)

update(self)

class Control(object)

Bases: object

Attributes

• value
• _extra_kws
• _extra_args

__init__(self, extra_args, extra_kws, *a, **k)

__get__(self, manager, owner)

__set__(self, manager, owner)

_get_state(self, manager)

_clear_state(self, manager)

class State(SlotManager)

Bases: SlotManager

Attributes

• enabled = True
• channel
• identifier

__init__(self, control, manager, channel, identifier, *a, **k)

set_control_element(self, control_element)

_register_value_slot(self, manager, control)

_event_listener_required(self)

_on_value(self, value, *a, **k)

_notifications_enabled(self)

update(self)

_get_channel(self)

_set_channel(self, channel)

_get_identifier(self)

_set_identifier(self, value)

class MappedControl(Control)

Bases: Control

__init__(self, *a, **k)

class State(Control.State)

Bases: Control.State

Attributes

• mapped_parameter

__init__(self, control, manager, *a, **k)

set_control_element(self, control_element)

_get_direct_mapping(self)

_set_direct_mapping(self, direct_mapping)

_update_direct_connection(self)

_notifications_enabled(self)

class ButtonControl(Control)

Bases: Control

Attributes

• DELAY_TIME
• REPEAT_RATE = 0.1
• pressed
• released
• pressed_delayed
• released_delayed
• released_immediately

__init__(self, *a, **k)

class State(Control.State)

Bases: Control.State

Attributes

• color
• pressed_color
• disabled_color
• enabled

__init__(self, control, manager, color, pressed_color, disabled_color, repeat, enabled, *a, **k)

_get_color(self)

_set_color(self, value)

_get_pressed_color(self)

_set_pressed_color(self, value)

_get_disabled_color(self)

_set_disabled_color(self, value)

_get_enabled(self)

_set_enabled(self, enabled)

is_momentary(self)

is_pressed(self)

_event_listener_required(self)

set_control_element(self, control_element)

_send_current_color(self)

_on_value(self, value, *a, **k)

_press_button(self)

_release_button(self)

_delay_task(self)

_repeat_task(self)

_has_delayed_event(self)

_on_pressed_delayed(self)

update(self)

class ToggleButtonControl(Control)

Bases: Control

Attributes

• toggled

__init__(self, *a, **k)

class State(Control.State)

Bases: Control.State

Attributes

• is_toggled
• untoggled_color
• toggled_color

__init__(self, control, manager, untoggled_color, toggled_color, *a, **k)

_get_is_toggled(self)

_set_is_toggled(self, toggled)

_get_untoggled_color(self)

_set_untoggled_color(self, value)

_get_toggled_color(self)

_set_toggled_color(self, value)

set_control_element(self, control_element)

_send_current_color(self)

_is_momentary(self)

_on_value(self, value, *a, **k)

update(self)

class RadioButtonControl(Control)

Bases: Control

Attributes

• checked

__init__(self, *a, **k)

class State(Control.State)

Bases: Control.State

Attributes

• is_checked
• unchecked_color
• checked_color

__init__(self, control, manager, unchecked_color, checked_color, *a, **k)

_get_is_checked(self)

_set_is_checked(self, value)

_get_unchecked_color(self)

_set_unchecked_color(self, value)

_get_checked_color(self)

_set_checked_color(self, value)

set_control_element(self, control_element)

_send_current_color(self)

_is_momentary(self)

_on_value(self, value, *a, **k)

_notify_checked(self)

update(self)

class EncoderControl(Control)

Bases: Control

Attributes

• TOUCH_TIME = 0.5
• touched
• released

class State(Control.State)

Bases: Control.State

__init__(self, control, manager, *a, **k)

_release_task(self)

is_touched(self)

set_control_element(self, control_element)

_touch_encoder(self)

_release_encoder(self)

_on_value(self, value, *a, **k)

_on_touch_value(self, value, *a, **k)

class PlayableControl(ButtonControl)

Bases: ButtonControl

class State(ButtonControl.State)

Bases: ButtonControl.State

Attributes

• enabled

__init__(self, *a, **k)

set_control_element(self, control_element)

_update_script_forwarding(self)

_get_enabled(self)

_set_enabled(self, enabled)

set_playable(self, value)

_notifications_enabled(self)

class ControlList(Control)

Bases: Control

Attributes

• DYNAMIC_CONTROL_COUNT

__init__(self, control_type, control_count, *a, **k)

class State(Control.State)

Bases: Control.State

Attributes

• _extra_kws
• _extra_args
• control_count
• unavailable_color

__init__(self, control, manager, extra_args, extra_kws, unavailable_color, *a, **k)

_get_control_count(self)

_set_control_count(self, count)

_get_unavailable_color(self)

_set_unavailable_color(self, value)

_create_controls(self, count)

_disconnect_controls(self)

_make_control(self, index)

set_control_element(self, control_elements)

_update_controls(self)

_send_unavailable_color(self, element)

__getitem__(self, index)

_on_value(self, value, *a, **k)

_register_value_slot(self, manager, control)

class RadioButtonGroup(ControlList, RadioButtonControl)

Bases: ControlList, RadioButtonControl

__init__(self, *a, **k)

class State(ControlList.State)

Bases: ControlList.State

__init__(self, *a, **k)

_create_controls(self, count)

_make_control(self, index)

_on_checked(self, checked_control)

class MatrixControl(ControlList)

Bases: ControlList

Attributes

• DYNAMIC_DIMENSIONS

__init__(self, *a, **k)

class State(ControlList.State)

Bases: ControlList.State

Attributes

• dimensions

__init__(self, control, manager, *a, **k)

_get_dimensions(self)

_set_dimensions(self, dimensions)

_make_control(self, index)

set_control_element(self, control_elements)

get_control(self, row, column)

width(self)

height(self)

Functions

control_event(event_name)

control_list(control_type, *a, **k)

control_matrix(control_type, *a, **k)