Package _Framework :: Module ControlSurfaceComponent :: Class ControlSurfaceComponent
[hide private]
[frames] | no frames]

Class ControlSurfaceComponent

source code

                       object --+            
                                |            
    Disconnectable.Disconnectable --+        
                                    |        
Disconnectable.CompoundDisconnectable --+    
                                        |    
                  SubjectSlot.SlotManager --+
                                            |
                           object --+       |
                                    |       |
        Disconnectable.Disconnectable --+   |
                                        |   |
                      SubjectSlot.Subject --+
                                            |
                                           ControlSurfaceComponent

Base class for all classes encapsulating functions in Live

Nested Classes [hide private]

Inherited from SubjectSlot.Subject: __metaclass__

Instance Methods [hide private]
 
__init__(self, name='', register_component=None, song=None, *a, **k)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
disconnect(self) source code
 
_internal_on_enabled_changed(self) source code
 
on_enabled_changed(self) source code
 
update(self) source code
 
update_all(self) source code
 
set_enabled(self, enable) source code
 
_set_enabled_recursive(self, enable) source code
 
_update_is_enabled(self) source code
 
set_allow_update(self, allow_updates) source code
 
application(self) source code
 
song(self) source code
 
_tasks(self, parent_task_group=None) source code
 
_get_layer(self) source code
 
_set_layer(self, new_layer) source code
 
is_enabled(self, explicit=False)
Returns whether the component is enabled.
source code
 
on_track_list_changed(self)
Called by the control surface if tracks are added/removed, to be overridden
source code
 
on_scene_list_changed(self)
Called by the control surface if scenes are added/removed, to be overridden
source code
 
on_selected_track_changed(self)
Called by the control surface when a track is selected, to be overridden
source code
 
on_selected_scene_changed(self)
Called by the control surface when a scene is selected, to be overridden
source code
 
_register_timer_callback(self, callback, parent_task_group=None)
DEPRECATED.
source code
 
_unregister_timer_callback(self, callback, parent_task_group=None)
DEPRECATED.
source code

Inherited from SubjectSlot.SlotManager: register_slot, register_slot_manager

Inherited from Disconnectable.CompoundDisconnectable: disconnect_disconnectable, find_disconnectable, has_disconnectable, register_disconnectable, unregister_disconnectable

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  name = ''
  canonical_parent = None
  is_private = False
  _show_msg_callback = dependency(show_message= None)
  _has_task_group = False
  _layer = None
  layer = property(_get_layer, _set_layer)
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name='', register_component=None, song=None, *a, **k)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Decorators:
  • @depends(register_component= None, song= None)
Overrides: object.__init__
(inherited documentation)

disconnect(self)

source code 
Overrides: Disconnectable.Disconnectable.disconnect

_tasks(self, parent_task_group=None)

source code 
Decorators:
  • @lazy_attribute
  • @depends(parent_task_group= None)

is_enabled(self, explicit=False)

source code 

Returns whether the component is enabled. If 'explicit' is True the parent state is ignored.

_register_timer_callback(self, callback, parent_task_group=None)

source code 

DEPRECATED. Use tasks instead

Decorators:
  • @depends(parent_task_group= None)

_unregister_timer_callback(self, callback, parent_task_group=None)

source code 

DEPRECATED. Use tasks instead

Decorators:
  • @depends(parent_task_group= None)