Package elisa :: Package plugins :: Package good :: Package pigment :: Module pigment_input :: Class PigmentInput
[hide private]
[frames] | no frames]

Class PigmentInput

source code


This class implements Pigment events support.

Nested Classes [hide private]

Inherited from core.component.Component: __metaclass__

Instance Methods [hide private]
 
__init__(self)
Lazily set name from class name styled with underscores (class ComponentBar -> name component_bar.
source code
 
bind(self)
Subscribe to the input device
source code
 
unbind(self)
Unsubscribe from the input device
source code
 
_process_delete_event(self, viewport, event) source code
 
_process_press_event(self, viewport, event) source code
 
_process_release_event(self, viewport, event) source code
 
_process_scroll_event(self, viewport, event) source code
 
_process_button_press_event(self, viewport, event) source code
 
_create_event_with_type(self, event, event_type) source code

Inherited from base_components.input_provider.PushInputProvider: clean

Inherited from base_components.input_provider.InputProvider: create_input_event

Inherited from core.component.Component: initialize, load_config, save_config

Inherited from extern.log.log.Loggable: debug, doLog, error, info, log, logFunction, logObjectName, warning, warningFailure

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

Static Methods [hide private]

Inherited from core.component.Component: __classinit__

Class Variables [hide private]
string name = 'pigment_input'
Component's name

Inherited from core.component.Component: checked, config_doc, default_config, id, plugin

Inherited from extern.log.log.Loggable: logCategory

Instance Variables [hide private]

Inherited from base_components.input_provider.PushInputProvider: input_manager

Inherited from base_components.input_provider.InputProvider: origin, viewport

Inherited from core.component.Component: config, path

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 
Lazily set name from class name styled with underscores (class ComponentBar -> name component_bar. Also set log category based on component name, with a 'comp_' prefix.
Overrides: core.component.Component.__init__
(inherited documentation)

bind(self)

source code 

Subscribe to the input device

This can be done by connecting external component signals to our handlers or register a local callback that will be called by the external component when it receives an input event.

This method must be overriden by implementation because it's totally dependent on the infrastructure used by the input device the component supports.
Overrides: base_components.input_provider.PushInputProvider.bind
(inherited documentation)

unbind(self)

source code 

Unsubscribe from the input device

This can be done by disconnecting our handlers from the external component signals or unregistering the local callback previously registered by the register() method.

This method must be overriden by implementation because it's totally dependent on the infrastructure used by the input device the component supports.
Overrides: base_components.input_provider.PushInputProvider.unbind
(inherited documentation)