Source code for cytoflowgui.view_plugins.i_view_plugin

#!/usr/bin/env python3.8
# coding: latin-1

# (c) Massachusetts Institute of Technology 2015-2018
# (c) Brian Teague 2018-2022
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <>.



from traits.api import Interface, Constant, List
from envisage.api import Plugin, ExtensionPoint


[docs]class IViewPlugin(Interface): """ Attributes ---------- id : Str The envisage ID used to refer to this plugin view_id : Str Same as the "id" attribute of the IView this plugin wraps Prefix: short_name : Str The view's "short" name - for menus, toolbar tips, etc. """ id = Constant view_id = Constant short_name = Constant
[docs] def get_view(self): """ Gets the IView instance that this plugin wraps. Returns ------- `IView` An instance of the view that this plugin wraps """
[docs] def get_handler(self, model): """ Gets an instance of the handler for this view or params model. NOTE: You have to check to see what the class of ``model`` is, and return an appropriate handler! Parameters ---------- model : IWorkflowView The model to associate with this handler. context : WorkflowItem The WorkflowItem that this model is a part of. Returns ------- `traitsui.handler.Controller` """
[docs] def get_icon(self): """ Returns an icon for this plugin Returns ------- `pyface.i_image_resource.IImageResource` The SVG icon """
[docs] def get_help(self): """ Gets the HTML help text for this plugin, deriving the filename from the class name. Probably best to use the default implementation in `cytoflowgui.view_plugins.view_plugin_base.PluginHelpMixin` Returns ------- string The HTML help, in a single string. """
[docs] def get_plugin(self): """ Returns an instance of `envisage.plugin.Plugin` implementing `IViewPlugin`. Usually returns ``self``. Returns ------- `envisage.plugin.Plugin` """
[docs]class ViewPluginManager(Plugin): view_plugins = ExtensionPoint(List(IViewPlugin), VIEW_PLUGIN_EXT)