MultiComboPropertyEditor Class Reference

Provides custom editor for ComboProperty with multi-select option. More...

Inheritance diagram for MultiComboPropertyEditor:

Collaboration diagram for MultiComboPropertyEditor:

Public Slots
void	setData (const QVariant &data)
	Sets the data from the model to editor. More...

Signals
void	dataChanged (const QVariant &data)
	Signal emit then user changed the data through the editor. More...

Public Member Functions
	MultiComboPropertyEditor (QWidget *parent=nullptr)
QVariant	editorData ()
QSize	minimumSizeHint () const
QSize	sizeHint () const

Protected Slots
void	onClickedList (const QModelIndex &index)
	Processes press event in QComboBox's underlying list view. More...
void	onModelDataChanged (const QModelIndex &, const QModelIndex &, const QVector< int > &)
	Propagate check state from the model to ComboProperty. More...

Protected Member Functions
void	initEditor ()
	Inits editor widgets from m_data. More...
void	setDataIntern (const QVariant &data)
	Saves the data from the editor and informs external delegates. More...

Protected Attributes
QVariant	m_data

Private Member Functions
bool	eventFilter (QObject *obj, QEvent *event)
	Handles mouse clicks on QComboBox elements. More...
bool	isClickToExpand (QObject *obj, QEvent *event) const
bool	isClickToSelect (QObject *obj, QEvent *event) const
void	setConnected (bool isConnected)
void	updateBoxLabel ()
	Update text on QComboBox with the label provided by combo property. More...

Private Attributes
QComboBox *	m_box
QStandardItemModel *	m_model
class WheelEventEater *	m_wheel_event_filter

Detailed Description

Provides custom editor for ComboProperty with multi-select option.

Definition at line 28 of file MultiComboPropertyEditor.h.

Constructor & Destructor Documentation

MultiComboPropertyEditor()

MultiComboPropertyEditor::MultiComboPropertyEditor ( QWidget *  parent = nullptr )

explicit

Definition at line 46 of file MultiComboPropertyEditor.cpp.

    : CustomEditor(parent)
    , m_box(new QComboBox)
    , m_wheel_event_filter(new WheelEventEater(this))
    , m_model(new QStandardItemModel(this))
{
    setAutoFillBackground(true);
    setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Minimum);
 
    m_box->installEventFilter(m_wheel_event_filter);
    m_box->view()->viewport()->installEventFilter(this);
 
    // Editable mode will be used to have None/Multiple labels on top
    m_box->setEditable(true);
    m_box->lineEdit()->setReadOnly(true);
    m_box->lineEdit()->installEventFilter(this);
    connect(m_box->lineEdit(), &QLineEdit::selectionChanged, m_box->lineEdit(),
            &QLineEdit::deselect);
 
    // transforms ordinary combo box into check list
    m_box->setItemDelegate(new QCheckListStyledItemDelegate(this));
    m_box->setModel(m_model);
 
    auto layout = new QVBoxLayout;
    layout->setMargin(0);
    layout->setSpacing(0);
    layout->addWidget(m_box);
    setLayout(layout);
    setConnected(true);
}

References m_box, m_model, m_wheel_event_filter, and setConnected().

Here is the call graph for this function:

Member Function Documentation

dataChanged

void CustomEditor::dataChanged ( const QVariant &  data )

signalinherited

Signal emit then user changed the data through the editor.

Referenced by PropertyWidgetItem::connectEditor(), SessionModelDelegate::createEditor(), and CustomEditor::setDataIntern().

editorData()

QVariant CustomEditor::editorData ( )

inlineinherited

Definition at line 33 of file CustomEditors.h.

{ return m_data; }

References CustomEditor::m_data.

eventFilter()

bool MultiComboPropertyEditor::eventFilter ( QObject *  obj, QEvent *  event  )

private

Handles mouse clicks on QComboBox elements.

Definition at line 120 of file MultiComboPropertyEditor.cpp.

{
    if (isClickToSelect(obj, event)) {
        // Handles mouse clicks on QListView when it is expanded from QComboBox
        // 1) Prevents list from closing while selecting items.
        // 2) Correctly calculates underlying model index when mouse is over check box style
        // element.
        const auto mouseEvent = static_cast<const QMouseEvent*>(event);
        auto index = m_box->view()->indexAt(mouseEvent->pos());
        onClickedList(index);
        return true;
 
    } else if (isClickToExpand(obj, event)) {
        // Expands box when clicking on None/Multiple label
        m_box->showPopup();
        return true;
 
    } else {
        // Propagate to the parent class.
        return QObject::eventFilter(obj, event);
    }
}

