Salome HOME
Issue #2260: Correction for processing of empty/non-empty folders
[modules/shaper.git] / src / XGUI / XGUI_DataModel.h
index b1c3935c285648bdae8c3fcf851f2c4559057d3d..9052260aa6554d85ea48355e660f655caf69f715 100644 (file)
@@ -1,20 +1,35 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        XGUI_DataModel.h
-// Created:     21 Jul 2015
-// Author:      Vitaly SMETANNIKOV
-
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// 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<mailto: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 <Config_DataModelReader.h>
-#include <QAbstractItemModel>
 #include <Events_Listener.h>
 
+#include <QAbstractItemModel>
+
+class Config_DataModelReader;
 
 /**\class XGUI_DataModel
  * \ingroup GUI
  * - Non Valid Index - root index
  * - An index with internal Id == -1 is a folder of root document
  * - An index which contains internal pointer as ModelAPI_Object its the object
- * - An index which contains internal pointer as ModelAPI_Document is a folder which belongs to this document
+ * - An index which contains internal pointer as ModelAPI_Document is 
+ *   a folder which belongs to this document
  */
 class XGUI_EXPORT XGUI_DataModel : public QAbstractItemModel, public Events_Listener
 {
 Q_OBJECT
 public:
+  /// Constructor
+  /// \param theParent a parent object
   XGUI_DataModel(QObject* theParent);
 
+  /// Destructor
+  virtual ~XGUI_DataModel();
+
   /// Event Listener method
   /// \param theMessage an event message
   virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
@@ -63,7 +84,7 @@ public:
   virtual QVariant headerData(int theSection, Qt::Orientation theOrient, int theRole =
                                   Qt::DisplayRole) const;
 
-  /// Returns the number of rows under the given parent. When the parent is valid it means that 
+  /// Returns the number of rows under the given parent. When the parent is valid it means that
   /// rowCount is returning the number of children of parent.
   /// \param theParent a parent model index
   virtual int rowCount(const QModelIndex& theParent = QModelIndex()) const;
@@ -73,14 +94,15 @@ public:
   /// \param theParent a parent model index
   virtual int columnCount(const QModelIndex& theParent = QModelIndex()) const;
 
-  /// Returns the index of the item in the model specified by the given row, column and parent index.
+  /// Returns the index of the item in the model specified by the given row,
+  /// column and parent index.
   /// \param theRow a row
   /// \param theColumn a column
   /// \param theParent a parent model index
   virtual QModelIndex index(int theRow, int theColumn, const QModelIndex &theParent =
                                 QModelIndex()) const;
 
-  /// Returns the parent of the model item with the given index. 
+  /// Returns the parent of the model item with the given index.
   /// If the item has no parent, an invalid QModelIndex is returned.
   /// \param theIndex a model index
   virtual QModelIndex parent(const QModelIndex& theIndex) const;
@@ -89,7 +111,7 @@ public:
   /// \param theParent a parent model index
   virtual bool hasChildren(const QModelIndex& theParent = QModelIndex()) const;
 
-  /// Inserts count rows into the model before the given row. 
+  /// Inserts count rows into the model before the given row.
   /// Items in the new row will be children of the item represented by the parent model index.
   /// \param theRow a start row
   /// \param theCount a nember of rows to insert
@@ -113,20 +135,75 @@ public:
   /// Returns last history object index
   virtual QModelIndex lastHistoryIndex() const;
 
+  /// Initialises XML data model reader. It must be initialised before DataModel using.
+  void setXMLReader(Config_DataModelReader* theReader) { myXMLReader = theReader; }
+
+  /// Do not processing anymore events of model loop
+  //bool blockEventsProcessing(const bool theState);
+
+signals:
+  /// Signal about tree had been rebuilt
+  void treeRebuilt();
+
 private:
   /// Find a root index which contains objects of the given document
   /// \param theDoc the document object
   QModelIndex findDocumentRootIndex(const ModelAPI_Document* theDoc) 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 
+  /// 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;
+
+  /// 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;
 
-  Config_DataModelReader myXMLReader;
+  void addShownFolder(DocumentPtr theDoc, QString theFolder)
+  {
+    if (!myShownFolders.contains(theDoc)) {
+      myShownFolders[theDoc] = QStringList();
+    }
+    myShownFolders[theDoc].append(theFolder);
+  }
+
+  void removeShownFolder(DocumentPtr theDoc, QString theFolder)
+  {
+    if (myShownFolders.contains(theDoc)) {
+      myShownFolders[theDoc].removeAll(theFolder);
+      if (myShownFolders[theDoc].isEmpty())
+        myShownFolders.remove(theDoc);
+    }
+  }
+
+  bool hasShownFolder(DocumentPtr theDoc, QString theFolder) const
+  {
+    if (myShownFolders.contains(theDoc))
+      return myShownFolders[theDoc].contains(theFolder);
+    return false;
+  }
+
+  Config_DataModelReader* myXMLReader;
+
+  QMap<DocumentPtr, QStringList> myShownFolders;
+  //bool myIsEventsProcessingBlocked;
 };
 
 #endif
\ No newline at end of file