ModelView::SelectableComboBoxEditor Class Reference

Adds multi-selection capabilities to QComboBox. More...

Inheritance diagram for ModelView::SelectableComboBoxEditor:

Collaboration diagram for ModelView::SelectableComboBoxEditor:

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

Signals
void	dataChanged (QVariant value)
	Emmits signal when data was changed in an editor. More...

Public Member Functions
	SelectableComboBoxEditor (QWidget *parent=nullptr)
QVariant	data () const
bool	is_persistent () const override
	Returns true if editor should remains alive after editing finished. More...
QSize	minimumSizeHint () const override
QSize	sizeHint () const override

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	setDataIntern (const QVariant &data)
	Saves the data as given by editor's internal components and notifies the model. More...
void	update_components () override
	Should update widget components from m_data, if necessary. More...

Protected Attributes
QVariant	m_data

Properties
QVariant	value

Private Member Functions
bool	eventFilter (QObject *obj, QEvent *event) override
	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 {nullptr}
QStandardItemModel *	m_model {nullptr}
WheelEventFilter *	m_wheelEventFilter {nullptr}

Detailed Description

Adds multi-selection capabilities to QComboBox.

Definition at line 29 of file selectablecomboboxeditor.h.

Constructor & Destructor Documentation

SelectableComboBoxEditor()

SelectableComboBoxEditor::SelectableComboBoxEditor ( QWidget *  parent = nullptr )

explicit

Definition at line 53 of file selectablecomboboxeditor.cpp.

    : CustomEditor(parent)
    , m_box(new QComboBox)
    , m_wheelEventFilter(new WheelEventFilter(this))
    , m_model(new QStandardItemModel(this))
{
    setAutoFillBackground(true);
    setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Minimum);
 
    m_box->installEventFilter(m_wheelEventFilter);
    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_wheelEventFilter, and setConnected().

Here is the call graph for this function:

Member Function Documentation

data()

QVariant CustomEditor::data ( ) const

inherited

Definition at line 21 of file customeditor.cpp.

{
    return m_data;
}

References ModelView::CustomEditor::m_data.

Referenced by ModelView::CustomEditor::setData(), and ModelView::CustomEditor::setDataIntern().

dataChanged

void ModelView::CustomEditor::dataChanged ( QVariant  value )

signalinherited

Emmits signal when data was changed in an editor.

Referenced by ModelView::PropertyFlatView::PropertyFlatViewImpl::create_editor(), ModelView::ViewModelDelegate::createEditor(), and ModelView::CustomEditor::setDataIntern().

eventFilter()

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

overrideprivate

Handles mouse clicks on QComboBox elements.

Definition at line 134 of file selectablecomboboxeditor.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:

is_persistent()

bool SelectableComboBoxEditor::is_persistent ( ) const

overridevirtual

Returns true if editor should remains alive after editing finished.

Reimplemented from ModelView::CustomEditor.

Definition at line 94 of file selectablecomboboxeditor.cpp.

{
    return true;
}

isClickToExpand()

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

private

Definition at line 208 of file selectablecomboboxeditor.cpp.

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

References m_box.

Referenced by eventFilter().

isClickToSelect()

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

private

Definition at line 203 of file selectablecomboboxeditor.cpp.

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

References m_box.

Referenced by eventFilter().

minimumSizeHint()

QSize SelectableComboBoxEditor::minimumSizeHint ( ) const

override

Definition at line 89 of file selectablecomboboxeditor.cpp.

{
    return m_box->minimumSizeHint();
}

References m_box.

onClickedList

void SelectableComboBoxEditor::onClickedList ( const QModelIndex &  index )

protectedslot

Processes press event in QComboBox's underlying list view.

Definition at line 124 of file selectablecomboboxeditor.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 SelectableComboBoxEditor::onModelDataChanged ( const QModelIndex &  topLeft, const QModelIndex &  , const QVector< int > &  roles  )

protectedslot

Propagate check state from the model to ComboProperty.

Definition at line 101 of file selectablecomboboxeditor.cpp.

{
#if QT_VERSION > QT_VERSION_CHECK(5, 9, 0)
    // for older versions this role is always empty
    if (!roles.contains(Qt::CheckStateRole))
        return;
#endif
 
    auto item = m_model->itemFromIndex(topLeft);
    if (!item)
        return;
 
    ComboProperty comboProperty = m_data.value<ComboProperty>();
    auto state = item->checkState() == Qt::Checked ? true : false;
    comboProperty.setSelected(topLeft.row(), state);
 
    updateBoxLabel();
    setDataIntern(QVariant::fromValue<ComboProperty>(comboProperty));
}

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

Referenced by setConnected().

Here is the call graph for this function:

setConnected()

void SelectableComboBoxEditor::setConnected ( bool  isConnected )

private