References isClickToExpand(), isClickToSelect(), m_box, and onClickedList().

Here is the call graph for this function:

initEditor()

void MultiComboPropertyEditor::initEditor ( )

protectedvirtual

Inits editor widgets from m_data.

Reimplemented from CustomEditor.

Definition at line 143 of file MultiComboPropertyEditor.cpp.

{
    if (!m_data.canConvert<ComboProperty>())
        return;
 
    ComboProperty property = m_data.value<ComboProperty>();
 
    setConnected(false);
    m_model->clear();
 
    auto labels = property.getValues();
    auto selectedIndices = property.selectedIndices();
 
    for (int i = 0; i < labels.size(); ++i) {
        auto item = new QStandardItem(labels[i]);
        m_model->invisibleRootItem()->appendRow(item);
        item->setFlags(Qt::ItemIsUserCheckable | Qt::ItemIsEnabled | Qt::ItemIsSelectable);
        item->setCheckable(true);
 
        auto state = selectedIndices.contains(i) ? Qt::Checked : Qt::Unchecked;
        item->setData(state, Qt::CheckStateRole);
    }
 
    setConnected(true);
    updateBoxLabel();
}

References SessionItemUtils::CheckStateRole(), CustomEditor::m_data, m_model, setConnected(), and updateBoxLabel().

Here is the call graph for this function:

isClickToExpand()

bool MultiComboPropertyEditor::isClickToExpand ( QObject *  obj, QEvent *  event  ) const

private

Definition at line 194 of file MultiComboPropertyEditor.cpp.

{
    return obj == m_box->lineEdit() && event->type() == QEvent::MouseButtonRelease;
}

References m_box.

Referenced by eventFilter().

isClickToSelect()

bool MultiComboPropertyEditor::isClickToSelect ( QObject *  obj, QEvent *  event  ) const

private

Definition at line 189 of file MultiComboPropertyEditor.cpp.

{
    return obj == m_box->view()->viewport() && event->type() == QEvent::MouseButtonRelease;
}

References m_box.

Referenced by eventFilter().

minimumSizeHint()

QSize MultiComboPropertyEditor::minimumSizeHint

(

)

const

Definition at line 82 of file MultiComboPropertyEditor.cpp.

{
    return m_box->minimumSizeHint();
}

References m_box.

onClickedList

void MultiComboPropertyEditor::onClickedList ( const QModelIndex &  index )

protectedslot

Processes press event in QComboBox's underlying list view.

Definition at line 110 of file MultiComboPropertyEditor.cpp.

{
    if (auto item = m_model->itemFromIndex(index)) {
        auto state = item->checkState() == Qt::Checked ? Qt::Unchecked : Qt::Checked;
        item->setCheckState(state);
    }
}

References m_model.

Referenced by eventFilter().

onModelDataChanged

void MultiComboPropertyEditor::onModelDataChanged ( const QModelIndex &  topLeft, const QModelIndex &  , const QVector< int > &    )

protectedslot

Propagate check state from the model to ComboProperty.

Definition at line 89 of file MultiComboPropertyEditor.cpp.

{
    // on Qt 5.9 roles remains empty for checked state. It will stop working if uncomment.
    //    if (!roles.contains(Qt::CheckStateRole))
    //        return;
 
    auto item = m_model->itemFromIndex(topLeft);
    if (!item)
        return;
 
    ComboProperty comboProperty = m_data.value<ComboProperty>();
    auto state = item->checkState() == Qt::Checked;
    comboProperty.setSelected(topLeft.row(), state);
 
    updateBoxLabel();
    setDataIntern(QVariant::fromValue<ComboProperty>(comboProperty));
}

References CustomEditor::m_data, m_model, CustomEditor::setDataIntern(), ComboProperty::setSelected(), and updateBoxLabel().

Referenced by setConnected().

Here is the call graph for this function:

setConnected()

void MultiComboPropertyEditor::setConnected ( bool  isConnected )

private

