Source code for gaphor.diagram.propertypages

"""Adapters for the Property Editor.

To register property pages implemented in this module, it is imported in
gaphor.adapter package.
"""

from __future__ import annotations

import abc
import textwrap
from typing import Iterator

import gaphas.item
from gaphas.segment import Segment
from gi.repository import GObject, Gtk

from gaphor.core import Transaction
from gaphor.core.modeling import Diagram, Element, Presentation, qualifiedName
from gaphor.i18n import gettext, translated_ui_string


class LabelValue(GObject.Object):
    __gtype_name__ = "LabelValue"

    def __init__(self, label, value):
        super().__init__()
        self._label = label
        self._value = value

    @GObject.Property(type=str)
    def label(self):
        return self._label

    @property
    def value(self):
        return self._value


def new_resource_builder(package, property_pages="propertypages"):
    def new_builder(*object_ids, signals=None):
        builder = Gtk.Builder(signals)
        builder.add_objects_from_string(
            translated_ui_string(package, f"{property_pages}.ui"), object_ids
        )
        return builder

    return new_builder


new_builder = new_resource_builder("gaphor.diagram")


class _PropertyPages:
    """Generic handler for property pages.

    Property pages are collected on type.
    """

    def __init__(self) -> None:
        self.pages: list[tuple[type[Element], type[PropertyPageBase]]] = []

    def register(self, subject_type, func=None):
        def reg(func):
            self.pages.append((subject_type, func))
            return func

        return reg(func) if func else reg

    def find(self, subject) -> Iterator[type[PropertyPageBase]]:
        for subject_type, page in self.pages:
            if isinstance(subject, subject_type):
                yield page


PropertyPages = _PropertyPages()


