Inherits from
- BaseTool: enthought.enable.base_tool.BaseTool
Attributes
- constrain
Constrain the panning to one direction?
constrain = Bool(False)
- constrain_direction
The direction of constrained draw. A value of None means that the user has initiated the drag and pressed the constrain_key, but hasn't moved the mouse yet; the magnitude of the components of the next mouse_move event will determine the constrain_direction.
constrain_direction = Enum(None, 'x', 'y')
- constrain_key
The modifier key that, if depressed when the drag is initiated, constrains the panning to happen in the only direction of largest initial motion. It is possible to permanently restrict this tool to always drag along one direction. To do so, set constrain=True, constrain_key=None, and constrain_direction to the desired direction.
constrain_key = Enum(None, 'shift', 'control', 'alt')
- drag_button
The mouse button that initiates the drag operation.
drag_button = Enum('left', 'middle', 'right')
- drag_pointer
The cursor to use when panning.
drag_pointer = Pointer('hand')
- draw_mode
The tool does not have a visual representation (overrides BaseTool).
draw_mode = 'none'
- event_state
The possible event states of this tool (overrides enable.Interactor).
event_state = Enum('normal', 'panning')
- speed
Scaling factor on the panning "speed".
speed = Float(1.0)
- visible
The tool is not visible (overrides BaseTool).
visible = False
Inherited from base classes
Method summary
- normal_left_down(self, event)
- normal_middle_down(self, event)
- normal_right_down(self, event)
- panning_left_up(self, event)
- panning_middle_up(self, event)
- panning_mouse_leave(self, event)
- panning_mouse_move(self, event)
- panning_right_up(self, event)
Inherited from base classes
- __deepcopy__(self, memo)
- __getstate__(self)
- __init__(self, component = None, **kwtraits)
- __prefix_trait__(self, name, is_set)
- __reduce_ex__(self, protocol)
- __setstate__(self, state, trait_change_notify = True)
- add_class_trait(cls, name, *trait)
- add_trait(self, name, *trait)
- add_trait_category(cls, category)
- add_trait_listener(self, object, prefix = '')
- all_trait_names(self)
- base_trait(self, name)
- class_default_traits_view(cls)
- class_editable_traits(cls)
- class_trait_names(cls, **metadata)
- class_trait_view(cls, name = None, view_element = None)
- class_trait_view_elements(cls)
- class_traits(cls, **metadata)
- clone_traits(self, traits = None, memo = None, copy = None, **metadata)
- configure_traits(self, filename = None, view = None, kind = None, edit = True, context = None, handler = None, id = '', scrollable = None, **args)
- copy_traits(self, other, traits = None, memo = None, copy = None, **metadata)
- copyable_trait_names(self, **metadata)
- deactivate(self, component = None)
- default_traits_view(self)
- dispatch(self, event, suffix)
- draw(self, gc, view_bounds = None)
- edit_traits(self, view = None, parent = None, kind = None, context = None, handler = None, id = '', scrollable = None, **args)
- editable_traits(self)
- get_event_transform(self, event = None, suffix = '')
- has_traits_interface(self, *interfaces)
- on_trait_change(self, handler, name = None, remove = False, dispatch = 'same', priority = False, deferred = False)
- print_traits(self, show_help = False, **metadata)
- remove_trait(self, name)
- remove_trait_listener(self, object, prefix = '')
- reset_traits(self, traits = None, **metadata)
- set_trait_dispatch_handler(cls, name, klass, override = False)
- sync_trait(self, trait_name, object, alias = None, mutual = True, remove = False)
- trait(self, name, force = False, copy = False)
- trait_context(self)
- trait_get(self, *names, **metadata)
- trait_monitor(cls, handler, remove = False)
- trait_names(self, **metadata)
- trait_set(self, trait_change_notify = True, **traits)
- trait_setq(self, **traits)
- trait_subclasses(cls, all = False)
- trait_view(self, name = None, view_element = None)
- trait_view_elements(self)
- trait_views(self, klass = None)
- traits(self, **metadata)
- validate_trait(self, name, value)
Methods
- normal_left_down(self, event)
Handles the left mouse button being pressed when the tool is in the 'normal' state.
Starts panning if the left mouse button is the drag button.
- normal_middle_down(self, event)
Handles the middle mouse button being pressed when the tool is in the 'normal' state.
Starts panning if the middle mouse button is the drag button.
- normal_right_down(self, event)
Handles the right mouse button being pressed when the tool is in the 'normal' state.
Starts panning if the right mouse button is the drag button.
- panning_left_up(self, event)
Handles the left mouse button coming up when the tool is in the 'panning' state.
Stops panning if the left mouse button is the drag button.
- panning_middle_up(self, event)
Handles the middle mouse button coming up when the tool is in the 'panning' state.
Stops panning if the middle mouse button is the drag button.
- panning_mouse_leave(self, event)
Handles the mouse leaving the plot when the tool is in the 'panning' state.
Ends panning.
- panning_mouse_move(self, event)
Handles the mouse being moved when the tool is in the 'panning' state.
- panning_right_up(self, event)
Handles the right mouse button coming up when the tool is in the 'panning' state.
Stops panning if the right mouse button is the drag button.