pqColorAnnotationsWidget.h

Go to the documentation of this file.

/*=========================================================================

   Program: ParaView
   Module:  pqColorAnnotationsWidget.cxx

   Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

========================================================================*/
#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 = 0);
  ~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);

  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 customMenuRequested(QPoint pos);

  void execGlobalOpacityDialog();

  void choosePreset(const char* presetName = nullptr);

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

  void updateOpacityColumnState();

  void editPastLastRow();

private:
  Q_DISABLE_COPY(pqColorAnnotationsWidget)

  class pqInternals;
  pqInternals* Internals;
};

#endif