ResInsight/Fwk/AppFwk/cafProjectDataModel/cafPdmUiCore/cafPdmUiFieldEditorHandle.cpp

//##################################################################################################
//
//   Custom Visualization Core library
//   Copyright (C) 2011-2013 Ceetron 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 "cafPdmUiFieldEditorHandle.h"

#include "cafPdmObjectHandle.h"
#include "cafPdmUiCommandSystemProxy.h"
#include "cafPdmUiFieldHandle.h"
#include "cafPdmUiObjectHandle.h"

#include <QAbstractScrollArea>
#include <QLabel>
#include <QMenu>
#include <QVariant>

namespace caf
{


//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
PdmUiFieldEditorHandle::PdmUiFieldEditorHandle()
{
    m_combinedWidget = QPointer<QWidget>();
    m_editorWidget = QPointer<QWidget>();
    m_labelWidget = QPointer<QWidget>();
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
PdmUiFieldEditorHandle::~PdmUiFieldEditorHandle()
{
    if (!m_combinedWidget.isNull()) m_combinedWidget->deleteLater(); 
    if (!m_editorWidget.isNull())   m_editorWidget->deleteLater();
    if (!m_labelWidget.isNull())    m_labelWidget->deleteLater();
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void PdmUiFieldEditorHandle::setUiField(PdmUiFieldHandle * field)
{
    this->bindToPdmItem(field);

    if (m_editorWidget)
    {
        // Required to be called here to be able to handle different context menu
        // policy when switching between objects of same type. In this case, the
        // PdmUiFieldEditorHandle::createWidgets() will not be run, as the field
        // widgets are cached by the property editor

        updateContextMenuPolicy();
    }
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void PdmUiFieldEditorHandle::updateContextMenuPolicy()
{
    if (m_editorWidget.isNull()) return;

    PdmUiFieldHandle* field = uiField();
    if (field && field->isCustomContextMenuEnabled())
    {
        m_editorWidget->setContextMenuPolicy(Qt::CustomContextMenu);
    }
    else
    {
        m_editorWidget->setContextMenuPolicy(Qt::DefaultContextMenu);
    }
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
PdmUiFieldHandle* PdmUiFieldEditorHandle::uiField()
{
    return dynamic_cast<PdmUiFieldHandle*>(pdmItem());
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void PdmUiFieldEditorHandle::createWidgets(QWidget * parent)
{
    if (m_combinedWidget.isNull()) m_combinedWidget = createCombinedWidget(parent);
    if (m_editorWidget.isNull()) m_editorWidget = createEditorWidget(parent);
    if (m_labelWidget.isNull()) m_labelWidget = createLabelWidget(parent);

    if (m_editorWidget)
    {
        updateContextMenuPolicy();

        connect(m_editorWidget, SIGNAL(customContextMenuRequested(QPoint)), this, SLOT(customMenuRequested(QPoint)));
    }
    if (m_labelWidget)
    {
        m_labelWidget->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Fixed);
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QMargins PdmUiFieldEditorHandle::labelContentMargins() const
{
    return calculateLabelContentMargins();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
int PdmUiFieldEditorHandle::rowStretchFactor() const
{
    return isMultiRowEditor() ? 1 : 0;
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void PdmUiFieldEditorHandle::setValueToField(const QVariant& newUiValue)
{
    PdmUiCommandSystemProxy::instance()->setUiValueToField(uiField(), newUiValue);
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void PdmUiFieldEditorHandle::updateLabelFromField(QShortenedLabel* label, const QString& uiConfigName /*= ""*/) const
{
    CAF_ASSERT(label);
    
    const PdmUiFieldHandle* fieldHandle = dynamic_cast<const PdmUiFieldHandle*>(pdmItem());
    if (fieldHandle)
    {
        QIcon ic = fieldHandle->uiIcon(uiConfigName);
        if (!ic.isNull())
        {
            label->setPixmap(ic.pixmap(ic.actualSize(QSize(64, 64))));
        }
        else
        {
            QString uiName = fieldHandle->uiName(uiConfigName);
            label->setText(uiName);
        }

        label->setEnabled(!fieldHandle->isUiReadOnly(uiConfigName));
        label->setToolTip(fieldHandle->uiToolTip(uiConfigName));
    }
}

//------------------------------------------------------------------------------------------------------------
/// Re-implement this virtual method if a custom PdmUiField is misaligned with its label.
/// See cafPdmUiLineEditor for an example.
//------------------------------------------------------------------------------------------------------------
QMargins PdmUiFieldEditorHandle::calculateLabelContentMargins() const
{
    return m_labelWidget->contentsMargins();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool PdmUiFieldEditorHandle::isMultiRowEditor() const
{
    return false;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiFieldEditorHandle::customMenuRequested(QPoint pos)
{
    PdmObjectHandle* objectHandle = nullptr;
    if (uiField() && uiField()->fieldHandle())
    {
        objectHandle = uiField()->fieldHandle()->ownerObject();
    }

    if (!objectHandle)
    {
        return;
    }

    auto widget = editorWidget();
    if (widget)
    {
        QPoint globalPos;

        auto abstractScrollAreaWidget = dynamic_cast<QAbstractScrollArea*>(widget);

        if (abstractScrollAreaWidget)
        {
            // Qt doc: QAbstractScrollArea and its subclasses that map the context menu event to coordinates of the viewport().
            globalPos = abstractScrollAreaWidget->viewport()->mapToGlobal(pos);
        }
        else
        {
            globalPos = widget->mapToGlobal(pos);
        }

        QMenu menu;
        PdmUiCommandSystemProxy::instance()->setCurrentContextMenuTargetWidget(widget);
        objectHandle->uiCapability()->defineCustomContextMenu(uiField()->fieldHandle(), &menu, widget);

        if (!menu.actions().empty())
        {
            menu.exec(globalPos);
        }
        PdmUiCommandSystemProxy::instance()->setCurrentContextMenuTargetWidget(nullptr);

    }
}

} // End of namespace caf