pqProxyAction.h

Go to the documentation of this file.

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

#ifndef pqProxyAction_h
#define pqProxyAction_h

#include "pqComponentsModule.h"

#include <QObject>
#include <QPointer>

class QAction;
class pqOutputPort;
class vtkSMProxy;

class PQCOMPONENTS_EXPORT pqProxyAction : public QObject
{
  Q_OBJECT
  typedef QObject Superclass;

public:
  pqProxyAction(QObject* parent, QAction* action);
  ~pqProxyAction() override;

  QAction* GetAction();

  bool IsEnabled();

  QString GetDisplayName();

  QIcon GetIcon();

  QString GetRequirement();

  QString GetProxyName();

  QString GetProxyGroup();

  QString GetDocumentation();

  static QString GetProxyDocumentation(QAction*);

  static vtkSMProxy* GetProxyPrototype(QAction*);

  static QString GetProxyName(QAction*);

  static QString GetProxyGroup(QAction*);

  static void updateActionsState(QList<QAction*> actions);

private:
  static void updateActionStatus(
    QAction* action, bool enabled, const QList<pqOutputPort*>& outputPorts);

  static QList<pqOutputPort*> getOutputPorts();

  QPointer<QAction> Action;
};

#endif