[docs] class PropertyPageBase(abc.ABC): """A property page which can display itself in a notebook.""" order = 100 # Order number, used for ordered display def __init__(self): super().__init__()
[docs] @abc.abstractmethod def construct(self) -> Gtk.Widget | None: """Create the page (Gtk.Widget) that belongs to the Property page. Returns the page's toplevel widget (Gtk.Widget). """
def help_link(builder, help_widget, popover): """Show the help popover for a `Help` link in the property page.""" def on_activate(*_args): builder.get_object(popover).set_visible(True) help = builder.get_object(help_widget) help.set_accessible_role(Gtk.AccessibleRole.BUTTON) click_handler = Gtk.GestureClick.new() click_handler.connect("released", on_activate) help.add_controller(click_handler) def handler_blocking(widget, event_name, widget_handler): changed_id = widget.connect(event_name, widget_handler) def handler_wrapper(func): def _handler(event): widget.handler_block(changed_id) func(event) widget.handler_unblock(changed_id) return _handler return handler_wrapper def _do_unparent(widget, _pspec, watcher): if not widget.props.parent: watcher.unsubscribe_all() def unsubscribe_all_on_destroy(widget, watcher): widget.connect("notify::parent", _do_unparent, watcher) return widget @PropertyPages.register(Diagram) class NamePropertyPage(PropertyPageBase): """An adapter which works for any named item view. It also sets up a table view which can be extended. """ order = 10 def __init__(self, subject, event_manager): assert subject is None or hasattr(subject, "name") super().__init__() self.subject = subject self.event_manager = event_manager self.watcher = subject.watcher() if subject else None def construct(self): if not self.subject: return assert self.watcher builder = new_builder( "name-editor", ) subject = self.subject entry = builder.get_object("name-entry") entry.set_text(subject and subject.name or "") type = builder.get_object("type-label") type.set_text(subject.__class__.__name__) @handler_blocking(entry, "changed", self._on_name_changed) def handler(event): if event.element is subject and event.new_value != entry.get_text(): entry.set_text(event.new_value or "") self.watcher.watch("name", handler) return unsubscribe_all_on_destroy( builder.get_object("name-editor"), self.watcher ) def _on_name_changed(self, entry): with Transaction(self.event_manager): if self.subject.name != entry.get_text(): self.subject.name = entry.get_text() @PropertyPages.register(gaphas.item.Line) class LineStylePage(PropertyPageBase): """Basic line style properties: color, orthogonal, etc.""" order = 400 def __init__(self, item, event_manager): super().__init__() self.item = item self.event_manager = event_manager self.horizontal_button: Gtk.Button def construct(self): builder = new_builder( "line-editor", signals={ "rectilinear-changed": (self._on_orthogonal_change,), "orientation-changed": (self._on_horizontal_change,), }, ) rectilinear_button = builder.get_object("line-rectilinear") horizontal_button = builder.get_object("flip-orientation") self.horizontal_button = horizontal_button rectilinear_button.set_active(self.item.orthogonal) horizontal_button.set_active(self.item.horizontal) horizontal_button.set_sensitive(self.item.orthogonal) return builder.get_object("line-editor") def _on_orthogonal_change(self, button, gparam): with Transaction(self.event_manager): if len(self.item.handles()) < 3: line_segment = Segment(self.item, self.item.diagram) line_segment.split_segment(0) active = button.get_active() self.item.orthogonal = active self.item.request_update() self.horizontal_button.set_sensitive(active) def _on_horizontal_change(self, button, gparam): with Transaction(self.event_manager): self.item.horizontal = button.get_active() self.item.request_update() @PropertyPages.register(Element) class NotePropertyPage(PropertyPageBase): """A facility to add a little note/remark.""" order = 300 def __init__(self, subject, event_manager): self.subject = subject.subject if isinstance(subject, Presentation) else subject self.event_manager = event_manager self.watcher = self.subject and self.subject.watcher() def construct(self): subject = self.subject if not subject: return builder = new_builder("note-editor") text_view = builder.get_object("note") buffer = Gtk.TextBuffer() if subject.note: buffer.set_text(subject.note) text_view.set_buffer(buffer) @handler_blocking(buffer, "changed", self._on_body_change) def handler(event): if not text_view.props.has_focus: buffer.set_text(event.new_value or "") self.watcher.watch("note", handler) text_view.connect("destroy", self.watcher.unsubscribe_all) return builder.get_object("note-editor") def _on_body_change(self, buffer): with Transaction(self.event_manager): self.subject.note = buffer.get_text( buffer.get_start_iter(), buffer.get_end_iter(), False ) @PropertyPages.register(Element) class InternalsPropertyPage(PropertyPageBase): """Show internals. This info may come in handy if you want to code. """ order = 400 def __init__(self, subject): self.subject = subject def construct(self): subject = self.subject if not subject: return builder = new_builder("internals-editor") internals = builder.get_object("internals") if isinstance(subject, Presentation): presentation_text = textwrap.dedent( f"""\ {gettext('Presentation')}: {gettext('class')}: {presentation_class(subject)} {gettext('id')}: {subject.id}""" ) element = subject.subject else: presentation_text = "" element = subject element_text = ( textwrap.dedent( f"""\ {gettext('Model Element')}: {gettext('qname')}: {'.'.join(map(str, qualifiedName(element)))} {gettext('class')}: {model_element_class(element)} {gettext('id')}: {element.id}""" ) if element else "" ) if presentation_text and element_text: internals.set_label(presentation_text + "\n\n" + element_text) else: internals.set_label(presentation_text or element_text) return builder.get_object("internals-editor") def presentation_class(subject): t = type(subject) if t.__module__.startswith("gaphor.UML."): return f"gaphor.UML.diagramitems.{t.__name__}" elif t.__module__.startswith("gaphor.SysML."): return f"gaphor.SysML.diagramitems.{t.__name__}" elif t.__module__.startswith("gaphor.RAAML."): return f"gaphor.RAAML.diagramitems.{t.__name__}" return f"{t.__module__}.{t.__name__}" def model_element_class(subject): t = type(subject) if t.__module__ == "gaphor.UML.uml": return f"gaphor.UML.{t.__name__}" return f"{t.__module__}.{t.__name__}"