qpuiq 0.10__tar.gz → 0.24__tar.gz

{qpuiq-0.10 → qpuiq-0.24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qpuiq
-Version: 0.10
+Version: 0.24
 Summary: "PUI" Python Declarative UI Framework
 Home-page: https://github.com/buganini/PUI
 Author: Buganini Chiu
@@ -17,8 +17,23 @@ PUI doesn't do UI itself, it turns imperative UI libraries into reactive/declara
 [CPPUI: Experimental C++ Version](https://github.com/buganini/CPPUI)
 
 # Installation
-```
+``` shell
 pip install QPUIQ
+
+# Optional, for hot-reload
+pip install jurigged
+
+# Optional, for PySide6 backend
+pip install PySide6
+
+# Optional, for textual backend
+pip install textual
+
+# Optional, for wxPython backend
+pip install wxPython
+
+# Optional, for flet backend
+pip install flet
 ```
 
 # Get Started
@@ -190,38 +205,30 @@ Then PUI will take care of view update [(code)](https://github.com/buganini/PUI/
 * textual (Text Mode)
     * no canvas
 
-# Components
-[Reference](REFERENCE.md)
+# Documents
+* [Components Reference](https://buganini.github.io/PUI/doc/Reference.html)
+* [Layout Strategy](https://buganini.github.io/PUI/doc/Layout.html)
 
 # Used by
-* https://github.com/buganini/kikit-ui
+* https://github.com/buganini/Kikakuka
 * https://github.com/solvcon/modmesh
 
 # TODO
-* Merge node and view
 * Dump with layout parameters and add test cases
 * [Toga](https://beeware.org/project/projects/libraries/toga/)
-* [ISSUE] textual layout sizing (cookbook scroll example)
 * [ISSUE] flet layout sizing (cookbook scroll example)
 * nested state trigger
     * set state in PUIView __init__
     * set state in setup() ?
 * Tabs(`tabposition`)
 * Lazy List
-* StateObject decorator
 * UI Flow
     * Navigation Stack
     * View Router
     * Model Window/Dialog
 * Layout
-    * ZBox
     * SwiftUI style overlay ??
 * Canvas
-    * Rect
     * Arc
-    * Image
     * ...
-* Table
-* Tree
-* Dialog
 * State with Pydantic support?

{qpuiq-0.10 → qpuiq-0.24}/PUI/PySide6/base.py

@@ -72,6 +72,19 @@ class QtPUIView(PUIView):
             self.qt_params[k] = v
         return self
 
+class EventFilter(QtCore.QObject):
+    def __init__(self):
+        super().__init__()
+        self.node = None
+
+    def eventFilter(self, obj, event):
+        node = self.node.get_node()
+        if event.type() == QtCore.QEvent.DragEnter:
+            return node.handleDragEnterEvent(event)
+        elif event.type() == QtCore.QEvent.Drop:
+            return node.handleDropEvent(event)
+        return super().eventFilter(obj, event)
+
 class QtBaseWidget(PUINode):
     pui_terminal = True
 
@@ -89,6 +102,12 @@ class QtBaseWidget(PUINode):
     def update(self, prev=None):
         super().update(prev)
 
+        if prev:
+            self.eventFilter = prev.eventFilter
+        else:
+            self.eventFilter = EventFilter()
+        self.eventFilter.node = self
+
         sizePolicy = self.ui.sizePolicy()
         if self.layout_width is not None:
             sizePolicy.setHorizontalPolicy(QtWidgets.QSizePolicy.Preferred)
@@ -102,6 +121,29 @@ class QtBaseWidget(PUINode):
 
         _apply_params(self.ui, self)
 
+    def postUpdate(self):
+        if self.ui:
+            if self._onDropped:
+                self.ui.setAcceptDrops(True)
+                self.ui.installEventFilter(self.eventFilter)
+            else:
+                self.ui.setAcceptDrops(False)
+        super().postUpdate()
+
+    def handleDragEnterEvent(self, event):
+        if self._onDragEntered:
+            return self._onDragEntered[0](event, *self._onDragEntered[1], **self._onDragEntered[2])
+        else:
+            event.ignore()
+            return True
+
+    def handleDropEvent(self, event):
+        if self._onDropped:
+            return self._onDropped[0](event, *self._onDropped[1], **self._onDropped[2])
+        else:
+            event.ignore()
+            return False
+
     def qtSizeHint(self):
         node = self.get_node()
         if not node.ui:
@@ -120,7 +162,11 @@ class QtBaseWidget(PUINode):
             self.qt_params[k] = v
         return self
 
-class QtBaseLayout(PUINode):
+class QtBaseLayout(QtBaseWidget):
+    pui_terminal = False
+    container_x = False
+    container_y = False
+
     def __init__(self):
         super().__init__()
         self.qt_params = {}
@@ -136,44 +182,61 @@ class QtBaseLayout(PUINode):
         return self.layout
 
     def destroy(self, direct):
-        if direct:
-            if self.ui:
-                self.ui.deleteLater()
         self.layout = None
-        self.ui = None
         super().destroy(direct)
 
     def update(self, prev=None):
+        if prev and prev.ui:
+            self.mounted_children = prev.mounted_children
+        else:
+            self.mounted_children = []
+
         super().update(prev)
-        _apply_params(self.ui, self)
 
     def addChild(self, idx, child):
         from .modal import Modal
         from .layout import Spacer
         if isinstance(child, Spacer):
-            self.layout.insertItem(idx, child.outer)
+            self.qtlayout.insertItem(idx, child.outer)
+            self.mounted_children.insert(idx, child)
         elif isinstance(child, Modal):
             pass
         elif isinstance(child, QtBaseWidget) or isinstance(child, QtBaseLayout):
             params = {}
             if not child.layout_weight is None:
                 params["stretch"] = child.layout_weight
-            self.layout.insertWidget(idx, child.outer, **params)
+            self.qtlayout.insertWidget(idx, child.outer, **params)
+            self.mounted_children.insert(idx, child)
 
     def removeChild(self, idx, child):
         from .modal import Modal
         from .layout import Spacer
         if isinstance(child, Spacer):
-            self.layout.removeItem(child.outer)
+            self.qtlayout.removeItem(child.outer)
+            self.mounted_children.pop(idx)
         elif isinstance(child, Modal):
             pass
         elif isinstance(child, QtBaseWidget) or isinstance(child, QtBaseLayout):
             child.outer.setParent(None)
+            self.mounted_children.pop(idx)
 
-    def qt(self, **kwargs):
-        for k,v in kwargs.items():
-            self.qt_params[k] = v
-        return self
+    def postUpdate(self):
+        if self.ui:
+            if self._onDropped:
+                self.ui.setAcceptDrops(True)
+                self.ui.installEventFilter(self.eventFilter)
+            else:
+                self.ui.setAcceptDrops(False)
+
+        super().postUpdate()
+
+        if self.container_x or self.container_y:
+            for i, child in enumerate(self.mounted_children):
+                child = child.get_node()
+                self.mounted_children[i] = child.get_node()
+
+                weight = child.layout_weight
+                self.qtlayout.setStretch(i, weight if weight else 0)
 
 class QtBaseFrame(QtBaseWidget):
     pui_terminal = False

{qpuiq-0.10 → qpuiq-0.24}/PUI/PySide6/canvas.py

@@ -2,12 +2,11 @@ from .. import *
 from .base import *
 
 from PySide6 import QtWidgets, QtGui
-from PySide6.QtGui import QPainter, QColor, QPainterPath
-from PySide6.QtCore import QPoint
+from PySide6.QtGui import QPainter, QColor, QPainterPath, QImage
 
 class PUIQtCanvas(QtWidgets.QWidget):
     def __init__(self, node, width=None, height=None):
-        self.node = node
+        self.puinode = node
         self.width = width
         self.height = height
         super().__init__()
@@ -19,25 +18,25 @@ class PUIQtCanvas(QtWidgets.QWidget):
         e = PUIEvent()
         e.button = event.button().value
         e.x, e.y = event.position().toPoint().toTuple()
-        self.node._dblclicked(e)
+        self.puinode._dblclicked(e)
 
     def mousePressEvent(self, event):
         e = PUIEvent()
         e.button = event.button().value
         e.x, e.y = event.position().toPoint().toTuple()
-        self.node._mousedown(e)
+        self.puinode._mousedown(e)
 
     def mouseReleaseEvent(self, event):
         e = PUIEvent()
         e.button = event.button().value
         e.x, e.y = event.position().toPoint().toTuple()
-        self.node._mouseup(e)
+        self.puinode._mouseup(e)
 
     def mouseMoveEvent(self, event):
         e = PUIEvent()
         e.button = event.button().value
         e.x, e.y = event.position().toPoint().toTuple()
-        self.node._mousemove(e)
+        self.puinode._mousemove(e)
 
     def wheelEvent(self, event):
         e = PUIEvent()
@@ -46,25 +45,59 @@ class PUIQtCanvas(QtWidgets.QWidget):
         e.x_delta = event.pixelDelta().x()
         e.v_delta = event.angleDelta().y()
         e.h_delta = event.angleDelta().x()
-        self.node._wheel(e)
+        modifier = 0
+        emodifiers = event.modifiers()
+        if emodifiers & QtCore.Qt.ShiftModifier:
+            modifier |= KeyModifier.SHIFT
+        if emodifiers & QtCore.Qt.ControlModifier:
+            modifier |= KeyModifier.CTRL
+        if emodifiers & QtCore.Qt.AltModifier:
+            modifier |= KeyModifier.ALT
+        if emodifiers & QtCore.Qt.MetaModifier:
+            modifier |= KeyModifier.META
+        e.modifiers = modifier
+        self.puinode._wheel(e)
 
     def paintEvent(self, event):
-        node = self.node.get_node()
-        node.qpainter = QPainter()
-        node.qpainter.begin(self)
-        node.qpainter.setRenderHints(QtGui.QPainter.Antialiasing, True)
+        puinode = self.puinode.get_node()
+        puinode.qpainter = QPainter()
+        puinode.qpainter.begin(self)
+        puinode.qpainter.setRenderHints(QtGui.QPainter.Antialiasing, True)
 
-        if not node.style_bgcolor is None:
+        if not puinode.style_bgcolor is None:
             bgBrush = QtGui.QBrush()
-            bgBrush.setColor(QtGui.QColor(node.style_bgcolor))
+            bgBrush.setColor(QtGui.QColor(puinode.style_bgcolor))
             bgBrush.setStyle(QtCore.Qt.SolidPattern)
             rect = QtCore.QRect(0, 0, self.width or self.geometry().width(), self.height or self.geometry().height())
-            node.qpainter.fillRect(rect, bgBrush)
-
-        node.painter(node, *node.args)
-
-        node.qpainter.end()
-        node.qpainter = None
+            puinode.qpainter.fillRect(rect, bgBrush)
+
+        puinode.width = self.geometry().width()
+        puinode.height = self.geometry().height()
+        immediate = puinode.painter(puinode, *puinode.args)
+        puinode.qpainter.end()
+        puinode.qpainter = None
+        if immediate:
+            self.update()
+
+class ImageResource():
+    @staticmethod
+    def load(path):
+        ir = ImageResource()
+        ir.qimage = QImage(path)
+        return ir
+
+    def crop(self, x, y, width, height):
+        ir = ImageResource()
+        ir.qimage = self.qimage.copy(x, y, width, height)
+        return ir
+
+    def scale(self, width, height, keepAspectRatio=True, quality=0):
+        ir = ImageResource()
+        method = {
+            0: QtCore.Qt.TransformationMode.FastTransformation
+        }.get(quality, QtCore.Qt.TransformationMode.SmoothTransformation)
+        ir.qimage = self.qimage.scaled(width, height, QtCore.Qt.AspectRatioMode.KeepAspectRatio if keepAspectRatio else QtCore.Qt.IgnoreAspectRatio, method)
+        return ir
 
 class Canvas(QtBaseWidget):
     def __init__(self, painter, *args):
@@ -286,3 +319,27 @@ class Canvas(QtBaseWidget):
             self.drawPolyline(shape.coords, color=stroke, width=width)
         else:
             raise RuntimeError(f"Not implemented: drawShapely({type(shape).__name__}) {dir(shape)}")
+
+    def loadImage(self, image_path):
+        return ImageResource.load(image_path)
+
+    def drawImage(self, image, x=0, y=0, width=None, height=None, src_x=0, src_y=0, src_width=None, src_height=None, opacity=1.0):
+        if image.qimage.isNull():
+            return
+
+        if src_width is None:
+            src_width = image.qimage.width() - src_x
+        if src_height is None:
+            src_height = image.qimage.height() - src_y
+
+        source_rect = QtCore.QRect(src_x, src_y, src_width, src_height)
+
+        if width is None:
+            width = src_width
+        if height is None:
+            height = src_height
+
+        dest_rect = QtCore.QRect(x, y, width, height)
+        self.qpainter.setOpacity(opacity)
+        self.qpainter.drawImage(dest_rect, image.qimage, source_rect)
+        self.qpainter.setOpacity(1.0)

{qpuiq-0.10 → qpuiq-0.24}/PUI/PySide6/combobox.py

@@ -24,15 +24,18 @@ class ComboBox(QtBaseWidget):
         super().update(prev)
 
     def postSync(self):
+        index = -1
+        text = ""
+
         if self.index_model:
             index = self.index_model.value
             text = self.children[index].text
         elif self.text_model:
             text = str(self.text_model.value)
             try:
-                index = [c.text for c in self.children].index(text)
+                index = [c.value for c in self.children].index(text)
             except:
-                index = 0
+                index = -1
 
         if self.signal_connected:
             self.ui.currentIndexChanged.disconnect()
@@ -51,11 +54,15 @@ class ComboBox(QtBaseWidget):
     def on_currentIndexChanged(self, idx):
         if self.index_model:
             self.index_model.value = idx
+        if self.text_model:
+            self.text_model.value = self.children[idx].value
         e = PUIEvent()
         e.value = idx
         self._change(e)
 
     def on_currentTextChanged(self, text):
+        if not self.editable:
+            return
         if self.text_model:
             self.text_model.value = text
         e = PUIEvent()
@@ -69,7 +76,10 @@ class ComboBox(QtBaseWidget):
         self.ui.removeItem(idx)
 
 class ComboBoxItem(PUINode):
-    def __init__(self, text):
+    def __init__(self, text, value=None):
         super().__init__()
         self.id(text)
         self.text = text
+        if value is None:
+            value = text
+        self.value = value

{qpuiq-0.10 → qpuiq-0.24}/PUI/PySide6/divider.py

@@ -3,6 +3,8 @@ from .base import *
 from .layout import *
 
 class Divider(QtBaseWidget):
+    pui_movable = False
+
     def __init__(self):
         super().__init__()
 

{qpuiq-0.10 → qpuiq-0.24}/PUI/PySide6/image.py

@@ -1,5 +1,8 @@
 from .. import *
 from .base import *
+from .label import ClickableQLabel
+from PySide6.QtWidgets import QSizePolicy
+import os
 
 class Image(QtBaseWidget):
     def __init__(self, path):
@@ -10,13 +13,28 @@ class Image(QtBaseWidget):
     def update(self, prev):
         if prev and prev.ui:
             self.ui = prev.ui
+            self.eventFilter = prev.eventFilter
             self.curr_path = prev.curr_path
+            self.curr_path_mtime = prev.curr_path_mtime
             self.pixmap = prev.pixmap
         else:
-            self.ui = QtWidgets.QLabel()
+            self.ui = ClickableQLabel()
+            self.ui.clicked.connect(self._clicked)
             self.curr_path = Prop()
+            self.curr_path_mtime = Prop()
 
-        if self.curr_path.set(self.path):
+        if self._onClicked:
+            self.ui.setCursor(QtCore.Qt.PointingHandCursor)
+
+        if self.layout_weight:
+            # XXX keep aspect ratio
+            self.ui.setScaledContents(True)
+            self.ui.setSizePolicy(QSizePolicy(QSizePolicy.Policy.Ignored, QSizePolicy.Policy.Ignored))
+        else:
+            self.ui.setScaledContents(False)
+            self.ui.setSizePolicy(QSizePolicy(QSizePolicy.Policy.Preferred, QSizePolicy.Policy.Preferred))
+
+        if self.curr_path.set(self.path) or self.curr_path_mtime.set(os.path.getmtime(self.path)):
             self.pixmap = QtGui.QPixmap(self.path)
             if self.layout_width is not None and self.layout_height is not None:
                 self.pixmap = self.pixmap.scaled(self.layout_width, self.layout_height, QtCore.Qt.KeepAspectRatio, mode=QtCore.Qt.SmoothTransformation)

qpuiq-0.24/PUI/PySide6/layout.py

@@ -0,0 +1,141 @@
+from .. import *
+from .base import *
+
+class Stack(QtBaseLayout):
+    pui_terminal = False
+    pui_reversed_order = True
+
+    def __init__(self):
+        super().__init__()
+        self.qt_params = {}
+        if not isinstance(self.non_virtual_parent, QtBaseLayout):
+            self.layout_padding = (11,11,11,11)
+
+    @property
+    def outer(self):
+        return self.ui
+
+    @property
+    def inner(self):
+        return self.layout
+
+    def destroy(self, direct):
+        self.layout = None
+        super().destroy(direct)
+
+    def update(self, prev=None):
+        if prev and prev.ui:
+            self.ui = prev.ui
+            self.qtlayout = prev.qtlayout
+        else:
+            self.ui = QtWidgets.QWidget()
+            self.qtlayout = QtWidgets.QStackedLayout()
+            self.qtlayout.setStackingMode(QtWidgets.QStackedLayout.StackAll)
+            self.qtlayout.setContentsMargins(0,0,0,0)
+            self.ui.setLayout(self.qtlayout)
+        super().update(prev)
+
+    def addChild(self, idx, child):
+        from .modal import Modal
+        from .layout import Spacer
+        if isinstance(child, Spacer):
+            pass
+        elif isinstance(child, Modal):
+            pass
+        elif isinstance(child, QtBaseWidget) or isinstance(child, QtBaseLayout):
+            self.qtlayout.insertWidget(idx, child.outer)
+            self.mounted_children.insert(idx, child)
+
+    def removeChild(self, idx, child):
+        from .modal import Modal
+        from .layout import Spacer
+        if isinstance(child, Spacer):
+            pass
+        elif isinstance(child, Modal):
+            pass
+        elif isinstance(child, QtBaseWidget) or isinstance(child, QtBaseLayout):
+            child.outer.setParent(None)
+            self.mounted_children.pop(idx)
+
+    def postUpdate(self):
+        if self.ui:
+            if self._onDropped:
+                self.ui.setAcceptDrops(True)
+                self.ui.installEventFilter(self.eventFilter)
+            else:
+                self.ui.setAcceptDrops(False)
+
+        super().postUpdate()
+
+class HBox(QtBaseLayout):
+    container_x = True
+    def update(self, prev):
+        if prev and prev.ui:
+            self.ui = prev.ui
+            self.qtlayout = prev.qtlayout
+        else:
+            self.ui = QtWidgets.QWidget()
+            self.qtlayout = QtWidgets.QHBoxLayout()
+            self.qtlayout.setContentsMargins(0,0,0,0)
+            self.ui.setLayout(self.qtlayout)
+        super().update(prev)
+
+class VBox(QtBaseLayout):
+    container_y = True
+    def update(self, prev):
+        if prev and prev.ui:
+            self.ui = prev.ui
+            self.qtlayout = prev.qtlayout
+        else:
+            self.ui = QtWidgets.QWidget()
+            self.qtlayout = QtWidgets.QVBoxLayout()
+            self.qtlayout.setContentsMargins(0,0,0,0)
+            self.ui.setLayout(self.qtlayout)
+        super().update(prev)
+
+class Spacer(PUINode):
+    pui_terminal = True
+    pui_movable = False
+
+    def update(self, prev):
+        if prev and prev.ui:
+            self.ui = prev.ui
+        else:
+            if isinstance(self.non_virtual_parent, VBox):
+                self.ui = QtWidgets.QSpacerItem(0, 0, QtWidgets.QSizePolicy.Preferred, QtWidgets.QSizePolicy.Expanding)
+            elif isinstance(self.non_virtual_parent, HBox):
+                self.ui = QtWidgets.QSpacerItem(0, 0, QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Preferred)
+            else:
+                self.ui = QtWidgets.QSpacerItem(0, 0, QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Expanding)
+        super().update(prev)
+
+    def destroy(self, direct):
+        # self.ui.deleteLater() # QSpacerItem doesn't have .deleteLater()
+        self.ui = None
+        super().destroy(direct)
+
+class Grid(QtBaseLayout):
+    pui_grid_layout = True
+
+    def update(self, prev):
+        if prev and prev.ui:
+            self.ui = prev.ui
+            self.layout = prev.layout
+        else:
+            self.ui = QtWidgets.QWidget()
+            self.layout = QtWidgets.QGridLayout()
+            self.layout.setContentsMargins(0,0,0,0)
+            self.ui.setLayout(self.layout)
+        super().update(prev)
+
+    def addChild(self, idx, child):
+        if isinstance(child, QtBaseWidget) or isinstance(child, QtBaseLayout):
+            self.layout.addWidget(child.outer, child.grid_row, child.grid_column, child.grid_rowspan or 1, child.grid_columnspan or 1)
+        elif child.children:
+            self.addChild(idx, child.children[0])
+
+    def removeChild(self, idx, child):
+        if isinstance(child, QtBaseWidget) or isinstance(child, QtBaseLayout):
+            child.outer.setParent(None)
+        elif child.children:
+            self.removeChild(idx, child.children[0])

{qpuiq-0.10 → qpuiq-0.24}/PUI/PySide6/scroll.py

@@ -75,7 +75,6 @@ class Scroll(QtBaseWidget):
         if node.destroyed:
             return
         node.children[0].outer.origResizeEvent(event)
-        node.children[0].outer.resizeEvent = self.onUiResized
         if node.horizontal is False:
             if isinstance(node.children[0], QtBaseLayout):
                 node.outer.setMinimumWidth(node.children[0].outer.sizeHint().width())
@@ -88,6 +87,9 @@ class Scroll(QtBaseWidget):
             elif isinstance(node.children[0], QtBaseWidget):
                 node.outer.setMinimumHeight(node.children[0].outer.sizeHint().height())
 
+    def postSync(self):
+        self.children[0].outer.resizeEvent = self.onUiResized
+
     def scrollX(self, pos=0):
         if math.copysign(1, pos) >= 0:
             self.align_x = 0