pqPythonMacroSupervisor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#ifndef pqPythonMacroSupervisor_h
#define pqPythonMacroSupervisor_h
 
#include "pqPythonModule.h"
 
#include "vtkParaViewDeprecation.h" // for deprecation
 
#include <QList>
#include <QMap>
#include <QObject>
#include <QPointer>
#include <QString>
 
class QAction;
 
class PQPYTHON_EXPORT pqPythonMacroSupervisor : public QObject
{
  Q_OBJECT
public:
  pqPythonMacroSupervisor(QObject* p = nullptr);
  ~pqPythonMacroSupervisor() override;
 
  void addWidgetForRunMacros(QWidget* widget);
 
  void addWidgetForEditMacros(QWidget* widget);
 
  void addWidgetForDeleteMacros(QWidget* widget);
 
  QAction* getMacro(const QString& fileName);
 
  static QMap<QString, QString> getStoredMacros();
 
  PARAVIEW_DEPRECATED_IN_5_12_0("Use hideFile instead.")
  static void removeStoredMacro(const QString& fileName);
 
  static void hideFile(const QString& fileName);
 
  static QString macroNameFromFileName(const QString& fileName);
 
  static QString iconPathFromFileName(const QString& fileName);
 
  static QStringList getMacrosFilePaths();
 
  static QStringList getSupportedIconFormats()
  {
    return QStringList() << ".svg"
                         << ".png";
  }
 
Q_SIGNALS:
 
  void executeScriptRequested(const QString& fileName);
 
  void onAddedMacro();
 
  void onEditMacro(const QString& fileName);
 
public Q_SLOTS:
 
  void addMacro(const QString& macroName, const QString& fileName);
  void addMacro(const QString& fileName);
 
  void removeMacro(const QString& fileName);
 
  void updateMacroList();
 
protected Q_SLOTS:
 
  void onMacroTriggered();
 
  void onDeleteMacroTriggered();
 
  void onEditMacroTriggered();
 
protected: // NOLINT(readability-redundant-access-specifiers)
  void addWidgetForMacros(QWidget* widget, int actionType); // 0:run, 1:edit, 2:delete
 
  void resetActions();
 
private:
  class pqInternal;
  pqInternal* Internal;
};
 
#endif // ifndef pqPythonMacroSupervisor_h