Salome HOME
updated copyright message
[modules/shaper.git] / src / XGUI / XGUI_DataModel.h
index cbcb030daf645f294010ebc9c893ed1b9e48fc30..0c56b2f1c826005e793c3738553453fc536d7642 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2023  CEA, EDF
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 //
 // 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
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-// See http://www.salome-platform.org/ or
-// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef XGUI_DataModel_H
@@ -29,8 +28,8 @@
 
 #include <QAbstractItemModel>
 
-class Config_DataModelReader;
 class XGUI_Workshop;
+class ModuleBase_ITreeNode;
 
 /**\class XGUI_DataModel
  * \ingroup GUI
@@ -54,6 +53,11 @@ public:
   /// Destructor
   virtual ~XGUI_DataModel();
 
+
+  void setRoot(ModuleBase_ITreeNode* theRoot) { myRoot = theRoot; }
+
+  ModuleBase_ITreeNode* root() const { return myRoot; }
+
   /// Event Listener method
   /// \param theMessage an event message
   virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
@@ -72,7 +76,6 @@ public:
   //! Rebuild data tree
   virtual void rebuildDataTree();
 
-
   /// Returns the data stored under the given role for the item referred to by the index.
   /// \param theIndex a model index
   /// \param theRole a data role (see Qt::ItemDataRole)
@@ -129,20 +132,53 @@ public:
   /// \param theIndex a model index
   virtual Qt::ItemFlags flags(const QModelIndex& theIndex) const;
 
+  /// Returns true if a model can accept a drop of the data (used for drag and drop functionality).
+  virtual bool canDropMimeData(const QMimeData *theData, Qt::DropAction theAction,
+                               int theRow, int theColumn, const QModelIndex &theParent) const override;
+
+  /// Converts the dragged items information into mime data format (to be encoded in dropMimeData)
+  virtual QMimeData* mimeData(const QModelIndexList &indexes) const override;
+
+  /// Performs a drag and drop of Part feature operation when it is droped.
+  virtual bool dropMimeData(const QMimeData *theData, Qt::DropAction theAction,
+                            int theRow, int theColumn, const QModelIndex &theParent) override;
+
   /// Returns an index which is root of the given document
   /// \param theDoc a document
   QModelIndex documentRootIndex(DocumentPtr theDoc, int theColumn = 1) const;
 
-  /// Returns last history object index
-  virtual QModelIndex lastHistoryIndex() const;
+  /// Returns true if the data model item has Hidden visual state
+  /// \param theIndex a tree model item
+  /// \return boolean value
+  bool hasHiddenState(const QModelIndex& theIndex);
+
+  /// Returns true if the given index exists in data tree
+  /// \param theIndex an index to check
+  bool hasIndex(const QModelIndex& theIndex) const;
+
+  /// Returns true if the given node is a parto of the data tree
+  /// \param theNode a node to check
+  bool hasNode(ModuleBase_ITreeNode* theNode) const;
 
-  /// Initialises XML data model reader. It must be initialised before DataModel using.
-  void setXMLReader(Config_DataModelReader* theReader) { myXMLReader = theReader; }
+  /// Returns document of the given index
+  /// \param theIndex an index to check
+  DocumentPtr document(const QModelIndex& theIndex) const;
 
-  /// Do not processing anymore events of model loop
-  //bool blockEventsProcessing(const bool theState);
+  /// Returns index for the node and column
+  /// \param theNode a node
+  /// \param thCol a column
+  QModelIndex getIndex(ModuleBase_ITreeNode* theNode, int thCol) const;
+
+  /// Allows to support drag and drop of some model items
+  virtual Qt::DropActions supportedDropActions() const override
+  {
+    return Qt::MoveAction;
+  }
 
 signals:
+  /// Signal send before tree rebuild
+  void beforeTreeRebuild();
+
   /// Signal about tree had been rebuilt
   void treeRebuilt();
 
@@ -153,41 +189,15 @@ private:
     SemiVisible,
     Hidden };
 
-  /// Find a root index which contains objects of the given document
-  /// \param theDoc the document object
-  QModelIndex findDocumentRootIndex(const ModelAPI_Document* theDoc, int aColumn = 1) const;
-
-  /// Returns number of folders in document.
-  /// Considered folders which has to be shown only if they are not empty.
-  /// \param theDoc document which has to be checked. If 0 then Root document will be considered
-  int foldersCount(ModelAPI_Document* theDoc = 0) const;
-
-  /// Retrurns indexes of folders which can not be shown because they are empty
-  /// \param theDoc document which has to be checked. If 0 then Root document will be considered
-  QIntList missedFolderIndexes(ModelAPI_Document* theDoc = 0) const;
 
-  /// Returns Id (row) of a folder taking into consideration
-  /// folders which can not be shown non empty
-  /// \param theType Type of the folder
-  /// \param theDoc a document which contains this folder
-  int folderId(std::string theType, ModelAPI_Document* theDoc = 0) const;
+  QModelIndex getParentIndex(ModuleBase_ITreeNode* theNode, int thCol) const;
 
-  /// Removes a row from branch of tree
-  /// \param theStart - start row to update indexes
-  /// \param theSize - number of indexes in the folder
-  /// \param theParent - index of parent folder
-  void rebuildBranch(int theRow, int theCount, const QModelIndex& theParent = QModelIndex());
-
-  /// Returns list of folders types which can not be shown empty
-  /// \param fromRoot - root document flag
-  QStringList listOfShowNotEmptyFolders(bool fromRoot = true) const;
-
-  VisibilityState getVisibilityState(const QModelIndex& theIndex) const;
-
-  Config_DataModelReader* myXMLReader;
+  void updateSubTree(ModuleBase_ITreeNode* theParent);
 
   XGUI_Workshop* myWorkshop;
-  //bool myIsEventsProcessingBlocked;
+  QMap<DocumentPtr, QStringList> myShownFolders;
+
+  ModuleBase_ITreeNode* myRoot;
 };
 
 #endif
\ No newline at end of file