1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModuleBase_ModelWidget.cpp
4 // Created: 25 Apr 2014
5 // Author: Natalia ERMOLAEVA
7 #include "ModuleBase_ModelWidget.h"
8 #include "ModuleBase_ViewerPrs.h"
9 #include "ModuleBase_Tools.h"
10 #include "ModuleBase_WidgetValidator.h"
12 #include <Events_InfoMessage.h>
14 #include <ModelAPI_Data.h>
15 #include <ModelAPI_Attribute.h>
16 #include <ModelAPI_Events.h>
17 #include <ModelAPI_Session.h>
18 #include <ModelAPI_Validator.h>
20 #include <Config_Keywords.h>
21 #include <Config_WidgetAPI.h>
22 #include <Config_Translator.h>
23 #include <Config_PropManager.h>
25 #include <Events_Loop.h>
29 #include <QFocusEvent>
32 //#define DEBUG_VALUE_STATE
34 //#define DEBUG_WIDGET_INSTANCE
36 ModuleBase_ModelWidget::ModuleBase_ModelWidget(QWidget* theParent,
37 const Config_WidgetAPI* theData)
41 myIsValueStateBlocked(false),
42 myFlushUpdateBlocked(false),
45 #ifdef DEBUG_WIDGET_INSTANCE
46 qDebug("ModuleBase_ModelWidget::ModuleBase_ModelWidget");
49 myIsInternal = theData->getBooleanAttribute(ATTR_INTERNAL, false);
51 myDefaultValue = theData->getProperty(ATTR_DEFAULT);
52 myUseReset = theData->getBooleanAttribute(ATTR_USE_RESET, true);
53 myIsComputedDefault = theData->getProperty(ATTR_DEFAULT) == DOUBLE_WDG_DEFAULT_COMPUTED;
54 myAttributeID = theData ? theData->widgetId() : "";
55 myIsObligatory = theData->getBooleanAttribute(ATTR_OBLIGATORY, true);
57 myIsValueEnabled = On; // not defined or "true"
58 std::string anEnableValue = theData->getProperty(DOUBLE_WDG_ENABLE_VALUE);
59 if (anEnableValue == "false")
60 myIsValueEnabled = Off;
61 if (anEnableValue == DOUBLE_WDG_ENABLE_VALUE_BY_PREFERENCES)
62 myIsValueEnabled = DefinedInPreferences;
64 connect(this, SIGNAL(valuesChanged()), this, SLOT(onWidgetValuesChanged()));
65 connect(this, SIGNAL(valuesModified()), this, SLOT(onWidgetValuesModified()));
68 ModuleBase_ModelWidget::~ModuleBase_ModelWidget()
70 #ifdef DEBUG_WIDGET_INSTANCE
71 qDebug("ModuleBase_ModelWidget::~ModuleBase_ModelWidget");
75 bool ModuleBase_ModelWidget::reset()
77 bool aResult = resetCustom();
84 bool ModuleBase_ModelWidget::isInitialized(ObjectPtr theObject) const
86 return theObject->data()->attribute(attributeID())->isInitialized();
89 bool ModuleBase_ModelWidget::isValueEnabled() const
91 bool anEnabled = true;
92 if (myIsValueEnabled == DefinedInPreferences) {
93 bool aCanDisable = Config_PropManager::boolean("Sketch planes", "disable_input_fields", "true");
97 else if (myIsValueEnabled == Off)
102 void ModuleBase_ModelWidget::processValueState()
104 if (myState == ModifiedInPP || myState == ModifiedInViewer)
108 QString ModuleBase_ModelWidget::getValueStateError() const
110 QString anError = "";
112 ModuleBase_ModelWidget::ValueState aState = getValueState();
113 if (aState != ModuleBase_ModelWidget::Stored) {
114 AttributePtr anAttr = feature()->attribute(attributeID());
116 QString anAttributeName = anAttr->id().c_str();
118 case ModuleBase_ModelWidget::ModifiedInViewer:
119 anError = "Attribute \"" + anAttributeName +
120 "\" is locked by modification value in the viewer.";
122 case ModuleBase_ModelWidget::Reset:
123 anError = "Attribute \"" + anAttributeName + "\" is not initialized.";
125 case ModuleBase_ModelWidget::ModifiedInPP: // Apply should be enabled in this mode
134 QString ModuleBase_ModelWidget::getError(const bool theValueStateChecked) const
138 if (!feature().get())
141 std::string anAttributeID = attributeID();
142 AttributePtr anAttribute = feature()->attribute(anAttributeID);
143 if (!anAttribute.get())
146 std::string aValidatorID;
147 Events_InfoMessage anErrorMsg;
149 static ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
150 if (!aValidators->validate(anAttribute, aValidatorID, anErrorMsg)) {
151 if (anErrorMsg.empty())
152 anErrorMsg = "unknown error.";
153 anErrorMsg = anAttributeID + " - " + aValidatorID + ": " + anErrorMsg.messageString();
156 if (!anErrorMsg.empty()) {
157 std::string aStr = Config_Translator::translate(anErrorMsg);
158 std::string aCodec = Config_Translator::codec(anErrorMsg.context());
159 anError = QTextCodec::codecForName(aCodec.c_str())->toUnicode(aStr.c_str());
162 if (anError.isEmpty() && theValueStateChecked)
163 anError = getValueStateError();
165 anError = translateString(anError);
170 QString ModuleBase_ModelWidget::translateString(const QString& theMsg) const
172 if (!theMsg.isEmpty()) {
173 std::string aContext = feature()->getKind();
174 std::string aStr = Config_Translator::translate(aContext, theMsg.toStdString().c_str());
175 std::string aCodec = Config_Translator::codec(aContext);
176 return QTextCodec::codecForName(aCodec.c_str())->toUnicode(aStr.c_str());
182 void ModuleBase_ModelWidget::enableFocusProcessing()
184 QList<QWidget*> aMyControls = getControls();
185 foreach(QWidget* eachControl, aMyControls) {
186 eachControl->setFocusPolicy(Qt::StrongFocus);
187 eachControl->installEventFilter(this);
191 void ModuleBase_ModelWidget::setHighlighted(bool isHighlighted)
193 QList<QWidget*> aWidgetList = getControls();
194 foreach(QWidget* aWidget, aWidgetList) {
195 QLabel* aLabel = qobject_cast<QLabel*>(aWidget);
196 // We won't set the effect to QLabels - it looks ugly
198 // If effect is the installed on a different widget, setGraphicsEffect() will
199 // remove the effect from the widget and install it on this widget.
200 // That's why we create a new effect for each widget
201 ModuleBase_Tools::setShadowEffect(aWidget, isHighlighted);
205 void ModuleBase_ModelWidget::setFeature(const FeaturePtr& theFeature, const bool theToStoreValue,
206 const bool isUpdateFlushed)
208 /// it is possible to give this flag as parameter in storeValue/storeCustomValue
209 /// after debug, it may be corrected
210 myFlushUpdateBlocked = !isUpdateFlushed;
211 myFeature = theFeature;
214 myFlushUpdateBlocked = false;
217 bool ModuleBase_ModelWidget::focusTo()
219 #ifdef DEBUG_WIDGET_INSTANCE
220 qDebug("ModuleBase_ModelWidget::focusTo");
222 QList<QWidget*> aControls = getControls();
223 QList<QWidget*>::const_iterator anIt = aControls.begin(), aLast = aControls.end();
224 bool isFocusAccepted = false;
225 for (; anIt != aLast && !isFocusAccepted; anIt++) {
226 QWidget* aWidget = *anIt;
227 if (aWidget && aWidget->focusPolicy() != Qt::NoFocus) {
228 ModuleBase_Tools::setFocus(aWidget, "ModuleBase_ModelWidget::focusTo()");
229 isFocusAccepted = true;
232 return isFocusAccepted;
235 void ModuleBase_ModelWidget::activate()
237 #ifdef DEBUG_WIDGET_INSTANCE
238 qDebug("ModuleBase_ModelWidget::activate");
240 // the control value is stored to the mode by the focus in on the widget
241 // we need the value is initialized in order to enable the apply button in the property panel.
242 // It should happens in the creation mode only because all fields are filled in the edition mode
243 if (!isEditingMode()) {
244 AttributePtr anAttribute = myFeature->data()->attribute(myAttributeID);
245 if (anAttribute.get() != NULL && !anAttribute->isInitialized())
246 initializeValueByActivate();
249 if (myWidgetValidator)
250 myWidgetValidator->activateFilters(true);
255 void ModuleBase_ModelWidget::deactivate()
257 #ifdef DEBUG_WIDGET_INSTANCE
258 qDebug("ModuleBase_ModelWidget::deactivate");
260 myIsValueStateBlocked = false;
262 if (myWidgetValidator)
263 myWidgetValidator->activateFilters(false);
266 void ModuleBase_ModelWidget::initializeValueByActivate()
268 if (isComputedDefault()) {
269 if (myFeature->compute(myAttributeID)) {
278 QWidget* ModuleBase_ModelWidget::getControlAcceptingFocus(const bool isFirst)
280 QWidget* aControl = 0;
282 QList<QWidget*> aControls = getControls();
283 int aSize = aControls.size();
286 for (int i = 0; i < aSize && !aControl; i++) {
287 if (aControls[i]->focusPolicy() != Qt::NoFocus)
288 aControl = aControls[i];
292 for (int i = aSize - 1; i >= 0 && !aControl; i--) {
293 if (aControls[i]->focusPolicy() != Qt::NoFocus)
294 aControl = aControls[i];
300 void ModuleBase_ModelWidget::setDefaultValue(const std::string& theValue)
302 myDefaultValue = theValue;
305 bool ModuleBase_ModelWidget::storeValue()
307 setValueState(Stored);
309 emit beforeValuesChanged();
310 bool isDone = storeValueCustom();
311 emit afterValuesChanged();
315 #ifdef DEBUG_VALUE_STATE
316 std::string getDebugInfo(const ModuleBase_ModelWidget::ValueState& theState)
320 case ModuleBase_ModelWidget::Stored: anInfo = "Stored "; break;
321 case ModuleBase_ModelWidget::ModifiedInPP: anInfo = "ModifiedInPP "; break;
322 case ModuleBase_ModelWidget::ModifiedInViewer: anInfo = "ModifiedInViewer"; break;
323 case ModuleBase_ModelWidget::Reset: anInfo = "Reset "; break;
330 ModuleBase_ModelWidget::ValueState ModuleBase_ModelWidget::setValueState
331 (const ModuleBase_ModelWidget::ValueState& theState)
333 ValueState aState = myState;
335 if (myState != theState && !myIsValueStateBlocked) {
336 #ifdef DEBUG_VALUE_STATE
337 qDebug(QString("setValueState: previous state = %1,\t new state = %2")
338 .arg(getDebugInfo(myState).c_str())
339 .arg(getDebugInfo(theState).c_str()).toStdString().c_str());
342 emit valueStateChanged(aState);
347 bool ModuleBase_ModelWidget::blockValueState(const bool theBlocked)
349 bool isBlocked = myIsValueStateBlocked;
350 myIsValueStateBlocked = theBlocked;
354 bool ModuleBase_ModelWidget::restoreValue()
356 emit beforeValuesRestored();
357 bool isDone = restoreValueCustom();
358 emit afterValuesRestored();
363 void ModuleBase_ModelWidget::updateObject(ObjectPtr theObject)
365 if (!myFlushUpdateBlocked) {
366 #ifdef DEBUG_WIDGET_INSTANCE
367 qDebug("ModuleBase_ModelWidget::updateObject");
369 ModuleBase_Tools::flushUpdated(theObject);
370 emit objectUpdated();
374 void ModuleBase_ModelWidget::moveObject(ObjectPtr theObj)
376 //blockUpdateViewer(true);
377 #ifdef DEBUG_WIDGET_INSTANCE
378 qDebug("ModuleBase_ModelWidget::moveObject");
381 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_MOVED);
382 ModelAPI_EventCreator::get()->sendUpdated(theObj, anEvent);
383 Events_Loop::loop()->flush(anEvent);
385 //blockUpdateViewer(false);
388 bool ModuleBase_ModelWidget::processEnter()
393 bool ModuleBase_ModelWidget::processDelete()
395 // we consider that model objects eats delete key in order to
396 // do nothing by for example symbol delete in line edit or spin box
400 bool ModuleBase_ModelWidget::eventFilter(QObject* theObject, QEvent *theEvent)
402 QWidget* aWidget = qobject_cast<QWidget*>(theObject);
403 if (theEvent->type() == QEvent::FocusIn) {
405 // The following two lines are for debugging purpose only
406 QFocusEvent* aFocusEvent = dynamic_cast<QFocusEvent*>(theEvent);
407 bool isWinFocus = aFocusEvent->reason() == Qt::ActiveWindowFocusReason;
409 if (getControls().contains(aWidget)) {
410 emit focusInWidget(this);
413 else if (theEvent->type() == QEvent::FocusOut) {
414 QFocusEvent* aFocusEvent = dynamic_cast<QFocusEvent*>(theEvent);
416 Qt::FocusReason aReason = aFocusEvent->reason();
417 bool aMouseOrKey = aReason == Qt::MouseFocusReason ||
418 aReason == Qt::TabFocusReason ||
419 aReason == Qt::BacktabFocusReason ||
420 aReason == Qt::OtherFocusReason; // to process widget->setFocus()
421 if (aMouseOrKey && getControls().contains(aWidget)) {
422 if (getValueState() == ModifiedInPP) {
427 // pass the event on to the parent class
429 return QObject::eventFilter(theObject, theEvent);
432 //**************************************************************
433 void ModuleBase_ModelWidget::onWidgetValuesChanged()
438 //**************************************************************
439 void ModuleBase_ModelWidget::onWidgetValuesModified()
441 setValueState(ModifiedInPP);