Skip to content
  • API documentation
  • careamics_napari
  • widgets
  • utils

utils

Win #

Bases: QWidget

docstring for Win

Source code in src/careamics_napari/widgets/utils.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
class Win(QWidget):
    """docstring for Win""" ""

    def __init__(self):
        super().__init__()
        line_edit = QLineEdit()
        # line_edit.setText(config.data_config.axes)
        btn = QPushButton("Test")
        btn.clicked.connect(lambda: print(self.axes))
        vbox = QVBoxLayout()
        vbox.addWidget(line_edit)
        vbox.addWidget(btn)
        self.setLayout(vbox)

        type(self).axes = bind(
            line_edit,
            "text",
            default_value=config.data_config.axes,  # type: ignore
            validation_fn=are_axes_valid,
        )
        self.axes = config.data_config.axes  # type: ignore

bind(widget, prop_name, default_value=None, validation_fn=None) #

Returns a property bound to the given widget.

This can be used as a general way to bind a widget property to a class property. So that when the class property is accessed, it gets the value from the widget, and when the class property is set, it sets the value in the widget. In this way, we don't need to watch for widget's value changed signals to update the class attributes.

Returns:

Type Description
property: A property
Source code in src/careamics_napari/widgets/utils.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def bind(
    widget: QWidget,
    prop_name: str,
    default_value: Any | None = None,
    validation_fn: Callable | None = None,
) -> property:
    """Returns a property bound to the given widget.

    This can be used as a general way to bind a widget property to a class property.
    So that when the class property is accessed, it gets the value from the widget,
    and when the class property is set, it sets the value in the widget.
    In this way, we don't need to watch for widget's value changed signals
    to update the class attributes.

    Parameters
    ----------
        widget: QWidget
            The widget whose property we want to bind to
        prop_name: str
            The name of the property in the widget (e.g. text)
        default_value: Any (optional)
            The default value to be used when the widget value is not valid.
            Defaults to None.
        validation_fn: Callable (optional)
        The validation function to check if the widget value is valid
        (must return a boolean). Defaults to None.

    Returns
    -------
        property: A property
    """

    def getter(self):
        ui_value = widget.property(prop_name)
        if validation_fn:
            if not validation_fn(ui_value):
                print(f"Invalid input: {ui_value}")
                ui_value = default_value

        return ui_value

    def setter(self, value):
        widget.setProperty(prop_name, value)

    return property(fget=getter, fset=setter)