Salome HOME
Reset value state is provided in ModelWidget to remove 'myIsResetCurrentValue' in...
[modules/shaper.git] / src / ModuleBase / ModuleBase_ModelWidget.cpp
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:        ModuleBase_ModelWidget.cpp
4 // Created:     25 Apr 2014
5 // Author:      Natalia ERMOLAEVA
6
7 #include "ModuleBase_ModelWidget.h"
8
9 #include <ModelAPI_Data.h>
10 #include <ModelAPI_Attribute.h>
11 #include <ModelAPI_Events.h>
12 #include <ModelAPI_Session.h>
13
14 #include <Config_Keywords.h>
15 #include <Config_WidgetAPI.h>
16
17 #include <Events_Loop.h>
18
19 #include <QEvent>
20 #include <QGraphicsDropShadowEffect>
21 #include <QColor>
22 #include <QLabel>
23 #include <QFocusEvent>
24
25 ModuleBase_ModelWidget::ModuleBase_ModelWidget(QWidget* theParent,
26                                                const Config_WidgetAPI* theData,
27                                                const std::string& theParentId)
28     : QWidget(theParent),
29       myParentId(theParentId),
30       myIsEditing(false),
31       myState(Stored)
32 {
33   myDefaultValue = theData->getProperty(ATTR_DEFAULT);
34   myUseReset = theData->getBooleanAttribute(ATTR_USE_RESET, true);
35   myIsComputedDefault = theData->getProperty(ATTR_DEFAULT) == DOUBLE_WDG_DEFAULT_COMPUTED;
36   myAttributeID = theData ? theData->widgetId() : "";
37   myIsObligatory = theData->getBooleanAttribute(ATTR_OBLIGATORY, true);
38
39   connect(this, SIGNAL(valuesChanged()), this, SLOT(onWidgetValuesChanged()));
40   connect(this, SIGNAL(valuesModified()), this, SLOT(onWidgetValuesModified()));
41 }
42
43 bool ModuleBase_ModelWidget::reset()
44 {
45   bool aResult = resetCustom();
46   if (aResult)
47     setValueState(Reset);
48
49   return aResult;
50 }
51
52 bool ModuleBase_ModelWidget::isInitialized(ObjectPtr theObject) const
53 {
54   return theObject->data()->attribute(attributeID())->isInitialized();
55 }
56
57 void ModuleBase_ModelWidget::enableFocusProcessing()
58 {
59   QList<QWidget*> aMyControls = getControls();
60   foreach(QWidget*  eachControl, aMyControls) {
61     if (myIsObligatory) {
62       eachControl->setFocusPolicy(Qt::StrongFocus);
63       eachControl->installEventFilter(this);
64     }
65     else {
66       eachControl->setFocusPolicy(Qt::NoFocus);
67     }
68   }
69 }
70
71 void ModuleBase_ModelWidget::setHighlighted(bool isHighlighted)
72 {
73   QList<QWidget*> aWidgetList = getControls();
74   foreach(QWidget* aWidget, aWidgetList) {
75     QLabel* aLabel = qobject_cast<QLabel*>(aWidget);
76     // We won't set the effect to QLabels - it looks ugly
77     if(aLabel) continue;
78     if(isHighlighted) {
79       // If effect is the installed on a different widget, setGraphicsEffect() will
80       // remove the effect from the widget and install it on this widget.
81       // That's why we create a new effect for each widget
82       QGraphicsDropShadowEffect* aGlowEffect = new QGraphicsDropShadowEffect();
83       aGlowEffect->setOffset(.0);
84       aGlowEffect->setBlurRadius(10.0);
85       aGlowEffect->setColor(QColor(0, 170, 255)); // Light-blue color, #00AAFF
86       aWidget->setGraphicsEffect(aGlowEffect);
87     } else {
88       QGraphicsEffect* anEffect = aWidget->graphicsEffect();
89       if(anEffect)
90         anEffect->deleteLater();
91       aWidget->setGraphicsEffect(NULL);
92     }
93   }
94 }
95
96 void ModuleBase_ModelWidget::setFeature(const FeaturePtr& theFeature, const bool theToStoreValue)
97 {
98   myFeature = theFeature;
99   if (theToStoreValue)
100     storeValue();
101 }
102
103 bool ModuleBase_ModelWidget::focusTo()
104 {
105   QList<QWidget*> aControls = getControls();
106   QList<QWidget*>::const_iterator anIt = aControls.begin(), aLast = aControls.end();
107   bool isFocusAccepted = false;
108   for (; anIt != aLast && !isFocusAccepted; anIt++) {
109     QWidget* aWidget = *anIt;
110     if (aWidget && aWidget->focusPolicy() != Qt::NoFocus) {
111       aWidget->setFocus();
112       isFocusAccepted = true;
113     }
114   }
115   return isFocusAccepted;
116 }
117
118 void ModuleBase_ModelWidget::activate()
119 {
120   // the control value is stored to the mode by the focus in on the widget
121   // we need the value is initialized in order to enable the apply button in the property panel.
122   // It should happens in the creation mode only because all fields are filled in the edition mode
123   if (!isEditingMode()) {
124     AttributePtr anAttribute = myFeature->data()->attribute(myAttributeID);
125     if (anAttribute.get() != NULL && !anAttribute->isInitialized()) {
126       if (isComputedDefault()) {
127         if (myFeature->compute(myAttributeID)) {
128           restoreValue();
129         }
130       }
131       else {
132         storeValue();
133       }
134     }
135   }
136   activateCustom();
137 }
138
139 void ModuleBase_ModelWidget::setDefaultValue(const std::string& theValue)
140 {
141   myDefaultValue = theValue;
142 }
143
144 bool ModuleBase_ModelWidget::storeValue()
145 {
146   setValueState(Stored);
147
148   emit beforeValuesChanged();
149   bool isDone = storeValueCustom();
150   emit afterValuesChanged();
151
152   return isDone;
153 }
154
155 void ModuleBase_ModelWidget::setValueState(const ValueState& theState)
156 {
157   if (myState == theState)
158     return;
159
160   myState = theState;
161   emit valueStateChanged();
162 }
163
164 bool ModuleBase_ModelWidget::restoreValue()
165 {
166   emit beforeValuesRestored();
167   bool isDone = restoreValueCustom();
168   emit afterValuesRestored();
169
170   return isDone;
171 }
172
173 void ModuleBase_ModelWidget::storeValueByApply()
174 {
175   // do not emit signal about update the currenty feature object
176   // in order to do not perform additional redisplay in the viewer.
177   // It should happens by finish operation of the apply action
178   storeValueCustom();
179 }
180
181 void ModuleBase_ModelWidget::updateObject(ObjectPtr theObj)
182 {
183   blockUpdateViewer(true);
184
185   Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
186
187   blockUpdateViewer(false);
188 }
189
190 void ModuleBase_ModelWidget::moveObject(ObjectPtr theObj)
191 {
192   //blockUpdateViewer(true);
193
194   static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_MOVED);
195   ModelAPI_EventCreator::get()->sendUpdated(theObj, anEvent);
196   Events_Loop::loop()->flush(anEvent);
197
198   //blockUpdateViewer(false);
199 }
200
201 bool ModuleBase_ModelWidget::isEventProcessed(QKeyEvent* theEvent)
202 {
203   return false;
204 }
205
206 bool ModuleBase_ModelWidget::eventFilter(QObject* theObject, QEvent *theEvent)
207 {
208   QWidget* aWidget = qobject_cast<QWidget*>(theObject);
209   if (theEvent->type() == QEvent::FocusIn) {
210     #ifdef _DEBUG
211     // The following two lines are for debugging purpose only
212     QFocusEvent* aFocusEvent = dynamic_cast<QFocusEvent*>(theEvent);
213     bool isWinFocus = aFocusEvent->reason() == Qt::ActiveWindowFocusReason;
214     #endif
215     if (getControls().contains(aWidget)) {
216       emit focusInWidget(this);
217     }
218   }
219   // pass the event on to the parent class
220
221   return QObject::eventFilter(theObject, theEvent);
222 }
223
224 //**************************************************************
225 void ModuleBase_ModelWidget::onWidgetValuesChanged()
226 {
227   storeValue();
228 }
229
230 //**************************************************************
231 void ModuleBase_ModelWidget::onWidgetValuesModified()
232 {
233   setValueState(Modified);
234 }
235
236 //**************************************************************
237 void ModuleBase_ModelWidget::blockUpdateViewer(const bool theValue)
238 {
239   // the viewer update should be blocked in order to avoid the temporary feature content
240   // when the solver processes the feature, the redisplay message can be flushed
241   // what caused the display in the viewer preliminary states of object
242   // e.g. fillet feature, angle value change
243   std::shared_ptr<Events_Message> aMsg;
244   if (theValue) {
245     aMsg = std::shared_ptr<Events_Message>(
246         new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_BLOCKED)));
247   }
248   else {
249     // the viewer update should be unblocked
250     aMsg = std::shared_ptr<Events_Message>(
251         new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_UNBLOCKED)));
252   }
253   Events_Loop::loop()->send(aMsg);
254 }