pyqt_reactive.forms.object_form_document_renderer

Render one or more ObjectState-backed objects as read-only forms.

Classes

ObjectFormDocument(title, entries[, ...])

A read-only object-form document with one or more selectable entries.

ObjectFormDocumentRenderer(context)

Render an ObjectFormDocument into an existing Qt layout.

ObjectFormEntry(name, object_instance[, summary])

One named object rendered by ObjectFormDocumentRenderer.

ObjectFormRenderContext(parent[, scope_id, ...])

Rendering context for ObjectState-backed read-only forms.

class pyqt_reactive.forms.object_form_document_renderer.ObjectFormEntry(name: str, object_instance: T, summary: str | None = None)[source]

One named object rendered by ObjectFormDocumentRenderer.

name: str
object_instance: T
summary: str | None
__init__(name: str, object_instance: T, summary: str | None = None) None
class pyqt_reactive.forms.object_form_document_renderer.ObjectFormDocument(title: str, entries: tuple[ObjectFormEntry[T], ...], selector_label: str = 'Entry:')[source]

A read-only object-form document with one or more selectable entries.

title: str
entries: tuple[ObjectFormEntry[T], ...]
selector_label: str
__init__(title: str, entries: tuple[ObjectFormEntry[T], ...], selector_label: str = 'Entry:') None
class pyqt_reactive.forms.object_form_document_renderer.ObjectFormRenderContext(parent: QWidget, scope_id: str | None = None, color_scheme: ColorScheme | None = None, exclude_params: tuple[str, ...] = ())[source]

Rendering context for ObjectState-backed read-only forms.

parent: QWidget
scope_id: str | None
color_scheme: ColorScheme | None
exclude_params: tuple[str, ...]
__init__(parent: QWidget, scope_id: str | None = None, color_scheme: ColorScheme | None = None, exclude_params: tuple[str, ...] = ()) None
class pyqt_reactive.forms.object_form_document_renderer.ObjectFormDocumentRenderer(context: ObjectFormRenderContext)[source]

Render an ObjectFormDocument into an existing Qt layout.

__init__(context: ObjectFormRenderContext) None[source]
render(layout: QVBoxLayout, document: ObjectFormDocument[T]) None[source]