pqPipelineBrowserWidget.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 pqPipelineBrowserWidget_h
#define pqPipelineBrowserWidget_h

#include "pqComponentsModule.h"
#include "pqFlatTreeView.h"

#include <QPointer>

class pqPipelineModel;
class pqPipelineAnnotationFilterModel;
class pqPipelineSource;
class pqOutputPort;
class pqView;
class QMenu;
class vtkSession;

class PQCOMPONENTS_EXPORT pqPipelineBrowserWidget : public pqFlatTreeView
{
  Q_OBJECT
  typedef pqFlatTreeView Superclass;

public:
  pqPipelineBrowserWidget(QWidget* parent = nullptr);
  ~pqPipelineBrowserWidget() override;

  bool eventFilter(QObject* object, QEvent* e) override;

  void setSelectionVisibility(bool visible);

  void enableAnnotationFilter(const QString& annotationKey);

  void disableAnnotationFilter();

  void setAnnotationFilterMatching(bool matching);

  void enableSessionFilter(vtkSession* session);

  void disableSessionFilter();

  void setModel(pqPipelineModel* model);

  QModelIndex pipelineModelIndex(const QModelIndex& index) const;
  const pqPipelineModel* getPipelineModel(const QModelIndex& index) const;

  static void setVisibility(bool visible, pqOutputPort* port);

  QMenu* contextMenu() const;

Q_SIGNALS:
  void deleteKey();

public Q_SLOTS:
  void setActiveView(pqView*);

protected Q_SLOTS:
  void handleIndexClicked(const QModelIndex& index);
  void expandWithModelIndexTranslation(const QModelIndex&);

protected: // NOLINT(readability-redundant-access-specifiers)
  void setVisibility(bool visible, const QModelIndexList& indices);

  void contextMenuEvent(QContextMenuEvent* e) override;

  bool viewportEvent(QEvent* e) override;

  pqPipelineModel* PipelineModel;
  pqPipelineAnnotationFilterModel* FilteredPipelineModel;
  QPointer<QMenu> ContextMenu;

private:
  void configureModel();

  Q_DISABLE_COPY(pqPipelineBrowserWidget)
};

#endif