Definition at line 170 of file MultiComboPropertyEditor.cpp.

{
    if (isConnected) {
        connect(m_model, &QStandardItemModel::dataChanged, this,
                &MultiComboPropertyEditor::onModelDataChanged);
    } else {
        disconnect(m_model, &QStandardItemModel::dataChanged, this,
                   &MultiComboPropertyEditor::onModelDataChanged);
    }
}

References m_model, and onModelDataChanged().

Referenced by MultiComboPropertyEditor(), and initEditor().

Here is the call graph for this function:

setData

void CustomEditor::setData ( const QVariant &  data )

slotinherited

Sets the data from the model to editor.

Definition at line 48 of file CustomEditors.cpp.

{
    m_data = data;
    initEditor();
}

References CustomEditor::initEditor(), and CustomEditor::m_data.

Here is the call graph for this function:

setDataIntern()

void CustomEditor::setDataIntern ( const QVariant &  data )

protectedinherited

Saves the data from the editor and informs external delegates.

Definition at line 60 of file CustomEditors.cpp.

{
    m_data = data;
    dataChanged(m_data);
}

References CustomEditor::dataChanged(), and CustomEditor::m_data.

Referenced by ExternalPropertyEditor::buttonClicked(), BoolEditor::onCheckBoxChange(), ScientificDoublePropertyEditor::onEditingFinished(), DoubleEditor::onEditingFinished(), ScientificSpinBoxEditor::onEditingFinished(), IntEditor::onEditingFinished(), ComboPropertyEditor::onIndexChanged(), and onModelDataChanged().

sizeHint()

QSize MultiComboPropertyEditor::sizeHint

(

)

const

Definition at line 77 of file MultiComboPropertyEditor.cpp.

{
    return m_box->sizeHint();
}

References m_box.

updateBoxLabel()

void MultiComboPropertyEditor::updateBoxLabel ( )

private

Update text on QComboBox with the label provided by combo property.

Definition at line 183 of file MultiComboPropertyEditor.cpp.

{
    ComboProperty combo = m_data.value<ComboProperty>();
    m_box->setCurrentText(combo.label());
}

References ComboProperty::label(), m_box, and CustomEditor::m_data.

Referenced by initEditor(), and onModelDataChanged().

Here is the call graph for this function:

Member Data Documentation

m_box

QComboBox* MultiComboPropertyEditor::m_box

private

Definition at line 52 of file MultiComboPropertyEditor.h.

Referenced by MultiComboPropertyEditor(), eventFilter(), isClickToExpand(), isClickToSelect(), minimumSizeHint(), sizeHint(), and updateBoxLabel().

m_data

QVariant CustomEditor::m_data

protectedinherited

Definition at line 45 of file CustomEditors.h.

Referenced by ExternalPropertyEditor::buttonClicked(), CustomEditor::editorData(), ExternalPropertyEditor::initEditor(), ScientificDoublePropertyEditor::initEditor(), DoubleEditor::initEditor(), ScientificSpinBoxEditor::initEditor(), IntEditor::initEditor(), BoolEditor::initEditor(), initEditor(), ComboPropertyEditor::internIndex(), ComboPropertyEditor::internLabels(), BoolEditor::onCheckBoxChange(), ScientificDoublePropertyEditor::onEditingFinished(), DoubleEditor::onEditingFinished(), ScientificSpinBoxEditor::onEditingFinished(), IntEditor::onEditingFinished(), ComboPropertyEditor::onIndexChanged(), onModelDataChanged(), CustomEditor::setData(), CustomEditor::setDataIntern(), and updateBoxLabel().

m_model

QStandardItemModel* MultiComboPropertyEditor::m_model

private

Definition at line 54 of file MultiComboPropertyEditor.h.

Referenced by MultiComboPropertyEditor(), initEditor(), onClickedList(), onModelDataChanged(), and setConnected().

m_wheel_event_filter

class WheelEventEater* MultiComboPropertyEditor::m_wheel_event_filter

private

Definition at line 53 of file MultiComboPropertyEditor.h.

Referenced by MultiComboPropertyEditor().

---

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

• /home/www/ba/GUI/coregui/Views/PropertyEditor/MultiComboPropertyEditor.h
• /home/www/ba/GUI/coregui/Views/PropertyEditor/MultiComboPropertyEditor.cpp