Source code for jdxi_editor.ui.widgets.spec

"""
Widget Specs
"""

from dataclasses import dataclass
from typing import Any, Optional

from picomidi.sysex.parameter.address import AddressParameter


@dataclass


class FilterWidgetSpec:
    """Filter Widget Spec"""



    cutoff_param: AddressParameter = None



    name: Optional[str] = None



    slope_param: Optional[AddressParameter] = (
        None  # Analog doesn't have a slope parameter
    )




@dataclass


class FilterSpec:
    """Class representing the specification for a filter mode."""



    name: str  # Filter mode name (e.g., "Low Pass", "High Pass", etc.)



    param: Optional[AddressParameter]  # Associated parameter (if applicable)



    icon: str  # Icon used for the filter mode



    description: Optional[str] = None  # Optional description or tooltip text




@dataclass(frozen=True)


class SliderSpec:
    """Class representing the specification for a slider."""



    param: Any



    label: str



    vertical: bool = True



    icon_name: str = None




@dataclass(frozen=True)


class SwitchSpec:
    """Class representing the specification for a switch."""



    param: Any



    label: str



    options: Any




@dataclass(frozen=True)


class ComboBoxSpec:
    """Class representing the specification for a combo box."""



    param: Any



    label: str



    options: Any = None



    values: Any = None




@dataclass(frozen=True)


class PWMSpec:
    """Spec for PWM widget: pulse width and modulation depth parameters."""



    pulse_width_param: AddressParameter



    mod_depth_param: AddressParameter




@dataclass(frozen=True)


class PitchEnvelopeSpec:
    """Spec for Pitch Envelope widget: attack, decay, and depth parameters."""



    attack_param: AddressParameter



    decay_param: AddressParameter



    depth_param: AddressParameter