pqPythonEditorActions.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 pqPythonEditorActions_h
#define pqPythonEditorActions_h

#include "pqPythonUtils.h"

#include <QAction>
#include <QMenu>
#include <QPointer>

#include <array>
#include <cstddef>
#include <vector>

class pqPythonManager;

template <typename E>
struct EditorActionGroup
{
  static_assert(static_cast<int>(E::END), "The input enum must end with END");
  static_assert(static_cast<int>(E::END) != 0, "At least one action is required");

  using Type = E;

  EditorActionGroup()
  {
    for (int i = 0; i < static_cast<int>(Type::END); ++i)
    {
      this->Actions[static_cast<Type>(i)] = new QAction();
    }
  }

  const QAction& operator[](const Type action) const { return *this->Actions[action]; }

  QAction& operator[](const Type action) { return *this->Actions[action]; }

  EnumArray<Type, QPointer<QAction>> Actions;
};

struct pqPythonEditorActions
{
  pqPythonEditorActions();

  enum class GeneralActionType : std::uint8_t
  {
    // File IO Actions
    NewFile,
    OpenFile,
    SaveFile,
    SaveFileAs,
    SaveFileAsMacro,
    SaveFileAsScript,
    DeleteAll,

    // Undo/Redo Actions
    Undo,
    Redo,

    // Text Actions
    Copy,
    Cut,
    Paste,

    // Editor Actions
    CloseCurrentTab,
    Exit,
    Run,

    END
  };

  enum class ScriptActionType : std::uint8_t
  {
    Open,
    Load,
    Delete,
    Run,

    END
  };

  using TGeneralAction = EditorActionGroup<GeneralActionType>;

  TGeneralAction GeneralActions;

  using ScriptAction = EditorActionGroup<ScriptActionType>;

  std::vector<ScriptAction> ScriptActions;

  const QAction& operator[](const GeneralActionType action) const
  {
    return this->GeneralActions[action];
  }

  QAction& operator[](const GeneralActionType action) { return this->GeneralActions[action]; }

  void updateScriptsList(pqPythonManager* python_mgr);

  void FillQMenu(EnumArray<ScriptAction::Type, QMenu*> menus);

  template <class T>
  static void connect(pqPythonEditorActions&, T*);

  template <class T>
  static void disconnect(pqPythonEditorActions&, T*);
};

#endif // pqPythonEditorActions_h