ResInsight/Fwk/AppFwk/cafUserInterface/cafPdmUiTableViewEditor.cpp

448 lines
16 KiB
C++

//##################################################################################################
//
// Custom Visualization Core library
// Copyright (C) Ceetron Solutions AS
//
// This library may be used under the terms of either the GNU General Public License or
// the GNU Lesser General Public License as follows:
//
// GNU General Public License Usage
// This library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE.
//
// See the GNU General Public License at <<http://www.gnu.org/licenses/gpl.html>>
// for more details.
//
// GNU Lesser General Public License Usage
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE.
//
// See the GNU Lesser General Public License at <<http://www.gnu.org/licenses/lgpl-2.1.html>>
// for more details.
//
//##################################################################################################
#include "cafPdmUiTableViewEditor.h"
#include "cafPdmChildArrayField.h"
#include "cafPdmField.h"
#include "cafPdmObject.h"
#include "cafPdmUiCheckBoxDelegate.h"
#include "cafPdmUiEditorHandle.h"
#include "cafPdmUiTableViewDelegate.h"
#include "cafPdmUiTableViewQModel.h"
#include "cafSelectionManager.h"
#include <QApplication>
#include <QEvent>
#include <QGridLayout>
#include <QLabel>
#include <QMenu>
#include <QTableView>
#include <QWidget>
namespace caf
{
CAF_PDM_UI_FIELD_EDITOR_SOURCE_INIT(PdmUiTableViewEditor);
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
PdmUiTableViewEditor::PdmUiTableViewEditor()
{
m_tableView = nullptr;
m_tableHeading = nullptr;
m_tableModelPdm = nullptr;
m_tableHeadingIcon = nullptr;
m_delegate = nullptr;
m_previousFieldHandle = nullptr;
m_useDefaultContextMenu = false;
m_checkboxDelegate = new PdmUiCheckBoxDelegate();
m_tableSelectionLevel = SelectionManager::BASE_LEVEL;
m_rowSelectionLevel = SelectionManager::FIRST_LEVEL;
m_isBlockingSelectionManagerChanged = false;
m_isUpdatingSelectionQModel = false;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
PdmUiTableViewEditor::~PdmUiTableViewEditor()
{
if (m_checkboxDelegate) m_checkboxDelegate->deleteLater();
if (m_delegate) m_delegate->deleteLater();
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QWidget* PdmUiTableViewEditor::createEditorWidget(QWidget* parent)
{
m_tableModelPdm = new PdmUiTableViewQModel(parent);
m_delegate = new PdmUiTableViewDelegate(nullptr, m_tableModelPdm);
m_tableView = new QTableView(parent);
m_tableView->setShowGrid(true);
m_tableView->setModel(m_tableModelPdm);
m_tableView->installEventFilter(this);
connect(m_tableView->selectionModel(), SIGNAL(selectionChanged( const QItemSelection & , const QItemSelection & )), SLOT(slotSelectionChanged( const QItemSelection & , const QItemSelection & )));
return m_tableView;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QWidget* PdmUiTableViewEditor::createLabelWidget(QWidget * parent)
{
if (m_tableHeading.isNull())
{
m_tableHeading = new QLabel(parent);
}
if (m_tableHeadingIcon.isNull())
{
m_tableHeadingIcon = new QLabel(parent);
}
QHBoxLayout* layoutForIconLabel = new QHBoxLayout();
layoutForIconLabel->setMargin(0);
layoutForIconLabel->addWidget(m_tableHeadingIcon);
layoutForIconLabel->addSpacing(3);
layoutForIconLabel->addWidget(m_tableHeading);
layoutForIconLabel->addStretch();
QWidget* widget = new QWidget(parent);
widget->setLayout(layoutForIconLabel);
return widget;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiTableViewEditor::configureAndUpdateUi(const QString& uiConfigName)
{
if (!m_tableModelPdm) return;
auto childArrayFH = childArrayFieldHandle();
PdmUiTableViewEditorAttribute editorAttrib;
bool editorAttribLoaded = false;
if ( childArrayFH && childArrayFH->ownerObject() && childArrayFH->ownerObject()->uiCapability() )
{
childArrayFH->ownerObject()->uiCapability()->editorAttribute(childArrayFH, uiConfigName, &editorAttrib);
editorAttribLoaded = true;
this->setTableSelectionLevel(editorAttrib.tableSelectionLevel);
this->setRowSelectionLevel(editorAttrib.rowSelectionLevel);
this->enableHeaderText(editorAttrib.enableHeaderText);
QPalette myPalette(m_tableView->palette());
myPalette.setColor(QPalette::Base, editorAttrib.baseColor);
m_tableView->setPalette(myPalette);
}
m_tableModelPdm->setArrayFieldAndBuildEditors(childArrayFH, uiConfigName);
if (m_tableModelPdm->rowCount() > 0)
{
for (int i = 0; i < m_tableModelPdm->columnCount(); i++)
{
if (m_tableModelPdm->isRepresentingBoolean(m_tableModelPdm->index(0, i)))
{
m_tableView->setItemDelegateForColumn(i, m_checkboxDelegate);
}
else
{
m_tableView->setItemDelegateForColumn(i, m_delegate);
}
}
}
if (childArrayFH && childArrayFH->uiCapability())
{
QString text = "";
if ( childArrayFH->uiCapability()->uiIcon(uiConfigName).isNull() )
{
m_tableHeadingIcon->setText(childArrayFH->uiCapability()->uiName(uiConfigName) + QString(" (%1)").arg(childArrayFH->size()));
m_tableHeading->setText("");
}
else
{
m_tableHeadingIcon->setPixmap(childArrayFH->uiCapability()->uiIcon(uiConfigName).pixmap(16, 16));
m_tableHeading->setText(childArrayFH->uiCapability()->uiName(uiConfigName) + QString(" (%1)").arg(childArrayFH->size()));
}
m_tableModelPdm->createPersistentPushButtonWidgets(m_tableView);
}
else
{
m_tableHeading->setText("");
m_tableHeadingIcon->setPixmap(QPixmap());
}
if (m_previousFieldHandle != childArrayFH )
{
if (editorAttrib.minimumHeight > 0)
{
m_tableView->setMinimumHeight(editorAttrib.minimumHeight);
}
}
if ( m_previousFieldHandle != childArrayFH || editorAttrib.forceColumnWidthResize )
{
// Set default column widths
m_tableView->resizeColumnsToContents();
// Set specified widths (if any)
if (editorAttribLoaded)
{
int colCount = m_tableModelPdm->columnCount();
for (int c = 0; c < colCount && c < static_cast<int>(editorAttrib.columnWidths.size()); c++)
{
auto w = editorAttrib.columnWidths[c];
if (w > 0) m_tableView->setColumnWidth(c, w);
}
}
}
m_previousFieldHandle = childArrayFH;
// Set default row heights
m_tableView->resizeRowsToContents();
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiTableViewEditor::selectedUiItems(const QModelIndexList& modelIndexList, std::vector<PdmUiItem*>& objects)
{
for (const QModelIndex& mi : modelIndexList)
{
int row = mi.row();
caf::PdmUiObjectHandle* uiObject = uiObj(m_tableModelPdm->pdmObjectForRow(row));
if (uiObject)
{
objects.push_back(uiObject);
}
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QTableView* PdmUiTableViewEditor::tableView()
{
return m_tableView;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiTableViewEditor::enableHeaderText(bool enable)
{
m_tableHeading->setVisible(enable);
m_tableHeadingIcon->setVisible(enable);
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiTableViewEditor::setTableSelectionLevel(int selectionLevel)
{
m_tableSelectionLevel = selectionLevel;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiTableViewEditor::setRowSelectionLevel(int selectionLevel)
{
m_rowSelectionLevel = selectionLevel;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiTableViewEditor::onSelectionManagerSelectionChanged( const std::set<int>& changedSelectionLevels )
{
if (!m_tableView->isVisible() || m_isBlockingSelectionManagerChanged ) return;
if (isSelectionRoleDefined() && (changedSelectionLevels.count(m_rowSelectionLevel) ))
{
std::vector<PdmUiItem*> items;
SelectionManager::instance()->selectedItems(items, m_rowSelectionLevel);
QItemSelection totalSelection;
for (auto item: items)
{
PdmObject* pdmObj = dynamic_cast<PdmObject*>(item);
QItemSelection itemSelection = m_tableModelPdm->modelIndexFromPdmObject(pdmObj);
totalSelection.merge(itemSelection, QItemSelectionModel::Select);
}
m_isUpdatingSelectionQModel = true;
m_tableView->selectionModel()->select(totalSelection, QItemSelectionModel::SelectCurrent);
m_isUpdatingSelectionQModel = false;
}
}
//--------------------------------------------------------------------------------------------------
/// NOTE: If no selection role is defined, the selection manager is not changed, the selection in the
/// editor is local to the editor
//--------------------------------------------------------------------------------------------------
void PdmUiTableViewEditor::slotSelectionChanged(const QItemSelection & selected, const QItemSelection & deselected)
{
if (!m_isUpdatingSelectionQModel) updateSelectionManagerFromTableSelection();
// Hack to circumvent missing redraw from Qt in certain situations, when selection has changed
m_tableView->resize(m_tableView->width(), m_tableView->height() +1);
m_tableView->resize(m_tableView->width(), m_tableView->height() -1);
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool PdmUiTableViewEditor::isSelectionRoleDefined() const
{
return m_rowSelectionLevel != SelectionManager::UNDEFINED;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
PdmObjectHandle* PdmUiTableViewEditor::pdmObjectFromModelIndex(const QModelIndex& mi)
{
if (mi.isValid())
{
return m_tableModelPdm->pdmObjectForRow(mi.row());
}
return nullptr;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiTableViewEditor::updateSelectionManagerFromTableSelection()
{
if (isSelectionRoleDefined())
{
std::set<PdmUiItem*> selectedRowObjects;
QModelIndexList modelIndexList = m_tableView->selectionModel()->selectedIndexes();
for (const QModelIndex& mi : modelIndexList)
{
PdmObjectHandle* obj = m_tableModelPdm->pdmObjectForRow(mi.row());
if (obj && obj->uiCapability())
{
selectedRowObjects.insert(obj->uiCapability());
}
}
std::vector<SelectionManager::SelectionItem> newCompleteSelection;
for (auto item : selectedRowObjects)
{
newCompleteSelection.push_back({ item, m_rowSelectionLevel });
}
if ( childArrayFieldHandle() && childArrayFieldHandle()->ownerObject() )
{
newCompleteSelection.push_back({ childArrayFieldHandle()->ownerObject()->uiCapability() ,
m_tableSelectionLevel });
}
m_isBlockingSelectionManagerChanged = true;
SelectionManager::instance()->setSelection(newCompleteSelection);
m_isBlockingSelectionManagerChanged = false;
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool PdmUiTableViewEditor::eventFilter(QObject* obj, QEvent* event)
{
if (event->type() == QEvent::FocusIn)
{
this->updateSelectionManagerFromTableSelection();
}
// standard event processing
return QObject::eventFilter(obj, event);
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
caf::PdmChildArrayFieldHandle* PdmUiTableViewEditor::childArrayFieldHandle()
{
caf::PdmChildArrayFieldHandle* fieldHandle = nullptr;
if (this->uiField())
{
fieldHandle = dynamic_cast<PdmChildArrayFieldHandle*>(this->uiField()->fieldHandle());
}
return fieldHandle;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiTableViewPushButtonEditorAttribute::registerPushButtonTextForFieldKeyword(const QString& keyword, const QString& text)
{
m_fieldKeywordAndPushButtonText[keyword] = text;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool PdmUiTableViewPushButtonEditorAttribute::showPushButtonForFieldKeyword(const QString& keyword) const
{
if (m_fieldKeywordAndPushButtonText.count(keyword) > 0) return true;
return false;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString PdmUiTableViewPushButtonEditorAttribute::pushButtonText(const QString& keyword) const
{
if (showPushButtonForFieldKeyword(keyword))
{
return m_fieldKeywordAndPushButtonText.at(keyword);
}
return "";
}
} // end namespace caf