qgsdatadefinedbutton.h

Go to the documentation of this file.

/***************************************************************************
    qgsdatadefinedbutton.h - Data defined selector button
     --------------------------------------
    Date                 : 27-April-2013
    Copyright            : (C) 2013 by Larry Shaffer
    Email                : larrys at dakcarto 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.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSDATADEFINEDBUTTON_H
#define QGSDATADEFINEDBUTTON_H

#include <QDialog>
#include <QFlags>
#include <QMap>
#include <QPointer>
#include <QToolButton>
#include <QScopedPointer>
#include "qgsexpressioncontext.h"

class QgsVectorLayer;
class QgsDataDefined;
class QgsMapCanvas;

class GUI_EXPORT QgsDataDefinedAssistant: public QDialog
{
    Q_OBJECT

  public:
    QgsDataDefinedAssistant() : mMapCanvas( nullptr ) {}

    virtual QgsDataDefined dataDefined() const = 0;

    virtual void setMapCanvas( QgsMapCanvas* canvas ) { mMapCanvas = canvas; }

    const QgsMapCanvas* mapCanvas() const { return mMapCanvas; }

  protected:

    QgsMapCanvas* mMapCanvas;
};

class GUI_EXPORT QgsDataDefinedButton: public QToolButton
{
    Q_OBJECT
    Q_PROPERTY( QString usageInfo READ usageInfo WRITE setUsageInfo )

  public:
    enum DataType
    {
      String  = 1,
      Int     = 2,
      Double  = 4,
      AnyType = String | Int | Double
    };
    Q_DECLARE_FLAGS( DataTypes, DataType )

    
    QgsDataDefinedButton( QWidget* parent = nullptr,
                          const QgsVectorLayer* vl = nullptr,
                          const QgsDataDefined* datadefined = nullptr,
                          const QgsDataDefinedButton::DataTypes& datatypes = AnyType,
                          const QString& description = QString() );
    ~QgsDataDefinedButton();

    void init( const QgsVectorLayer* vl,
               const QgsDataDefined* datadefined = nullptr,
               const QgsDataDefinedButton::DataTypes& datatypes = AnyType,
               const QString& description = QString() );

    QMap< QString, QString > definedProperty() const { return mProperty; }

    void updateDataDefined( QgsDataDefined* dd ) const;

    QgsDataDefined currentDataDefined() const;

    bool isActive() const { return mProperty.value( "active" ).toInt(); }

    bool useExpression() const { return mProperty.value( "useexpr" ).toInt(); }

    QString getExpression() const { return mProperty.value( "expression" ); }

    QString getField() const { return mProperty.value( "field" ); }

    QString currentDefinition() const { return mCurrentDefinition; }

    const DataTypes& validDataTypes() const { return mDataTypes; }

    QString fullDescription() const { return mFullDescription; }

    QString usageInfo() const { return mUsageInfo; }

    void setUsageInfo( const QString& info ) { mUsageInfo = info; updateGui(); }

    void registerEnabledWidgets( const QList<QWidget*>& wdgts );

    void registerEnabledWidget( QWidget* wdgt );

    QList<QWidget*> registeredEnabledWidgets();

    void clearEnabledWidgets() { mEnabledWidgets.clear(); }

    void registerCheckedWidgets( const QList<QWidget*>& wdgts );

    void registerCheckedWidget( QWidget* wdgt );

    QList<QWidget*> registeredCheckedWidgets();

    void clearCheckedWidgets() { mCheckedWidgets.clear(); }

    typedef QgsExpressionContext( *ExpressionContextCallback )( const void* context );

    void registerGetExpressionContextCallback( ExpressionContextCallback fnGetExpressionContext, const void* context );

    void setAssistant( const QString& title, QgsDataDefinedAssistant * assistant );

    QgsDataDefinedAssistant* assistant();

    static QString trString();
    static QString charDesc();
    static QString boolDesc();
    static QString anyStringDesc();
    static QString intDesc();
    static QString intPosDesc();
    static QString intPosOneDesc();
    static QString doubleDesc();
    static QString doublePosDesc();
    static QString double0to1Desc();
    static QString doubleXYDesc();
    static QString double180RotDesc();
    static QString intTranspDesc();
    static QString unitsMmMuDesc();
    static QString unitsMmMuPercentDesc();
    static QString colorNoAlphaDesc();
    static QString colorAlphaDesc();
    static QString textHorzAlignDesc();
    static QString textVertAlignDesc();
    static QString penJoinStyleDesc();
    static QString blendModesDesc();
    static QString svgPathDesc();
    static QString filePathDesc();
    static QString paperSizeDesc();
    static QString paperOrientationDesc();
    static QString horizontalAnchorDesc();
    static QString verticalAnchorDesc();
    static QString gradientTypeDesc();
    static QString gradientCoordModeDesc();
    static QString gradientSpreadDesc();
    static QString lineStyleDesc();
    static QString capStyleDesc();
    static QString fillStyleDesc();
    static QString markerStyleDesc();
    static QString customDashDesc();

  public slots:
    void setActive( bool active );

    void disableEnabledWidgets( bool disable );

    void checkCheckedWidgets( bool check );

  signals:
    void dataDefinedChanged( const QString& definition );

    void dataDefinedActivated( bool active );

  protected:
    void mouseReleaseEvent( QMouseEvent *event ) override;

    void setUseExpression( bool use ) { mProperty.insert( "useexpr", use ? "1" : "0" ); }

    void setExpression( const QString& exp ) { mProperty.insert( "expression", exp ); }

    void setField( const QString& field ) { mProperty.insert( "field", field ); }

  private:
    void showDescriptionDialog();
    void showExpressionDialog();
    void showAssistant();
    void updateGui();

    const QgsVectorLayer* mVectorLayer;
    QStringList mFieldNameList;
    QStringList mFieldTypeList;
    QMap< QString, QString > mProperty;
    QList< QPointer<QWidget> > mEnabledWidgets;
    QList< QPointer<QWidget> > mCheckedWidgets;

    QMenu* mDefineMenu;
    QAction* mActionDataTypes;
    QMenu* mFieldsMenu;
    QMenu* mVariablesMenu;
    QAction* mActionVariables;

    QAction* mActionActive;
    QAction* mActionDescription;
    QAction* mActionExpDialog;
    QAction* mActionExpression;
    QAction* mActionPasteExpr;
    QAction* mActionCopyExpr;
    QAction* mActionClearExpr;
    QAction* mActionAssistant;

    DataTypes mDataTypes;
    QString mDataTypesString;
    QString mInputDescription;
    QString mFullDescription;
    QString mUsageInfo;
    QString mCurrentDefinition;

    QScopedPointer<QgsDataDefinedAssistant> mAssistant;

    static QIcon mIconDataDefine;
    static QIcon mIconDataDefineOn;
    static QIcon mIconDataDefineError;
    static QIcon mIconDataDefineExpression;
    static QIcon mIconDataDefineExpressionOn;
    static QIcon mIconDataDefineExpressionError;

    ExpressionContextCallback mExpressionContextCallback;
    const void* mExpressionContextCallbackContext;

  private slots:
    void aboutToShowMenu();
    void menuActionTriggered( QAction* action );
};

Q_DECLARE_OPERATORS_FOR_FLAGS( QgsDataDefinedButton::DataTypes )


#endif // QGSDATADEFINEDBUTTON_H