Package elisa :: Package base_components :: Module input_provider :: Class InputProvider
[hide private]
[frames] | no frames]

Class InputProvider

source code


Input events provider class. Plugins can't subclass it directly, they have to use either PollInputProvider or PushInputProvider classes.

Nested Classes [hide private]

Inherited from core.component.Component: __metaclass__

Instance Methods [hide private]
 
create_input_event(self, data)
Translate external input data to an InputEvent object, understandable by the InputManager.
source code

Inherited from core.component.Component: __init__, clean, 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 = 'input_provider'
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]
Backend or Frontend or None origin
source of the events; can be a frontend, a backend or None
  viewport
DOCME

Inherited from core.component.Component: config, path

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

create_input_event(self, data)

source code 
Translate external input data to an InputEvent object, understandable by the InputManager. This method has to be overriden by InputProvider implementations. This method is called by InputProvider implementations.
Parameters:
  • data - the data to translate, can be of any type
Returns:
elisa.core.input_event.InputEvent