_Framework.ModesComponent (runtime)¶
Live 12 — Live Object Model & framework reference (descriptions and signatures).
Functions¶
depends(**dependencies)¶
generator_mode(function)¶
infinite_context_manager(generator)¶
is_contextmanager(value)¶
is_iterable(value)¶
old_hasattr(obj, attr)¶
subject_slot(events, *a, **k)¶
tomode(thing)¶
Classes¶
class AddLayerMode(LayerModeBase)¶
Methods¶
__init__(self, component=None, layer=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
_get_component(self)¶
enter_mode(self)¶
leave_mode(self)¶
class AlternativeBehaviour(CancellableBehaviour)¶
Methods¶
__init__(self, alternative_mode=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
_check_mode_groups(self, component, mode)¶
press_delayed(self, component, mode)¶
press_immediate(self, component, mode)¶
release_delayed(self, component, mode)¶
release_immediate(self, component, mode)¶
remember_previous_mode(self, component)¶
restore_previous_mode(self, component)¶
update_button(self, component, mode, selected_mode)¶
Attributes¶
_previous_mode=None
class CancellableBehaviour(ModeButtonBehaviour)¶
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
press_delayed(self, component, mode)¶
press_immediate(self, component, mode)¶
release_delayed(self, component, mode)¶
release_immediate(self, component, mode)¶
remember_previous_mode(self, component)¶
restore_previous_mode(self, component)¶
update_button(self, component, mode, selected_mode)¶
Attributes¶
_previous_mode=None
class ComponentMode(Mode)¶
Methods¶
__init__(self, component=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
enter_mode(self)¶
leave_mode(self)¶
class CompoundComponent(ControlSurfaceComponent)¶
class CompoundMode(Mode)¶
Methods¶
__init__(self, *modes, **k)¶
Initialize self. See help(type(self)) for accurate signature.
enter_mode(self)¶
leave_mode(self)¶
class ContextManagerMode(Mode)¶
Methods¶
__init__(self, context_manager=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
enter_mode(self)¶
leave_mode(self)¶
class ControlSurfaceComponent(ControlManager, Subject)¶
class DelayMode(Mode)¶
Methods¶
__init__(self, mode=None, delay=None, parent_task_group=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
_enter_mode_delayed(self)¶
enter_mode(self)¶
leave_mode(self)¶
class DisableMode(Mode)¶
Methods¶
__init__(self, component=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
enter_mode(self)¶
leave_mode(self)¶
class DisplayingModesComponent(ModesComponent)¶
class DynamicBehaviourMixin(ModeButtonBehaviour)¶
Methods¶
__init__(self, mode_chooser=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
press_delayed(self, component, mode)¶
press_immediate(self, component, mode)¶
release_delayed(self, component, mode)¶
release_immediate(self, component, mode)¶
update_button(self, component, mode, selected_mode)¶
class EnablingModesComponent(ModesComponent)¶
class ExcludingBehaviourMixin(ModeButtonBehaviour)¶
Methods¶
__init__(self, excluded_groups=set(), *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
is_excluded(self, component, selected)¶
press_delayed(self, component, mode)¶
press_immediate(self, component, mode)¶
release_delayed(self, component, mode)¶
release_immediate(self, component, mode)¶
update_button(self, component, mode, selected_mode)¶
class ImmediateBehaviour(ModeButtonBehaviour)¶
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
press_delayed(self, component, mode)¶
press_immediate(self, component, mode)¶
release_delayed(self, component, mode)¶
release_immediate(self, component, mode)¶
update_button(self, component, mode, selected_mode)¶
class LatchingBehaviour(ModeButtonBehaviour)¶
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
press_delayed(self, component, mode)¶
press_immediate(self, component, mode)¶
release_delayed(self, component, mode)¶
release_immediate(self, component, mode)¶
update_button(self, component, mode, selected_mode)¶
class LayerBase¶
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
class LayerMode(LayerModeBase)¶
Methods¶
__init__(self, component=None, layer=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
_get_component(self)¶
enter_mode(self)¶
leave_mode(self)¶
class LayerModeBase(Mode)¶
Methods¶
__init__(self, component=None, layer=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
_get_component(self)¶
enter_mode(self)¶
leave_mode(self)¶
class LazyComponentMode(Mode)¶
Methods¶
__init__(self, component_creator=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
enter_mode(self)¶
leave_mode(self)¶
Attributes¶
component=<_Framework.Util.lazy_attribute object at 0x13ccc60d0>
class Mode¶
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
enter_mode(self)¶
leave_mode(self)¶
class ModeButtonBehaviour¶
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
press_delayed(self, component, mode)¶
press_immediate(self, component, mode)¶
release_delayed(self, component, mode)¶
release_immediate(self, component, mode)¶
update_button(self, component, mode, selected_mode)¶
class ModesComponent(CompoundComponent)¶
class MultiEntryMode(Mode)¶
Properties¶
is_entered
Methods¶
__init__(self, mode=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
enter_mode(self)¶
leave_mode(self)¶
class NamedTuple¶
Methods¶
__init__(self, *others, **k)¶
Initialize self. See help(type(self)) for accurate signature.
Attributes¶
_eq_dict=<_Framework.Util.lazy_attribute object at 0x129d83b50>
class ReenterBehaviour(LatchingBehaviour)¶
Methods¶
__init__(self, on_reenter=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
on_reenter(self)¶
press_delayed(self, component, mode)¶
press_immediate(self, component, mode)¶
release_delayed(self, component, mode)¶
release_immediate(self, component, mode)¶
update_button(self, component, mode, selected_mode)¶
class SetAttributeMode(Mode)¶
Methods¶
__init__(self, obj=None, attribute=None, value=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
_get_object(self)¶
enter_mode(self)¶
leave_mode(self)¶
class StackingResource(Resource)¶
Properties¶
clientsmax_priorityownerownersstack_size
Methods¶
__init__(self, on_received_callback=None, on_lost_callback=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
_actual_owners(self)¶
_add_client(self, client, priority)¶
_on_lost_set(self, clients)¶
_on_received_set(self, clients)¶
_remove_client(self, client)¶
get_owner(self)¶
grab(self, client, priority=None)¶
on_lost(self, client)¶
on_received(self, client)¶
release(self, client)¶
release_all(self)¶
release_stacked(self)¶
class lazy_attribute¶
Methods¶
__init__(self, func, name=None)¶
Initialize self. See help(type(self)) for accurate signature.
class partial¶
partial(func, args, *keywords) - new function with partial application of the given arguments and keywords.
Methods¶
__call__(self, /, *args, **kwargs)¶
Call self as a function.
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
Attributes¶
args=<member 'args' of 'functools.partial' objects>- tuple of arguments to future partial callsfunc=<member 'func' of 'functools.partial' objects>- function object to use in future partial callskeywords=<member 'keywords' of 'functools.partial' objects>- dictionary of keyword arguments to future partial calls