Inherits from
- Interactor: enthought.enable2.interactor.Interactor
Attributes
- component
The component that this tool is attached to.
component = Instance(PlotComponent)
- draw_mode
How the tool draws on top of its component. This, in conjuction with a a tool's status on the component, is used by the component to determine how to render itself. In general, the meanings of the draw modes are:
- normal:
- The appearance of part of the component is modified such that the component is redrawn even if it has not otherwise received any indication that its previous rendering is invalid. The tool controls its own drawing loop, and calls out to this tool after it is done drawing itself.
- overlay:
- The component needs to be drawn, but can be drawn after all of the background and foreground elements in the component. Furthermore, the tool renders correctly regardless of how the component renders itself (e.g., via a cached image). The overlay gets full control of the rendering loop, and must explicitly call the component's _draw() method; otherwise the component does not render.
- none:
- The tool does not have a visual representation that the component needs to render.
draw_mode = Enum('none', 'overlay', 'normal')
- visible
Is this tool's visual representation visible? For passive inspector-type tools, this is a constant value set in the class definition; for stateful or modal tools, the tool's listener sets this attribute.
visible = false
Inherited from base classes
Method summary
- __init__(self, component = None, **kwtraits)
- deactivate(self, component = None)
- dispatch(self, event, suffix)
- draw(self, gc, view_bounds = None)
Inherited from base classes
- __deepcopy__(self, memo)
- __getstate__(self)
- __prefix_trait__(self, name)
- __reduce_ex__(self, protocol)
- __setstate__(self, state)
- 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(self, *names, **metadata)
- on_trait_change(self, handler, name = None, remove = False, dispatch = 'same')
- print_traits(self, show_help = False, **metadata)
- remove_trait(self, name)
- remove_trait_listener(self, object, prefix = '')
- reset_traits(self, traits = None, **metadata)
- set(self, trait_change_notify = True, **traits)
- 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_monitor(cls, handler, remove = False)
- trait_names(self, **metadata)
- 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
- __init__(self, component = None, **kwtraits)
- deactivate(self, component = None)
Handles this component no longer being the active tool.
- dispatch(self, event, suffix)
Dispatches a mouse event based on the current event state.
Overrides enable2.Interactor.
- draw(self, gc, view_bounds = None)
Draws this tool on a graphics context.
It is assumed that the graphics context has a coordinate transform that matches the origin of its component. (For containers, this is just the origin; for components, it is the origin of their containers.)