1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModuleBase_ModelWidget.h
4 // Created: 25 Apr 2014
5 // Author: Natalia ERMOLAEVA
7 #ifndef MODULEBASE_MODELWIDGET_H
8 #define MODULEBASE_MODELWIDGET_H
10 #include <ModuleBase.h>
11 #include <ModuleBase_ViewerPrs.h>
13 #include <ModelAPI_Feature.h>
19 class Config_WidgetAPI;
22 /**\class ModuleBase_ModelWidget
24 * \brief An abstract custom widget class. This class realization is assumed to create some controls.
25 * The controls values modification should send signal about values change.
27 * Common interface for widgets in the property panel.
28 * Every widget are able to save/restore data from the model and/or to contain other widgets.
31 class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QObject
36 /// \param theParent the parent object
37 /// \param theData the widget configuation. The attribute of the model widget is obtained from
38 /// \param theParentId is Id of a parent of the current attribute
39 ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData,
40 const std::string& theParentId);
42 virtual ~ModuleBase_ModelWidget()
46 /// Fills the widget with default values
47 virtual void reset() {};
49 /// Returns the state whether the attribute of the feature is initialized
50 /// \param theObject a model feature to be checked
51 /// \return the boolean result
52 bool isInitialized(ObjectPtr theObject) const;
54 /// Returns true, if default value of the widget should be computed
55 /// on operation's execute, like radius for circle's constraint (can not be zero)
56 bool isComputedDefault() const { return myIsComputedDefault; }
58 /// Returns true, if default value of the widget is defined in the XML and it is not the
60 /// \return the boolean result
61 std::string getDefaultValue() const { return myDefaultValue; }
63 /// Defines if it is supposed that the widget should interact with the viewer.
64 virtual bool isViewerSelector() { return false; }
66 /// Defines if it is supported to set the value in this widget
67 /// By default it returns true
68 virtual bool canSetValue() const { return true; };
70 /// Set the given wrapped value to the current widget
71 /// This value should be processed in the widget according to the needs
72 /// \param theValue the wrapped widget value
73 virtual bool setSelection(ModuleBase_ViewerPrs theValue)
78 /// Restore value from attribute data to the widget's control
79 virtual bool restoreValue() = 0;
81 /// Set focus to the first control of the current widget. The focus policy of the control is checked.
82 /// If the widget has the NonFocus focus policy, it is skipped.
83 /// \return the state whether the widget can accept the focus
84 virtual bool focusTo();
86 /// The methiod called when widget is activated
89 /// The methiod called when widget is deactivated
90 virtual void deactivate() {}
92 /// Returns the internal parent wiget control, that can be shown anywhere
93 /// \returns the widget
94 virtual QWidget* getControl() const = 0;
96 /// Returns list of widget controls
97 /// \return a control list
98 virtual QList<QWidget*> getControls() const = 0;
100 /// FocusIn events processing
101 virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
103 //! \brief Enables processing of focus event on all controls by the widget
104 void enableFocusProcessing();
106 //! Switch On/Off highlighting of the widget
107 void setHighlighted(bool isHighlighted);
109 /// Returns the attribute name
110 /// \returns the string value
111 std::string attributeID() const
113 return myAttributeID;
116 /// Returns the parent of the attribute
117 /// \returns the string value
118 std::string parentID() const
123 /// \return Current feature
124 FeaturePtr feature() const
129 /// Set feature which is processing by active operation
130 /// \param theToStoreValue a value about necessity to store the widget value to the feature
131 void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
133 /// Editing mode depends on mode of current operation. This value is defined by it.
134 void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
136 /// \return Current Editing mode
137 bool isEditingMode() const { return myIsEditing; }
140 /// The signal about widget values are to be changed
141 void beforeValuesChanged();
142 /// The signal about widget values changed
143 void valuesChanged();
144 /// The signal about widget values are to be changed
145 void afterValuesChanged();
147 /// The signal about key release on the control, that corresponds to the attribute
148 /// \param theEvent key release event
149 void keyReleased(QKeyEvent* theEvent);
151 /// The signal about the widget is get focus
152 /// \param theWidget the model base widget
153 void focusInWidget(ModuleBase_ModelWidget* theWidget);
155 /// The signal about the widget is lost focus
156 /// \param theWidget the model base widget
157 void focusOutWidget(ModuleBase_ModelWidget* theWidget);
160 /// \brief Set the attribute name
161 /// \param theAttribute the string value with attribute name
162 void setAttributeID(const std::string& theAttribute)
164 myAttributeID = theAttribute;
167 /// Saves the internal parameters to the given feature. Emits signals before and after store
168 /// \return True in success
171 /// Saves the internal parameters to the given feature
172 /// \return True in success
173 virtual bool storeValueCustom() const = 0;
175 /// The methiod called when widget is activated
176 virtual void activateCustom() {};
178 /// Sends Update and Redisplay for the given object
179 /// \param theObj is updating object
180 void updateObject(ObjectPtr theObj) const;
182 /// Sends Move event for the given object
183 /// \param theObj is object for moving
184 void moveObject(ObjectPtr theObj) const;
187 /// Processing of values changed in model widget by store the current value to the feature
188 void onWidgetValuesChanged();
192 /// The attribute name of the model feature
193 std::string myAttributeID;
196 std::string myParentId;
198 /// A feature which is processing by active operation
199 FeaturePtr myFeature;
201 /// Flag which shows that current operation is in editing mode
205 /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
206 bool myIsComputedDefault;
208 /// the default value, which is defined in the XML for this attribute
209 std::string myDefaultValue;