XGUI_DataModel.h

// Copyright (C) 2014-2026  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef XGUI_DataModel_H
#define XGUI_DataModel_H
 
#include "XGUI.h"
#include <ModuleBase_Definitions.h>
#include <ModelAPI_Object.h>
#include <ModelAPI_Document.h>
#include <Events_Listener.h>
 
#include <QAbstractItemModel>
 
class XGUI_Workshop;
class ModuleBase_ITreeNode;
 
class XGUI_EXPORT XGUI_DataModel : public QAbstractItemModel, public Events_Listener
{
Q_OBJECT
public:
  XGUI_DataModel(QObject* theParent);
 
  virtual ~XGUI_DataModel();
 
 
  void setRoot(ModuleBase_ITreeNode* theRoot) { myRoot = theRoot; }
 
  ModuleBase_ITreeNode* root() const { return myRoot; }
 
  virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
 
  virtual ObjectPtr object(const QModelIndex& theIndex) const;
 
  virtual QModelIndex objectIndex(const ObjectPtr theObject, int theColumn = 1) const;
 
  virtual void clear();
 
  virtual void rebuildDataTree();
 
  virtual QVariant data(const QModelIndex& theIndex, int theRole) const;
 
  virtual QVariant headerData(int theSection, Qt::Orientation theOrient, int theRole =
                                  Qt::DisplayRole) const;
 
  virtual int rowCount(const QModelIndex& theParent = QModelIndex()) const;
 
  virtual int columnCount(const QModelIndex& theParent = QModelIndex()) const;
 
  virtual QModelIndex index(int theRow, int theColumn, const QModelIndex &theParent =
                                QModelIndex()) const;
 
  virtual QModelIndex parent(const QModelIndex& theIndex) const;
 
  virtual bool hasChildren(const QModelIndex& theParent = QModelIndex()) const;
 
  virtual bool insertRows(int theRow, int theCount, const QModelIndex& theParent = QModelIndex());
 
  virtual bool removeRows(int theRow, int theCount, const QModelIndex& theParent = QModelIndex());
 
  virtual Qt::ItemFlags flags(const QModelIndex& theIndex) const;
 
  virtual bool canDropMimeData(const QMimeData *theData, Qt::DropAction theAction,
                               int theRow, int theColumn, const QModelIndex &theParent) const override;
 
  virtual QMimeData* mimeData(const QModelIndexList &indexes) const override;
 
  virtual bool dropMimeData(const QMimeData *theData, Qt::DropAction theAction,
                            int theRow, int theColumn, const QModelIndex &theParent) override;
 
  QModelIndex documentRootIndex(DocumentPtr theDoc, int theColumn = 1) const;
 
  bool hasHiddenState(const QModelIndex& theIndex);
 
  bool hasIndex(const QModelIndex& theIndex) const;
 
  bool hasNode(ModuleBase_ITreeNode* theNode) const;
 
  DocumentPtr document(const QModelIndex& theIndex) const;
 
  QModelIndex getIndex(ModuleBase_ITreeNode* theNode, int thCol) const;
 
  virtual Qt::DropActions supportedDropActions() const override
  {
    return Qt::MoveAction;
  }
 
signals:
  void beforeTreeRebuild();
 
  void treeRebuilt();
 
private:
  enum VisibilityState {
    NoneState,
    Visible,
    SemiVisible,
    Hidden };
 
 
  QModelIndex getParentIndex(ModuleBase_ITreeNode* theNode, int thCol) const;
 
  void updateSubTree(ModuleBase_ITreeNode* theParent);
 
  XGUI_Workshop* myWorkshop;
  QMap<DocumentPtr, QStringList> myShownFolders;
 
  ModuleBase_ITreeNode* myRoot;
};
 
#endif