qgslegendfilterbutton.cpp

Go to the documentation of this file.

/***************************************************************************
    qgslegendfilterbutton.h - QToolButton for legend filter by map content
     --------------------------------------
    Date                 : June 2015
    Copyright            : (C) 2015 by Hugo Mercier at Oslandia
    Email                : hugo dot mercier at oslandia dot com
 ***************************************************************************
 *                                                                         *
 *   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 "qgslegendfilterbutton.h"
 
#include "qgsapplication.h"
#include "qgsexpressionbuilderdialog.h"
#include "qgsexpressioncontextutils.h"
 
#include <QAction>
#include <QMenu>
#include <QString>
 
#include "moc_qgslegendfilterbutton.cpp"
 
using namespace Qt::StringLiterals;
 
QgsLegendFilterButton::QgsLegendFilterButton( QWidget *parent )
  : QToolButton( parent )
 
{
  mMenu = new QMenu( this );
  mSetExpressionAction = new QAction( tr( "Edit Filter Expression…" ), mMenu );
  connect( mSetExpressionAction, &QAction::triggered, this, &QgsLegendFilterButton::onSetLegendFilterExpression );
 
  mClearExpressionAction = new QAction( tr( "Clear Filter Expression" ), mMenu );
  connect( mClearExpressionAction, &QAction::triggered, this, &QgsLegendFilterButton::onClearFilterExpression );
  mClearExpressionAction->setEnabled( false );
 
  mMenu->addAction( mSetExpressionAction );
  mMenu->addAction( mClearExpressionAction );
 
  setCheckable( true );
  setIcon( QgsApplication::getThemeIcon( u"/mIconExpressionFilter.svg"_s ) );
  setPopupMode( QToolButton::MenuButtonPopup );
 
  setMenu( mMenu );
 
  connect( this, &QAbstractButton::toggled, this, &QgsLegendFilterButton::onToggle );
}
 
void QgsLegendFilterButton::onToggle( bool checked )
{
  if ( checked && expressionText().isEmpty() )
  {
    // show the dialog if the current expression is empty
    blockSignals( true );
    onSetLegendFilterExpression();
    blockSignals( false );
  }
}
 
void QgsLegendFilterButton::onSetLegendFilterExpression()
{
  QgsExpressionContext context;
  if ( mExpressionContextGenerator )
    context = mExpressionContextGenerator->createExpressionContext();
  else
  {
    context.appendScopes( QgsExpressionContextUtils::globalProjectLayerScopes( mLayer ) );
  }
  QgsExpressionBuilderDialog dlg( mLayer, mExpression, nullptr, u"generic"_s, context );
  if ( dlg.exec() )
  {
    setExpressionText( dlg.expressionText() );
 
    bool emitSignal = false;
    if ( !expressionText().isEmpty() )
    {
      emitSignal = isChecked();
      setChecked( true );
    }
    else
    {
      emitSignal = !isChecked();
      setChecked( false );
    }
    if ( emitSignal )
      emit toggled( isChecked() );
  }
}
 
void QgsLegendFilterButton::registerExpressionContextGenerator( QgsExpressionContextGenerator *generator )
{
  mExpressionContextGenerator = generator;
}
 
void QgsLegendFilterButton::onClearFilterExpression()
{
  mClearExpressionAction->setEnabled( false );
  setExpressionText( QString() );
 
  setChecked( false );
}
 
void QgsLegendFilterButton::updateMenu()
{
  if ( !mExpression.isEmpty() )
  {
    mClearExpressionAction->setEnabled( true );
    mSetExpressionAction->setText( tr( "Edit Filter Expression (current: %1)" ).arg( mExpression ) );
  }
  else
  {
    mClearExpressionAction->setEnabled( false );
    mSetExpressionAction->setText( tr( "Edit Filter Expression" ) );
  }
}
 
QString QgsLegendFilterButton::expressionText() const
{
  return mExpression;
}
 
void QgsLegendFilterButton::setExpressionText( const QString &expression )
{
  mExpression = expression;
  updateMenu();
}
 
QgsVectorLayer *QgsLegendFilterButton::vectorLayer() const
{
  return mLayer;
}
 
void QgsLegendFilterButton::setVectorLayer( QgsVectorLayer *layer )
{
  mLayer = layer;
}