_Framework.ModesComponent

Classes

class Mode(object)

Bases: object

enter_mode(self)

leave_mode(self)

__enter__(self)

__exit__(self, *a)

class ContextManagerMode(Mode)

Bases: Mode

__init__(self, context_manager, *a, **k)

enter_mode(self)

leave_mode(self)

__exit__(self, exc_type, exc_value, traceback)

class ComponentMode(Mode)

Bases: Mode

__init__(self, component, *a, **k)

enter_mode(self)

leave_mode(self)

class LazyComponentMode(Mode)

Bases: Mode

__init__(self, component_creator, *a, **k)

component(self)

enter_mode(self)

leave_mode(self)

class DisableMode(Mode)

Bases: Mode

__init__(self, component, *a, **k)

enter_mode(self)

leave_mode(self)

class LayerModeBase(Mode)

Bases: Mode

__init__(self, component, layer, *a, **k)

_get_component(self)

class LayerMode(LayerModeBase)

Bases: LayerModeBase

enter_mode(self)

leave_mode(self)

class AddLayerMode(LayerModeBase)

Bases: LayerModeBase

enter_mode(self)

leave_mode(self)

class CompoundMode(Mode)

Bases: Mode

__init__(self, *modes, **k)

enter_mode(self)

leave_mode(self)

class MultiEntryMode(Mode)

Bases: Mode

__init__(self, mode, *a, **k)

enter_mode(self)

leave_mode(self)

is_entered(self)

class SetAttributeMode(Mode)

Bases: Mode

__init__(self, obj, attribute, value, *a, **k)

_get_object(self)

enter_mode(self)

leave_mode(self)

class DelayMode(Mode)

Bases: Mode

__init__(self, mode, delay, parent_task_group, *a, **k)

_enter_mode_delayed(self)

enter_mode(self)

leave_mode(self)

class ModeButtonBehaviour(object)

Bases: object

press_immediate(self, component, mode)

release_immediate(self, component, mode)

press_delayed(self, component, mode)

release_delayed(self, component, mode)

update_button(self, component, mode, selected_mode)

class LatchingBehaviour(ModeButtonBehaviour)

Bases: ModeButtonBehaviour

press_immediate(self, component, mode)

release_immediate(self, component, mode)

release_delayed(self, component, mode)

class ReenterBehaviour(LatchingBehaviour)

Bases: LatchingBehaviour

__init__(self, on_reenter, *a, **k)

press_immediate(self, component, mode)

on_reenter(self)

class CancellableBehaviour(ModeButtonBehaviour)

Bases: ModeButtonBehaviour

Attributes

• _previous_mode = None

press_immediate(self, component, mode)

remember_previous_mode(self, component)

restore_previous_mode(self, component)

class ImmediateBehaviour(ModeButtonBehaviour)

Bases: ModeButtonBehaviour

press_immediate(self, component, mode)

class AlternativeBehaviour(CancellableBehaviour)

Bases: CancellableBehaviour

__init__(self, alternative_mode, *a, **k)

_check_mode_groups(self, component, mode)

release_delayed(self, component, mode)

press_delayed(self, component, mode)

release_immediate(self, component, mode)

press_immediate(self, component, mode)

class DynamicBehaviourMixin(ModeButtonBehaviour)

Bases: ModeButtonBehaviour

__init__(self, mode_chooser, *a, **k)

press_immediate(self, component, mode)

release_delayed(self, component, mode)

press_delayed(self, component, mode)

release_immediate(self, component, mode)

class ExcludingBehaviourMixin(ModeButtonBehaviour)

Bases: ModeButtonBehaviour

__init__(self, excluded_groups, *a, **k)

is_excluded(self, component, selected)

press_immediate(self, component, mode)

release_delayed(self, component, mode)

press_delayed(self, component, mode)

release_immediate(self, component, mode)

update_button(self, component, mode, selected_mode)

class _ModeEntry(NamedTuple)

Bases: NamedTuple

Attributes

• mode = None
• groups
• toggle_value = False
• subject_slot = None
• momentary_task = None

class ModesComponent(CompoundComponent)

Bases: CompoundComponent

Attributes

• momentary_toggle = False
• default_behaviour
• selected_mode

__init__(self, *a, **k)

disconnect(self)

set_shift_button(self, button)

_do_enter_mode(self, name)

_do_leave_mode(self, name)

_get_selected_mode(self)

_set_selected_mode(self, mode)

selected_groups(self)

active_modes(self)

push_mode(self, mode)

pop_mode(self, mode)

pop_groups(self, groups)

pop_unselected_modes(self)

on_enabled_changed(self)

update(self)

add_mode(self, name, mode_or_component, toggle_value, groups, behaviour)

_get_mode_behaviour(self, name)

get_mode(self, name)

get_mode_groups(self, name)

set_toggle_button(self, button)

set_mode_button(self, name, button)

get_mode_button(self, name)

_update_buttons(self, selected)

_on_mode_button_value(self, name, value, sender)

_on_toggle_value(self, value)

cycle_mode(self, delta)

class DisplayingModesComponent(ModesComponent)

Bases: ModesComponent

__init__(self, *a, **k)

add_mode(self, name, mode_or_component, data_source)

update(self)

_do_enter_mode(self, name)

_update_data_sources(self, selected)

class EnablingModesComponent(ModesComponent)

Bases: ModesComponent

__init__(self, component, toggle_value, disabled_value, *a, **k)

Functions

tomode(thing)

generator_mode(function)