]> SALOME platform Git repositories - modules/shaper.git/blob - src/XGUI/XGUI_PropertyPanel.cpp
Salome HOME
#1189 Tab - Cancel - Enter validate not cancel
[modules/shaper.git] / src / XGUI / XGUI_PropertyPanel.cpp
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
2
3 /*
4  * XGUI_PropertyPanel.cpp
5  *
6  *  Created on: Apr 29, 2014
7  *      Author: sbh
8  */
9
10 #include <XGUI_PropertyPanel.h>
11 #include <XGUI_ActionsMgr.h>
12 #include <XGUI_OperationMgr.h>
13 //#include <AppElements_Constants.h>
14 #include <ModuleBase_WidgetMultiSelector.h>
15 #include <ModuleBase_Tools.h>
16 #include <ModuleBase_PageBase.h>
17 #include <ModuleBase_PageWidget.h>
18
19 #include <ModelAPI_Session.h>
20 #include <ModelAPI_Validator.h>
21
22 #include <QEvent>
23 #include <QFrame>
24 #include <QIcon>
25 #include <QKeyEvent>
26 #include <QLayoutItem>
27 #include <QToolButton>
28 #include <QVBoxLayout>
29 #include <QGridLayout>
30 #include <QWidget>
31 #include <QToolButton>
32 #include <QAction>
33
34 #ifdef _DEBUG
35 #include <iostream>
36 #endif
37
38 //#define DEBUG_TAB_WIDGETS
39
40 XGUI_PropertyPanel::XGUI_PropertyPanel(QWidget* theParent, XGUI_OperationMgr* theMgr)
41     : ModuleBase_IPropertyPanel(theParent), 
42     myActiveWidget(NULL),
43     myPreselectionWidget(NULL),
44     myPanelPage(NULL),
45     myOperationMgr(theMgr)
46 {
47   this->setWindowTitle(tr("Property Panel"));
48   QAction* aViewAct = this->toggleViewAction();
49   this->setObjectName(PROP_PANEL);
50   setStyleSheet("::title { position: relative; padding-left: 5px; text-align: left center }");
51
52   QWidget* aContent = new QWidget(this);
53   QGridLayout* aMainLayout = new QGridLayout(aContent);
54   const int kPanelColumn = 0;
55   int aPanelRow = 0;
56   aMainLayout->setContentsMargins(3, 3, 3, 3);
57   this->setWidget(aContent);
58
59   QFrame* aFrm = new QFrame(aContent);
60   aFrm->setFrameStyle(QFrame::Raised);
61   aFrm->setFrameShape(QFrame::Panel);
62   QHBoxLayout* aBtnLay = new QHBoxLayout(aFrm);
63   ModuleBase_Tools::zeroMargins(aBtnLay);
64   aMainLayout->addWidget(aFrm, aPanelRow++, kPanelColumn);
65
66   myHeaderWidget = aFrm;
67
68   QStringList aBtnNames;
69   aBtnNames << QString(PROP_PANEL_HELP)
70             << QString(PROP_PANEL_OK)
71             << QString(PROP_PANEL_CANCEL);
72   foreach(QString eachBtnName, aBtnNames) {
73     QToolButton* aBtn = new QToolButton(aFrm);
74     aBtn->setObjectName(eachBtnName);
75     aBtn->setAutoRaise(true);
76     aBtnLay->addWidget(aBtn);
77   }
78   aBtnLay->insertStretch(1, 1);
79
80   myPanelPage = new ModuleBase_PageWidget(aContent);
81   myPanelPage->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::MinimumExpanding);
82   aMainLayout->addWidget(myPanelPage, aPanelRow, kPanelColumn);
83 }
84
85 XGUI_PropertyPanel::~XGUI_PropertyPanel()
86 {
87 }
88
89 void XGUI_PropertyPanel::cleanContent()
90 {
91   if (myActiveWidget)
92     myActiveWidget->deactivate();
93
94   /// as the widgets are deleted later, it is important that the signals
95   /// of these widgets are not processed. An example of the error is issue 986.
96   /// In the given case, the property panel is firstly filled by new widgets
97   /// of restarted operation and after that the mouse release signal come from
98   /// the widget of the previous operation (Point2d widget about mouse is released
99   /// and focus is out of this widget)
100   QList<ModuleBase_ModelWidget*>::const_iterator anIt = myWidgets.begin(),
101                                                  aLast = myWidgets.end();
102   for (; anIt != aLast; anIt++) {
103     QWidget* aWidget = *anIt;
104     if (aWidget) {
105       aWidget->blockSignals(true);
106     }
107   }
108
109   myWidgets.clear();
110   myPanelPage->clearPage();
111   myActiveWidget = NULL;
112   setWindowTitle(tr("Property Panel"));
113 }
114
115 void XGUI_PropertyPanel::setModelWidgets(const QList<ModuleBase_ModelWidget*>& theWidgets)
116 {
117   myWidgets = theWidgets;
118   if (theWidgets.empty()) return;
119   foreach (ModuleBase_ModelWidget* aWidget, theWidgets) {
120     connect(aWidget, SIGNAL(focusInWidget(ModuleBase_ModelWidget*)),
121             this,    SLOT(activateWidget(ModuleBase_ModelWidget*)));
122     connect(aWidget, SIGNAL(focusOutWidget(ModuleBase_ModelWidget*)),
123             this,    SLOT(onActivateNextWidget(ModuleBase_ModelWidget*)));
124     connect(aWidget, SIGNAL(keyReleased(QKeyEvent*)),
125             this,    SIGNAL(keyReleased(QKeyEvent*)));
126     connect(aWidget, SIGNAL(enterClicked()),
127             this,    SIGNAL(enterClicked()));
128
129   }
130 }
131
132 const QList<ModuleBase_ModelWidget*>& XGUI_PropertyPanel::modelWidgets() const
133 {
134   return myWidgets;
135 }
136
137 ModuleBase_PageBase* XGUI_PropertyPanel::contentWidget()
138 {
139   return static_cast<ModuleBase_PageBase*>(myPanelPage);
140 }
141
142 void XGUI_PropertyPanel::updateContentWidget(FeaturePtr theFeature)
143 {
144   // Invalid feature case on abort of the operation
145   if (theFeature.get() == NULL)
146     return;
147   if (theFeature->isAction() || !theFeature->data())
148     return;
149   foreach(ModuleBase_ModelWidget* eachWidget, myWidgets) {
150     if (!eachWidget->feature().get())
151       eachWidget->setFeature(theFeature);
152     eachWidget->restoreValue();
153   }
154   // the repaint is used here to immediately react in GUI to the values change.
155   repaint();
156 }
157
158 void XGUI_PropertyPanel::activateNextWidget(ModuleBase_ModelWidget* theWidget)
159 {
160   // it is possible that the property panel widgets have not been visualized
161   // (e.g. on start operation), so it is strictly important to do not check visualized state
162   activateNextWidget(theWidget, false);
163 }
164
165 void XGUI_PropertyPanel::onActivateNextWidget(ModuleBase_ModelWidget* theWidget)
166 {
167   // this slot happens when some widget lost focus, the next widget which accepts the focus
168   // should be shown, so the second parameter is true
169   // it is important for features where in cases the same attributes are used, isCase for this
170   // attribute returns true, however it can be placed in hidden stack widget(extrusion: elements,
171   // sketch multi rotation -> single/full point)
172   // it is important to check the widget visibility to do not check of the next widget visible
173   // state if the current is not shown. (example: sketch circle re-entrant operation after mouse
174   // release in the viewer, next, radius, widget should be activated but the first is not visualized)
175   bool isVisible = theWidget->isVisible();
176   activateNextWidget(theWidget, isVisible);
177 }
178
179
180 void XGUI_PropertyPanel::activateNextWidget(ModuleBase_ModelWidget* theWidget,
181                                             const bool isCheckVisibility)
182 {
183   // TO CHECK: Editing operation does not have automatical activation of widgets
184   if (isEditingMode()) {
185     activateWidget(NULL);
186     return;
187   }
188   ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
189
190   QList<ModuleBase_ModelWidget*>::const_iterator anIt = myWidgets.begin(), aLast = myWidgets.end();
191   bool isFoundWidget = false;
192   ModuleBase_Tools::activateWindow(this, "XGUI_PropertyPanel::activateNextWidget()");
193   for (; anIt != aLast; anIt++) {
194     ModuleBase_ModelWidget* aCurrentWidget = *anIt;
195     if (isFoundWidget || !theWidget) {
196
197       if (!aValidators->isCase(aCurrentWidget->feature(), aCurrentWidget->attributeID()))
198         continue; // this attribute is not participated in the current case
199       if (isCheckVisibility && !aCurrentWidget->isInternal()) {
200         if (!aCurrentWidget->isVisible())
201           continue;
202       }
203       if (!aCurrentWidget->isObligatory())
204         continue; // not obligatory widgets are not activated automatically
205
206       if (aCurrentWidget->focusTo()) {
207         return;
208       }
209     }
210     isFoundWidget = isFoundWidget || (*anIt) == theWidget;
211   }
212   activateWidget(NULL);
213 }
214
215 void findDirectChildren(QWidget* theParent, QList<QWidget*>& theWidgets, const bool theDebug)
216 {
217   QList<QWidget*> aWidgets;
218
219   if (theParent) {
220     QLayout* aLayout = theParent->layout();
221     if (aLayout) {
222       for (int i = 0, aCount = aLayout->count(); i < aCount; i++) {
223         QLayoutItem* anItem = aLayout->itemAt(i);
224         QWidget* aWidget = anItem ? anItem->widget() : 0;
225         if (aWidget && aWidget->isVisible()) {
226           if (aWidget->focusPolicy() != Qt::NoFocus)
227             theWidgets.append(aWidget);
228           findDirectChildren(aWidget, theWidgets, false);
229         }
230       }
231     }
232   }
233 #ifdef DEBUG_TAB_WIDGETS
234   if (theDebug) {
235     QStringList aWidgetTypes;
236     QList<QWidget*>::const_iterator anIt =  theWidgets.begin(), aLast = theWidgets.end();
237     for (; anIt != aLast; anIt++) {
238       QWidget* aWidget = *anIt;
239       if (aWidget)
240         aWidgetTypes.append(aWidget->objectName());
241     }
242     QString anInfo = QString("theWidgets[%1]: %2").arg(theWidgets.count()).arg(aWidgetTypes.join(","));
243     qDebug(anInfo.toStdString().c_str());
244   }
245 #endif
246 }
247
248 bool XGUI_PropertyPanel::focusNextPrevChild(bool theIsNext)
249 {
250   //bool isChangedFocus = ModuleBase_IPropertyPanel::focusNextPrevChild(theIsNext);
251   //return true;//isChangedFocus;
252
253   // it wraps the Tabs clicking to follow in the chain:
254   // controls, last control, Apply, Cancel, first control, controls
255   bool isChangedFocus = false;
256
257   QWidget* aFocusWidget = focusWidget();
258 #ifdef DEBUG_TAB_WIDGETS
259   if (aFocusWidget) {
260     QString anInfo = QString("focus Widget: %1").arg(aFocusWidget->objectName());
261     qDebug(anInfo.toStdString().c_str());
262   }
263 #endif
264
265   QWidget* aNewFocusWidget = 0;
266   if (aFocusWidget) {
267     QList<QWidget*> aChildren;
268     findDirectChildren(this, aChildren, true);
269     int aChildrenCount = aChildren.count();
270     int aFocusWidgetIndex = aChildren.indexOf(aFocusWidget);
271     if (aFocusWidgetIndex >= 0) {
272       if (theIsNext) {
273         if (aFocusWidgetIndex == aChildrenCount-1) {
274           // after the last widget focus should be set to "Apply"
275           QToolButton* anOkBtn = findChild<QToolButton*>(PROP_PANEL_OK);
276           aNewFocusWidget = anOkBtn;
277         }
278         else {
279           aNewFocusWidget = aChildren[aFocusWidgetIndex+1];
280         }
281       }
282       else {
283         if (aFocusWidgetIndex == 0) {
284           // before the first widget, the last should accept focus
285           aNewFocusWidget = aChildren[aChildrenCount - 1];
286         }
287         else {
288           // before the "Apply" button, the last should accept focus for consistency with "Next"
289           QToolButton* anOkBtn = findChild<QToolButton*>(PROP_PANEL_OK);
290           if (aFocusWidget == anOkBtn) {
291             aNewFocusWidget = aChildren[aChildrenCount - 1];
292           }
293           else {
294             aNewFocusWidget = aChildren[aFocusWidgetIndex-1];
295           }
296         }
297       }
298     }
299   }
300   if (aNewFocusWidget) {
301     if (myActiveWidget) {
302       myActiveWidget->getControls();
303       bool isFirstControl = !theIsNext;
304       QWidget* aLastFocusControl = myActiveWidget->getControlAcceptingFocus(isFirstControl);
305       if (aFocusWidget == aLastFocusControl) {
306         setActiveWidget(NULL);
307       }
308     }
309
310     //ModuleBase_Tools::setFocus(aNewFocusWidget, "XGUI_PropertyPanel::focusNextPrevChild()");
311     aNewFocusWidget->setFocus(theIsNext ? Qt::TabFocusReason : Qt::BacktabFocusReason);
312     isChangedFocus = true;
313   }
314   return isChangedFocus;
315 }
316
317 void XGUI_PropertyPanel::activateNextWidget()
318 {
319   activateNextWidget(myActiveWidget);
320 }
321
322 void XGUI_PropertyPanel::activateWidget(ModuleBase_ModelWidget* theWidget)
323 {
324   std::string aPreviosAttributeID;
325   if(myActiveWidget)
326     aPreviosAttributeID = myActiveWidget->attributeID();
327
328   // Avoid activation of already actve widget. It could happen on focusIn event many times
329   if (setActiveWidget(theWidget)) {
330     emit widgetActivated(myActiveWidget);
331     if (!myActiveWidget && !isEditingMode()) {
332       emit noMoreWidgets(aPreviosAttributeID);
333     }
334   }
335 }
336
337 bool XGUI_PropertyPanel::setActiveWidget(ModuleBase_ModelWidget* theWidget)
338 {
339   // Avoid activation of already actve widget. It could happen on focusIn event many times
340   if (theWidget == myActiveWidget) {
341     return false;
342   }
343   std::string aPreviosAttributeID;
344   if(myActiveWidget) {
345     aPreviosAttributeID = myActiveWidget->attributeID();
346     myActiveWidget->deactivate();
347     myActiveWidget->setHighlighted(false);
348   }
349   if(theWidget) {
350     emit beforeWidgetActivated(theWidget);
351     theWidget->setHighlighted(true);
352     theWidget->activate();
353   }
354   myActiveWidget = theWidget;
355   return true;
356 }
357
358 void XGUI_PropertyPanel::setFocusOnOkButton()
359 {
360   QToolButton* anOkBtn = findChild<QToolButton*>(PROP_PANEL_OK);
361   ModuleBase_Tools::setFocus(anOkBtn, "XGUI_PropertyPanel::setFocusOnOkButton()");
362 }
363
364 void XGUI_PropertyPanel::setCancelEnabled(bool theEnabled)
365 {
366   QToolButton* anCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
367   anCancelBtn->setEnabled(theEnabled);
368 }
369
370 bool XGUI_PropertyPanel::isCancelEnabled() const
371 {
372   QToolButton* anCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
373   return anCancelBtn->isEnabled();
374 }
375
376 void XGUI_PropertyPanel::setEditingMode(bool isEditing)
377 {
378   ModuleBase_IPropertyPanel::setEditingMode(isEditing);
379   foreach(ModuleBase_ModelWidget* aWgt, myWidgets) {
380     aWgt->setEditingMode(isEditing);
381   }
382 }
383
384 void XGUI_PropertyPanel::setupActions(XGUI_ActionsMgr* theMgr)
385 {
386   QStringList aButtonNames;
387   aButtonNames << PROP_PANEL_OK << PROP_PANEL_CANCEL << PROP_PANEL_HELP;
388   QList<XGUI_ActionsMgr::OperationStateActionId> aActionIds;
389   aActionIds << XGUI_ActionsMgr::Accept << XGUI_ActionsMgr::Abort << XGUI_ActionsMgr::Help;
390   for (int i = 0; i < aButtonNames.size(); ++i) {
391     QToolButton* aBtn = findChild<QToolButton*>(aButtonNames.at(i));
392     QAction* anAct = theMgr->operationStateAction(aActionIds.at(i));
393     aBtn->setDefaultAction(anAct);
394   }
395 }
396
397 ModuleBase_ModelWidget* XGUI_PropertyPanel::preselectionWidget() const
398 {
399   return myPreselectionWidget;
400 }
401
402 void XGUI_PropertyPanel::setPreselectionWidget(ModuleBase_ModelWidget* theWidget)
403 {
404   myPreselectionWidget = theWidget;
405 }
406
407
408 void XGUI_PropertyPanel::closeEvent(QCloseEvent* theEvent)
409 {
410   ModuleBase_Operation* aOp = myOperationMgr->currentOperation();
411   if (aOp) {
412     if (myOperationMgr->canStopOperation(aOp)) {
413       myOperationMgr->abortOperation(aOp);
414       if (myOperationMgr->hasOperation())
415         theEvent->ignore();
416       else
417         theEvent->accept();
418     } else 
419       theEvent->ignore();
420   } else
421     ModuleBase_IPropertyPanel::closeEvent(theEvent);
422 }