BindingMapper

class ginga.Bindings.BindingMapper(logger, btnmap=None, mode_map=None, modifier_map=None)[source]

Bases: Callbacks

Map physical events to logical events.

The BindingMapper class maps physical events (key presses, button clicks, mouse movement, etc) into logical events. By registering for logical events, plugins and other event handling code doesn’t need to care about the physical controls bindings. The bindings can be changed and everything continues to work.

Methods Summary

add_mode(keyname, mode_name[, mode_type, msg])

add_modifier(keyname, modname)

clear_button_map()

clear_event_map()

clear_mode_map()

clear_modifier_map()

current_mode()

get_button(btncode)

get_buttons()

get_default_mode_type()

get_modes()

get_modifiers()

has_mode(mode_name)

map_button(btncode, alias)

For remapping the buttons to different names.

map_event(mode, modifiers, trigger, eventname)

mode_key_down(viewer, keyname)

This method is called when a key is pressed and was not handled by some other handler with precedence, such as a subcanvas.

mode_key_up(viewer, keyname)

This method is called when a key is pressed in a mode and was not handled by some other handler with precedence, such as a subcanvas.

register_for_events(viewer)

remove_mode(mode_name)

reset_mode(viewer)

set_default_mode_type(mode_type)

set_mode(name[, mode_type])

set_mode_map(mode_map)

window_button_press(viewer, btncode, data_x, ...)

window_button_release(viewer, btncode, ...)

window_enter(viewer)

window_focus(viewer, has_focus)

window_key_press(viewer, keyname)

window_key_release(viewer, keyname)

window_leave(viewer)

window_map(viewer)

window_motion(viewer, btncode, data_x, data_y)

window_pan(viewer, state, delta_x, delta_y)

window_pinch(viewer, state, rot_deg, scale)

window_scroll(viewer, direction, amount, ...)

Methods Documentation

add_mode(keyname, mode_name, mode_type='held', msg=None)[source]
add_modifier(keyname, modname)[source]
clear_button_map()[source]
clear_event_map()[source]
clear_mode_map()[source]
clear_modifier_map()[source]
current_mode()[source]
get_button(btncode)[source]
get_buttons()[source]
get_default_mode_type()[source]
get_modes()[source]
get_modifiers()[source]
has_mode(mode_name)[source]
map_button(btncode, alias)[source]

For remapping the buttons to different names. ‘btncode’ is a fixed button code and ‘alias’ is a logical name.

map_event(mode, modifiers, trigger, eventname)[source]
mode_key_down(viewer, keyname)[source]

This method is called when a key is pressed and was not handled by some other handler with precedence, such as a subcanvas.

mode_key_up(viewer, keyname)[source]

This method is called when a key is pressed in a mode and was not handled by some other handler with precedence, such as a subcanvas.

register_for_events(viewer)[source]
remove_mode(mode_name)[source]
reset_mode(viewer)[source]
set_default_mode_type(mode_type)[source]
set_mode(name, mode_type=None)[source]
set_mode_map(mode_map)[source]
window_button_press(viewer, btncode, data_x, data_y)[source]
window_button_release(viewer, btncode, data_x, data_y)[source]
window_enter(viewer)[source]
window_focus(viewer, has_focus)[source]
window_key_press(viewer, keyname)[source]
window_key_release(viewer, keyname)[source]
window_leave(viewer)[source]
window_map(viewer)[source]
window_motion(viewer, btncode, data_x, data_y)[source]
window_pan(viewer, state, delta_x, delta_y)[source]
window_pinch(viewer, state, rot_deg, scale)[source]
window_scroll(viewer, direction, amount, data_x, data_y)[source]