pqProxyInfo.h

Go to the documentation of this file.

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

#include "pqApplicationComponentsModule.h"

#include <QObject>

#include <QMap>     // for QMap
#include <QPointer> // for QPointer
#include <QString>  // for QString

class pqProxyCategory;
class vtkPVXMLElement;

class pqProxyInfo : public QObject
{
  Q_OBJECT
  typedef QObject Superclass;

public:
  pqProxyInfo(pqProxyCategory* parent, const QString& name, const QString& group,
    const QString& label, const QString& icon = "",
    const QStringList& omitFromToolbar = QStringList(), bool hideFromMenu = false);

  pqProxyInfo(pqProxyCategory* parent, pqProxyInfo* other);
  pqProxyInfo(pqProxyCategory* parent, vtkPVXMLElement* xmlElement);
  pqProxyInfo() = default;

  void setLabel(const QString& label);

  void setHideFromMenu(bool hidden);

  void setIcon(const QString& iconPath);

  void merge(pqProxyInfo* other);

  static QMap<QString, QPointer<pqProxyInfo>> mergeProxies(
    const QMap<QString, QPointer<pqProxyInfo>>& proxies,
    const QMap<QString, QPointer<pqProxyInfo>>& otherProxies);

  void convertToXML(vtkPVXMLElement* root);


  QString name() { return this->Name; }
  QString group() { return this->Group; }
  QString label();
  QString icon() { return this->Icon; }
  QStringList omitFromToolbar() { return this->OmitFromToolbar; }
  bool hideFromMenu();

private:
  QString Name;
  QString Group;
  QString Label;
  QString Icon;
  QStringList OmitFromToolbar;
  bool HideFromMenu = false;
};

using pqProxyInfoMap = QMap<QString, pqProxyInfo*>;

#endif