Definition at line 184 of file selectablecomboboxeditor.cpp.

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

References m_model, and onModelDataChanged().

Referenced by SelectableComboBoxEditor(), and update_components().

Here is the call graph for this function:

setData

void CustomEditor::setData ( const QVariant &  data )

slotinherited

Sets the data from model to editor.

Definition at line 35 of file customeditor.cpp.

{
    m_data = data;
    update_components();
}

References ModelView::CustomEditor::data(), ModelView::CustomEditor::m_data, and ModelView::CustomEditor::update_components().

Here is the call graph for this function:

setDataIntern()

void CustomEditor::setDataIntern ( const QVariant &  data )

protectedinherited

Saves the data as given by editor's internal components and notifies the model.

Definition at line 43 of file customeditor.cpp.

{
    m_data = data;
    dataChanged(m_data);
}

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

Referenced by ModelView::ColorEditor::mousePressEvent(), ModelView::BoolEditor::onCheckBoxChange(), ModelView::DoubleEditor::onEditingFinished(), ModelView::IntegerEditor::onEditingFinished(), ModelView::ScientificDoubleEditor::onEditingFinished(), ModelView::ScientificSpinBoxEditor::onEditingFinished(), ModelView::ComboPropertyEditor::onIndexChanged(), ModelView::ExternalPropertyComboEditor::onIndexChanged(), and onModelDataChanged().

Here is the call graph for this function:

sizeHint()

QSize SelectableComboBoxEditor::sizeHint ( ) const

override

Definition at line 84 of file selectablecomboboxeditor.cpp.

{
    return m_box->sizeHint();
}

References m_box.

update_components()

void SelectableComboBoxEditor::update_components ( )

overrideprotectedvirtual

Should update widget components from m_data, if necessary.

Implements ModelView::CustomEditor.

Definition at line 157 of file selectablecomboboxeditor.cpp.

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

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

Here is the call graph for this function:

updateBoxLabel()

void SelectableComboBoxEditor::updateBoxLabel ( )

private

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

Definition at line 197 of file selectablecomboboxeditor.cpp.

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

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

Referenced by onModelDataChanged(), and update_components().

Here is the call graph for this function:

Member Data Documentation

m_box

QComboBox* ModelView::SelectableComboBoxEditor::m_box {nullptr}

private

Definition at line 56 of file selectablecomboboxeditor.h.

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

m_data

QVariant ModelView::CustomEditor::m_data

protectedinherited

Definition at line 48 of file customeditor.h.

Referenced by ModelView::ExternalPropertyEditor::buttonClicked(), ModelView::ColorEditor::currentColor(), ModelView::CustomEditor::data(), ModelView::ComboPropertyEditor::internIndex(), ModelView::ExternalPropertyComboEditor::internIndex(), ModelView::ComboPropertyEditor::internLabels(), ModelView::BoolEditor::onCheckBoxChange(), ModelView::DoubleEditor::onEditingFinished(), ModelView::IntegerEditor::onEditingFinished(), ModelView::ScientificDoubleEditor::onEditingFinished(), ModelView::ScientificSpinBoxEditor::onEditingFinished(), ModelView::ComboPropertyEditor::onIndexChanged(), ModelView::ExternalPropertyComboEditor::onIndexChanged(), onModelDataChanged(), ModelView::CustomEditor::setData(), ModelView::CustomEditor::setDataIntern(), ModelView::BoolEditor::update_components(), ModelView::ColorEditor::update_components(), ModelView::DoubleEditor::update_components(), ModelView::ExternalPropertyEditor::update_components(), ModelView::IntegerEditor::update_components(), ModelView::ScientificDoubleEditor::update_components(), ModelView::ScientificSpinBoxEditor::update_components(), update_components(), and updateBoxLabel().

m_model

QStandardItemModel* ModelView::SelectableComboBoxEditor::m_model {nullptr}

private

Definition at line 58 of file selectablecomboboxeditor.h.

Referenced by SelectableComboBoxEditor(), onClickedList(), onModelDataChanged(), setConnected(), and update_components().

m_wheelEventFilter

WheelEventFilter* ModelView::SelectableComboBoxEditor::m_wheelEventFilter {nullptr}

private

Definition at line 57 of file selectablecomboboxeditor.h.

Referenced by SelectableComboBoxEditor().

Property Documentation

value

QVariant ModelView::CustomEditor::value

readwriteinherited

Definition at line 1 of file customeditor.h.

Referenced by ModelView::BoolEditor::onCheckBoxChange(), ModelView::DoubleEditor::setSingleStep(), and ModelView::BoolEditor::update_components().

---

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

• /home/www/ba/mvvm/viewmodel/mvvm/editors/selectablecomboboxeditor.h
• /home/www/ba/mvvm/viewmodel/mvvm/editors/selectablecomboboxeditor.cpp