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 "processing/qgsprocessingcontext.h"
#include "processing/qgsprocessingfeedback.h"


class QgsProcessingAlgorithm;
class QToolButton;
class QgsProcessingAlgorithmDialogBase;
class QgsMessageBar;
class QgsProcessingAlgRunnerTask;
class QgsTask;

#ifndef SIP_RUN

class QgsProcessingAlgorithmDialogFeedback : public QgsProcessingFeedback
{
    Q_OBJECT

  public:

    QgsProcessingAlgorithmDialogFeedback() = default;

  signals:

    void progressTextChanged( const QString &text );
    void errorReported( const QString &text, bool fatalError );
    void infoPushed( const QString &text );
    void commandInfoPushed( const QString &text );
    void debugInfoPushed( const QString &text );
    void consoleInfoPushed( const QString &text );

  public slots:

    void setProgressText( const QString &text ) override;
    void reportError( const QString &error, bool fatalError ) 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;


};
#endif

class GUI_EXPORT QgsProcessingAlgorithmDialogBase : public QDialog, private Ui::QgsProcessingDialogBase
{
    Q_OBJECT

  public:

    enum LogFormat
    {
      FormatPlainText, 
      FormatHtml, 
    };

    QgsProcessingAlgorithmDialogBase( QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = nullptr );
    ~QgsProcessingAlgorithmDialogBase() override;

    void setAlgorithm( QgsProcessingAlgorithm *algorithm SIP_TRANSFER );

    QgsProcessingAlgorithm *algorithm();

    void setMainWidget( QWidget *widget SIP_TRANSFER );

    QWidget *mainWidget();

    void showLog();

    bool wasExecuted() const { return mExecuted; }

    QVariantMap results() const { return mResults; }

    QgsProcessingFeedback *createFeedback() SIP_FACTORY;

    virtual QVariantMap getParameterValues() const;

    void saveLogToFile( const QString &path, LogFormat format = FormatPlainText );

  public slots:

    void reportError( const QString &error, bool fatalError );

    void pushInfo( const QString &info );

    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();

  protected:

    void closeEvent( QCloseEvent *e ) override;

    QPushButton *runButton();

    QPushButton *cancelButton();

    QDialogButtonBox *buttonBox();

    QTabWidget *tabWidget();

    void clearProgress();

    void setExecuted( bool executed );

    void setResults( const QVariantMap &results );

    void setInfo( const QString &message, bool isError = false, bool escapeHtml = true );

    void resetGui();

    QgsMessageBar *messageBar();

    void hideShortHelp();

    void setCurrentTask( QgsProcessingAlgRunnerTask *task SIP_TRANSFER );

    static QString formatStringForLog( const QString &string );

  protected slots:

    virtual void finished( bool successful, const QVariantMap &result, QgsProcessingContext &context, QgsProcessingFeedback *feedback );

    virtual void runAlgorithm();

  private slots:

    void openHelp();
    void toggleCollapsed();

    void splitterChanged( int pos, int index );
    void linkClicked( const QUrl &url );
    void algExecuted( bool successful, const QVariantMap &results );
    void taskTriggered( QgsTask *task );
    void closeClicked();

  private:

    QPushButton *mButtonRun = nullptr;
    QPushButton *mButtonClose = nullptr;
    QByteArray mSplitterState;
    QToolButton *mButtonCollapse = nullptr;
    QgsMessageBar *mMessageBar = nullptr;

    bool mExecuted = false;
    QVariantMap mResults;
    QWidget *mMainWidget = nullptr;
    std::unique_ptr< QgsProcessingAlgorithm > mAlgorithm;
    QgsProcessingAlgRunnerTask *mAlgorithmTask = nullptr;

    bool mHelpCollapsed = false;

    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;

};

#endif


#endif // QGSPROCESSINGALGORITHMDIALOGBASE_H