cytoflowgui.view_plugins.i_view_plugin

class cytoflowgui.view_plugins.i_view_plugin.IViewPlugin

Bases: Interface

id

The envisage ID used to refer to this plugin

Type:

Str

view_id

Same as the “id” attribute of the IView this plugin wraps Prefix: cytoflowgui.view

Type:

Str

name

The view’s name - for menus, toolbar tips, etc.

Type:

Str

short_name

The view’s “short” name - for under the tool on the toolbar. Max 8 characters.

Type:

Str

get_view()

Gets the IView instance that this plugin wraps.

Returns:

An instance of the view that this plugin wraps

Return type:

IView

get_handler(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.

Return type:

traitsui.handler.Controller

get_icon()

Returns an icon for this plugin

Returns:

The SVG icon

Return type:

pyface.i_image_resource.IImageResource

get_help()

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:

The HTML help, in a single string.

Return type:

string

get_plugin()

Returns an instance of envisage.plugin.Plugin implementing IViewPlugin. Usually returns self.

Return type:

envisage.plugin.Plugin

class cytoflowgui.view_plugins.i_view_plugin.ViewPluginManager

Bases: Plugin