SelectionContainerForm Class Reference

Description

A widget to contain a selection, defined by a SelectionDescriptor.

This SelectionContainerForm is limited to contain the selection combo box and a list of double values represented by DoubleDescriptors. The list of DoubleDescriptors is queried by calling LayerEditorUtils::doubleDescriptorsOfItem(). To have the correct DoubleDescriptors on this form, you may have to overload this method according to your class and your needs. The overload will expect the template type you defined for SelectionDescriptor.

Example: SelectionDescriptor<RotationItem*> => LayerEditorUtils::doubleDescriptorsOfItem(RotationItem*)

The connection from selection combo -> SelectionDescriptor is made via SampleEditorController::setCurrentIndex(), where a command can be used for undo purposes.

For each DoubleDescriptor, a unit-aware DoubleSpinBox is created. The connection from each spinbox to the DoubleDescriptor is made via SampleEditorController::setDouble(), where a command can be used for undo purposes.

If a more complex selection shall be realized (e.g. with sub-selections or different value types), this class is not sufficient.

Definition at line 100 of file SelectionContainerForm.h.

Inheritance diagram for SelectionContainerForm:

Collaboration diagram for SelectionContainerForm:

Public Member Functions
template<typename T >
	SelectionContainerForm (QWidget *parent, const SelectionDescriptor< T > &d, SampleEditorController *ec)
virtual void	createContent ()

Protected Member Functions
template<typename T >
void	initUI (const SelectionDescriptor< T > &d)

Protected Attributes
QComboBox *	m_combo
SampleEditorController *	m_ec
QGridLayout *	m_gridLayout

Private Member Functions
void	clear ()
	Remove all descriptors from the layout. More...

Private Attributes
function< DoubleDescriptors()>	currentValues = nullptr

Constructor & Destructor Documentation

SelectionContainerForm()

template<typename T >

SelectionContainerForm::SelectionContainerForm ( QWidget *  parent, const SelectionDescriptor< T > &  d, SampleEditorController *  ec  )

inline

Definition at line 103 of file SelectionContainerForm.h.

        : AbstractSelectionContainerForm(parent, ec)
    {
        if (d.currentItem != nullptr)
            currentValues = [=] {
                return LayerEditorUtils::doubleDescriptorsOfItem(d.currentItem());
            };
        else
            currentValues = [] { return DoubleDescriptors(); };
 
        initUI(d);
    }

References SelectionDescriptor< T >::currentItem, currentValues, LayerEditorUtils::doubleDescriptorsOfItem(), and AbstractSelectionContainerForm::initUI().

Here is the call graph for this function:

Member Function Documentation

clear()

void AbstractSelectionContainerForm::clear ( )

inlineprivateinherited

Remove all descriptors from the layout.

Definition at line 66 of file SelectionContainerForm.h.

    {
        auto* layoutItemOfComboBox = m_gridLayout->itemAtPosition(1, 0);
        m_gridLayout->takeAt(m_gridLayout->indexOf(layoutItemOfComboBox));
        GUI::Util::Layout::clearLayout(m_gridLayout, true);
        m_gridLayout->addWidget(layoutItemOfComboBox->widget(), 1, 0);
    }

References GUI::Util::Layout::clearLayout(), and AbstractSelectionContainerForm::m_gridLayout.

Referenced by AbstractSelectionContainerForm::initUI().

Here is the call graph for this function:

createContent()

virtual void SelectionContainerForm::createContent ( )

inlinevirtual

Implements AbstractSelectionContainerForm.

Definition at line 117 of file SelectionContainerForm.h.

    {
        if (currentValues != nullptr)
            LayerEditorUtils::addMultiPropertyToGrid(m_gridLayout, 1, currentValues(), m_ec, true);
    }

References LayerEditorUtils::addMultiPropertyToGrid(), currentValues, AbstractSelectionContainerForm::m_ec, and AbstractSelectionContainerForm::m_gridLayout.

Here is the call graph for this function:

initUI()

template<typename T >

void AbstractSelectionContainerForm::initUI ( const SelectionDescriptor< T > &  d )

inlineprotectedinherited

Definition at line 42 of file SelectionContainerForm.h.

    {
        m_gridLayout = new QGridLayout(this);
        m_gridLayout->setContentsMargins(0, 0, 0, 0);
        m_gridLayout->setSpacing(6);
 
        m_combo = new QComboBox;
        WheelEventEater::install(m_combo);
        m_combo->addItems(d.options);
        m_combo->setCurrentIndex(d.currentIndex());
        m_combo->setMaxVisibleItems(m_combo->count());
 
        QObject::connect(m_combo, QOverload<int>::of(&QComboBox::currentIndexChanged),
                         [=](int current) {
                             clear();
                             m_ec->setCurrentIndex(this, current, d);
                         });
 
        m_gridLayout->addWidget(m_combo, 1, 0);
        createContent();
    }

References AbstractSelectionContainerForm::clear(), AbstractSelectionContainerForm::createContent(), SelectionDescriptor< T >::currentIndex(), WheelEventEater::install(), AbstractSelectionContainerForm::m_combo, AbstractSelectionContainerForm::m_ec, AbstractSelectionContainerForm::m_gridLayout, SelectionDescriptor< T >::options, and SampleEditorController::setCurrentIndex().

Referenced by LatticeTypeSelectionForm::LatticeTypeSelectionForm(), and SelectionContainerForm().

Here is the call graph for this function:

Member Data Documentation

currentValues

function<DoubleDescriptors()> SelectionContainerForm::currentValues = nullptr

private

Definition at line 124 of file SelectionContainerForm.h.

Referenced by SelectionContainerForm(), and createContent().

m_combo

QComboBox* AbstractSelectionContainerForm::m_combo

protectedinherited

Definition at line 76 of file SelectionContainerForm.h.

Referenced by AbstractSelectionContainerForm::initUI().

m_ec

SampleEditorController* AbstractSelectionContainerForm::m_ec

protectedinherited

Definition at line 77 of file SelectionContainerForm.h.

Referenced by createContent(), LatticeTypeSelectionForm::createContent(), and AbstractSelectionContainerForm::initUI().

m_gridLayout

QGridLayout* AbstractSelectionContainerForm::m_gridLayout

protectedinherited

Definition at line 75 of file SelectionContainerForm.h.

Referenced by AbstractSelectionContainerForm::clear(), createContent(), LatticeTypeSelectionForm::createContent(), and AbstractSelectionContainerForm::initUI().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/SampleDesigner/SelectionContainerForm.h