pqColorAnnotationsWidget.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 pqColorAnnotationsWidget_h
#define pqColorAnnotationsWidget_h

#include "pqApplicationComponentsModule.h"

#include "pqAnnotationsModel.h" // for pqAnnotationsModel::ColumnRoles

#include <QWidget>

class QItemSelection;
class QModelIndex;

class vtkSMProxy;

class PQAPPLICATIONCOMPONENTS_EXPORT pqColorAnnotationsWidget : public QWidget
{
  Q_OBJECT;
  typedef QWidget Superclass;

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

  void setLookupTableProxy(vtkSMProxy* proxy);


  QList<QVariant> annotations() const;
  void setAnnotations(const QList<QVariant>&);


  QList<QVariant> indexedColors() const;
  void setIndexedColors(const QList<QVariant>&);


  QList<QVariant> indexedOpacities() const;
  void setIndexedOpacities(const QList<QVariant>&);


  QList<QVariant> visibilities() const;
  void setVisibilities(const QList<QVariant>&);


  QVariant opacityMapping() const;
  void setOpacityMapping(const QVariant&);

  void applyPreset(const char* presetName);

  void indexedLookupStateUpdated(bool indexed);

  bool addActiveAnnotations(bool force);

  bool addActiveAnnotations(bool force, bool extend);

  QModelIndex currentIndex();

  QModelIndexList selectedIndexes();

  void setAnnotationsModel(pqAnnotationsModel* model);

  void setSupportsReorder(bool reorder);

  void sort(int column, Qt::SortOrder order = Qt::AscendingOrder);

  void allowsUserDefinedValues(bool allow);

  void allowsRegexpMatching(bool allow);

  void enablePresets(bool enable);

  void supportsVisibilityCheck(bool val);

  void supportsOpacityMapping(bool val);

  void setColumnVisibility(pqAnnotationsModel::ColumnRoles col, bool visible);


  const char* currentPresetName();
  void setCurrentPresetName(const char* name);

  QString currentAnnotationValue();

  QStringList selectedAnnotations();
  void setSelectedAnnotations(const QStringList& annotations);

  bool presetLoadAnnotations();

  QRegularExpression presetRegularExpression();

Q_SIGNALS:
  void annotationsChanged();

  void indexedColorsChanged();

  void indexedOpacitiesChanged();

  void visibilitiesChanged();

  void opacityMappingChanged();

  void presetChanged(const QString& name);

  void selectionChanged(const QItemSelection&, const QItemSelection&);

protected:
  bool addActiveAnnotationsFromVisibleSources(bool force);

private Q_SLOTS:

  void addAnnotation();
  void removeAnnotation();
  void addActiveAnnotations();
  void addActiveAnnotationsFromVisibleSources();
  void removeAllAnnotations();

  void onPresetApplied(const QString& presetName);

  void onDataChanged(const QModelIndex& topleft, const QModelIndex& btmright);

  void onDoubleClicked(const QModelIndex& idx);

  void onHeaderDoubleClicked(int section);

  void execGlobalOpacityDialog();

  void choosePreset(const char* presetName = nullptr);

  void saveAsNewPreset();
  void saveAsPreset(const char* name, bool removeAnnotations, bool allowOverride);

  void updateOpacityColumnState();

  void editPastLastRow();

private: // NOLINT(readability-redundant-access-specifiers)
  Q_DISABLE_COPY(pqColorAnnotationsWidget)

  class pqInternals;
  pqInternals* Internals;
};

#endif