Salome HOME
Update of second column on history change
[modules/shaper.git] / src / ModuleBase / ModuleBase_IPropertyPanel.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 /*
4  * ModuleBase_IPropertyPanel.h
5  *
6  *  Created on: Oct 01, 2014
7  *      Author: vsv
8  */
9
10 #ifndef ModuleBase_PROPERTYPANEL_H_
11 #define ModuleBase_PROPERTYPANEL_H_
12
13 #include "ModuleBase.h"
14
15 #include <QDockWidget>
16 #include <QKeyEvent>
17
18 class ModuleBase_ModelWidget;
19
20 /**
21 * \ingroup GUI
22 * A class for Property panel object definition
23 */
24 class MODULEBASE_EXPORT ModuleBase_IPropertyPanel : public QDockWidget
25 {
26 Q_OBJECT
27 public:
28   /// Constructor
29   /// \param theParent is a parent of the property panel
30   ModuleBase_IPropertyPanel(QWidget* theParent);
31
32   /// Returns header widget
33   virtual QWidget* headerWidget() const = 0;
34
35   /// Returns currently active widget
36   virtual ModuleBase_ModelWidget* activeWidget() const = 0;
37
38   /// Returns all property panel's widget created by WidgetFactory
39   virtual const QList<ModuleBase_ModelWidget*>& modelWidgets() const = 0;
40
41   /// Removes all widgets in the widget area of the property panel
42   virtual void cleanContent() = 0;
43
44   /// Editing mode depends on mode of current operation. This value is defined by it.
45   /// \param isEditing state of editing mode flag
46   virtual void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
47
48   /// \return State of editing mode flag
49   bool isEditingMode() const { return myIsEditing; }
50
51   /// Set focus on the Ok button
52   virtual void setFocusOnOkButton() = 0;
53
54   /// Set Enable/Disable state of Cancel button
55   /// \param theEnabled Enable/Disable state of Cancel button
56   virtual void setCancelEnabled(bool theEnabled) = 0;
57
58   /// \return Enable/Disable state of Cancel button
59   virtual bool isCancelEnabled() const = 0;
60
61   /// Returns widget processed by preselection
62   virtual ModuleBase_ModelWidget* preselectionWidget() const = 0;
63
64   /// Sets widget processed by preselection
65   virtual void setPreselectionWidget(ModuleBase_ModelWidget* theWidget) = 0;
66
67 signals:
68   /// The signal about key release on the control, that corresponds to the attribute
69   /// \param theEvent key release event
70   void keyReleased(QKeyEvent* theEvent);
71
72   /// The signal about the widget activation
73   /// \param theWidget the activated widget
74   void beforeWidgetActivated(ModuleBase_ModelWidget* theWidget);
75
76   /// The signal about the widget activation
77   /// \param theWidget the activated widget
78   void widgetActivated(ModuleBase_ModelWidget* theWidget);
79
80   /// Emited when there is no next widget
81   void noMoreWidgets();
82
83 public slots:
84   /// Activate the next widget in the property panel
85   /// \param theWidget a widget. The next widget should be activated
86   virtual void activateNextWidget(ModuleBase_ModelWidget* theWidget) = 0;
87
88   /// Activate the next from current widget in the property panel
89   virtual void activateNextWidget() = 0;
90
91   /**
92   * Makes the given widget active, highlights it and removes
93   * highlighting from the previous active widget
94   * emits widgetActivated(theWidget) signal
95   * \param theWidget which has to be activated
96   */
97   virtual void activateWidget(ModuleBase_ModelWidget* theWidget) = 0;
98
99 protected:
100
101   /// Flag which shows that current operation is in editing mode
102   bool myIsEditing;
103 };
104
105 #endif