X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FXGUI%2FXGUI_DocumentDataModel.h;h=63fa17a9ff61e06dad3153b71c78e7749b618075;hb=3a5be0c5d1edb60a71f9daab6dd834ffa45eb550;hp=c49c6696535871e683459407e8214527a01de0a4;hpb=3985b767e74385e51d1b503d2c97d3bb1e3f6faa;p=modules%2Fshaper.git diff --git a/src/XGUI/XGUI_DocumentDataModel.h b/src/XGUI/XGUI_DocumentDataModel.h index c49c66965..63fa17a9f 100644 --- a/src/XGUI/XGUI_DocumentDataModel.h +++ b/src/XGUI/XGUI_DocumentDataModel.h @@ -1,3 +1,4 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D --> #ifndef XGUI_DocumentDataModel_H #define XGUI_DocumentDataModel_H @@ -22,66 +23,116 @@ class XGUI_TopDataModel; */ class XGUI_EXPORT XGUI_DocumentDataModel : public QAbstractItemModel, public Events_Listener { - Q_OBJECT -public: - - +Q_OBJECT + public: + /// Constructor + /// \param theParent a parent object XGUI_DocumentDataModel(QObject* theParent); virtual ~XGUI_DocumentDataModel(); - // Event Listener method - virtual void processEvent(const Events_Message* theMessage); - + /// Event Listener method + /// \param theMessage an event message + virtual void processEvent(const std::shared_ptr& theMessage); + /// 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) virtual QVariant data(const QModelIndex& theIndex, int theRole) const; - virtual QVariant headerData(int theSection, Qt::Orientation theOrient, - int theRole = Qt::DisplayRole) const; + /// Returns the data for the given role and section in the header with the specified orientation. + /// \param theSection a section + /// \param theOrient an orientation + /// \param theRole a data role (see Qt::ItemDataRole) + 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 + /// rowCount is returning the number of children of parent. + /// \param theParent a parent model index virtual int rowCount(const QModelIndex& theParent = QModelIndex()) const; + + /// Returns the number of columns for the children of the given parent. + /// It has a one column + /// \param theParent a parent model index virtual int columnCount(const QModelIndex& theParent = QModelIndex()) const; - virtual QModelIndex index(int theRow, int theColumn, - const QModelIndex &parent = QModelIndex()) const; + /// 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. + /// If the item has no parent, an invalid QModelIndex is returned. + /// \param theIndex a model index virtual QModelIndex parent(const QModelIndex& theIndex) const; + /// Returns true if parent has any children; otherwise returns false. + /// \param theParent a parent model index virtual bool hasChildren(const QModelIndex& theParent = QModelIndex()) const; + /// 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 + /// \param theParent a parent model index bool insertRows(int theRow, int theCount, const QModelIndex& theParent = QModelIndex()); + /// Removes count rows starting with the given row under parent parent from the model. + /// \param theRow a start row + /// \param theCount a nember of rows to remove + /// \param theParent a parent model index bool removeRows(int theRow, int theCount, const QModelIndex& theParent = QModelIndex()); + /// Returns the item flags for the given index. + /// \param theIndex a model index Qt::ItemFlags flags(const QModelIndex& theIndex) const; //! Returns an object by the given Model index. //! Returns 0 if the given index is not index of an object ObjectPtr object(const QModelIndex& theIndex) const; + //! Returns index of the object + //! \param theObject object to find QModelIndex objectIndex(const ObjectPtr theObject) const; //! Returns QModelIndex which corresponds to the given part //! If the object is not found then index is not valid + //! \param thePart a part for analysis QModelIndex partIndex(const ResultPartPtr& thePart) const; //! Activates a part data model if the index is a Part node index. //! Returns true if active part changed. + //! \param theIndex a model index bool activatedIndex(const QModelIndex& theIndex); //! Retrurns active part ResultPartPtr activePart() const; //! Retrurns QModelIndex of active part - QModelIndex activePartIndex() const { return myActivePartIndex; } + QModelIndex activePartIndex() const + { + return myActivePartIndex; + } //! Deactivates a Part void deactivatePart(); + //! Rebuild data tree void rebuildDataTree(); -private: + //! Clear internal data + void clear(); - enum {PartsFolder, HistoryNode}; + private: + + enum + { + PartsFolder, + HistoryNode + }; //! Converts QModelIndex of this model to QModelIndex of a one of sub-models. QModelIndex* toSourceModelIndex(const QModelIndex& theProxy) const; @@ -95,6 +146,9 @@ private: //! Deletes all saved pointers on QModelIndex objects. void clearModelIndexes(); + //! Deletes all saved pointers on QModelIndex objects. + void clearSubModels(); + //! Removes sub-model on removing a part object. Also it removes QModelIndex-es which refer to this model void removeSubModel(int theModelId); @@ -109,7 +163,6 @@ private: int historyOffset() const; - //! Data model of top part of data tree (not parts object) XGUI_TopDataModel* myModel; @@ -126,4 +179,4 @@ private: }; -#endif \ No newline at end of file +#endif