qgsprocessingmaplayercombobox.h

Go to the documentation of this file.

/***************************************************************************
    qgsprocessingmaplayercombobox.h
    -----------------------------
    begin                : June 2019
    copyright            : (C) 2019 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 QGSPROCESSINGMAPLAYERCOMBOBOX_H
#define QGSPROCESSINGMAPLAYERCOMBOBOX_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include <QTreeView>
#include "qgsfeatureid.h"
#include "qgsmimedatautils.h"
#include "qgsprocessingcontext.h"
#include "qgsprocessinggui.h"
 
class QgsMapLayerComboBox;
class QToolButton;
class QCheckBox;
class QgsProcessingParameterDefinition;
class QgsBrowserGuiModel;
class QgsProcessingParameterWidgetContext;
 
 
class GUI_EXPORT QgsProcessingMapLayerComboBox : public QWidget
{
    Q_OBJECT
 
  public:
    QgsProcessingMapLayerComboBox( const QgsProcessingParameterDefinition *parameter, Qgis::ProcessingMode type = Qgis::ProcessingMode::Standard, QWidget *parent = nullptr );
 
    ~QgsProcessingMapLayerComboBox() override;
 
    void setLayer( QgsMapLayer *layer );
 
    QgsMapLayer *currentLayer();
 
    QString currentText();
 
    void setValue( const QVariant &value, QgsProcessingContext &context );
 
    QVariant value() const;
 
    void setWidgetContext( const QgsProcessingParameterWidgetContext &context );
 
    void setEditable( bool editable );
 
    bool isEditable() const;
 
  signals:
 
    void valueChanged();
 
  protected:
    void dragEnterEvent( QDragEnterEvent *event ) override;
    void dragLeaveEvent( QDragLeaveEvent *event ) override;
    void dropEvent( QDropEvent *event ) override;
 
  private slots:
 
    void onLayerChanged( QgsMapLayer *layer );
    void selectionChanged( const QgsFeatureIds &selected, const QgsFeatureIds &deselected, bool clearAndSelect );
    void showSourceOptions();
    void selectFromFile();
    void browseForLayer();
 
  private:
    std::unique_ptr<QgsProcessingParameterDefinition> mParameter;
    QgsMapLayerComboBox *mCombo = nullptr;
    QToolButton *mSelectButton = nullptr;
    QToolButton *mIterateButton = nullptr;
    QToolButton *mSettingsButton = nullptr;
    QCheckBox *mUseSelectionCheckBox = nullptr;
    bool mDragActive = false;
    long long mFeatureLimit = -1;
    QString mFilterExpression;
    bool mIsOverridingDefaultGeometryCheck = false;
    Qgis::InvalidGeometryCheck mGeometryCheck = Qgis::InvalidGeometryCheck::AbortOnInvalid;
    QPointer<QgsMapLayer> mPrevLayer;
    int mBlockChangedSignal = 0;
 
    QgsBrowserGuiModel *mBrowserModel = nullptr;
 
    QMenu *mFeatureSourceMenu = nullptr;
    QgsMapLayer *compatibleMapLayerFromMimeData( const QMimeData *data, bool &incompatibleLayerSelected ) const;
    QString compatibleUriFromMimeData( const QMimeData *data ) const;
};
 
#endif // QGSPROCESSINGMAPLAYERCOMBOBOX_H