DoubleSpinBox Class Reference

Description

SpinBox for DoubleDescriptors, supporting units.

Definition at line 22 of file DoubleSpinBox.h.

Inheritance diagram for DoubleSpinBox:

Collaboration diagram for DoubleSpinBox:

Signals
void	baseValueChanged (double newBaseValue)
	Emitted whenever the value changes. More...

Public Member Functions
	DoubleSpinBox (QWidget *parent, const DoubleDescriptor &d)
	Create a DoubleSpinBox with the information found in a DoubleDescriptor. More...
Unit	baseUnit () const
	Returns the unit of the contained DoubleDescriptor. More...
QString	displayUnitAsString () const
	The display unit as human readable string. More...
void	setBaseValue (double baseValue)
	Set the base value (unit is the one of the contained descriptor). More...
void	setDisplayUnit (Unit displayUnit)
	Set a display unit. More...
void	updateValue ()
	Update the shown value to the one contained in the value descriptor. More...
const DoubleDescriptor &	valueDescriptor () const
	The descriptor on which this spinbox operates. More...

Protected Member Functions
void	wheelEvent (QWheelEvent *event) override

Private Member Functions
void	onDisplayValueChanged (double newDisplayValue)
double	toBaseValue (double displayValue) const
double	toDisplayValue (double baseValue) const

Private Attributes
Unit	m_displayUnit = Unit::unitless
bool	m_showUnitAsSuffix = false
	it was decided to not show the unit as a suffix. However, this may be user selectable once, therefore the code is kept and controlled by this flag More...
DoubleDescriptor	m_valueDescriptor

Constructor & Destructor Documentation

DoubleSpinBox()

DoubleSpinBox::DoubleSpinBox	(	QWidget *	parent,
		const DoubleDescriptor &	d
	)

Create a DoubleSpinBox with the information found in a DoubleDescriptor.

The spin box will be fully initialized (tooltip, limits, unit, current value, size policy). Furthermore, the spin box will prohibit accidental changes by the mouse wheel. Otherwise it would be dangerous if the spin box is on a scrollable form - unintended and unnoticed changes would take place when just scrolling through the form.

Definition at line 19 of file DoubleSpinBox.cpp.

    : QDoubleSpinBox(parent)
    , m_valueDescriptor(d)
{
    setFocusPolicy(Qt::StrongFocus);
    GUI::View::EditUtil::configSpinbox(this, d.decimals, d.limits);
    setToolTip(d.tooltip);
    setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Fixed);
 
    if (std::holds_alternative<QString>(m_valueDescriptor.unit))
        setDisplayUnit(Unit::other);
    else
        setDisplayUnit(std::get<Unit>(m_valueDescriptor.unit));
 
    QObject::connect(this, QOverload<double>::of(&QDoubleSpinBox::valueChanged), this,
                     &DoubleSpinBox::onDisplayValueChanged);
}

References GUI::View::EditUtil::configSpinbox(), DoubleDescriptor::decimals, DoubleDescriptor::limits, m_valueDescriptor, onDisplayValueChanged(), other, setDisplayUnit(), DoubleDescriptor::tooltip, and DoubleDescriptor::unit.

Here is the call graph for this function:

Member Function Documentation

baseUnit()

Unit DoubleSpinBox::baseUnit

(

)

const

Returns the unit of the contained DoubleDescriptor.

If the unit is defined as a string, this method returns Unit::other. To get the string, use valueDescriptor().unit

Definition at line 94 of file DoubleSpinBox.cpp.

{
    if (std::holds_alternative<QString>(m_valueDescriptor.unit))
        return Unit::other;
 
    return std::get<Unit>(m_valueDescriptor.unit);
}

References m_valueDescriptor, other, and DoubleDescriptor::unit.

Referenced by toBaseValue(), toDisplayValue(), and MultiLayerForm::updateUnits().

baseValueChanged

void DoubleSpinBox::baseValueChanged ( double  newBaseValue )

signal

Emitted whenever the value changes.

newBaseValue is in the unit of the valueDescriptor.

Referenced by AxisPropertyEditor::AxisPropertyEditor(), RectangularDetectorEditor::RectangularDetectorEditor(), MaskEditorPropertyPanel::addMaskSpinBox(), LayerEditorUtils::addMultiPropertyToGrid(), EnvironmentEditor::createBackgroundWidgets(), DistributionSelector::createDistributionWidgets(), MinimizerSettingsWidget::createDoubleSpinbox(), IntensityDataPropertyWidget::createDoubleSpinbox(), SpecularDataPropertyWidget::createDoubleSpinbox(), FootprintCorrectionEditor::createFootprintWidgets(), ResolutionFunctionEditor::createResolutionWidgets(), DistributionSelector::createSpinBox(), DetectorAlignmentEditor::createSpinBox(), GUI::Util::createSpinBox(), PolarizationAnalysisEditor::createSpinBox(), FormLayouter::insertValue(), and onDisplayValueChanged().

displayUnitAsString()

QString DoubleSpinBox::displayUnitAsString

(

)

const

The display unit as human readable string.

