Source code for cytoflowgui.editors.instance_handler_editor

#!/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 <>.


A `traitsui.editors.instance_editor.InstanceEditor` that allows the handler
to be created at runtime, using a factory.

from pyface.qt import QtGui

from traits.api import HasTraits, Callable
from traitsui.api import InstanceEditor, Handler
from traitsui.qt4.instance_editor import CustomEditor as _InstanceEditor

class _InstanceHandlerEditor(_InstanceEditor):
    Override InstanceEditor to use a factory to get the handler for 
    the instance we're editing. This lets us both change the handler we
    use depending on the instance, as well as look in that handler for
    the view.
    def resynch_editor(self):
        """ Resynchronizes the contents of the editor when the object trait
        changes externally to the editor.
        panel = self._panel
        if panel is not None:
            # Dispose of the previous contents of the panel:
            layout = panel.layout()
            if layout is None:
                layout = QtGui.QVBoxLayout(panel)
                layout.setContentsMargins(0, 0, 0, 0)
            elif self._ui is not None:
                self._ui = None
                child = layout.takeAt(0)
                while child is not None:
                    child = layout.takeAt(0)

                del child

            # Create the new content for the panel:
#             stretch = 0
            value = self.value
            if not isinstance(value, HasTraits):
                str_value = ""
                if value is not None:
                    str_value = self.str_value
                control = QtGui.QLabel(str_value)
                handler = self.factory.handler_factory(value) if self.factory.handler_factory else None

                view = self.view_for(value, self.item_for(value), handler)
                context = value.trait_context()
                if isinstance(value, Handler):
                    handler = value
                context.setdefault("context", self.object)
                context.setdefault("context_handler", self.ui.handler)
                self._ui = ui = view.ui(
                control = ui.control
                self.scrollable = ui._scrollable
                ui.parent = self.ui

#                 if view.resizable or view.scrollable or ui._scrollable:
#                     stretch = 1

            # FIXME: Handle stretch.
    def view_for(self, object, item, handler):  # @ReservedAssignment
        """ Returns the view to use for a specified object.
        view = ""
        if item is not None:
            view = item.get_view()

        if view == "":
            view = self.view

        if handler is None:
            return self.ui.handler.trait_view_for(
      , view, object, self.object_name,
            return handler.trait_view_for(
      , view, object, self.object_name,

[docs]class InstanceHandlerEditor(InstanceEditor): custom_editor_class = _InstanceHandlerEditor handler_factory = Callable """The factory to create this editor's handler"""
[docs] def custom_editor(self, ui, object, name, description, parent): # @ReservedAssignment """ Generates an editor using the "custom" style. """ return _InstanceHandlerEditor( parent, factory=self, ui=ui, object=object, name=name, description=description, )