qgsprocessingprovideractions.h

Go to the documentation of this file.

/***************************************************************************
                             qgsprocessingprovideractions.h
                             ----------------------------------
    Date                 : September 2026
    Copyright            : (C) 2026 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 QGSPROCESSINGPROVIDERACTIONS_H
#define QGSPROCESSINGPROVIDERACTIONS_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QPointer>
 
class QgsDockWidget;
class QgsProcessingAlgorithm;

class GUI_EXPORT QgsProcessingActionContext
{
  public:
    QWidget *parentWidget() const;

    void setParentWidget( QWidget *widget );

    QString algorithmName() const;

    void setAlgorithmName( const QString &name );

    QString providerId() const;

    void setProviderId( const QString &id );
 
  private:
    QWidget *mParentWidget = nullptr;
 
    QString mAlgorithmName;
    QString mProviderId;
};

class GUI_EXPORT QgsProcessingToolboxAction
{
  public:
    //TODO QGIS 5.0 -- name and group should be mandatory
    QgsProcessingToolboxAction( const QString &name = QString(), const QString &group = QString() );
 
    virtual ~QgsProcessingToolboxAction();

    QString actionName() const { return mName; }

    Q_DECL_DEPRECATED void setActionName( const QString &name ) SIP_DEPRECATED { mName = name; }

    QString groupName() const { return mGroup; }

    Q_DECL_DEPRECATED void setGroupName( const QString &group ) SIP_DEPRECATED { mGroup = group; }
 
#ifdef SIP_RUN
    SIP_PROPERTY( name = group, get = groupName, set = setGroupName )
#endif

    virtual QIcon icon() const;

    Q_DECL_DEPRECATED virtual QIcon getIcon() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setData( QgsDockWidget *widget ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED QgsDockWidget *data() const SIP_DEPRECATED;
 
#ifdef SIP_RUN
    SIP_PROPERTY( name = toolbox, get = data, set = setData )
#endif

    Q_DECL_DEPRECATED virtual void execute() SIP_DEPRECATED;

    virtual void trigger( const QgsProcessingActionContext &context );
 
  private:
    QString mName;
    QString mGroup;
 
    mutable bool mUseDeprecatedLoopBreak = false;
 
    QPointer< QgsDockWidget > mToolboxDockWidget;
};
 

class GUI_EXPORT QgsProcessingToolboxContextAction
{
  public:
    //TODO QGIS 5.0 -- name should be mandatory
    QgsProcessingToolboxContextAction( const QString &name = QString() );
 
    virtual ~QgsProcessingToolboxContextAction();

    QString actionName() const { return mName; }

    Q_DECL_DEPRECATED void setActionName( const QString &name ) SIP_DEPRECATED { mName = name; }

    virtual QIcon icon() const;

    Q_DECL_DEPRECATED virtual bool isEnabled() const SIP_DEPRECATED;

    virtual bool isCompatibleWithAlgorithm( const QString &providerId, const QString &algorithmName );

    Q_DECL_DEPRECATED QgsDockWidget *getToolbox() SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setToolbox( QgsDockWidget *toolbox ) SIP_DEPRECATED;
 
#ifdef SIP_RUN
    SIP_PROPERTY( name = toolbox, get = getToolbox, set = setToolbox )
#endif

    Q_DECL_DEPRECATED QgsProcessingAlgorithm *getItemData() SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setItemData( QgsProcessingAlgorithm *data ) SIP_DEPRECATED;
 
#ifdef SIP_RUN
    SIP_PROPERTY( name = itemData, get = getItemData, set = setItemData )
#endif

    Q_DECL_DEPRECATED void setData( QgsProcessingAlgorithm *data, QgsDockWidget *toolbox ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED virtual void execute() SIP_DEPRECATED;

    virtual void trigger( const QgsProcessingActionContext &context );

    bool isSeparator() const;

    void setIsSeparator( bool isSeparator );
 
#ifdef SIP_RUN
    SIP_PROPERTY( name = is_separator, get = isSeparator, set = setIsSeparator )
#endif
 
  private:
    QString mName;
 
    mutable bool mUseDeprecatedLoopBreak = false;
 
    QPointer< QgsDockWidget > mToolboxDockWidget;
    QgsProcessingAlgorithm *mAlgorithm = nullptr;
 
    bool mIsSeparator = false;
};
 
 
#endif // QGSPROCESSINGPROVIDERACTIONS_H