pqStandardViewFrameActionsImplementation.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 pqStandardViewFrameActionsImplementation_h
#define pqStandardViewFrameActionsImplementation_h

#include "pqApplicationComponentsModule.h" // needed for export macros
#include "pqViewFrameActionsInterface.h"
#include <QObject>  // needed for QObject
#include <QPointer> // needed for QPointer

class pqContextView;
class pqRenderView;
class pqSpreadSheetView;
class pqView;
class QAction;
class QActionGroup;
class QShortcut;
class QWidget;

class PQAPPLICATIONCOMPONENTS_EXPORT pqStandardViewFrameActionsImplementation
  : public QObject
  , public pqViewFrameActionsInterface
{
  Q_OBJECT
  Q_INTERFACES(pqViewFrameActionsInterface);

public:
  pqStandardViewFrameActionsImplementation(QObject* parent = nullptr);
  ~pqStandardViewFrameActionsImplementation() override;

  void frameConnected(pqViewFrame* frame, pqView* view) override;

protected Q_SLOTS:
  void aboutToShowConvertMenu();

  void selectSurfaceCellsTriggered();
  void selectSurfacePointsTriggered();
  void selectFrustumCellsTriggered();
  void selectFrustumPointsTriggered();
  void selectBlocksTriggered();
  void escTriggered();

  void manageGroupExclusivity(QAction*);

  void escapeableActionToggled(bool checked);

  void interactiveSelectionToggled(bool checked);

  void captureViewTriggered();

protected: // NOLINT(readability-redundant-access-specifiers)
  virtual void setupEmptyFrame(QWidget* frame);

  virtual void addGenericActions(pqViewFrame* frame, pqView* view);

  virtual QActionGroup* addSelectionModifierActions(pqViewFrame* frame, pqView* view);

  virtual void addSeparator(pqViewFrame* frame, pqView* view);

  virtual void addContextViewActions(pqViewFrame* frame, pqContextView* chart_view);

  virtual void addRenderViewActions(pqViewFrame* frame, pqRenderView* view);

  virtual void addSpreadSheetViewActions(pqViewFrame* frame, pqSpreadSheetView* view);

  virtual bool isButtonVisible(const std::string& buttonName, pqView* view);

  struct ViewType
  {
    QString Label;
    QString Name;
    ViewType() = default;
    ViewType(const QString& label, const QString& name)
      : Label(label)
      , Name(name)
    {
    }
  };

  virtual QList<ViewType> availableViewTypes();

  virtual pqView* handleCreateView(const ViewType& viewType);

  void invoked(pqViewFrame*, const ViewType& type, const QString& command);

private:
  Q_DISABLE_COPY(pqStandardViewFrameActionsImplementation)
  QPointer<QShortcut> ShortCutSurfaceCells;
  QPointer<QShortcut> ShortCutSurfacePoints;
  QPointer<QShortcut> ShortCutFrustumCells;
  QPointer<QShortcut> ShortCutFrustumPoints;
  QPointer<QShortcut> ShortCutBlocks;
  QPointer<QShortcut> ShortCutEsc;
  QPointer<QShortcut> ShortCutGrow;
  QPointer<QShortcut> ShortCutShrink;
  static bool ViewTypeComparator(const ViewType& one, const ViewType& two);
};

#endif