pqPythonMacroSettings.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause

#ifndef pqPythonMacroSettings_h
#define pqPythonMacroSettings_h

#include "pqPythonModule.h" // for exports

#include <QMap>
#include <QString>

class PQPYTHON_EXPORT pqPythonMacroSettings
{
public:
  enum class MacroItemCategories
  {
    ToolTip,
    Name,
    Unused
  };

  explicit pqPythonMacroSettings(MacroItemCategories currentCategory);

  void setItemInSettings(const QString& macroPath, const QString& value);

  QString getItemFromSettings(const QString& macroPath);

  QMap<QString, QString> getItemSettings();

  void writeItemSettings(const QMap<QString, QString>& settingsMap);

  void removeItemFromSettings(const QString& macroPath);

private:
  bool getItemIndexInSettings(const QString& macroPath, int& idx, int& size);

  MacroItemCategories CurrentCategory = MacroItemCategories::Unused;
};

#endif // pqPythonMacroSettings_h