Inherits from
- BaseTool: enthought.enable.base_tool.BaseTool
Attributes
- cancel_keys
These keys, if pressed during drag, cause the drag operation to reset.
cancel_keys = Tuple('Esc')
- capture_mouse
Whether or not to capture the mouse during the drag operation. In general this is a good idea.
capture_mouse = Bool(True)
- drag_button
The mouse button used for this drag operation.
drag_button = Enum('left', 'right')
- end_drag_on_leave
End the drag operation if the mouse leaves the associated component?
end_drag_on_leave = Bool(True)
- modifier_key
The modifier key that must be used to activate the tool.
modifier_key = Enum('none', 'shift', 'alt', 'control')
- mouse_down_position
The position of the initial mouse click that started the drag. Typically, tools that move things around use this position to do hit-testing to determine what object to "pick up".
mouse_down_position = Tuple(0.0, 0.0)
Inherited from base classes
Method summary
- drag_cancel(self, event)
- drag_end(self, event)
- drag_start(self, event)
- dragging(self, event)
- is_draggable(self, x, y)
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
- drag_cancel(self, event)
Called when the drag is cancelled.
A drag is usually cancelled by receiving a mouse_leave event when end_drag_on_leave is True, or by the user pressing any of the cancel_keys.
- drag_end(self, event)
Called when a mouse event causes the drag operation to end.
- drag_start(self, event)
Called when the drag operation starts.
The event parameter is the mouse event that established the drag operation; its x and y attributes correspond to the current location of the mouse, and not to the position of the mouse when the initial left_down or right_down event happened.
- dragging(self, event)
This method is called for every mouse_move event that the tool receives while the user is dragging the mouse.
It is recommended that subclasses do most of their work in this method.
- is_draggable(self, x, y)
Returns whether the (x,y) position is in a region that is OK to drag.
Used by the tool to determine when to start a drag.