menus.param_values
==================

.. py:module:: menus.param_values

.. autoapi-nested-parse::

   A module for widgets that hold parameter values. Each of these
   widgets implements the following interface:

   class ParamValue(QWidget):
       valueChanged = Signal(object)

       def update_value(self, value: Any) -> None:
           raise NotImplementedError()

       def get_value(self) -> Any:
           raise NotImplementedError

   This "interface" is only enforced by duck typing, as is the pythonic way.



Classes
-------

.. autoapisummary::

   menus.param_values.StaticParamValue
   menus.param_values.EditableParamValue


Module Contents
---------------

.. py:class:: StaticParamValue

   Bases: :py:obj:`qtpy.QtWidgets.QLabel`


   A widget for holding a parameter value (int or float) that cannot be
   changed from the UI. The valueChanged signal is just to fit my interface
   so that the compound widget can treat the static and editable children
   the same.


   .. py:attribute:: valueChanged


   .. py:method:: update_value(value: int | float | None) -> None


   .. py:method:: get_value() -> int | float


.. py:class:: EditableParamValue(dtype: type, negative: bool = True)

   Bases: :py:obj:`qtpy.QtWidgets.QDoubleSpinBox`


   .. py:attribute:: valueChanged


   .. py:method:: update_value(value: int | float | None) -> None


   .. py:method:: get_value() -> int | float