1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
4 * XGUI_PropertyPanel.cpp
6 * Created on: Apr 29, 2014
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>
19 #include <ModelAPI_Session.h>
20 #include <ModelAPI_Validator.h>
26 #include <QLayoutItem>
27 #include <QToolButton>
28 #include <QVBoxLayout>
29 #include <QGridLayout>
31 #include <QToolButton>
38 XGUI_PropertyPanel::XGUI_PropertyPanel(QWidget* theParent, XGUI_OperationMgr* theMgr)
39 : ModuleBase_IPropertyPanel(theParent),
41 myPreselectionWidget(NULL),
43 myOperationMgr(theMgr)
45 this->setWindowTitle(tr("Property Panel"));
46 QAction* aViewAct = this->toggleViewAction();
47 this->setObjectName(PROP_PANEL);
48 setStyleSheet("::title { position: relative; padding-left: 5px; text-align: left center }");
50 QWidget* aContent = new QWidget(this);
51 QGridLayout* aMainLayout = new QGridLayout(aContent);
52 const int kPanelColumn = 0;
54 aMainLayout->setContentsMargins(3, 3, 3, 3);
55 this->setWidget(aContent);
57 QFrame* aFrm = new QFrame(aContent);
58 aFrm->setFrameStyle(QFrame::Raised);
59 aFrm->setFrameShape(QFrame::Panel);
60 QHBoxLayout* aBtnLay = new QHBoxLayout(aFrm);
61 ModuleBase_Tools::zeroMargins(aBtnLay);
62 aMainLayout->addWidget(aFrm, aPanelRow++, kPanelColumn);
64 myHeaderWidget = aFrm;
66 QStringList aBtnNames;
67 aBtnNames << QString(PROP_PANEL_HELP)
68 << QString(PROP_PANEL_OK)
69 << QString(PROP_PANEL_CANCEL);
70 foreach(QString eachBtnName, aBtnNames) {
71 QToolButton* aBtn = new QToolButton(aFrm);
72 aBtn->setObjectName(eachBtnName);
73 aBtn->setAutoRaise(true);
74 aBtnLay->addWidget(aBtn);
76 aBtnLay->insertStretch(1, 1);
78 myPanelPage = new ModuleBase_PageWidget(aContent);
79 myPanelPage->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::MinimumExpanding);
80 aMainLayout->addWidget(myPanelPage, aPanelRow, kPanelColumn);
83 XGUI_PropertyPanel::~XGUI_PropertyPanel()
87 void XGUI_PropertyPanel::cleanContent()
90 myActiveWidget->deactivate();
92 /// as the widgets are deleted later, it is important that the signals
93 /// of these widgets are not processed. An example of the error is issue 986.
94 /// In the given case, the property panel is firstly filled by new widgets
95 /// of restarted operation and after that the mouse release signal come from
96 /// the widget of the previous operation (Point2d widget about mouse is released
97 /// and focus is out of this widget)
98 QList<ModuleBase_ModelWidget*>::const_iterator anIt = myWidgets.begin(),
99 aLast = myWidgets.end();
100 for (; anIt != aLast; anIt++) {
101 QWidget* aWidget = *anIt;
103 aWidget->blockSignals(true);
108 myPanelPage->clearPage();
109 myActiveWidget = NULL;
110 setWindowTitle(tr("Property Panel"));
113 void XGUI_PropertyPanel::setModelWidgets(const QList<ModuleBase_ModelWidget*>& theWidgets)
115 myWidgets = theWidgets;
116 if (theWidgets.empty()) return;
117 foreach (ModuleBase_ModelWidget* aWidget, theWidgets) {
118 connect(aWidget, SIGNAL(focusInWidget(ModuleBase_ModelWidget*)),
119 this, SLOT(activateWidget(ModuleBase_ModelWidget*)));
120 connect(aWidget, SIGNAL(focusOutWidget(ModuleBase_ModelWidget*)),
121 this, SLOT(activateNextWidget(ModuleBase_ModelWidget*)));
122 connect(aWidget, SIGNAL(keyReleased(QKeyEvent*)),
123 this, SIGNAL(keyReleased(QKeyEvent*)));
124 connect(aWidget, SIGNAL(enterClicked()),
125 this, SIGNAL(enterClicked()));
130 const QList<ModuleBase_ModelWidget*>& XGUI_PropertyPanel::modelWidgets() const
135 ModuleBase_PageBase* XGUI_PropertyPanel::contentWidget()
137 return static_cast<ModuleBase_PageBase*>(myPanelPage);
140 void XGUI_PropertyPanel::updateContentWidget(FeaturePtr theFeature)
142 // Invalid feature case on abort of the operation
143 if (theFeature.get() == NULL)
145 if (theFeature->isAction() || !theFeature->data())
147 foreach(ModuleBase_ModelWidget* eachWidget, myWidgets) {
148 if (!eachWidget->feature().get())
149 eachWidget->setFeature(theFeature);
150 eachWidget->restoreValue();
152 // the repaint is used here to immediately react in GUI to the values change.
156 void XGUI_PropertyPanel::activateNextWidget(ModuleBase_ModelWidget* theWidget)
158 // TO CHECK: Editing operation does not have automatical activation of widgets
159 if (isEditingMode()) {
160 activateWidget(NULL);
163 ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
165 QList<ModuleBase_ModelWidget*>::const_iterator anIt = myWidgets.begin(), aLast = myWidgets.end();
166 bool isFoundWidget = false;
167 ModuleBase_Tools::activateWindow(this, "XGUI_PropertyPanel::activateNextWidget()");
168 for (; anIt != aLast; anIt++) {
169 ModuleBase_ModelWidget* aCurrentWidget = *anIt;
170 if (isFoundWidget || !theWidget) {
172 if (!aValidators->isCase(aCurrentWidget->feature(), aCurrentWidget->attributeID()))
173 continue; // this attribute is not participated in the current case
174 if (!aCurrentWidget->isObligatory())
175 continue; // not obligatory widgets are not activated automatically
177 if (aCurrentWidget->focusTo()) {
181 isFoundWidget = isFoundWidget || (*anIt) == theWidget;
183 activateWidget(NULL);
186 //#define DEBUG_TAB_WIDGETS
190 void findDirectChildren(QWidget* theParent, QList<QWidget*>& theWidgets, const bool theDebug)
192 QList<QWidget*> aWidgets;
195 QLayout* aLayout = theParent->layout();
197 for (int i = 0, aCount = aLayout->count(); i < aCount; i++) {
198 QLayoutItem* anItem = aLayout->itemAt(i);
199 QWidget* aWidget = anItem ? anItem->widget() : 0;
200 if (aWidget && aWidget->isVisible()) {
201 if (aWidget->focusPolicy() != Qt::NoFocus)
202 theWidgets.append(aWidget);
203 findDirectChildren(aWidget, theWidgets, false);
208 #ifdef DEBUG_TAB_WIDGETS
210 QStringList aWidgetTypes;
211 QList<QWidget*>::const_iterator anIt = theWidgets.begin(), aLast = theWidgets.end();
212 for (; anIt != aLast; anIt++) {
213 QWidget* aWidget = *anIt;
215 aWidgetTypes.append(aWidget->objectName());
217 QString anInfo = QString("theWidgets[%1]: %2").arg(theWidgets.count()).arg(aWidgetTypes.join(","));
218 qDebug(anInfo.toStdString().c_str());
223 bool XGUI_PropertyPanel::focusNextPrevChild(bool theIsNext)
225 //bool isChangedFocus = ModuleBase_IPropertyPanel::focusNextPrevChild(theIsNext);
226 //return true;//isChangedFocus;
228 // it wraps the Tabs clicking to follow in the chain:
229 // controls, last control, Apply, Cancel, first control, controls
230 bool isChangedFocus = false;
232 QWidget* aFocusWidget = focusWidget();
233 #ifdef DEBUG_TAB_WIDGETS
235 QString anInfo = QString("focus Widget: %1").arg(aFocusWidget->objectName());
236 qDebug(anInfo.toStdString().c_str());
240 QWidget* aNewFocusWidget = 0;
242 QList<QWidget*> aChildren;
243 findDirectChildren(this, aChildren, true);
244 int aChildrenCount = aChildren.count();
245 int aFocusWidgetIndex = aChildren.indexOf(aFocusWidget);
246 if (aFocusWidgetIndex >= 0) {
248 if (aFocusWidgetIndex == aChildrenCount-1) {
249 // after the last widget focus should be set to "Apply"
250 QToolButton* anOkBtn = findChild<QToolButton*>(PROP_PANEL_OK);
251 aNewFocusWidget = anOkBtn;
254 aNewFocusWidget = aChildren[aFocusWidgetIndex+1];
258 if (aFocusWidgetIndex == 0) {
259 // before the first widget, the last should accept focus
260 aNewFocusWidget = aChildren[aChildrenCount - 1];
263 // before the "Apply" button, the last should accept focus for consistency with "Next"
264 QToolButton* anOkBtn = findChild<QToolButton*>(PROP_PANEL_OK);
265 if (aFocusWidget == anOkBtn) {
266 aNewFocusWidget = aChildren[aChildrenCount - 1];
269 aNewFocusWidget = aChildren[aFocusWidgetIndex-1];
275 if (aNewFocusWidget) {
276 if (myActiveWidget) {
277 myActiveWidget->getControls();
278 bool isFirstControl = !theIsNext;
279 QWidget* aLastFocusControl = myActiveWidget->getControlAcceptingFocus(isFirstControl);
280 if (aFocusWidget == aLastFocusControl) {
281 this->setActiveWidget(NULL);
285 //ModuleBase_Tools::setFocus(aNewFocusWidget, "XGUI_PropertyPanel::focusNextPrevChild()");
286 aNewFocusWidget->setFocus(theIsNext ? Qt::TabFocusReason : Qt::BacktabFocusReason);
287 isChangedFocus = true;
289 return isChangedFocus;
292 bool XGUI_PropertyPanel::focusNextPrevChild(bool theIsNext)
294 // it wraps the Tabs clicking to follow in the chain:
295 // controls, last control, Apply, Cancel, first control, controls
296 bool isChangedFocus = false;
298 if (theIsNext) { // forward by Tab
299 QToolButton* aCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
300 if (aCancelBtn->hasFocus()) {
301 // after cancel, the first control should be focused
302 QWidget* aFirstControl = 0;
303 for (int i = 0, aSize = myWidgets.size(); i < aSize && !aFirstControl; i++)
304 aFirstControl = myWidgets[i]->getControlAcceptingFocus(true);
306 ModuleBase_Tools::setFocus(aFirstControl, "XGUI_PropertyPanel::focusNextPrevChild()");
307 isChangedFocus = true;
310 // after the last control, the Apply button should be focused
311 QWidget* aLastControl = 0;
312 for (int i = myWidgets.size()-1; i >= 0 && !aLastControl; i--)
313 aLastControl = myWidgets[i]->getControlAcceptingFocus(false);
314 if (aLastControl && aLastControl->hasFocus()) {
315 setFocusOnOkButton();
316 isChangedFocus = true;
320 else { // backward by SHIFT + Tab
321 QToolButton* anOkBtn = findChild<QToolButton*>(PROP_PANEL_OK);
322 if (anOkBtn->hasFocus()) {
323 // after Apply, the last control should be focused
324 QWidget* aLastControl = 0;
325 for (int i = myWidgets.size()-1; i >= 0 && !aLastControl; i--)
326 aLastControl = myWidgets[i]->getControlAcceptingFocus(false);
328 ModuleBase_Tools::setFocus(aLastControl, "XGUI_PropertyPanel::focusNextPrevChild()");
329 isChangedFocus = true;
332 // after the first control, the Cancel button should be focused
333 QWidget* aFirstControl = 0;
334 for (int i = 0, aSize = myWidgets.size(); i < aSize && !aFirstControl; i++)
335 aFirstControl = myWidgets[i]->getControlAcceptingFocus(true);
336 if (aFirstControl && aFirstControl->hasFocus()) {
337 QToolButton* aCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
338 ModuleBase_Tools::setFocus(aCancelBtn, "XGUI_PropertyPanel::focusNextPrevChild()");
339 isChangedFocus = true;
345 isChangedFocus = ModuleBase_IPropertyPanel::focusNextPrevChild(theIsNext);
346 return isChangedFocus;
350 void XGUI_PropertyPanel::activateNextWidget()
352 activateNextWidget(myActiveWidget);
355 void XGUI_PropertyPanel::activateWidget(ModuleBase_ModelWidget* theWidget)
357 std::string aPreviosAttributeID;
359 aPreviosAttributeID = myActiveWidget->attributeID();
361 // Avoid activation of already actve widget. It could happen on focusIn event many times
362 if (setActiveWidget(theWidget)) {
363 emit widgetActivated(myActiveWidget);
364 if (!myActiveWidget && !isEditingMode()) {
365 emit noMoreWidgets(aPreviosAttributeID);
370 bool XGUI_PropertyPanel::setActiveWidget(ModuleBase_ModelWidget* theWidget)
372 // Avoid activation of already actve widget. It could happen on focusIn event many times
373 if (theWidget == myActiveWidget) {
376 std::string aPreviosAttributeID;
378 aPreviosAttributeID = myActiveWidget->attributeID();
379 myActiveWidget->deactivate();
380 myActiveWidget->setHighlighted(false);
383 emit beforeWidgetActivated(theWidget);
384 theWidget->setHighlighted(true);
385 theWidget->activate();
387 myActiveWidget = theWidget;
391 void XGUI_PropertyPanel::setFocusOnOkButton()
393 QToolButton* anOkBtn = findChild<QToolButton*>(PROP_PANEL_OK);
394 ModuleBase_Tools::setFocus(anOkBtn, "XGUI_PropertyPanel::setFocusOnOkButton()");
397 void XGUI_PropertyPanel::setCancelEnabled(bool theEnabled)
399 QToolButton* anCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
400 anCancelBtn->setEnabled(theEnabled);
403 bool XGUI_PropertyPanel::isCancelEnabled() const
405 QToolButton* anCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
406 return anCancelBtn->isEnabled();
409 void XGUI_PropertyPanel::setEditingMode(bool isEditing)
411 ModuleBase_IPropertyPanel::setEditingMode(isEditing);
412 foreach(ModuleBase_ModelWidget* aWgt, myWidgets) {
413 aWgt->setEditingMode(isEditing);
417 void XGUI_PropertyPanel::setupActions(XGUI_ActionsMgr* theMgr)
419 QStringList aButtonNames;
420 aButtonNames << PROP_PANEL_OK << PROP_PANEL_CANCEL << PROP_PANEL_HELP;
421 QList<XGUI_ActionsMgr::OperationStateActionId> aActionIds;
422 aActionIds << XGUI_ActionsMgr::Accept << XGUI_ActionsMgr::Abort << XGUI_ActionsMgr::Help;
423 for (int i = 0; i < aButtonNames.size(); ++i) {
424 QToolButton* aBtn = findChild<QToolButton*>(aButtonNames.at(i));
425 QAction* anAct = theMgr->operationStateAction(aActionIds.at(i));
426 aBtn->setDefaultAction(anAct);
430 ModuleBase_ModelWidget* XGUI_PropertyPanel::preselectionWidget() const
432 return myPreselectionWidget;
435 void XGUI_PropertyPanel::setPreselectionWidget(ModuleBase_ModelWidget* theWidget)
437 myPreselectionWidget = theWidget;
441 void XGUI_PropertyPanel::closeEvent(QCloseEvent* theEvent)
443 ModuleBase_Operation* aOp = myOperationMgr->currentOperation();
445 if (myOperationMgr->abortAllOperations()) {
450 ModuleBase_IPropertyPanel::closeEvent(theEvent);