mirror of
https://github.com/OPM/ResInsight.git
synced 2025-02-25 18:55:39 -06:00
caf: Renamed the WidgetBasedObjectEditor to FormLayoutObjectEditor
This commit is contained in:
Jacob Støren
438
Fwk/AppFwk/cafUserInterface/cafPdmUiFormLayoutObjectEditor.cpp
Normal file
438
Fwk/AppFwk/cafUserInterface/cafPdmUiFormLayoutObjectEditor.cpp
Normal file
@@ -0,0 +1,438 @@
|
||||
//##################################################################################################
|
||||
//
|
||||
// Custom Visualization Core library
|
||||
// Copyright (C) 2017 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 "cafPdmUiFormLayoutObjectEditor.h"
|
||||
|
||||
#include "cafPdmObjectHandle.h"
|
||||
#include "cafPdmUiFieldEditorHandle.h"
|
||||
#include "cafPdmUiFieldEditorHelper.h"
|
||||
#include "cafPdmUiFieldHandle.h"
|
||||
#include "cafPdmUiObjectHandle.h"
|
||||
#include "cafPdmUiOrdering.h"
|
||||
#include "cafPdmXmlObjectHandle.h"
|
||||
|
||||
#include "QMinimizePanel.h"
|
||||
|
||||
#include <QGridLayout>
|
||||
#include <QFrame>
|
||||
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
///
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
caf::PdmUiFormLayoutObjectEditor::PdmUiFormLayoutObjectEditor()
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
///
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
caf::PdmUiFormLayoutObjectEditor::~PdmUiFormLayoutObjectEditor()
|
||||
{
|
||||
// If there are field editor present, the usage of this editor has not cleared correctly
|
||||
// The intended usage is to call the method setPdmObject(NULL) before closing the dialog
|
||||
CAF_ASSERT(m_fieldViews.size() == 0);
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
///
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
void caf::PdmUiFormLayoutObjectEditor::recursivelyConfigureAndUpdateUiItemsInGridLayoutColumn(const std::vector<PdmUiItem*>& uiItems, QWidget* containerWidgetWithGridLayout, const QString& uiConfigName)
|
||||
{
|
||||
CAF_ASSERT(containerWidgetWithGridLayout);
|
||||
|
||||
int currentRowIndex = 0;
|
||||
QWidget* previousTabOrderWidget = nullptr;
|
||||
|
||||
// Currently, only QGridLayout is supported
|
||||
QGridLayout* parentLayout = dynamic_cast<QGridLayout*>(containerWidgetWithGridLayout->layout());
|
||||
CAF_ASSERT(parentLayout);
|
||||
|
||||
for (size_t i = 0; i < uiItems.size(); ++i)
|
||||
{
|
||||
if (uiItems[i]->isUiHidden(uiConfigName)) continue;
|
||||
|
||||
if (uiItems[i]->isUiGroup())
|
||||
{
|
||||
PdmUiGroup* group = static_cast<PdmUiGroup*>(uiItems[i]);
|
||||
|
||||
QMinimizePanel* groupBox = findOrCreateGroupBox(containerWidgetWithGridLayout, group, uiConfigName);
|
||||
|
||||
/// Insert the group box at the correct position of the parent layout
|
||||
parentLayout->addWidget(groupBox, currentRowIndex, 0, 1, 2);
|
||||
|
||||
const std::vector<PdmUiItem*>& groupChildren = group->uiItems();
|
||||
recursivelyConfigureAndUpdateUiItemsInGridLayoutColumn(groupChildren, groupBox->contentFrame(), uiConfigName);
|
||||
|
||||
currentRowIndex++;
|
||||
}
|
||||
else
|
||||
{
|
||||
PdmUiFieldHandle* field = dynamic_cast<PdmUiFieldHandle*>(uiItems[i]);
|
||||
|
||||
PdmUiFieldEditorHandle* fieldEditor = findOrCreateFieldEditor(containerWidgetWithGridLayout, field, uiConfigName);
|
||||
|
||||
if (fieldEditor)
|
||||
{
|
||||
fieldEditor->setUiField(field);
|
||||
|
||||
// Place the widget(s) into the correct parent and layout
|
||||
QWidget* fieldCombinedWidget = fieldEditor->combinedWidget();
|
||||
|
||||
if (fieldCombinedWidget)
|
||||
{
|
||||
fieldCombinedWidget->setParent(containerWidgetWithGridLayout);
|
||||
parentLayout->addWidget(fieldCombinedWidget, currentRowIndex, 0, 1, 2);
|
||||
}
|
||||
else
|
||||
{
|
||||
PdmUiItemInfo::LabelPosType labelPos = field->uiLabelPosition(uiConfigName);
|
||||
bool labelOnTop = (labelPos == PdmUiItemInfo::TOP);
|
||||
bool editorSpanBoth = labelOnTop;
|
||||
|
||||
QWidget* fieldEditorWidget = fieldEditor->editorWidget();
|
||||
|
||||
if (labelPos != PdmUiItemInfo::HIDDEN)
|
||||
{
|
||||
QWidget* fieldLabelWidget = fieldEditor->labelWidget();
|
||||
if (fieldLabelWidget)
|
||||
{
|
||||
fieldLabelWidget->setParent(containerWidgetWithGridLayout);
|
||||
|
||||
// Label widget will span two columns if aligned on top
|
||||
int colSpan = labelOnTop ? 2 : 1;
|
||||
// If the label is on the side, and the editor can expand vertically, allign the label with the top edge of the editor
|
||||
if (!labelOnTop && (fieldEditorWidget->sizePolicy().verticalPolicy() & QSizePolicy::ExpandFlag))
|
||||
parentLayout->addWidget(fieldLabelWidget, currentRowIndex, 0, 1, colSpan, Qt::AlignTop);
|
||||
else
|
||||
parentLayout->addWidget(fieldLabelWidget, currentRowIndex, 0, 1, colSpan, Qt::AlignVCenter);
|
||||
|
||||
fieldLabelWidget->show();
|
||||
|
||||
if (labelOnTop) currentRowIndex++;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
QWidget* fieldLabelWidget = fieldEditor->labelWidget();
|
||||
if (fieldLabelWidget) fieldLabelWidget->hide();
|
||||
editorSpanBoth = true; // To span both columns when there is no label
|
||||
}
|
||||
|
||||
if (fieldEditorWidget)
|
||||
{
|
||||
fieldEditorWidget->setParent(containerWidgetWithGridLayout); // To make sure this widget has the current group box as parent.
|
||||
|
||||
// Label widget will span two columns if aligned on top
|
||||
int colSpan = editorSpanBoth ? 2 : 1;
|
||||
int colIndex = editorSpanBoth ? 0 : 1;
|
||||
parentLayout->addWidget(fieldEditorWidget, currentRowIndex, colIndex, 1, colSpan, Qt::AlignTop);
|
||||
|
||||
if (previousTabOrderWidget) QWidget::setTabOrder(previousTabOrderWidget, fieldEditorWidget);
|
||||
|
||||
previousTabOrderWidget = fieldEditorWidget;
|
||||
}
|
||||
}
|
||||
|
||||
fieldEditor->updateUi(uiConfigName);
|
||||
|
||||
currentRowIndex++;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
///
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
bool caf::PdmUiFormLayoutObjectEditor::isUiGroupExpanded(const PdmUiGroup* uiGroup) const
|
||||
{
|
||||
if (uiGroup->hasForcedExpandedState()) return uiGroup->forcedExpandedState();
|
||||
|
||||
auto kwMapPair = m_objectKeywordGroupUiNameExpandedState.find(pdmObject()->xmlCapability()->classKeyword());
|
||||
if (kwMapPair != m_objectKeywordGroupUiNameExpandedState.end())
|
||||
{
|
||||
QString keyword = uiGroup->keyword();
|
||||
|
||||
auto uiNameExpStatePair = kwMapPair->second.find(keyword);
|
||||
if (uiNameExpStatePair != kwMapPair->second.end())
|
||||
{
|
||||
return uiNameExpStatePair->second;
|
||||
}
|
||||
}
|
||||
|
||||
return uiGroup->isExpandedByDefault();
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
///
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
QMinimizePanel* caf::PdmUiFormLayoutObjectEditor::findOrCreateGroupBox(QWidget* parent, PdmUiGroup* group, const QString& uiConfigName)
|
||||
{
|
||||
QString groupBoxKey = group->keyword();
|
||||
QMinimizePanel* groupBox = nullptr;
|
||||
QGridLayout* groupBoxLayout = nullptr;
|
||||
|
||||
// Find or create groupBox
|
||||
std::map<QString, QPointer<QMinimizePanel> >::iterator it;
|
||||
it = m_groupBoxes.find(groupBoxKey);
|
||||
|
||||
if (it == m_groupBoxes.end())
|
||||
{
|
||||
groupBox = new QMinimizePanel(parent);
|
||||
groupBox->setTitle(group->uiName(uiConfigName));
|
||||
groupBox->setObjectName(group->keyword());
|
||||
groupBoxLayout = new QGridLayout();
|
||||
groupBox->contentFrame()->setLayout(groupBoxLayout);
|
||||
connect(groupBox, SIGNAL(expandedChanged(bool)), this, SLOT(groupBoxExpandedStateToggled(bool)));
|
||||
|
||||
m_newGroupBoxes[groupBoxKey] = groupBox;
|
||||
}
|
||||
else
|
||||
{
|
||||
groupBox = it->second;
|
||||
CAF_ASSERT(groupBox);
|
||||
|
||||
m_newGroupBoxes[groupBoxKey] = groupBox;
|
||||
}
|
||||
|
||||
// Set Expanded state
|
||||
bool isExpanded = isUiGroupExpanded(group);
|
||||
groupBox->setExpanded(isExpanded);
|
||||
|
||||
// Update the title to be able to support dynamic group names
|
||||
groupBox->setTitle(group->uiName(uiConfigName));
|
||||
|
||||
return groupBox;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
///
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
caf::PdmUiFieldEditorHandle* caf::PdmUiFormLayoutObjectEditor::findOrCreateFieldEditor(QWidget* parent, PdmUiFieldHandle* field, const QString& uiConfigName)
|
||||
{
|
||||
caf::PdmUiFieldEditorHandle* fieldEditor = nullptr;
|
||||
|
||||
std::map<PdmFieldHandle*, PdmUiFieldEditorHandle*>::iterator it = m_fieldViews.find(field->fieldHandle());
|
||||
|
||||
if (it == m_fieldViews.end())
|
||||
{
|
||||
fieldEditor = PdmUiFieldEditorHelper::fieldEditorForField(field, uiConfigName);
|
||||
|
||||
if (fieldEditor)
|
||||
{
|
||||
m_fieldViews[field->fieldHandle()] = fieldEditor;
|
||||
fieldEditor->createWidgets(parent);
|
||||
}
|
||||
else
|
||||
{
|
||||
// This assert happens if no editor is available for a given field
|
||||
// If the macro for registering the editor is put as the single statement
|
||||
// in a cpp file, a dummy static class must be used to make sure the compile unit
|
||||
// is included
|
||||
//
|
||||
// See cafPdmUiCoreColor3f and cafPdmUiCoreVec3d
|
||||
|
||||
// This assert will trigger for PdmChildArrayField and PdmChildField
|
||||
// Consider to exclude assert or add editors for these types if the assert is reintroduced
|
||||
//CAF_ASSERT(false);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
fieldEditor = it->second;
|
||||
}
|
||||
|
||||
return fieldEditor;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
///
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
void caf::PdmUiFormLayoutObjectEditor::groupBoxExpandedStateToggled(bool isExpanded)
|
||||
{
|
||||
if (!this->pdmObject()->xmlCapability()) return;
|
||||
|
||||
QString objKeyword = this->pdmObject()->xmlCapability()->classKeyword();
|
||||
QMinimizePanel* panel = dynamic_cast<QMinimizePanel*>(this->sender());
|
||||
|
||||
if (!panel) return;
|
||||
|
||||
m_objectKeywordGroupUiNameExpandedState[objKeyword][panel->objectName()] = isExpanded;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
///
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
void caf::PdmUiFormLayoutObjectEditor::cleanupBeforeSettingPdmObject()
|
||||
{
|
||||
std::map<PdmFieldHandle*, PdmUiFieldEditorHandle*>::iterator it;
|
||||
for (it = m_fieldViews.begin(); it != m_fieldViews.end(); ++it)
|
||||
{
|
||||
PdmUiFieldEditorHandle* fvh = it->second;
|
||||
delete fvh;
|
||||
}
|
||||
m_fieldViews.clear();
|
||||
|
||||
m_newGroupBoxes.clear();
|
||||
|
||||
std::map<QString, QPointer<QMinimizePanel> >::iterator groupIt;
|
||||
for (groupIt = m_groupBoxes.begin(); groupIt != m_groupBoxes.end(); ++groupIt)
|
||||
{
|
||||
if (!groupIt->second.isNull()) groupIt->second->deleteLater();
|
||||
}
|
||||
|
||||
m_groupBoxes.clear();
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
///
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
void caf::PdmUiFormLayoutObjectEditor::configureAndUpdateUi(const QString& uiConfigName)
|
||||
{
|
||||
caf::PdmUiOrdering config;
|
||||
if (pdmObject())
|
||||
{
|
||||
caf::PdmUiObjectHandle* uiObject = uiObj(pdmObject());
|
||||
if (uiObject)
|
||||
{
|
||||
uiObject->uiOrdering(uiConfigName, config);
|
||||
}
|
||||
}
|
||||
|
||||
// Set all fieldViews to be unvisited
|
||||
std::map<PdmFieldHandle*, PdmUiFieldEditorHandle*>::iterator it;
|
||||
for (it = m_fieldViews.begin(); it != m_fieldViews.end(); ++it)
|
||||
{
|
||||
it->second->setUiField(nullptr);
|
||||
}
|
||||
|
||||
// Set all group Boxes to be unvisited
|
||||
m_newGroupBoxes.clear();
|
||||
|
||||
const std::vector<PdmUiItem*>& uiItems = config.uiItems();
|
||||
recursivelyConfigureAndUpdateTopLevelUiItems(uiItems, uiConfigName);
|
||||
|
||||
// Remove all fieldViews not mentioned by the configuration from the layout
|
||||
|
||||
std::vector< PdmFieldHandle* > fvhToRemoveFromMap;
|
||||
for (it = m_fieldViews.begin(); it != m_fieldViews.end(); ++it)
|
||||
{
|
||||
if (it->second->uiField() == nullptr)
|
||||
{
|
||||
PdmUiFieldEditorHandle* fvh = it->second;
|
||||
delete fvh;
|
||||
fvhToRemoveFromMap.push_back(it->first);
|
||||
}
|
||||
}
|
||||
|
||||
for (size_t i = 0; i < fvhToRemoveFromMap.size(); ++i)
|
||||
{
|
||||
m_fieldViews.erase(fvhToRemoveFromMap[i]);
|
||||
}
|
||||
|
||||
// Remove all unmentioned group boxes
|
||||
|
||||
std::map<QString, QPointer<QMinimizePanel> >::iterator itOld;
|
||||
std::map<QString, QPointer<QMinimizePanel> >::iterator itNew;
|
||||
|
||||
for (itOld = m_groupBoxes.begin(); itOld != m_groupBoxes.end(); ++itOld)
|
||||
{
|
||||
itNew = m_newGroupBoxes.find(itOld->first);
|
||||
if (itNew == m_newGroupBoxes.end())
|
||||
{
|
||||
// The old groupBox is not present anymore, get rid of it
|
||||
if (!itOld->second.isNull()) delete itOld->second;
|
||||
}
|
||||
}
|
||||
m_groupBoxes = m_newGroupBoxes;
|
||||
|
||||
// Notify pdm object when widgets have been created
|
||||
caf::PdmUiObjectHandle* uiObject = uiObj(pdmObject());
|
||||
if (uiObject)
|
||||
{
|
||||
uiObject->onEditorWidgetsCreated();
|
||||
}
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
/// Unused. Should probably remove
|
||||
//--------------------------------------------------------------------------------------------------
|
||||
void caf::PdmUiFormLayoutObjectEditor::recursiveVerifyUniqueNames(const std::vector<PdmUiItem*>& uiItems,
|
||||
const QString& uiConfigName,
|
||||
std::set<QString>* fieldKeywordNames,
|
||||
std::set<QString>* groupNames)
|
||||
{
|
||||
for (size_t i = 0; i < uiItems.size(); ++i)
|
||||
{
|
||||
if (uiItems[i]->isUiGroup())
|
||||
{
|
||||
PdmUiGroup* group = static_cast<PdmUiGroup*>(uiItems[i]);
|
||||
const std::vector<PdmUiItem*>& groupChildren = group->uiItems();
|
||||
|
||||
QString groupBoxKey = group->keyword();
|
||||
|
||||
if (groupNames->find(groupBoxKey) != groupNames->end())
|
||||
{
|
||||
// It is not supported to have two groups with identical names
|
||||
CAF_ASSERT(false);
|
||||
}
|
||||
else
|
||||
{
|
||||
groupNames->insert(groupBoxKey);
|
||||
}
|
||||
|
||||
recursiveVerifyUniqueNames(groupChildren, uiConfigName, fieldKeywordNames, groupNames);
|
||||
}
|
||||
else
|
||||
{
|
||||
PdmUiFieldHandle* field = dynamic_cast<PdmUiFieldHandle*>(uiItems[i]);
|
||||
|
||||
QString fieldKeyword = field->fieldHandle()->keyword();
|
||||
if (fieldKeywordNames->find(fieldKeyword) != fieldKeywordNames->end())
|
||||
{
|
||||
// It is not supported to have two fields with identical names
|
||||
CAF_ASSERT(false);
|
||||
}
|
||||
else
|
||||
{
|
||||
fieldKeywordNames->insert(fieldKeyword);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user