pqProxyCategory.h

Go to the documentation of this file.

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

#include "pqApplicationComponentsModule.h"

#include "pqProxyInfo.h" // for pqProxyInfoMap
#include <QMap>          // for QMap
#include <QString>       // for QString

class vtkPVXMLElement;

class PQAPPLICATIONCOMPONENTS_EXPORT pqProxyCategory : public QObject
{
  Q_OBJECT
  typedef QObject Superclass;

public:
  pqProxyCategory(pqProxyCategory* parent = nullptr);
  pqProxyCategory(pqProxyCategory* parent, const QString& name, const QString& label);
  ~pqProxyCategory() override;

  bool parseXML(vtkPVXMLElement* root);
  void convertToXML(vtkPVXMLElement* root) { this->convertToXML(this, root); }
  bool parseXMLHintsTag(
    const QString& proxyGroup, const QString& proxyName, vtkPVXMLElement* hints);
  static void convertLegacyXML(vtkPVXMLElement* root);

  void writeSettings(const QString& resourceTag);
  void loadSettings(const QString& resourceTag);


  void copyAttributes(pqProxyCategory* other);
  void deepCopy(pqProxyCategory* other);

  bool hasProxy(const QString& name);
  pqProxyInfo* findProxy(const QString& name, bool recursive = false);
  QList<pqProxyInfo*> getRootProxies();
  QList<pqProxyInfo*> getProxiesRecursive();
  QStringList getOrderedRootProxiesNames();

  pqProxyCategory* findSubCategory(const QString& name);
  QMap<QString, pqProxyCategory*> getSubCategories();
  QMap<QString, pqProxyCategory*> getSubCategoriesRecursive();
  QList<pqProxyCategory*> getCategoriesAlphabetically();
  QString makeUniqueCategoryName(const QString& name);
  QString makeUniqueCategoryLabel(const QString& label);

  void addCategory(pqProxyCategory* category);
  void removeCategory(const QString& name);
  void addProxy(pqProxyInfo* info);
  void removeProxy(const QString& name);
  void clear();

  bool hasProxiesRecursive();
  pqProxyCategory* parentCategory() { return dynamic_cast<pqProxyCategory*>(this->parent()); }
  bool isEmpty();
  QString name() { return this->Name; }
  QString label();
  bool preserveOrder() { return this->PreserveOrder; }
  bool showInToolbar() { return this->ShowInToolbar; }

  void rename(const QString& name);
  void updateLabel(const QString& label = "");
  void setShowInToolbar(bool show);

protected:
  pqProxyCategory* addCategory(const QString& name, vtkPVXMLElement* node);

protected Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)

  void cleanDeletedProxy(QObject* deleted);

private:
  bool parseXML(pqProxyCategory* categoryRoot, vtkPVXMLElement* root);

  void convertToXML(pqProxyCategory* parent, vtkPVXMLElement* root);

  QString Name;
  QString Label;

  bool PreserveOrder = false;
  bool ShowInToolbar = false;

  pqProxyInfoMap Proxies;
  QMap<QString, pqProxyCategory*> SubCategories;
  QStringList OrderedProxies;
};

using pqCategoryMap = QMap<QString, pqProxyCategory*>;

#endif