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 #include <ModuleBase_WidgetFactory.h>
  19 #include <ModuleBase_OperationDescription.h>
  20 #include <ModuleBase_Events.h>
  21
  22 #include <Events_Loop.h>
  23
  24 #include <ModelAPI_Session.h>
  25 #include <ModelAPI_Validator.h>
  26
  27 #include <QEvent>
  28 #include <QFrame>
  29 #include <QIcon>
  30 #include <QKeyEvent>
  31 #include <QLayoutItem>
  32 #include <QToolButton>
  33 #include <QVBoxLayout>
  34 #include <QGridLayout>
  35 #include <QWidget>
  36 #include <QToolButton>
  37 #include <QAction>
  38
  39 #ifdef _DEBUG
  40 #include <iostream>
  41 #endif
  42
  43 //#define DEBUG_TAB_WIDGETS
  44
  45 XGUI_PropertyPanel::XGUI_PropertyPanel(QWidget* theParent, XGUI_OperationMgr* theMgr)
  46     : ModuleBase_IPropertyPanel(theParent),
  47     myActiveWidget(NULL),
  48     myPreselectionWidget(NULL),
  49     myPanelPage(NULL),
  50     myOperationMgr(theMgr)
  51 {
  52   setWindowTitle(tr("Property Panel"));
  53   QAction* aViewAct = toggleViewAction();
  54   setObjectName(PROP_PANEL);
  55   setStyleSheet("::title { position: relative; padding-left: 5px; text-align: left center }");
  56
  57   QWidget* aContent = new QWidget(this);
  58   QGridLayout* aMainLayout = new QGridLayout(aContent);
  59   const int kPanelColumn = 0;
  60   int aPanelRow = 0;
  61   aMainLayout->setContentsMargins(3, 3, 3, 3);
  62   setWidget(aContent);
  63
  64   QFrame* aFrm = new QFrame(aContent);
  65   aFrm->setFrameStyle(QFrame::Raised);
  66   aFrm->setFrameShape(QFrame::Panel);
  67   QHBoxLayout* aBtnLay = new QHBoxLayout(aFrm);
  68   ModuleBase_Tools::zeroMargins(aBtnLay);
  69   aMainLayout->addWidget(aFrm, aPanelRow++, kPanelColumn);
  70
  71   myHeaderWidget = aFrm;
  72
  73   QStringList aBtnNames;
  74   aBtnNames << QString(PROP_PANEL_HELP)
  75             << QString(PROP_PANEL_OK)
  76             << QString(PROP_PANEL_CANCEL);
  77   foreach(QString eachBtnName, aBtnNames) {
  78     QToolButton* aBtn = new QToolButton(aFrm);
  79     aBtn->setObjectName(eachBtnName);
  80     aBtn->setAutoRaise(true);
  81     aBtnLay->addWidget(aBtn);
  82   }
  83   aBtnLay->insertStretch(1, 1);
  84
  85   myPanelPage = new ModuleBase_PageWidget(aContent);
  86   myPanelPage->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::MinimumExpanding);
  87   aMainLayout->addWidget(myPanelPage, aPanelRow, kPanelColumn);
  88
  89   // spit to make the preview button on the bottom of the panel
  90   aMainLayout->setRowStretch(aPanelRow++, 1);
  91
  92   // preview button on the bottom of panel
  93   aFrm = new QFrame(aContent);
  94   aBtnLay = new QHBoxLayout(aFrm);
  95   aBtnLay->addStretch(1);
  96   ModuleBase_Tools::zeroMargins(aBtnLay);
  97   aMainLayout->addWidget(aFrm, aPanelRow++, kPanelColumn);
  98
  99   QToolButton* aBtn = new QToolButton(aFrm);
 100   aBtn->setObjectName(PROP_PANEL_PREVIEW);
 101   aBtnLay->addWidget(aBtn);
 102 }
 103
 104 XGUI_PropertyPanel::~XGUI_PropertyPanel()
 105 {
 106 }
 107
 108 void XGUI_PropertyPanel::cleanContent()
 109 {
 110   if (myActiveWidget)
 111     myActiveWidget->deactivate();
 112
 113   /// as the widgets are deleted later, it is important that the signals
 114   /// of these widgets are not processed. An example of the error is issue 986.
 115   /// In the given case, the property panel is firstly filled by new widgets
 116   /// of restarted operation and after that the mouse release signal come from
 117   /// the widget of the previous operation (Point2d widget about mouse is released
 118   /// and focus is out of this widget)
 119   QList<ModuleBase_ModelWidget*>::const_iterator anIt = myWidgets.begin(),
 120                                                  aLast = myWidgets.end();
 121   for (; anIt != aLast; anIt++) {
 122     QWidget* aWidget = *anIt;
 123     if (aWidget) {
 124       aWidget->blockSignals(true);
 125     }
 126   }
 127
 128   myWidgets.clear();
 129   myPanelPage->clearPage();
 130   myActiveWidget = NULL;
 131
 132   findButton(PROP_PANEL_PREVIEW)->setVisible(false); /// by default it is hidden
 133   setWindowTitle(tr("Property Panel"));
 134 }
 135
 136 void XGUI_PropertyPanel::setModelWidgets(const QList<ModuleBase_ModelWidget*>& theWidgets)
 137 {
 138   myWidgets = theWidgets;
 139   if (theWidgets.empty()) return;
 140   foreach (ModuleBase_ModelWidget* aWidget, theWidgets) {
 141     connect(aWidget, SIGNAL(focusInWidget(ModuleBase_ModelWidget*)),
 142             this,    SLOT(onFocusInWidget(ModuleBase_ModelWidget*)));
 143     connect(aWidget, SIGNAL(focusOutWidget(ModuleBase_ModelWidget*)),
 144             this,    SLOT(onActivateNextWidget(ModuleBase_ModelWidget*)));
 145     connect(aWidget, SIGNAL(keyReleased(QObject*, QKeyEvent*)),
 146             this,    SIGNAL(keyReleased(QObject*, QKeyEvent*)));
 147     connect(aWidget, SIGNAL(enterClicked(QObject*)),
 148             this,    SIGNAL(enterClicked(QObject*)));
 149
 150   }
 151 }
 152
 153 const QList<ModuleBase_ModelWidget*>& XGUI_PropertyPanel::modelWidgets() const
 154 {
 155   return myWidgets;
 156 }
 157
 158 ModuleBase_PageBase* XGUI_PropertyPanel::contentWidget()
 159 {
 160   return static_cast<ModuleBase_PageBase*>(myPanelPage);
 161 }
 162
 163 void XGUI_PropertyPanel::updateContentWidget(FeaturePtr theFeature)
 164 {
 165   // Invalid feature case on abort of the operation
 166   if (theFeature.get() == NULL)
 167     return;
 168   if (theFeature->isAction() || !theFeature->data())
 169     return;
 170   foreach(ModuleBase_ModelWidget* eachWidget, myWidgets) {
 171     if (!eachWidget->feature().get())
 172       eachWidget->setFeature(theFeature);
 173     eachWidget->restoreValue();
 174   }
 175   // the repaint is used here to immediately react in GUI to the values change.
 176   repaint();
 177 }
 178
 179 void XGUI_PropertyPanel::createContentPanel(FeaturePtr theFeature)
 180 {
 181   // Invalid feature case on abort of the operation
 182   if (theFeature.get() == NULL)
 183     return;
 184   if (theFeature->isAction() || !theFeature->data())
 185     return;
 186
 187   if (myWidgets.empty()) {
 188     ModuleBase_Operation* anOperation = myOperationMgr->currentOperation();
 189     QString aXmlRepr = anOperation->getDescription()->xmlRepresentation();
 190
 191     ModuleBase_WidgetFactory aFactory(aXmlRepr.toStdString(), myOperationMgr->workshop());
 192     aFactory.createPanel(contentWidget(), theFeature);
 193     /// Apply button should be update if the feature was modified by the panel
 194     myOperationMgr->onValidateOperation();
 195   }
 196 }
 197
 198 void XGUI_PropertyPanel::activateNextWidget(ModuleBase_ModelWidget* theWidget)
 199 {
 200   // it is possible that the property panel widgets have not been visualized
 201   // (e.g. on start operation), so it is strictly important to do not check visualized state
 202   activateNextWidget(theWidget, false);
 203 }
 204
 205 void XGUI_PropertyPanel::onFocusInWidget(ModuleBase_ModelWidget* theWidget)
 206 {
 207   if (theWidget->canAcceptFocus())
 208     activateWidget(theWidget);
 209 }
 210
 211 void XGUI_PropertyPanel::onActivateNextWidget(ModuleBase_ModelWidget* theWidget)
 212 {
 213   // this slot happens when some widget lost focus, the next widget which accepts the focus
 214   // should be shown, so the second parameter is true
 215   // it is important for features where in cases the same attributes are used, isCase for this
 216   // attribute returns true, however it can be placed in hidden stack widget(extrusion: elements,
 217   // sketch multi rotation -> single/full point)
 218   // it is important to check the widget visibility to do not check of the next widget visible
 219   // state if the current is not shown. (example: sketch circle re-entrant operation after mouse
 220   // release in the viewer, next, radius,
 221   // widget should be activated but the first is not visualized)
 222   bool isVisible = theWidget->isVisible();
 223   activateNextWidget(theWidget, isVisible);
 224 }
 225
 226
 227 void XGUI_PropertyPanel::activateNextWidget(ModuleBase_ModelWidget* theWidget,
 228                                             const bool isCheckVisibility)
 229 {
 230   // TO CHECK: Editing operation does not have automatical activation of widgets
 231   if (isEditingMode()) {
 232     activateWidget(NULL);
 233     return;
 234   }
 235   ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
 236
 237   QList<ModuleBase_ModelWidget*>::const_iterator anIt = myWidgets.begin(), aLast = myWidgets.end();
 238   bool isFoundWidget = false;
 239   ModuleBase_Tools::activateWindow(this, "XGUI_PropertyPanel::activateNextWidget()");
 240   for (; anIt != aLast; anIt++) {
 241     ModuleBase_ModelWidget* aCurrentWidget = *anIt;
 242     if (isFoundWidget || !theWidget) {
 243
 244       if (!aValidators->isCase(aCurrentWidget->feature(), aCurrentWidget->attributeID()))
 245         continue; // this attribute does not participate in the current case
 246       if (isCheckVisibility && !aCurrentWidget->isInternal()) {
 247         if (!aCurrentWidget->isVisible())
 248           continue;
 249       }
 250       if (!aCurrentWidget->isObligatory())
 251         continue; // not obligatory widgets are not activated automatically
 252
 253       if (aCurrentWidget->focusTo()) {
 254         return;
 255       }
 256     }
 257     isFoundWidget = isFoundWidget || (*anIt) == theWidget;
 258   }
 259   // set focus to Ok/Cancel button in Property panel if there are no more active widgets
 260   // it should be performed before activateWidget(NULL) because it emits some signals which
 261   // can be processed by moudule for example as to activate another widget with setting focus
 262   QWidget* aNewFocusWidget = 0;
 263   QToolButton* anOkBtn = findButton(PROP_PANEL_OK);
 264   if (anOkBtn->isEnabled())
 265     aNewFocusWidget = anOkBtn;
 266   else {
 267     QToolButton* aCancelBtn = findButton(PROP_PANEL_CANCEL);
 268     if (aCancelBtn->isEnabled())
 269       aNewFocusWidget = aCancelBtn;
 270   }
 271   if (aNewFocusWidget)
 272     aNewFocusWidget->setFocus(Qt::TabFocusReason);
 273
 274   activateWidget(NULL);
 275 }
 276
 277 void findDirectChildren(QWidget* theParent, QList<QWidget*>& theWidgets, const bool theDebug)
 278 {
 279   QList<QWidget*> aWidgets;
 280
 281   if (theParent) {
 282     QLayout* aLayout = theParent->layout();
 283     if (aLayout) {
 284       for (int i = 0, aCount = aLayout->count(); i < aCount; i++) {
 285         QLayoutItem* anItem = aLayout->itemAt(i);
 286         QWidget* aWidget = anItem ? anItem->widget() : 0;
 287         if (aWidget) {
 288           if (aWidget->isVisible()) {
 289             if (aWidget->focusPolicy() != Qt::NoFocus)
 290               theWidgets.append(aWidget);
 291             findDirectChildren(aWidget, theWidgets, false);
 292           }
 293         }
 294         else if (anItem->layout()) {
 295           QLayout* aLayout = anItem->layout();
 296           for (int i = 0, aCount = aLayout->count(); i < aCount; i++) {
 297             QLayoutItem* anItem = aLayout->itemAt(i);
 298             QWidget* aWidget = anItem ? anItem->widget() : 0;
 299             if (aWidget) {
 300               if (aWidget->isVisible()) {
 301                 if (aWidget->focusPolicy() != Qt::NoFocus)
 302                   theWidgets.append(aWidget);
 303                 findDirectChildren(aWidget, theWidgets, false);
 304               }
 305             }
 306             else {
 307               // TODO: improve recursive search for the case when here QLayout is used
 308               // currently, the switch widget uses only 1 level of qlayout in qlayout using for
 309               // example for construction plane feature. If there are more levels,
 310               // it should be implemented here
 311             }
 312           }
 313         }
 314       }
 315     }
 316   }
 317 #ifdef DEBUG_TAB_WIDGETS
 318   if (theDebug) {
 319     QStringList aWidgetTypes;
 320     QList<QWidget*>::const_iterator anIt =  theWidgets.begin(), aLast = theWidgets.end();
 321     for (; anIt != aLast; anIt++) {
 322       QWidget* aWidget = *anIt;
 323       if (aWidget)
 324         aWidgetTypes.append(aWidget->objectName());
 325     }
 326     QString anInfo = QString("theWidgets[%1]: %2")
 327       .arg(theWidgets.count()).arg(aWidgetTypes.join(","));
 328     qDebug(anInfo.toStdString().c_str());
 329   }
 330 #endif
 331 }
 332
 333 bool XGUI_PropertyPanel::focusNextPrevChild(bool theIsNext)
 334 {
 335   // it wraps the Tabs clicking to follow in the chain:
 336   // controls, last control, Apply, Cancel, first control, controls
 337   bool isChangedFocus = false;
 338
 339   QWidget* aFocusWidget = focusWidget();
 340 #ifdef DEBUG_TAB_WIDGETS
 341   if (aFocusWidget) {
 342     QString anInfo = QString("focus Widget: %1").arg(aFocusWidget->objectName());
 343     qDebug(anInfo.toStdString().c_str());
 344   }
 345 #endif
 346
 347   QWidget* aNewFocusWidget = 0;
 348   if (aFocusWidget) {
 349     QList<QWidget*> aChildren;
 350     findDirectChildren(this, aChildren, true);
 351     int aChildrenCount = aChildren.count();
 352     int aFocusWidgetIndex = aChildren.indexOf(aFocusWidget);
 353     if (aFocusWidgetIndex >= 0) {
 354       if (theIsNext) {
 355         if (aFocusWidgetIndex == aChildrenCount-1) {
 356           // after the last widget focus should be set to "Apply"
 357           QToolButton* anOkBtn = findButton(PROP_PANEL_OK);
 358           if (anOkBtn->isEnabled())
 359             aNewFocusWidget = anOkBtn;
 360           else {
 361             QToolButton* aCancelBtn = findButton(PROP_PANEL_CANCEL);
 362             if (aCancelBtn->isEnabled())
 363               aNewFocusWidget = aCancelBtn;
 364           }
 365         }
 366         else {
 367           aNewFocusWidget = aChildren[aFocusWidgetIndex+1];
 368         }
 369       }
 370       else {
 371         if (aFocusWidgetIndex == 0) {
 372           // before the first widget, the last should accept focus
 373           aNewFocusWidget = aChildren[aChildrenCount - 1];
 374         }
 375         else {
 376           // before the "Apply" button, the last should accept focus for consistency with "Next"
 377           QToolButton* anOkBtn = findButton(PROP_PANEL_OK);
 378           if (aFocusWidget == anOkBtn) {
 379             aNewFocusWidget = aChildren[aChildrenCount - 1];
 380           }
 381           else {
 382             aNewFocusWidget = aChildren[aFocusWidgetIndex-1];
 383           }
 384         }
 385       }
 386     }
 387   }
 388   if (aNewFocusWidget) {
 389     if (myActiveWidget) {
 390       myActiveWidget->getControls();
 391       bool isFirstControl = !theIsNext;
 392       QWidget* aLastFocusControl = myActiveWidget->getControlAcceptingFocus(isFirstControl);
 393       if (aFocusWidget == aLastFocusControl) {
 394         setActiveWidget(NULL);
 395       }
 396     }
 397
 398     //ModuleBase_Tools::setFocus(aNewFocusWidget, "XGUI_PropertyPanel::focusNextPrevChild()");
 399     aNewFocusWidget->setFocus(theIsNext ? Qt::TabFocusReason : Qt::BacktabFocusReason);
 400     isChangedFocus = true;
 401   }
 402   return isChangedFocus;
 403 }
 404
 405 void XGUI_PropertyPanel::activateNextWidget()
 406 {
 407   activateNextWidget(myActiveWidget);
 408 }
 409
 410 void XGUI_PropertyPanel::activateWidget(ModuleBase_ModelWidget* theWidget, const bool theEmitSignal)
 411 {
 412   std::string aPreviosAttributeID;
 413   if(myActiveWidget)
 414     aPreviosAttributeID = myActiveWidget->attributeID();
 415
 416   // Avoid activation of already actve widget. It could happen on focusIn event many times
 417   if (setActiveWidget(theWidget) && theEmitSignal) {
 418     emit widgetActivated(myActiveWidget);
 419     if (!myActiveWidget && !isEditingMode()) {
 420       emit noMoreWidgets(aPreviosAttributeID);
 421     }
 422   }
 423 }
 424
 425 bool XGUI_PropertyPanel::setActiveWidget(ModuleBase_ModelWidget* theWidget)
 426 {
 427   // Avoid activation of already actve widget. It could happen on focusIn event many times
 428   if (theWidget == myActiveWidget) {
 429     return false;
 430   }
 431   std::string aPreviosAttributeID;
 432   if(myActiveWidget) {
 433     aPreviosAttributeID = myActiveWidget->attributeID();
 434     myActiveWidget->processValueState();
 435     myActiveWidget->deactivate();
 436     myActiveWidget->setHighlighted(false);
 437   }
 438   if(theWidget) {
 439     emit beforeWidgetActivated(theWidget);
 440     theWidget->setHighlighted(true);
 441     theWidget->activate();
 442   }
 443   myActiveWidget = theWidget;
 444   static Events_ID anEvent = Events_Loop::eventByName(EVENT_UPDATE_BY_WIDGET_SELECTION);
 445   Events_Loop::loop()->flush(anEvent);
 446
 447   return true;
 448 }
 449
 450 void XGUI_PropertyPanel::setFocusOnOkButton()
 451 {
 452   QToolButton* anOkBtn = findButton(PROP_PANEL_OK);
 453   ModuleBase_Tools::setFocus(anOkBtn, "XGUI_PropertyPanel::setFocusOnOkButton()");
 454 }
 455
 456 void XGUI_PropertyPanel::setCancelEnabled(bool theEnabled)
 457 {
 458   QToolButton* anCancelBtn = findButton(PROP_PANEL_CANCEL);
 459   anCancelBtn->setEnabled(theEnabled);
 460 }
 461
 462 bool XGUI_PropertyPanel::isCancelEnabled() const
 463 {
 464   QToolButton* anCancelBtn = findButton(PROP_PANEL_CANCEL);
 465   return anCancelBtn->isEnabled();
 466 }
 467
 468 void XGUI_PropertyPanel::setEditingMode(bool isEditing)
 469 {
 470   ModuleBase_IPropertyPanel::setEditingMode(isEditing);
 471   foreach(ModuleBase_ModelWidget* aWgt, myWidgets) {
 472     aWgt->setEditingMode(isEditing);
 473   }
 474 }
 475
 476 void XGUI_PropertyPanel::setupActions(XGUI_ActionsMgr* theMgr)
 477 {
 478   QStringList aButtonNames;
 479   aButtonNames << PROP_PANEL_OK << PROP_PANEL_CANCEL << PROP_PANEL_HELP << PROP_PANEL_PREVIEW;
 480   QList<XGUI_ActionsMgr::OperationStateActionId> aActionIds;
 481   aActionIds << XGUI_ActionsMgr::Accept << XGUI_ActionsMgr::Abort << XGUI_ActionsMgr::Help
 482              << XGUI_ActionsMgr::Preview;
 483   for (int i = 0; i < aButtonNames.size(); ++i) {
 484     QToolButton* aBtn = findButton(aButtonNames.at(i).toStdString().c_str());
 485     QAction* anAct = theMgr->operationStateAction(aActionIds.at(i));
 486     aBtn->setDefaultAction(anAct);
 487   }
 488 }
 489
 490 ModuleBase_ModelWidget* XGUI_PropertyPanel::preselectionWidget() const
 491 {
 492   return myPreselectionWidget;
 493 }
 494
 495 void XGUI_PropertyPanel::setPreselectionWidget(ModuleBase_ModelWidget* theWidget)
 496 {
 497   myPreselectionWidget = theWidget;
 498 }
 499
 500
 501 void XGUI_PropertyPanel::closeEvent(QCloseEvent* theEvent)
 502 {
 503   ModuleBase_Operation* aOp = myOperationMgr->currentOperation();
 504   if (aOp) {
 505     if (myOperationMgr->canStopOperation(aOp)) {
 506       myOperationMgr->abortOperation(aOp);
 507       if (myOperationMgr->hasOperation())
 508         theEvent->ignore();
 509       else
 510         theEvent->accept();
 511     } else
 512       theEvent->ignore();
 513   } else
 514     ModuleBase_IPropertyPanel::closeEvent(theEvent);
 515 }
 516
 517 QToolButton* XGUI_PropertyPanel::findButton(const char* theInternalName) const
 518 {
 519   return findChild<QToolButton*>(theInternalName);
 520 }