Definition at line 63 of file DoubleSpinBox.cpp.

{
    if (std::holds_alternative<QString>(m_valueDescriptor.unit))
        return std::get<QString>(m_valueDescriptor.unit);
 
    return unitAsString(m_displayUnit);
}

References m_displayUnit, m_valueDescriptor, DoubleDescriptor::unit, and unitAsString().

Referenced by setDisplayUnit(), and LayerEditorUtils::updateLabelUnit().

Here is the call graph for this function:

onDisplayValueChanged()

void DoubleSpinBox::onDisplayValueChanged ( double  newDisplayValue )

private

Definition at line 89 of file DoubleSpinBox.cpp.

{
    emit baseValueChanged(toBaseValue(newDisplayValue));
}

References baseValueChanged(), and toBaseValue().

Referenced by DoubleSpinBox().

Here is the call graph for this function:

setBaseValue()

void DoubleSpinBox::setBaseValue

(

double

baseValue

)

Set the base value (unit is the one of the contained descriptor).

Definition at line 76 of file DoubleSpinBox.cpp.

{
    setValue(toDisplayValue(baseValue));
}

References toDisplayValue().

Referenced by SampleEditorController::setDoubleFromUndo(), and updateValue().

Here is the call graph for this function:

setDisplayUnit()

void DoubleSpinBox::setDisplayUnit

(

Unit

displayUnit

)

Set a display unit.

The caller has to make sure that the new display unit has a conversion to/from the contained base value unit.

Definition at line 37 of file DoubleSpinBox.cpp.

{
    m_displayUnit = displayUnit;
 
    if (m_showUnitAsSuffix) {
        const QString suffix = displayUnitAsString();
        if (suffix.isEmpty())
            setSuffix("");
        else
            setSuffix(" " + suffix);
    }
 
    QSignalBlocker b(this);
    setValue(toDisplayValue(m_valueDescriptor.get()));
}

References displayUnitAsString(), DoubleDescriptor::get, m_displayUnit, m_showUnitAsSuffix, m_valueDescriptor, and toDisplayValue().

Referenced by DoubleSpinBox(), and MultiLayerForm::updateUnits().

Here is the call graph for this function:

toBaseValue()

double DoubleSpinBox::toBaseValue ( double  displayValue ) const

private

Definition at line 58 of file DoubleSpinBox.cpp.

{
    return convert(displayValue, m_displayUnit, baseUnit());
}

References baseUnit(), convert(), and m_displayUnit.

Referenced by onDisplayValueChanged().

Here is the call graph for this function:

toDisplayValue()

double DoubleSpinBox::toDisplayValue ( double  baseValue ) const

private

Definition at line 53 of file DoubleSpinBox.cpp.

{
    return convert(baseValue, baseUnit(), m_displayUnit);
}

References baseUnit(), convert(), and m_displayUnit.

Referenced by setBaseValue(), and setDisplayUnit().

Here is the call graph for this function:

updateValue()

void DoubleSpinBox::updateValue

(

)

Update the shown value to the one contained in the value descriptor.

No signal will be emitted if the new value has changed.

Definition at line 102 of file DoubleSpinBox.cpp.

{
    QSignalBlocker b(this);
    setBaseValue(m_valueDescriptor.get());
}

References DoubleDescriptor::get, m_valueDescriptor, and setBaseValue().

Referenced by AxisPropertyEditor::updateData(), and ParticleLayoutForm::updateDensityValue().

Here is the call graph for this function:

valueDescriptor()

const DoubleDescriptor & DoubleSpinBox::valueDescriptor

(

)

const

The descriptor on which this spinbox operates.

Definition at line 71 of file DoubleSpinBox.cpp.

{
    return m_valueDescriptor;
}

References m_valueDescriptor.

Referenced by SampleEditorController::setDoubleFromUndo().

wheelEvent()

void DoubleSpinBox::wheelEvent ( QWheelEvent *  event )

overrideprotected

Definition at line 81 of file DoubleSpinBox.cpp.

{
    if (!hasFocus())
        event->ignore();
    else
        QDoubleSpinBox::wheelEvent(event);
}

Member Data Documentation

m_displayUnit

Unit DoubleSpinBox::m_displayUnit = Unit::unitless

private

Definition at line 77 of file DoubleSpinBox.h.

Referenced by displayUnitAsString(), setDisplayUnit(), toBaseValue(), and toDisplayValue().

m_showUnitAsSuffix

bool DoubleSpinBox::m_showUnitAsSuffix = false

private

it was decided to not show the unit as a suffix. However, this may be user selectable once, therefore the code is kept and controlled by this flag

Definition at line 83 of file DoubleSpinBox.h.

Referenced by setDisplayUnit().

m_valueDescriptor

DoubleDescriptor DoubleSpinBox::m_valueDescriptor

private

Definition at line 79 of file DoubleSpinBox.h.

Referenced by DoubleSpinBox(), baseUnit(), displayUnitAsString(), setDisplayUnit(), updateValue(), and valueDescriptor().

---

The documentation for this class was generated from the following files:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Common/DoubleSpinBox.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Common/DoubleSpinBox.cpp