qgsprocessingalgorithmdialogbase.h

Go to the documentation of this file.

/***************************************************************************
                             qgsprocessingalgorithmdialogbase.h
                             ----------------------------------
    Date                 : November 2017
    Copyright            : (C) 2017 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 QGSPROCESSINGALGORITHMDIALOGBASE_H
#define QGSPROCESSINGALGORITHMDIALOGBASE_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "ui_qgsprocessingalgorithmdialogbase.h"
#include "ui_qgsprocessingalgorithmprogressdialogbase.h"
#include "ui_qgsprocessingcontextoptionsbase.h"
#include "qgsprocessingcontext.h"
#include "qgsprocessingfeedback.h"
#include "qgsprocessingwidgetwrapper.h"
 
#include <QThread>
 
 
class QgsProcessingAlgorithm;
class QToolButton;
class QgsProcessingAlgorithmDialogBase;
class QgsProcessingContextOptionsWidget;
class QgsMessageBar;
class QgsProcessingAlgRunnerTask;
class QgsTask;
 
#ifndef SIP_RUN
 
class QgsProcessingAlgorithmDialogFeedback : public QgsProcessingFeedback
{
    Q_OBJECT
 
  public:
 
    QgsProcessingAlgorithmDialogFeedback();
 
  signals:
 
    void progressTextChanged( const QString &text );
    void errorReported( const QString &text, bool fatalError );
    void warningPushed( const QString &text );
    void infoPushed( const QString &text );
    void commandInfoPushed( const QString &text );
    void debugInfoPushed( const QString &text );
    void consoleInfoPushed( const QString &text );
    void formattedMessagePushed( const QString &html );
 
  public slots:
 
    void setProgressText( const QString &text ) override;
    void reportError( const QString &error, bool fatalError ) override;
    void pushWarning( const QString &info ) override;
    void pushInfo( const QString &info ) override;
    void pushCommandInfo( const QString &info ) override;
    void pushDebugInfo( const QString &info ) override;
    void pushConsoleInfo( const QString &info ) override;
    void pushFormattedMessage( const QString &html, const QString &text ) override;
 
};
#endif
 
class GUI_EXPORT QgsProcessingAlgorithmDialogBase : public QDialog, public QgsProcessingParametersGenerator, public QgsProcessingContextGenerator, private Ui::QgsProcessingDialogBase
{
    Q_OBJECT
 
  public:
 
    enum LogFormat
    {
      FormatPlainText, 
      FormatHtml, 
    };
 
    enum class DialogMode : int
    {
      Single, 
      Batch, 
    };
    Q_ENUM( QgsProcessingAlgorithmDialogBase::DialogMode )
 
    
    QgsProcessingAlgorithmDialogBase( QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = Qt::WindowFlags(), QgsProcessingAlgorithmDialogBase::DialogMode mode = QgsProcessingAlgorithmDialogBase::DialogMode::Single );
    ~QgsProcessingAlgorithmDialogBase() override;
 
    void setAlgorithm( QgsProcessingAlgorithm *algorithm SIP_TRANSFER );
 
    QgsProcessingAlgorithm *algorithm();
 
    void setMainWidget( QgsPanelWidget *widget SIP_TRANSFER );
 
    QgsPanelWidget *mainWidget();
 
    void showLog();
 
    bool wasExecuted() const { return mExecuted; }
 
    QVariantMap results() const { return mResults; }
 
    QgsProcessingFeedback *createFeedback() SIP_FACTORY;
 
    void saveLogToFile( const QString &path, LogFormat format = FormatPlainText );
 
    Qgis::ProcessingLogLevel logLevel() const;
 
    void setLogLevel( Qgis::ProcessingLogLevel level );
 
    virtual void setParameters( const QVariantMap &values );
 
  public slots:
 
    void reportError( const QString &error, bool fatalError );
 
    void pushWarning( const QString &warning );
 
    void pushInfo( const QString &info );
 
    void pushFormattedMessage( const QString &html );
 
    void pushDebugInfo( const QString &message );
 
    void pushCommandInfo( const QString &info );
 
    void setPercentage( double percent );
 
    void setProgressText( const QString &text );
 
    void pushConsoleInfo( const QString &info );
 
    QDialog *createProgressDialog();
 
    void clearLog();
 
    void saveLog();
 
    void copyLogToClipboard();
 
    void showParameters();
 
    void reject() override;
 
  protected:
 
    void closeEvent( QCloseEvent *e ) override;
 
    QPushButton *runButton();
 
    QPushButton *cancelButton();
 
    QPushButton *changeParametersButton();
 
    QDialogButtonBox *buttonBox();
 
    QTabWidget *tabWidget();
 
    void clearProgress();
 
    void setExecuted( bool executed );
 
    void setExecutedAnyResult( bool executedAnyResult );
 
    void setResults( const QVariantMap &results );
 
    void setInfo( const QString &message, bool isError = false, bool escapeHtml = true, bool isWarning = false );
 
    void resetGui();
 
    virtual void resetAdditionalGui();
 
    void updateRunButtonVisibility();
 
    void blockControlsWhileRunning();
 
    virtual void blockAdditionalControlsWhileRunning();
 
    QgsMessageBar *messageBar();
 
    void hideShortHelp();
 
    void setCurrentTask( QgsProcessingAlgRunnerTask *task SIP_TRANSFER );
 
    static QString formatStringForLog( const QString &string );
 
    virtual bool isFinalized();
 
    void applyContextOverrides( QgsProcessingContext *context );
 
  signals:
 
    void algorithmAboutToRun( QgsProcessingContext *context );
 
    void algorithmFinished( bool successful, const QVariantMap &result );
 
  protected slots:
 
    virtual void finished( bool successful, const QVariantMap &result, QgsProcessingContext &context, QgsProcessingFeedback *feedback );
 
    virtual void runAlgorithm();
 
    virtual void algExecuted( bool successful, const QVariantMap &results );
 
  private slots:
 
    void openHelp();
    void toggleCollapsed();
 
    void splitterChanged( int pos, int index );
    void mTabWidget_currentChanged( int index );
    void linkClicked( const QUrl &url );
    void taskTriggered( QgsTask *task );
    void closeClicked();
    void urlClicked( const QUrl &url );
 
  private:
 
    DialogMode mMode = DialogMode::Single;
 
    QPushButton *mButtonRun = nullptr;
    QPushButton *mButtonClose = nullptr;
    QPushButton *mButtonChangeParameters = nullptr;
    QByteArray mSplitterState;
    QToolButton *mButtonCollapse = nullptr;
    QgsMessageBar *mMessageBar = nullptr;
    QPushButton *mAdvancedButton = nullptr;
    QMenu *mAdvancedMenu = nullptr;
    QAction *mCopyAsQgisProcessCommand = nullptr;
    QAction *mPasteJsonAction = nullptr;
    QAction *mContextSettingsAction = nullptr;
 
    bool mExecuted = false;
    bool mExecutedAnyResult = false;
    QVariantMap mResults;
    QgsPanelWidget *mMainWidget = nullptr;
    std::unique_ptr< QgsProcessingAlgorithm > mAlgorithm;
    QgsProcessingAlgRunnerTask *mAlgorithmTask = nullptr;
 
    bool mHelpCollapsed = false;
 
    int mMessageLoggedCount = 0;
 
    Qgis::ProcessingLogLevel mLogLevel = Qgis::ProcessingLogLevel::DefaultLevel;
 
    QPointer< QgsProcessingContextOptionsWidget > mContextOptionsWidget;
    bool mOverrideDefaultContextSettings = false;
    Qgis::InvalidGeometryCheck mGeometryCheck = Qgis::InvalidGeometryCheck::AbortOnInvalid;
    Qgis::DistanceUnit mDistanceUnits = Qgis::DistanceUnit::Unknown;
    Qgis::AreaUnit mAreaUnits = Qgis::AreaUnit::Unknown;
    QString mTemporaryFolderOverride;
    int mMaximumThreads = QThread::idealThreadCount();
 
    QString formatHelp( QgsProcessingAlgorithm *algorithm );
    void scrollToBottomOfLog();
    void processEvents();
 
};
 
#ifndef SIP_RUN
 
class QgsProcessingAlgorithmProgressDialog : public QDialog, private Ui::QgsProcessingProgressDialogBase
{
    Q_OBJECT
 
  public:
 
    QgsProcessingAlgorithmProgressDialog( QWidget *parent = nullptr );
 
    QProgressBar *progressBar();
 
    QPushButton *cancelButton();
 
    QTextEdit *logTextEdit();
 
  public slots:
 
    void reject() override;
 
};
 
class GUI_EXPORT QgsProcessingContextOptionsWidget : public QgsPanelWidget, private Ui::QgsProcessingContextOptionsBase
{
    Q_OBJECT
 
  public:
 
    QgsProcessingContextOptionsWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );
 
    void setFromContext( const QgsProcessingContext *context );
 
    Qgis::InvalidGeometryCheck invalidGeometryCheck() const;
 
    Qgis::DistanceUnit distanceUnit() const;
 
    Qgis::AreaUnit areaUnit() const;
 
    QString temporaryFolder();
 
    int maximumThreads() const;
 
    void setLogLevel( Qgis::ProcessingLogLevel level );
 
    Qgis::ProcessingLogLevel logLevel() const;
};
 
#endif
 
 
#endif // QGSPROCESSINGALGORITHMDIALOGBASE_H