qgsattributeactionpropertiesdialog.cpp

Go to the documentation of this file.

/***************************************************************************
  qgsattributeactionpropertiesdialog.cpp - QgsAttributeActionPropertiesDialog
 
 ---------------------
 begin                : 18.4.2016
 copyright            : (C) 2016 by Matthias Kuhn
 email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   This program 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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsattributeactionpropertiesdialog.h"
 
#include "qgsactionscope.h"
#include "qgsactionscoperegistry.h"
#include "qgsapplication.h"
#include "qgsexpressioncontextutils.h"
#include "qgsfieldexpressionwidget.h"
#include "qgsproject.h"
#include "qgsvectorlayer.h"
 
#include <QCheckBox>
#include <QComboBox>
#include <QFileDialog>
#include <QImageWriter>
#include <QLineEdit>
#include <QPlainTextEdit>
#include <QString>
 
#include "moc_qgsattributeactionpropertiesdialog.cpp"
 
using namespace Qt::StringLiterals;
 
QgsAttributeActionPropertiesDialog::QgsAttributeActionPropertiesDialog(
  Qgis::AttributeActionType type,
  const QString &description,
  const QString &shortTitle,
  const QString &iconPath,
  const QString &actionText,
  bool capture,
  const QSet<QString> &actionScopes,
  const QString &notificationMessage,
  bool isEnabledOnlyWhenEditable,
  QgsVectorLayer *layer,
  QWidget *parent
)
  : QDialog( parent )
  , mLayer( layer )
{
  setupUi( this );
 
  populateActionTypes();
 
  mActionType->setCurrentIndex( mActionType->findData( static_cast<int>( type ) ) );
  mActionName->setText( description );
  mShortTitle->setText( shortTitle );
  mActionIcon->setText( iconPath );
  mIconPreview->setPixmap( QPixmap( iconPath ) );
  mActionText->setText( actionText );
  mCaptureOutput->setChecked( capture );
  mNotificationMessage->setText( notificationMessage );
  mIsEnabledOnlyWhenEditable->setChecked( isEnabledOnlyWhenEditable );
 
  init( actionScopes );
}
 
QgsAttributeActionPropertiesDialog::QgsAttributeActionPropertiesDialog( QgsVectorLayer *layer, QWidget *parent )
  : QDialog( parent )
  , mLayer( layer )
{
  setupUi( this );
 
  populateActionTypes();
 
  QSet<QString> defaultActionScopes;
  defaultActionScopes << u"Canvas"_s << u"FieldSpecific"_s << u"Feature"_s << u"FeatureForm"_s;
 
  init( defaultActionScopes );
}
 
Qgis::AttributeActionType QgsAttributeActionPropertiesDialog::type() const
{
  return static_cast<Qgis::AttributeActionType>( mActionType->currentData().toInt() );
}
 
QString QgsAttributeActionPropertiesDialog::description() const
{
  return mActionName->text();
}
 
QString QgsAttributeActionPropertiesDialog::shortTitle() const
{
  return mShortTitle->text();
}
 
QString QgsAttributeActionPropertiesDialog::iconPath() const
{
  return mActionIcon->text();
}
 
QString QgsAttributeActionPropertiesDialog::actionText() const
{
  return mActionText->text();
}
 
QSet<QString> QgsAttributeActionPropertiesDialog::actionScopes() const
{
  QSet<QString> actionScopes;
 
  const auto constMActionScopeCheckBoxes = mActionScopeCheckBoxes;
  for ( QCheckBox *cb : constMActionScopeCheckBoxes )
  {
    if ( cb->isChecked() )
      actionScopes.insert( cb->property( "ActionScopeName" ).toString() );
  }
 
  return actionScopes;
}
 
QString QgsAttributeActionPropertiesDialog::notificationMessage() const
{
  return mNotificationMessage->text();
}
 
bool QgsAttributeActionPropertiesDialog::isEnabledOnlyWhenEditable() const
{
  return mIsEnabledOnlyWhenEditable->isChecked();
}
 
bool QgsAttributeActionPropertiesDialog::capture() const
{
  return mCaptureOutput->isChecked();
}
 
QgsExpressionContext QgsAttributeActionPropertiesDialog::createExpressionContext() const
{
  QgsExpressionContext context = mLayer->createExpressionContext();
 
  const auto constMActionScopeCheckBoxes = mActionScopeCheckBoxes;
  for ( QCheckBox *cb : constMActionScopeCheckBoxes )
  {
    if ( cb->isChecked() )
    {
      const QgsActionScope actionScope = QgsApplication::actionScopeRegistry()->actionScope( cb->property( "ActionScopeName" ).toString() );
      context.appendScope( new QgsExpressionContextScope( actionScope.expressionContextScope() ) );
    }
  }
 
  context << QgsExpressionContextUtils::notificationScope();
 
  return context;
}
 
void QgsAttributeActionPropertiesDialog::browse()
{
  // Popup a file browser and place the results into the action widget
  const QString action = QFileDialog::getOpenFileName( this, tr( "Select an action", "File dialog window title" ), QDir::homePath() );
 
  if ( !action.isNull() )
    mActionText->insertText( action );
}
 
void QgsAttributeActionPropertiesDialog::insertExpressionOrField()
{
  QString selText = mActionText->selectedText();
 
  // edit the selected expression if there's one
  if ( selText.startsWith( "[%"_L1 ) && selText.endsWith( "%]"_L1 ) )
    selText = selText.mid( 2, selText.size() - 4 );
 
  mActionText->insertText( "[%" + mFieldExpression->currentField() + "%]" );
}
 
void QgsAttributeActionPropertiesDialog::chooseIcon()
{
  const QList<QByteArray> list = QImageWriter::supportedImageFormats();
  QStringList formatList;
  const auto constList = list;
  for ( const QByteArray &format : constList )
    formatList << u"*.%1"_s.arg( QString( format ) );
 
  const QString filter = tr( "Images( %1 ); All( *.* )" ).arg( formatList.join( ' '_L1 ) );
  const QString icon = QFileDialog::getOpenFileName( this, tr( "Choose Icon…" ), mActionIcon->text(), filter );
 
  if ( !icon.isNull() )
  {
    mActionIcon->setText( icon );
    mIconPreview->setPixmap( QPixmap( icon ) );
  }
}
 
void QgsAttributeActionPropertiesDialog::updateButtons()
{
  if ( mActionName->text().isEmpty() || mActionText->text().isEmpty() )
  {
    mButtonBox->button( QDialogButtonBox::Ok )->setEnabled( false );
  }
  else
  {
    mButtonBox->button( QDialogButtonBox::Ok )->setEnabled( true );
  }
}
 
void QgsAttributeActionPropertiesDialog::init( const QSet<QString> &actionScopes )
{
  const QSet<QgsActionScope> availableActionScopes = QgsApplication::actionScopeRegistry()->actionScopes();
 
  const auto constAvailableActionScopes = availableActionScopes;
  for ( const QgsActionScope &scope : constAvailableActionScopes )
  {
    QCheckBox *actionScopeCheckBox = new QCheckBox( scope.title() );
    if ( actionScopes.contains( scope.id() ) )
      actionScopeCheckBox->setChecked( true );
    const QStringList variables = scope.expressionContextScope().variableNames();
 
    QString tooltip = scope.description();
    if ( !variables.empty() )
    {
      tooltip += "<br><br>"_L1;
      tooltip += tr( "Additional variables" );
      tooltip += "<ul><li>"_L1;
      tooltip += variables.join( "</li><li>"_L1 );
      tooltip += "</ul></li>"_L1;
    }
    actionScopeCheckBox->setToolTip( tooltip );
    actionScopeCheckBox->setProperty( "ActionScopeName", scope.id() );
    mActionScopeCheckBoxes.append( actionScopeCheckBox );
    mActionScopesGroupBox->layout()->addWidget( actionScopeCheckBox );
  }
 
  QgsDistanceArea myDa;
  myDa.setSourceCrs( mLayer->crs(), QgsProject::instance()->transformContext() );
  myDa.setEllipsoid( QgsProject::instance()->ellipsoid() );
 
  mFieldExpression->setLayer( mLayer );
  mFieldExpression->setGeomCalculator( myDa );
  mFieldExpression->registerExpressionContextGenerator( this );
 
  connect( mBrowseButton, &QAbstractButton::clicked, this, &QgsAttributeActionPropertiesDialog::browse );
  connect( mInsertFieldOrExpression, &QAbstractButton::clicked, this, &QgsAttributeActionPropertiesDialog::insertExpressionOrField );
  connect( mActionName, &QLineEdit::textChanged, this, &QgsAttributeActionPropertiesDialog::updateButtons );
  connect( mActionText, &QsciScintilla::textChanged, this, &QgsAttributeActionPropertiesDialog::updateButtons );
  connect( mChooseIconButton, &QAbstractButton::clicked, this, &QgsAttributeActionPropertiesDialog::chooseIcon );
 
  connect( mButtonBox, &QDialogButtonBox::helpRequested, this, &QgsAttributeActionPropertiesDialog::showHelp );
 
  updateButtons();
}
 
void QgsAttributeActionPropertiesDialog::showHelp()
{
  QgsHelp::openHelp( u"working_with_vector/vector_properties.html#actions-properties"_s );
}
 
void QgsAttributeActionPropertiesDialog::populateActionTypes()
{
  mActionType->addItem( tr( "Generic" ), static_cast<int>( Qgis::AttributeActionType::Generic ) );
  mActionType->addItem( tr( "Python" ), static_cast<int>( Qgis::AttributeActionType::GenericPython ) );
  mActionType->addItem( tr( "macOS" ), static_cast<int>( Qgis::AttributeActionType::Mac ) );
  mActionType->addItem( tr( "Windows" ), static_cast<int>( Qgis::AttributeActionType::Windows ) );
  mActionType->addItem( tr( "Unix" ), static_cast<int>( Qgis::AttributeActionType::Unix ) );
  mActionType->addItem( tr( "Open URL" ), static_cast<int>( Qgis::AttributeActionType::OpenUrl ) );
  mActionType->addItem( tr( "Submit URL (urlencoded or JSON)" ), static_cast<int>( Qgis::AttributeActionType::SubmitUrlEncoded ) );
  mActionType->addItem( tr( "Submit URL (multipart)" ), static_cast<int>( Qgis::AttributeActionType::SubmitUrlMultipart ) );
}