pqCompositeDataInformationTreeModel.h

Go to the documentation of this file.

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

   Program: ParaView
   Module:  pqCompositeDataInformationTreeModel.h

   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 pqCompositeDataInformationTreeModel_h
#define pqCompositeDataInformationTreeModel_h

#include "pqComponentsModule.h" // for exports.
#include <QAbstractItemModel>
#include <QPair>          // for QPair.
#include <QScopedPointer> // for ivar.

class vtkPVDataInformation;

namespace pqCompositeDataInformationTreeModelNS
{
class CNode;
}

class PQCOMPONENTS_EXPORT pqCompositeDataInformationTreeModel : public QAbstractItemModel
{
  Q_OBJECT
  Q_PROPERTY(bool userCheckable READ userCheckable WRITE setUserCheckable);
  Q_PROPERTY(bool expandMultiPiece READ expandMultiPiece WRITE setExpandMultiPiece);
  Q_PROPERTY(bool exclusivity READ exclusivity WRITE setExclusivity);
  Q_PROPERTY(bool defaultCheckState READ defaultCheckState WRITE setDefaultCheckState);

  typedef QAbstractItemModel Superclass;

public:
  pqCompositeDataInformationTreeModel(QObject* parent = 0);
  ~pqCompositeDataInformationTreeModel() override;


  int columnCount(const QModelIndex& parent = QModelIndex()) const override;
  int rowCount(const QModelIndex& parent = QModelIndex()) const override;
  QModelIndex index(int row, int column, const QModelIndex& parent = QModelIndex()) const override;
  QModelIndex parent(const QModelIndex& index = QModelIndex()) const override;
  QVariant data(const QModelIndex& index, int role) const override;
  Qt::ItemFlags flags(const QModelIndex& index) const override;
  bool setData(const QModelIndex& index, const QVariant& value, int role) override;
  QVariant headerData(
    int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
  bool setHeaderData(int section, Qt::Orientation orientation, const QVariant& value,
    int role = Qt::DisplayRole) override;


  void setUserCheckable(bool val) { this->UserCheckable = val; }
  bool userCheckable() const { return this->UserCheckable; }


  void setOnlyLeavesAreUserCheckable(bool val) { this->OnlyLeavesAreUserCheckable = val; }
  bool onlyLeavesAreUserCheckable() const { return this->OnlyLeavesAreUserCheckable; }


  void setDefaultCheckState(bool checked) { this->DefaultCheckState = checked; }
  bool defaultCheckState() const { return this->DefaultCheckState; }


  void setExpandMultiPiece(bool val) { this->ExpandMultiPiece = val; }
  bool expandMultiPiece() const { return this->ExpandMultiPiece; }


  void setExclusivity(bool val) { this->Exclusivity = val; }
  bool exclusivity() const { return this->Exclusivity; }

  QList<unsigned int> checkedNodes() const;

  QList<unsigned int> checkedLeaves() const;

  void setChecked(const QList<unsigned int>& indices);

  QList<QPair<unsigned int, bool> > checkStates() const;

  void setCheckStates(const QList<QPair<unsigned int, bool> >& states);


  QList<unsigned int> checkedLevels() const;
  void setCheckedLevels(const QList<unsigned int>& indices);


  QList<QPair<unsigned int, unsigned int> > checkedLevelDatasets() const;
  void setCheckedLevelDatasets(const QList<QPair<unsigned int, unsigned int> >& indices);

  unsigned int compositeIndex(const QModelIndex& idx) const;

  QModelIndex find(unsigned int compositeIndex) const;

  const QModelIndex rootIndex() const;

  int addColumn(const QString& propertyName);

  int columnIndex(const QString& propertyName);

  void clearColumns();


  void setColumnStates(
    const QString& propertyName, const QList<QPair<unsigned int, QVariant> >& values);
  QList<QPair<unsigned int, QVariant> > columnStates(const QString& propertyName) const;

  enum
  {
    ValueInheritedRole = Qt::UserRole,

    LeafIndexRole,

    CompositeIndexRole
  };

public Q_SLOTS:
  bool reset(vtkPVDataInformation* info = nullptr);

private:
  Q_DISABLE_COPY(pqCompositeDataInformationTreeModel);

  class pqInternals;
  QScopedPointer<pqInternals> Internals;
  QString HeaderLabel;
  bool UserCheckable;
  bool OnlyLeavesAreUserCheckable;
  bool ExpandMultiPiece;
  bool Exclusivity;
  bool DefaultCheckState;

  friend class pqCompositeDataInformationTreeModelNS::CNode;
};

#endif