mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-17 00:04:02 -04:00
240c52a4c0
which cannot run in background tasks This is not fantastic UX, but we have lots of constraints here: - The algorithm dialog itself cannot be made modal. There's child widgets (such as the point and extent parameter widgets) which interact with the main QGIS window. - There is no reliable way in Qt to make a dialog modal after it's shown (e.g. make it modal only when the algorithm is running). Trust me - I've tried everything, and all approaches break with some corner case. - For non-background algorithms, we must have processEvents calls in order to show the algorithm feedback and progress to users, and detect cancel button clicks. Yet these processEvents calls means that users can interact with other parts of QGIS, e.g. removing layers from a project, and other operations which could cause the algorithm to crash. So we MUST have some modal dialog in order to block interactions outside of allowing the cancel button clicks/progress repainting. I've tried many approaches, but this is the only one which works reliably...
227 lines
5.2 KiB
Plaintext
227 lines
5.2 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/processing/qgsprocessingalgorithmdialogbase.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsProcessingAlgorithmDialogBase : QDialog
|
|
{
|
|
%Docstring
|
|
Base class for processing algorithm dialogs.
|
|
|
|
.. note::
|
|
|
|
This is not considered stable API and may change in future QGIS versions.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsprocessingalgorithmdialogbase.h"
|
|
%End
|
|
public:
|
|
|
|
QgsProcessingAlgorithmDialogBase( QWidget *parent = 0, Qt::WindowFlags flags = 0 );
|
|
%Docstring
|
|
Constructor for QgsProcessingAlgorithmDialogBase.
|
|
%End
|
|
|
|
void setAlgorithm( QgsProcessingAlgorithm *algorithm );
|
|
%Docstring
|
|
Sets the ``algorithm`` to run in the dialog.
|
|
|
|
.. seealso:: :py:func:`algorithm()`
|
|
%End
|
|
|
|
QgsProcessingAlgorithm *algorithm();
|
|
%Docstring
|
|
Returns the algorithm running in the dialog.
|
|
|
|
.. seealso:: :py:func:`setAlgorithm()`
|
|
%End
|
|
|
|
void setMainWidget( QWidget *widget /Transfer/ );
|
|
%Docstring
|
|
Sets the main ``widget`` for the dialog, usually a panel for configuring algorithm parameters.
|
|
|
|
.. seealso:: :py:func:`mainWidget()`
|
|
%End
|
|
|
|
QWidget *mainWidget();
|
|
%Docstring
|
|
Returns the main widget for the dialog, usually a panel for configuring algorithm parameters.
|
|
|
|
.. seealso:: :py:func:`setMainWidget()`
|
|
%End
|
|
|
|
void showLog();
|
|
%Docstring
|
|
Switches the dialog to the log page.
|
|
%End
|
|
|
|
bool wasExecuted() const;
|
|
%Docstring
|
|
Returns true if an algorithm was executed in the dialog.
|
|
|
|
.. seealso:: :py:func:`results()`
|
|
|
|
.. seealso:: :py:func:`setExecuted()`
|
|
%End
|
|
|
|
QVariantMap results() const;
|
|
%Docstring
|
|
Returns the results returned by the algorithm executed.
|
|
|
|
.. seealso:: :py:func:`wasExecuted()`
|
|
|
|
.. seealso:: :py:func:`setResults()`
|
|
%End
|
|
|
|
QgsProcessingFeedback *createFeedback() /Factory/;
|
|
%Docstring
|
|
Creates a new processing feedback object, automatically connected to the appropriate
|
|
slots in this dialog.
|
|
%End
|
|
|
|
virtual QVariantMap getParameterValues() const;
|
|
%Docstring
|
|
Returns the parameter values for the algorithm to run in the dialog.
|
|
%End
|
|
|
|
public slots:
|
|
|
|
virtual void accept();
|
|
|
|
|
|
void reportError( const QString &error );
|
|
%Docstring
|
|
Reports an ``error`` string to the dialog's log.
|
|
%End
|
|
|
|
void pushInfo( const QString &info );
|
|
%Docstring
|
|
Pushes an information string to the dialog's log.
|
|
%End
|
|
|
|
void pushDebugInfo( const QString &message );
|
|
%Docstring
|
|
Pushes a debug info string to the dialog's log.
|
|
%End
|
|
|
|
void pushCommandInfo( const QString &info );
|
|
%Docstring
|
|
Pushes command info to the dialog's log.
|
|
%End
|
|
|
|
void setPercentage( double percent );
|
|
%Docstring
|
|
Sets the percentage progress for the dialog, between 0 and 100.
|
|
%End
|
|
|
|
void setProgressText( const QString &text );
|
|
%Docstring
|
|
Sets a progress text message.
|
|
%End
|
|
|
|
void pushConsoleInfo( const QString &info );
|
|
%Docstring
|
|
Pushes a console info string to the dialog's log.
|
|
%End
|
|
|
|
QDialog *createProgressDialog();
|
|
%Docstring
|
|
Creates a modal progress dialog showing progress and log messages
|
|
from this dialog.
|
|
%End
|
|
|
|
protected:
|
|
|
|
QPushButton *runButton();
|
|
%Docstring
|
|
Returns the dialog's run button.
|
|
%End
|
|
|
|
QPushButton *cancelButton();
|
|
%Docstring
|
|
Returns the dialog's cancel button.
|
|
%End
|
|
|
|
QDialogButtonBox *buttonBox();
|
|
%Docstring
|
|
Returns the dialog's button box.
|
|
%End
|
|
|
|
QTabWidget *tabWidget();
|
|
%Docstring
|
|
Returns the dialog's tab widget.
|
|
%End
|
|
|
|
void clearProgress();
|
|
%Docstring
|
|
Clears any current progress from the dialog.
|
|
%End
|
|
|
|
void setExecuted( bool executed );
|
|
%Docstring
|
|
Sets whether the algorithm was executed through the dialog.
|
|
|
|
.. seealso:: :py:func:`wasExecuted()`
|
|
|
|
.. seealso:: :py:func:`setResults()`
|
|
%End
|
|
|
|
void setResults( const QVariantMap &results );
|
|
%Docstring
|
|
Sets the algorithm results.
|
|
|
|
.. seealso:: :py:func:`results()`
|
|
|
|
.. seealso:: :py:func:`setExecuted()`
|
|
%End
|
|
|
|
void setInfo( const QString &message, bool isError = false, bool escapeHtml = true );
|
|
%Docstring
|
|
Displays an info ``message`` in the dialog's log.
|
|
%End
|
|
|
|
void resetGui();
|
|
%Docstring
|
|
Resets the dialog's gui, ready for another algorithm execution.
|
|
%End
|
|
|
|
QgsMessageBar *messageBar();
|
|
%Docstring
|
|
Returns the dialog's message bar.
|
|
%End
|
|
|
|
void hideShortHelp();
|
|
%Docstring
|
|
Hides the short help panel.
|
|
%End
|
|
|
|
protected slots:
|
|
|
|
virtual void finished( bool successful, const QVariantMap &result, QgsProcessingContext &context, QgsProcessingFeedback *feedback );
|
|
%Docstring
|
|
Called when the algorithm has finished executing.
|
|
%End
|
|
|
|
};
|
|
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/processing/qgsprocessingalgorithmdialogbase.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|