Salome HOME
Merge from 'master'
[modules/shaper.git] / src / XGUI / XGUI_DocumentDataModel.h
index 796a8e51a750f694176a8607d18c1ed028fdd5ee..a5257a981c7d1041f9a991d97447bcbf08f54269 100644 (file)
@@ -2,25 +2,34 @@
 #ifndef XGUI_DocumentDataModel_H
 #define XGUI_DocumentDataModel_H
 
+#include "XGUI.h"
+#include "XGUI_Constants.h"
+
 #include <QAbstractItemModel>
-#include <Event_Listener.h>
+#include <Events_Listener.h>
 
 #include <QList>
 
 class ModelAPI_Document;
-class XGUI_PartDataModel;
+class XGUI_PartModel;
 class XGUI_TopDataModel;
 
-
-class XGUI_DocumentDataModel : public QAbstractItemModel, public Event_Listener
+/**\class XGUI_DocumentDataModel
+ * \ingroup GUI
+ * \brief This is a proxy data model for Object Browser (QTreeView).
+ * It contains several sub-models for generation of each sub-part of data tree.
+ */
+class XGUI_EXPORT XGUI_DocumentDataModel : public QAbstractItemModel, public Events_Listener
 {
   Q_OBJECT
 public:
+
+
   XGUI_DocumentDataModel(QObject* theParent);
   virtual ~XGUI_DocumentDataModel();
 
   // Event Listener method
-  virtual void processEvent(const Event_Message* theMessage);
+  virtual void processEvent(const Events_Message* theMessage);
 
 
   virtual QVariant data(const QModelIndex& theIndex, int theRole) const;
@@ -37,16 +46,83 @@ public:
 
   virtual bool hasChildren(const QModelIndex& theParent = QModelIndex()) const;
 
+  bool insertRows(int theRow, int theCount, const QModelIndex& theParent = QModelIndex());
+
+  bool removeRows(int theRow, int theCount, const QModelIndex& theParent = QModelIndex());
+
+  Qt::ItemFlags flags(const QModelIndex& theIndex) const;
+
+  //! Returns Feature object by the given Model index.
+  //! Returns 0 if the given index is not index of a feature
+  FeaturePtr feature(const QModelIndex& theIndex) const;
+
+  QModelIndex featureIndex(const FeaturePtr theFeature) const;
+
+  //! Returns QModelIndex which corresponds to the given feature if this is a part
+  //! If the feature is not found then index is not valid
+  QModelIndex partIndex(const FeaturePtr& theFeature) const;
+
+  //! Activates a part data model if the index is a Part node index. 
+  //! Returns true if active part changed.
+  bool activatedIndex(const QModelIndex& theIndex);
+
+  //! Retrurns Feature which corresponds to active part
+  FeaturePtr activePart() const;
+
+  //! Retrurns QModelIndex of active part
+  QModelIndex activePartIndex() const { return myActivePartIndex; }
+
+  //! Deactivates a Part
+  void deactivatePart();
+
+  void rebuildDataTree();
+
 private:
 
-  QModelIndex toSourceModel(const QModelIndex& theProxy) const;
-  QModelIndex fromSourceModel(const QModelIndex& theSource) const;
+  enum {PartsFolder, HistoryNode};
 
 
-  std::shared_ptr<ModelAPI_Document> myDocument;
+  //! Converts QModelIndex of this model to QModelIndex of a one of sub-models.
+  QModelIndex* toSourceModelIndex(const QModelIndex& theProxy) const;
 
+  //! Finds a pointer on QModelIndex which is equal to the given one
+  QModelIndex* findModelIndex(const QModelIndex& theIndex) const;
+
+  //! Returns pointer on QModelIndex which is equal to the given one.
+  QModelIndex* getModelIndex(const QModelIndex& theIndex) const;
+
+  //! Deletes all saved pointers on QModelIndex objects.
+  void clearModelIndexes();
+
+  //! Removes sub-model on removing a part object. Also it removes QModelIndex-es which refer to this model
+  void removeSubModel(int theModelId);
+
+  //! Returns true if the given model is a one of sub-models (of both types)
+  bool isSubModel(const QAbstractItemModel* theModel) const;
+
+  //! Returns true if the given model is a one of sub-models of Part type
+  bool isPartSubModel(const QAbstractItemModel* theModel) const;
+
+  //! Returns Parts Folder node
+  QModelIndex partFolderNode() const;
+
+  int historyOffset() const;
+
+
+  //! Data model of top part of data tree (not parts object)
   XGUI_TopDataModel* myModel;
-  QList<XGUI_PartDataModel*> myPartModels;
+
+  //! Data models for Parts data tree representation (one data model per a one part)
+  QList<XGUI_PartModel*> myPartModels;
+
+  //! Active part in part editing mode
+  XGUI_PartModel* myActivePart;
+
+  QModelIndex myActivePartIndex;
+
+  //! List of saved QModelIndexes created by sub-models
+  QList<QModelIndex*> myIndexes;
+
 };
 
 #endif
\ No newline at end of file