0031939: Coding - correction of spelling errors in comments [part 2]
[occt.git] / tools / ViewControl / ViewControl_PropertyView.hxx
1 // Created on: 2020-01-25
2 // Created by: Natalia ERMOLAEVA
3 // Copyright (c) 2020 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 TreeModel_PropertyView_H
17 #define TreeModel_PropertyView_H
18
19 #include <Standard.hxx>
20 #include <Standard_Macro.hxx>
21
22 #include <inspector/ViewControl_Table.hxx>
23
24 #include <Standard_WarningsDisable.hxx>
25 #include <QObject>
26 #include <QList>
27 #include <Standard_WarningsRestore.hxx>
28
29 class QAbstractTableModel;
30 class QStackedWidget;
31 class QWidget;
32 class QVBoxLayout;
33
34 class ViewControl_TableModelValues;
35
36 //! \class ViewControl_PropertyView
37 //! \brief View widget where several tables are visualized in vertical layout.
38 class ViewControl_PropertyView : public QObject
39 {
40   Q_OBJECT
41 public:
42
43   //! Constructor
44   Standard_EXPORT ViewControl_PropertyView (QWidget* theParent, const QSize& thePredefinedSize = QSize());
45
46   //! Destructor
47   virtual ~ViewControl_PropertyView() {}
48
49   //! Fills the view content with values. Number of visible tables is size of container,
50   //! Each element of container is values of the corresponded table
51   //! \param theTableValues values
52   Standard_EXPORT void Init (ViewControl_TableModelValues* theTableValues);
53
54   //! Fills the view content with the parameter custom widget.
55   //! \param theWidget control
56   Standard_EXPORT void Init (QWidget* theWidget);
57
58   //! Clears layout of the view and tables models.
59   Standard_EXPORT void Clear();
60
61   //! \return the text edit control
62   QWidget* GetControl() const { return myMainWidget; }
63
64   //! Returns container an active table or NULL
65   ViewControl_Table* Table() { return myTable; }
66
67   //! Clears selection in active tables
68   Standard_EXPORT void ClearActiveTablesSelection();
69
70   //! Saves state of property view in a container in form: key, value. It saves:
71   //! - visibility of columns,
72   //! - columns width
73   //! \param theTreeView a view instance
74   //! \param theItems [out] properties
75   //! \param thePrefix preference item prefix
76   Standard_EXPORT static void SaveState (ViewControl_PropertyView* theParameters,
77                                          QMap<QString, QString>& theItems,
78                                          const QString& thePrefix = QString());
79
80   //! Restores state of property view by a container
81   //! \param theTreeView a view instance
82   //! \param theKey property key
83   //! \param theValue property value
84   //! \param thePrefix preference item prefix
85   //! \return boolean value whether the property is applied to the tree view
86   Standard_EXPORT static bool RestoreState (ViewControl_PropertyView* theParameters,
87                                             const QString& theKey, const QString& theValue,
88                                             const QString& thePrefix = QString());
89
90 signals:
91   //! Signal about selection change in property view table
92   void propertyViewSelectionChanged();
93
94   //! Signal about data change in property view table
95   void propertyViewDataChanged();
96
97 protected slots:
98   //! Emits signal about selection is changed
99   //! \param theSelected container of selected table cells
100   //! \param theDeselected container of selected table cells
101   void onTableSelectionChanged (const QItemSelection& theSelected, const QItemSelection& theDeselected);
102
103 private:
104   bool myOwnSelectionChangeBlocked; //!< blocking emit of selection changed signal
105
106   QWidget* myMainWidget; //!< parent of all controls
107
108   QStackedWidget* myAttributesStack; //!< container of already created panes
109   QWidget* myEmptyWidget; //!< an empty widget when nothing is selected in tree view
110
111   QWidget* myTableWidget; //!< widget of tables in vertical layout
112   QVBoxLayout* myTableWidgetLayout; //!< main view layout where tables or custom widgets are presented
113   ViewControl_Table* myTable; //!< table view, shown only first tables filled in Init method
114   QWidget* myCustomWidget; //!< custom view widget
115 };
116 #endif