circuits.core.components – Components

Components

This module defines the BaseComponent and the subclass Component

Components

class circuits.core.components.BaseComponent(*args, **kwargs)

Base Component

This is the Base of the Component which manages registrations to other components or managers. Every Base Component and thus Component has a unique Channel that is used as a separation of concern for its registered Event Handlers. By default, this Channels is None (or also known as the Global Channel).

When a Component (Base Component) has a set Channel that is not the Global Channel (None), then any Event Handlers will actually listen on a Channel that is a combination of the Component’s Channel prefixed with the Event Handler’s Channel. The form becomes:

C{target:channel}

Where:
  • target is the Component’s Channel
  • channel is the Event Handler’s Channel
Variables:channel – The Component’s Channel

initializes x; see x.__class__.__doc__ for signature

register(manager)

Register all Event Handlers with the given Manager

This will register all Event Handlers of this Component to the given Manager. By default, every Component (Base Component) is registered with itself.

If the Component or Manager being registered with is not the current Component, then any Hidden Components in registered to this Component will also be registered with the given Manager. A Registered Event will also be sent.

unregister()

Unregister all registered Event Handlers

This will unregister all registered Event Handlers of this Component from its registered Component or Manager.

@note: It’s possible to unregister a Component from itself!

class circuits.core.components.Component(*args, **kwargs)

initializes x; see x.__class__.__doc__ for signature