cleaning up custom node widget base classes

renamed MWB, IWB to NodeMainWidget and NodeInputWidget respectively

Author: leon-thomm

docs/unused/gui.md

@@ -40,11 +40,11 @@ import ryvencore_qt as rc
 from PySide2.QtWidgets import QPushButton
 
 
-class MyMainWidget(rc.MWB, QPushButton):
+class MyMainWidget(rc.NodeMainWidget, QPushButton):
     def __init__(self, params):
-        rc.MWB.__init__(self, params)
+        rc.NodeMainWidget.__init__(self, params)
         QPushButton.__init__(self)
-        
+
         # then do your stuff like
         self.setEnabled(False)
         self.clicked.connect(self.node.update)

ryvencore_qt/__init__.py

@@ -14,7 +14,7 @@
 
 # customer base classes
 from ryvencore import Node
-from .src.flows.nodes.WidgetBaseClasses import MWB, IWB
+from .src.flows.nodes.WidgetBaseClasses import NodeMainWidget, NodeInputWidget
 
 # gui classes
 from .src.widgets import *

ryvencore_qt/src/flows/nodes/PortItemInputWidgets.py

@@ -1,10 +1,10 @@
 from qtpy.QtGui import QFontMetrics, QFont
 from qtpy.QtWidgets import QSpinBox, QLineEdit, QCheckBox, QComboBox
 
-from .WidgetBaseClasses import IWB
+from .WidgetBaseClasses import NodeInputWidget
 
 
-class DType_IW_Base(IWB):
+class DType_IW_Base(NodeInputWidget):
 
     def __init__(self, params):
         super().__init__(params)

ryvencore_qt/src/flows/nodes/WidgetBaseClasses.py

@@ -2,69 +2,97 @@
 from ryvencore import Data
 
 
-class MWB:
-    """MainWidgetBase"""
+class NodeMainWidget:
+    """Base class for the main widget of a node."""
 
     def __init__(self, params):
         self.node, self.node_item = params
 
     # OVERRIDE
     def get_state(self) -> dict:
+        """
+        *VIRTUAL*
+
+        Return the state of the widget, in a (pickle) serializable format.
+        """
         data = {}
         return data
 
-    # OVERRIDE
     def set_state(self, data: dict):
-        pass
+        """
+        *VIRTUAL*
 
-    # OVERRIDE
-    def remove_event(self):
+        Set the state of the widget, where data corresponds to the dict
+        returned by get_state().
+        """
         pass
 
+    # def remove_event(self):
+    #     """
+    #     *VIRTUAL*
+    #
+    #     Called when the input is removed.
+    #     """
+    #     pass
+
     def update_node(self):
         self.node.update()
 
     def update_node_shape(self):
         self.node_item.update_shape()
 
 
-class IWB:
-    """InputWidgetBase"""
+class NodeInputWidget:
+    """Base class for the input widget of a node."""
 
     def __init__(self, params):
         self.input, self.input_item, self.node, self.node_gui, self.position = \
             params
 
-    # OVERRIDE
-    def get_val(self):
-        """
-        Returns the value that the widget represents for the data input.
-        It has to be (pickle) serializable!
+    def get_state(self) -> dict:
         """
+        *VIRTUAL*
 
-        return None
-
-    # OVERRIDE
-    def get_state(self) -> dict:
+        Return the state of the widget, in a (pickle) serializable format.
+        """
         data = {}
         return data
 
     # OVERRIDE
     def set_state(self, data: dict):
-        pass
+        """
+        *VIRTUAL*
 
-    # OVERRIDE
-    def remove_event(self):
+        Set the state of the widget, where data corresponds to the dict
+        returned by get_state().
+        """
         pass
 
     # OVERRIDE
+    # def remove_event(self):
+    #     pass
+
     def val_update_event(self, val):
+        """
+        *VIRTUAL*
+
+        Called when the input's value is updated through a connection.
+        This can be used to represent the value in the widget.
+        The widget is disabled when the port is connected.
+        """
         pass
 
+    """
+    
+    API methods
+    
+    """
+
     def update_node_input(self, val: Data):
-        # updates the input's default value which is used when
-        # the input is not connected
-        self.input.default = Data(val)
+        """
+        Update the input's value and update the node.
+        """
+        self.input.default = val
         self.input.node.update(self.node.inputs.index(self.input))
 
     def update_node(self):