File: TreeModel_ItemProperties.hxx

package info (click to toggle)
opencascade 7.9.2%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 301,924 kB
  • sloc: cpp: 1,523,264; tcl: 10,159; cs: 5,173; java: 1,554; sh: 1,342; ansic: 827; xml: 699; makefile: 30; javascript: 22
file content (183 lines) | stat: -rw-r--r-- 6,894 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
// Created on: 2020-01-25
// Created by: Natalia ERMOLAEVA
// Copyright (c) 2020 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef TreeModel_ItemProperties_H
#define TreeModel_ItemProperties_H

#include <Standard.hxx>
#include <Standard_Dump.hxx>
#include <Standard_Handle.hxx>
#include <Standard_Macro.hxx>
#include <Standard_Type.hxx>
#include <Standard_Transient.hxx>

#include <NCollection_IndexedDataMap.hxx>
#include <NCollection_IndexedMap.hxx>
#include <NCollection_List.hxx>

#include <TCollection_AsciiString.hxx>

#include <inspector/TreeModel_ItemBase.hxx>
#include <inspector/ViewControl_EditType.hxx>

#include <Standard_WarningsDisable.hxx>
#include <QAbstractTableModel>
#include <QColor>
#include <QList>
#include <QModelIndexList>
#include <QVariant>
#include <Standard_WarningsRestore.hxx>

//! \class TreeModel_ItemProperties
//! Class to manipulate properties of tree item. The properties are organized in table structure
class TreeModel_ItemProperties : public Standard_Transient
{
  //! enum defined the dimension type
  enum TreeModel_DimType
  {
    TreeModel_DimType_Rows,   //!< defines number of rows
    TreeModel_DimType_Columns //!< defines number of columns
  };

  //! container of values in a row of property table
  struct TreeModel_RowValue
  {
    TreeModel_RowValue(const Standard_Integer theValueStartPosition,
                       const QVariant&        theKey,
                       QVariant               theValue)
        : ValueStartPosition(theValueStartPosition),
          Key(theKey),
          Value(theValue)
    {
    }

    Standard_Integer ValueStartPosition; //!< start position of the key
    QVariant         Key;                //!< value in the first column
    QVariant         Value;              //!< value in the second column
    QMap<int, QVariant>
      CustomValues; //!< custom values, e.g. key is Background, value is a defined color
  };

public:
  //! Constructor
  TreeModel_ItemProperties() {}

  //! Destructor
  ~TreeModel_ItemProperties() {}

  //! Sets the current item
  void SetItem(const TreeModel_ItemBasePtr& theItem) { myItem = theItem; }

  //! Fills properties with the stream value
  Standard_EXPORT void InitByStream(const Standard_SStream& theStream);

  //! Returns the current item
  TreeModel_ItemBasePtr Item() const { return myItem; }

  //! Fills internal containers by item stream values
  Standard_EXPORT void Init();

  //! If the item has internal values, they should be reset here.
  Standard_EXPORT void Reset();

  //! Returns number of table rows
  //! \return an integer value
  Standard_EXPORT int RowCount() const;

  //! Returns number of table columns
  //! \return an integer value
  int ColumnCount() const { return 2; }

  //! Returns content of the model index for the given role, it is obtained from internal container
  //! of values \param theRow a model index row \param theColumn a model index column \param theRole
  //! a view role \return value interpreted depending on the given role
  Standard_EXPORT QVariant Data(const int theRow,
                                const int theColumn,
                                int       theRole = Qt::DisplayRole) const;

  //! Returns type of edit control for the model index. By default, it is an empty control
  //! \param theRow a model index row
  //! \param theColumn a model index column
  //! \return edit type
  Standard_EXPORT ViewControl_EditType EditType(const int theRow, const int theColumn) const;

  //! Sets content of the model index for the given role, it is applied to internal container of
  //! values \param theRow a model index row \param theColumn a model index column \param theRole a
  //! view role \return true if the value is changed
  Standard_EXPORT bool SetData(const int       theRow,
                               const int       theColumn,
                               const QVariant& theValue,
                               int             theRole = Qt::DisplayRole);

  //! Returns presentation of the attribute to be visualized in the view
  //! \thePresentations[out]  container of presentation handles to be visualized
  Standard_EXPORT void Presentations(
    NCollection_List<Handle(Standard_Transient)>& thePresentations);

  //! Returns flags for the item: ItemIsEnabled | Qt::ItemIsSelectable.
  //! Additional flag for the column 1 is Qt::ItemIsEditable.
  //! \param theIndex a model index
  //! \return flags
  Standard_EXPORT Qt::ItemFlags TableFlags(const int theRow, const int theColumn) const;

  //! Returns stream value of the item to fulfill property panel.
  //! \return stream value or dummy
  Standard_EXPORT void ChildStream(const int                theRowId,
                                   TCollection_AsciiString& theKey,
                                   Standard_DumpValue&      theValue) const;

  //! Returns data object of the item.
  //! \return object key
  const TCollection_AsciiString& Key() const { return myKey; }

  //! Returns stream value of the item.
  //! \return value
  const TCollection_AsciiString& StreamValue() const { return myStreamValue.myValue; }

  //! Returns children stream values
  // const NCollection_IndexedDataMap<TCollection_AsciiString, Standard_DumpValue>& Values() const {
  // initItem(); return myValues; }

  //! Returns children stream values
  const NCollection_IndexedDataMap<Standard_Integer, TreeModel_RowValue>& RowValues() const
  {
    initItem();
    return myRowValues;
  }

  //! Returns children stream values
  const NCollection_IndexedDataMap<TCollection_AsciiString, Standard_DumpValue>& Children() const
  {
    initItem();
    return myChildren;
  }

  DEFINE_STANDARD_RTTIEXT(TreeModel_ItemProperties, Standard_Transient)

protected:
  //! Initializes the current item. It creates a backup of the specific item information
  Standard_EXPORT void initItem() const;

private:
  TreeModel_ItemBasePtr myItem; //!< current item

  TCollection_AsciiString myKey;         //!< the item key
  Standard_DumpValue      myStreamValue; //!< the stream value
  NCollection_IndexedDataMap<TCollection_AsciiString, Standard_DumpValue>
                                                                   myChildren;  //!< the children
  NCollection_IndexedDataMap<Standard_Integer, TreeModel_RowValue> myRowValues; //!< the values
};

#endif