qgspropertyoverridebutton.h

Go to the documentation of this file.

/***************************************************************************
     qgspropertyoverridebutton.h
     ---------------------------
    Date                 : January 2017
    Copyright            : (C) 2017 by Nyall Dawson
    Email                : nyall dot dawson at gmail 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 QGSPROPERTYOVERRIDEBUTTON_H
#define QGSPROPERTYOVERRIDEBUTTON_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsexpressioncontextgenerator.h"
#include "qgsproperty.h"
#include "qgspropertycollection.h"
 
#include <QDialog>
#include <QFlags>
#include <QMap>
#include <QPointer>
#include <QToolButton>
 
class QgsVectorLayer;
class QgsMapCanvas;
class QgsSymbol;

 
class GUI_EXPORT QgsPropertyOverrideButton : public QToolButton
{
    Q_OBJECT
    Q_PROPERTY( QString usageInfo READ usageInfo WRITE setUsageInfo )
    Q_PROPERTY( bool active READ isActive WRITE setActive )
 
  public:
    QgsPropertyOverrideButton( QWidget *parent SIP_TRANSFERTHIS = nullptr, const QgsVectorLayer *layer = nullptr );

    void init( int propertyKey, const QgsProperty &property, const QgsPropertiesDefinition &definitions, const QgsVectorLayer *layer = nullptr, bool auxiliaryStorageEnabled = false );

    void init( int propertyKey, const QgsProperty &property, const QgsPropertyDefinition &definition, const QgsVectorLayer *layer = nullptr, bool auxiliaryStorageEnabled = false );

    void init( int propertyKey, const QgsAbstractPropertyCollection &collection, const QgsPropertiesDefinition &definitions, const QgsVectorLayer *layer = nullptr, bool auxiliaryStorageEnabled = false );

    QgsProperty toProperty() const;

    void setToProperty( const QgsProperty &property );

    int propertyKey() const { return mPropertyKey; }

    bool isActive() const { return mProperty && mProperty.isActive(); }

    QgsPropertyDefinition::DataType validDataType() const { return mDataTypes; }

    QString fullDescription() const { return mFullDescription; }

    QString usageInfo() const { return mUsageInfo; }

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

    void setVectorLayer( const QgsVectorLayer *layer );

    const QgsVectorLayer *vectorLayer() const { return mVectorLayer; }

    void registerCheckedWidget( QWidget *widget, bool natural = true );

    void registerEnabledWidget( QWidget *widget, bool natural = true );

    void registerVisibleWidget( QWidget *widget, bool natural = true );

    void registerExpressionWidget( QWidget *widget );

    void registerExpressionContextGenerator( QgsExpressionContextGenerator *generator );

    void registerLinkedWidget( QWidget *widget );

    void updateFieldLists();

    void setSymbol( std::shared_ptr<QgsSymbol> symbol ) SIP_SKIP
    {
      mSymbol = std::move( symbol );
    }
 
  public slots:

    void setActive( bool active );
 

 
    // exposed to Python for testing only
    void aboutToShowMenu();
    void menuActionTriggered( QAction *action );

 
  signals:

    void changed();

    void activated( bool isActive );

    void createAuxiliaryField();
 
  protected:
    void mouseReleaseEvent( QMouseEvent *event ) override;
 
  private:
    void showDescriptionDialog();
    void showExpressionDialog();
    void showAssistant();
    void updateGui();

    void setActivePrivate( bool active );
 
    // Returns color name if current expression is a reference to a color
    QString getColor() const;
 
    int mPropertyKey = -1;
 
    const QgsVectorLayer *mVectorLayer = nullptr;
 
    QStringList mFieldNameList;
    QStringList mFieldDisplayNameList;
    QList<QIcon> mFieldIcons;
 
    QString mExpressionString;
    QString mFieldName;
 
    QMenu *mDefineMenu = nullptr;
    QAction *mActionDataTypes = nullptr;
    QMenu *mFieldsMenu = nullptr;
    QMenu *mVariablesMenu = nullptr;
    QAction *mActionVariables = nullptr;
    QMenu *mColorsMenu = nullptr;
    QAction *mActionColors = nullptr;
 
    QAction *mActionActive = nullptr;
    QAction *mActionDescription = nullptr;
    QAction *mActionExpDialog = nullptr;
    QAction *mActionExpression = nullptr;
    QAction *mActionPasteExpr = nullptr;
    QAction *mActionCopyExpr = nullptr;
    QAction *mActionClearExpr = nullptr;
    QAction *mActionAssistant = nullptr;
    QAction *mActionCreateAuxiliaryField = nullptr;
 
    QgsPropertyDefinition mDefinition;
 
    QgsPropertyDefinition::DataType mDataTypes = QgsPropertyDefinition::DataTypeString;
    QString mDataTypesString;
    QString mInputDescription;
    QString mFullDescription;
    QString mUsageInfo;
 
    QgsExpressionContextGenerator *mExpressionContextGenerator = nullptr;
 
    enum SiblingType
    {
      SiblingCheckState,
      SiblingEnableState,
      SiblingVisibility,
      SiblingExpressionText,
      SiblingLinkedWidget,
    };
    struct SiblingWidget
    {
        SiblingWidget( const QPointer<QWidget> &widgetPointer, SiblingType siblingType, bool natural = true )
          : mWidgetPointer( widgetPointer )
          , mSiblingType( siblingType )
          , mNatural( natural )
        {}
        QPointer<QWidget> mWidgetPointer;
        SiblingType mSiblingType;
        bool mNatural;
    };
    QList<SiblingWidget> mSiblingWidgets;

    QgsProperty mProperty;
 
    bool mAuxiliaryStorageEnabled = false;
 
    std::shared_ptr<QgsSymbol> mSymbol;
 
  private slots:
 
    void showHelp();
    void updateSiblingWidgets( bool state );
};
 
#endif // QGSPROPERTYOVERRIDEBUTTON_H