qgsprocessingoutputdestinationwidget.h

Go to the documentation of this file.

/***************************************************************************
                             qgsprocessingoutputdestinationwidget.h
                             ----------------------------------
    Date                 : March 2020
    Copyright            : (C) 2020 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 QGSPROCESSINGOUTPUTDESTINATIONWIDGET_H
#define QGSPROCESSINGOUTPUTDESTINATIONWIDGET_H
 
#include "ui_qgsprocessingdestinationwidgetbase.h"
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgsprocessingcontext.h"
#include "qgsprocessingwidgetwrapper.h"
 
#include <QAction>
#include <QWidget>
 
class QgsProcessingDestinationParameter;
class QgsBrowserGuiModel;
class QCheckBox;

class GUI_EXPORT QgsProcessingLayerOutputDestinationWidget : public QWidget, private Ui::QgsProcessingDestinationWidgetBase
{
    Q_OBJECT
 
  public:
    QgsProcessingLayerOutputDestinationWidget( const QgsProcessingDestinationParameter *parameter, bool defaultSelection, QWidget *parent SIP_TRANSFERTHIS = nullptr );

    bool outputIsSkipped() const;

    void setValue( const QVariant &value );

    QVariant value() const;

    void setWidgetContext( const QgsProcessingParameterWidgetContext &context );

    void setContext( QgsProcessingContext *context );

    void registerProcessingParametersGenerator( QgsProcessingParametersGenerator *generator );

    void addOpenAfterRunningOption();

    bool openAfterRunning() const;
 
  signals:

    void skipOutputChanged( bool skipped );

    void destinationChanged();
 
  protected:
    void dragEnterEvent( QDragEnterEvent *event ) override;
    void dragLeaveEvent( QDragLeaveEvent *event ) override;
    void dropEvent( QDropEvent *event ) override;
 
  private slots:
 
    void menuAboutToShow();
    void skipOutput();
    void saveToTemporary( const QString &name = QString() );
    void selectDirectory();
    void selectFile();
    void saveToGeopackage();
    void saveToDatabase();
    void appendToLayer();
    void selectEncoding();
    void textChanged( const QString &text );
 
  private:
    void setAppendDestination( const QString &uri, const QgsFields &destFields );

    bool couldBeTemporaryLayerName( const QString &value ) const;
    QString memoryProviderLayerName( const QString &value ) const;
 
    /*
    * Checks if two string descriptions of temporary outputs should be considered equal.
    */
    bool consideredEqualTemporaryOutputValues( const QString &val1, const QString &val2 ) const;
 
    /*
    * Converts a QVariant value to a string for comparison purposes, handling standard types nad QgsProcessingOutputLayerDefinition.
    */
    QString variantToString( const QVariant &value ) const;
 
    void setupPlaceholderText();
 
    QString mimeDataToPath( const QMimeData *data );
 
    const QgsProcessingDestinationParameter *mParameter = nullptr;
    QgsProcessingParametersGenerator *mParametersGenerator = nullptr;
    QMenu *mMenu = nullptr;
 
    bool mUseTemporary = true;
    bool mDefaultSelection = false;
    QString mEncoding;
    QgsBrowserGuiModel *mBrowserModel = nullptr;
    QCheckBox *mOpenAfterRunningCheck = nullptr;
 
    QgsRemappingSinkDefinition mRemapDefinition;
    bool mUseRemapping = false;
 
    QString mFormat;
 
    QgsProcessingContext *mContext = nullptr;
 
    QAction *mActionTemporaryOutputIcon = nullptr;
 
    // value used in leText in previous state, for comparison
    QString mPreviousValueString = QgsProcessing::TEMPORARY_OUTPUT;
 
    friend class TestProcessingGui;
};

 
#endif // QGSPROCESSINGOUTPUTDESTINATIONWIDGET_H