0029018: Documentation - Provide user guide for Qt browser
[occt.git] / tools / DFBrowserPane / DFBrowserPane_TDataStdTreeNodeModel.hxx
1 // Created on: 2017-06-16
2 // Created by: Natalia ERMOLAEVA
3 // Copyright (c) 2017 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement. 
15
16 #ifndef DFBrowserPane_TDataStdTreeNodeMode_H
17 #define DFBrowserPane_TDataStdTreeNodeMode_H
18
19 #include <inspector/TreeModel_ModelBase.hxx>
20
21 #include <Standard.hxx>
22 #include <TDF_Attribute.hxx>
23
24 #include <QObject>
25 #include <QHash>
26 #include <QByteArray>
27
28 //! \class DFBrowserPane_TDataStdTreeNodeModel
29 //! \brief It builds a tree of items for the given tree node attribute.
30 class DFBrowserPane_TDataStdTreeNodeModel : public TreeModel_ModelBase
31 {
32   Q_OBJECT
33 public:
34
35   //! Constructor
36   Standard_EXPORT DFBrowserPane_TDataStdTreeNodeModel (QObject* theParent);
37
38   //! Destructor
39   virtual ~DFBrowserPane_TDataStdTreeNodeModel() Standard_OVERRIDE {};
40
41   //! Initializes the tree model by the attribute
42   //! \param theAttribute a current attribute
43   Standard_EXPORT void SetAttribute (const Handle(TDF_Attribute)& theAttribute);
44
45   //! Returns model index by the attribute. The method is recursive.
46   //! \param theAttribute an attribute that is searched
47   //! \param theParentIndex an index of the parent item
48   //! \return the model index
49   QModelIndex FindIndex (const Handle(TDF_Attribute)& theAttribute, const QModelIndex theParentIndex);
50
51   //! Returns count of columns in the model.
52   //! \param theParent an index of the parent item
53   //! \return integer value
54   virtual int columnCount (const QModelIndex& theParent = QModelIndex()) const Standard_OVERRIDE
55   { (void)theParent; return 1; }
56
57 private:
58
59   Handle(TDF_Attribute) myAttribute; //! the parent attribute
60 };
61
62 #endif