qgsprocessingmultipleselectiondialog.h

Go to the documentation of this file.

/***************************************************************************
                             qgsprocessingmultipleselectiondialog.h
                             ----------------------------------
    Date                 : February 2019
    Copyright            : (C) 2019 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 QGSPROCESSINGMULTIPLESELECTIONDIALOG_H
#define QGSPROCESSINGMULTIPLESELECTIONDIALOG_H
 
#include "ui_qgsprocessingmultipleselectiondialogbase.h"
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgsmimedatautils.h"
#include "qgsprocessingparameters.h"
 
#include <QDialog>
 
class QStandardItemModel;
class QToolButton;
class QStandardItem;
class QgsProcessingModelChildParameterSource;
class QgsProcessingModelAlgorithm;


class GUI_EXPORT QgsProcessingMultipleSelectionPanelWidget : public QgsPanelWidget, private Ui::QgsProcessingMultipleSelectionDialogBase
{
    Q_OBJECT
 
  public:
    QgsProcessingMultipleSelectionPanelWidget( const QVariantList &availableOptions = QVariantList(), const QVariantList &selectedOptions = QVariantList(), QWidget *parent SIP_TRANSFERTHIS = nullptr );

#ifndef SIP_RUN
    void setValueFormatter( const std::function<QString( const QVariant & )> &formatter );
#else
    void setValueFormatter( SIP_PYCALLABLE );
    //%MethodCode
 
    Py_BEGIN_ALLOW_THREADS
 
      sipCpp->setValueFormatter( [a0]( const QVariant &v ) -> QString {
        QString res;
        SIP_BLOCK_THREADS
        PyObject *s = sipCallMethod( NULL, a0, "D", &v, sipType_QVariant, NULL );
        int state;
        int sipIsError = 0;
        QString *t1 = reinterpret_cast<QString *>( sipConvertToType( s, sipType_QString, 0, SIP_NOT_NONE, &state, &sipIsError ) );
        if ( sipIsError == 0 )
        {
          res = QString( *t1 );
        }
        sipReleaseType( t1, sipType_QString, state );
        SIP_UNBLOCK_THREADS
        return res;
      } );
 
    Py_END_ALLOW_THREADS
    //%End
#endif
 

    QVariantList selectedOptions() const;

    QDialogButtonBox *buttonBox() { return mButtonBox; }
 
  signals:

    void acceptClicked();

    void selectionChanged();
 
  protected:
    void addOption( const QVariant &value, const QString &title, bool selected, bool updateExistingTitle = false, QIcon optionalIconDecoration = QIcon(), const QString &tooltip = QString() );
    QListView *listView() const { return mSelectionList; }

    QStandardItemModel *mModel = nullptr;
    std::function<QString( const QVariant & )> mValueFormatter;
 
    void dragEnterEvent( QDragEnterEvent *event ) override;
    void dropEvent( QDropEvent *event ) override;
 
  private slots:
 
    void selectAll( bool checked );
    void toggleSelection();
 
  private:
    QPushButton *mButtonSelectAll = nullptr;
    QPushButton *mButtonClearSelection = nullptr;
    QPushButton *mButtonToggleSelection = nullptr;
 
    QList<QStandardItem *> currentItems();
 
    void populateList( const QVariantList &availableOptions, const QVariantList &selectedOptions );
 
    friend class TestProcessingGui;

    QList<int> existingMapLayerFromMimeData( const QMimeData *data ) const;
};
 

class GUI_EXPORT QgsProcessingMultipleSelectionDialog : public QDialog
{
    Q_OBJECT
 
  public:
    QgsProcessingMultipleSelectionDialog(
      const QVariantList &availableOptions = QVariantList(), const QVariantList &selectedOptions = QVariantList(), QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = Qt::WindowFlags()
    );
 

#ifndef SIP_RUN
    void setValueFormatter( const std::function<QString( const QVariant & )> &formatter );
#else
    void setValueFormatter( SIP_PYCALLABLE );
    //%MethodCode
 
    Py_BEGIN_ALLOW_THREADS
 
      sipCpp->setValueFormatter( [a0]( const QVariant &v ) -> QString {
        QString res;
        SIP_BLOCK_THREADS
        PyObject *s = sipCallMethod( NULL, a0, "D", &v, sipType_QVariant, NULL );
        int state;
        int sipIsError = 0;
        QString *t1 = reinterpret_cast<QString *>( sipConvertToType( s, sipType_QString, 0, SIP_NOT_NONE, &state, &sipIsError ) );
        if ( sipIsError == 0 )
        {
          res = QString( *t1 );
        }
        sipReleaseType( t1, sipType_QString, state );
        SIP_UNBLOCK_THREADS
        return res;
      } );
 
    Py_END_ALLOW_THREADS
    //%End
#endif
 

    QVariantList selectedOptions() const;
 
  private:
    QgsProcessingMultipleSelectionPanelWidget *mWidget = nullptr;
};
 

class GUI_EXPORT QgsProcessingMultipleInputPanelWidget : public QgsProcessingMultipleSelectionPanelWidget
{
    Q_OBJECT
 
  public:
    QgsProcessingMultipleInputPanelWidget(
      const QgsProcessingParameterMultipleLayers *parameter,
      const QVariantList &selectedOptions,
      const QList<QgsProcessingModelChildParameterSource> &modelSources,
      QgsProcessingModelAlgorithm *model = nullptr,
      QWidget *parent SIP_TRANSFERTHIS = nullptr
    );

    void setProject( QgsProject *project );

    static QStringList compatibleUrisFromMimeData( const QgsProcessingParameterMultipleLayers *parameter, const QMimeData *data, const QgsMimeDataUtils::UriList &skipUrls ) SIP_SKIP;
 
  private slots:
 
    void addFiles();
    void addDirectory();
 
  protected:
    void dragEnterEvent( QDragEnterEvent *event ) override;
    void dropEvent( QDropEvent *event ) override;
 
  private:
    QList<int> existingMapLayerFromMimeData( const QMimeData *data, QgsMimeDataUtils::UriList &handledUrls ) const;
    void populateFromProject( QgsProject *project );
 
    const QgsProcessingParameterMultipleLayers *mParameter = nullptr;
};
 

class GUI_EXPORT QgsProcessingMultipleInputDialog : public QDialog
{
    Q_OBJECT
 
  public:
    QgsProcessingMultipleInputDialog(
      const QgsProcessingParameterMultipleLayers *parameter,
      const QVariantList &selectedOptions,
      const QList<QgsProcessingModelChildParameterSource> &modelSources,
      QgsProcessingModelAlgorithm *model = nullptr,
      QWidget *parent SIP_TRANSFERTHIS = nullptr,
      Qt::WindowFlags flags = Qt::WindowFlags()
    );

    QVariantList selectedOptions() const;

    void setProject( QgsProject *project );
 
  private:
    QgsProcessingMultipleInputPanelWidget *mWidget = nullptr;
};
 

 
#endif // QGSPROCESSINGMULTIPLESELECTIONDIALOG_H