catalight.analysis.user_inputs.Option

class catalight.analysis.user_inputs.Option(value: tuple | bool | float | str, include: bool, label: str, tooltip: str, widget: QComboBox | QDoubleSpinBox | QLineEdit | QRadioButton)

Bases: object

Generic option to use when building plotting dialogs.

See PlotOptionList for main usage. Multiple Option items are created within PlotOptionList.__init__() to take in common user inputs. New Option items can be created to easily update GUI components for basic UI.

__init__(value: tuple | bool | float | str, include: bool, label: str, tooltip: str, widget: QComboBox | QDoubleSpinBox | QLineEdit | QRadioButton) → None

Methods

__init__(value, include, label, tooltip, widget)

Attributes

value	User supplied value
include	Indicates whether or not to include GUI element
label	String for constructing QLabel(label)
tooltip	String for widget tooltip
widget	Widget used for entering option values

include: bool

Indicates whether or not to include GUI element

label: str

String for constructing QLabel(label)

tooltip: str

String for widget tooltip

value: tuple | bool | float | str

User supplied value

widget: QComboBox | QDoubleSpinBox | QLineEdit | QRadioButton

Widget used for entering option values