Caf: Add PdmUiActionPushButtonEditor as a simpler and more intuitive editor for action buttons

This commit is contained in:
Jacob Støren 2020-02-18 11:19:01 +01:00
parent 1f109d0ee2
commit 591e5ab503
3 changed files with 242 additions and 0 deletions

View File

@ -31,6 +31,7 @@ set (MOC_HEADER_FILES
cafPdmUiListViewEditor.h
cafPdmUiPropertyView.h
cafPdmUiPushButtonEditor.h
cafPdmUiActionPushButtonEditor.h
cafPdmUiSliderEditor.h
cafPdmUiTableView.h
cafPdmUiTableViewDelegate.h
@ -92,6 +93,8 @@ set( PROJECT_FILES
cafPdmUiListEditor.h
cafPdmUiPushButtonEditor.cpp
cafPdmUiPushButtonEditor.h
cafPdmUiActionPushButtonEditor.cpp
cafPdmUiActionPushButtonEditor.h
cafPdmUiSliderEditor.cpp
cafPdmUiSliderEditor.h
cafPdmUiTextEditor.cpp

View File

@ -0,0 +1,144 @@
//##################################################################################################
//
// Custom Visualization Core library
// Copyright (C) 2020- 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 "cafPdmUiActionPushButtonEditor.h"
#include "cafPdmUiDefaultObjectEditor.h"
#include "cafPdmObject.h"
#include "cafPdmUiFieldEditorHandle.h"
#include "cafPdmUiOrdering.h"
#include "cafPdmField.h"
#include "cafFactory.h"
#include <QBoxLayout>
#include <cmath>
namespace caf
{
CAF_PDM_UI_FIELD_EDITOR_SOURCE_INIT( PdmUiActionPushButtonEditor );
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiActionPushButtonEditor::configureAndUpdateUi( const QString& uiConfigName )
{
CAF_ASSERT( !m_pushButton.isNull() );
m_pushButton->setCheckable( true );
m_pushButton->setEnabled( !uiField()->isUiReadOnly( uiConfigName ) );
m_pushButton->setToolTip( uiField()->uiToolTip( uiConfigName ) );
m_buttonLayout->setAlignment(Qt::AlignRight);
if( !uiField()->uiIcon( uiConfigName ).isNull() )
{
m_pushButton->setIcon( uiField()->uiIcon( uiConfigName ) );
m_pushButton->setMaximumWidth(m_pushButton->sizeHint().width());
}
else
{
m_pushButton->setText( uiField()->uiName( uiConfigName ) );
QFontMetrics fontMetr = m_pushButton->fontMetrics();
m_pushButton->setMaximumWidth( fontMetr.width( m_pushButton->text() ) + 2 * fontMetr.width( "M" ) );
}
QVariant variantFieldValue = uiField()->uiValue();
if( variantFieldValue.type() == QVariant::Bool )
{
m_pushButton->setChecked( uiField()->uiValue().toBool() );
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiActionPushButtonEditor::configureEditorForField( PdmFieldHandle* fieldHandle )
{
CAF_ASSERT( fieldHandle );
CAF_ASSERT( fieldHandle->uiCapability() );
if( fieldHandle->xmlCapability() )
{
fieldHandle->xmlCapability()->disableIO();
}
fieldHandle->uiCapability()->setUiEditorTypeName( caf::PdmUiActionPushButtonEditor::uiEditorTypeName() );
fieldHandle->uiCapability()->setUiLabelPosition( caf::PdmUiItemInfo::HIDDEN );
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QWidget* PdmUiActionPushButtonEditor::createEditorWidget( QWidget * parent )
{
QWidget* containerWidget = new QWidget( parent );
m_pushButton = new QPushButton(containerWidget);
connect(m_pushButton, SIGNAL(clicked(bool)), this, SLOT(slotClicked(bool)));
m_buttonLayout = new QHBoxLayout(containerWidget);
m_buttonLayout->addWidget(m_pushButton);
m_buttonLayout->setMargin(0);
m_buttonLayout->setSpacing(0);
containerWidget->setLayout(m_buttonLayout);
return containerWidget;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void PdmUiActionPushButtonEditor::slotClicked( bool checked )
{
if( uiField() && dynamic_cast<PdmField<bool> *> (uiField()->fieldHandle()) )
{
QVariant v;
v = checked;
this->setValueToField( v );
}
}
} // end namespace caf

View File

@ -0,0 +1,95 @@
//##################################################################################################
//
// Custom Visualization Core library
// Copyright (C) 2020- 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.
//
//##################################################################################################
#pragma once
#include "cafPdmUiFieldEditorHandle.h"
#include <QWidget>
#include <QPointer>
#include <QPushButton>
#include <QLabel>
class QHBoxLayout;
namespace caf
{
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
class PdmUiActionPushButtonEditorAttribute : public PdmUiEditorAttribute
{
public:
// This is unused for now, but relevant customization would be:
// * Size requirement to make several buttons same size
// possibly in the form of number of "X" characters
// * Horizontal Alignment options controlling how the button will place itself in the
// assigned area: Fill, Left, Right Center default is Right
//
// * Optional label/icon to use in front of button
};
//--------------------------------------------------------------------------------------------------
/// Button using the uiIcon or (if not present) the uiName of the field as button text.
/// Aligns to the left by default, and uses only the minimum needed place.
/// Expects to work with a PdmField<bool>
//--------------------------------------------------------------------------------------------------
class PdmUiActionPushButtonEditor : public PdmUiFieldEditorHandle
{
Q_OBJECT
CAF_PDM_UI_FIELD_EDITOR_HEADER_INIT;
public:
PdmUiActionPushButtonEditor() {}
~PdmUiActionPushButtonEditor() override {}
static void configureEditorForField(PdmFieldHandle* fieldHandle);
protected:
QWidget* createEditorWidget(QWidget * parent) override;
//QWidget* createLabelWidget(QWidget * parent) override;
void configureAndUpdateUi(const QString& uiConfigName) override;
protected slots:
void slotClicked(bool checked);
private:
QPointer<QPushButton> m_pushButton;
//QPointer<QShortenedLabel> m_label;
QPointer<QHBoxLayout> m_buttonLayout;
};
} // end namespace caf