Inherits from
- BaseTool: enthought.enable.base_tool.BaseTool
Attributes
- area
The width/height of the border or corner area. (Corners are assumed to be square.)
area = Float(35.0)
- area_type
Defines the part of the component that the hover tool will listen
area_type = Enum('top', 'bottom', 'left', 'right', 'borders', 'UL', 'UR', 'LL', 'LR', 'corners')
- callback
The action to perform when the hover activates. This can be used instead of subclassing and overriding on_hover(). If cb_param is not None, then the callback gets passed it as its single parameter.
callback = Callable
- cb_param
An optional parameter that gets passed to the callback.
cb_param = Any
- hover_delay
The number of milliseconds that the user has to keep the mouse within the hover threshold before a hover is triggered.
hover_delay = Int(500)
- hover_threshold
Controls the mouse sensitivity; if the mouse moves less than the threshold amount in X or Y, then the hover timer is not reset.
hover_threshold = Int(5)
Inherited from base classes
Method summary
- normal_mouse_move(self, event)
- on_hover(self)
- on_timer(self, event)
- restart_hover_timer(self, event)
Inherited from base classes
- __deepcopy__(self, memo)
- __getstate__(self)
- __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)
- default_traits_view(self)
- 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_mouse_move(self, event)
- on_hover(self)
This gets called when all the conditions of the hover action have been met, and the tool determines that the mouse is, in fact, hovering over a target region on the component.
By default, this method call self.callback (if one is configured).
- on_timer(self, event)
- restart_hover_timer(self, event)