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(QObject*, QKeyEvent*)),
 125             this,    SIGNAL(keyReleased(QObject*, QKeyEvent*)));
 126     connect(aWidget, SIGNAL(enterClicked(QObject*)),
 127             this,    SIGNAL(enterClicked(QObject*)));
 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   // set focus to Ok/Cancel button in Property panel if there are no more active widgets
 213   // it should be performed before activateWidget(NULL) because it emits some signals which
 214   // can be processed by moudule for example as to activate another widget with setting focus
 215   QWidget* aNewFocusWidget = 0;
 216   QToolButton* anOkBtn = findChild<QToolButton*>(PROP_PANEL_OK);
 217   if (anOkBtn->isEnabled())
 218     aNewFocusWidget = anOkBtn;
 219   else {
 220     QToolButton* aCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
 221     if (aCancelBtn->isEnabled())
 222       aNewFocusWidget = aCancelBtn;
 223   }
 224   if (aNewFocusWidget)
 225     aNewFocusWidget->setFocus(Qt::TabFocusReason);
 226
 227   activateWidget(NULL);
 228 }
 229
 230 void findDirectChildren(QWidget* theParent, QList<QWidget*>& theWidgets, const bool theDebug)
 231 {
 232   QList<QWidget*> aWidgets;
 233
 234   if (theParent) {
 235     QLayout* aLayout = theParent->layout();
 236     if (aLayout) {
 237       for (int i = 0, aCount = aLayout->count(); i < aCount; i++) {
 238         QLayoutItem* anItem = aLayout->itemAt(i);
 239         QWidget* aWidget = anItem ? anItem->widget() : 0;
 240         if (aWidget) {
 241           if (aWidget->isVisible()) {
 242             if (aWidget->focusPolicy() != Qt::NoFocus)
 243               theWidgets.append(aWidget);
 244             findDirectChildren(aWidget, theWidgets, false);
 245           }
 246         }
 247         else if (anItem->layout()) {
 248           QLayout* aLayout = anItem->layout();
 249           for (int i = 0, aCount = aLayout->count(); i < aCount; i++) {
 250             QLayoutItem* anItem = aLayout->itemAt(i);
 251             QWidget* aWidget = anItem ? anItem->widget() : 0;
 252             if (aWidget) {
 253               if (aWidget->isVisible()) {
 254                 if (aWidget->focusPolicy() != Qt::NoFocus)
 255                   theWidgets.append(aWidget);
 256                 findDirectChildren(aWidget, theWidgets, false);
 257               }
 258             }
 259             else {
 260               // TODO: improve recursive search for the case when here QLayout is used
 261               // currently, the switch widget uses only 1 level of qlayout in qlayout using for
 262               // example for construction plane feature. If there are more levels,
 263               // it should be implemented here
 264             }
 265           }
 266         }
 267       }
 268     }
 269   }
 270 #ifdef DEBUG_TAB_WIDGETS
 271   if (theDebug) {
 272     QStringList aWidgetTypes;
 273     QList<QWidget*>::const_iterator anIt =  theWidgets.begin(), aLast = theWidgets.end();
 274     for (; anIt != aLast; anIt++) {
 275       QWidget* aWidget = *anIt;
 276       if (aWidget)
 277         aWidgetTypes.append(aWidget->objectName());
 278     }
 279     QString anInfo = QString("theWidgets[%1]: %2").arg(theWidgets.count()).arg(aWidgetTypes.join(","));
 280     qDebug(anInfo.toStdString().c_str());
 281   }
 282 #endif
 283 }
 284
 285 bool XGUI_PropertyPanel::focusNextPrevChild(bool theIsNext)
 286 {
 287   // it wraps the Tabs clicking to follow in the chain:
 288   // controls, last control, Apply, Cancel, first control, controls
 289   bool isChangedFocus = false;
 290
 291   QWidget* aFocusWidget = focusWidget();
 292 #ifdef DEBUG_TAB_WIDGETS
 293   if (aFocusWidget) {
 294     QString anInfo = QString("focus Widget: %1").arg(aFocusWidget->objectName());
 295     qDebug(anInfo.toStdString().c_str());
 296   }
 297 #endif
 298
 299   QWidget* aNewFocusWidget = 0;
 300   if (aFocusWidget) {
 301     QList<QWidget*> aChildren;
 302     findDirectChildren(this, aChildren, true);
 303     int aChildrenCount = aChildren.count();
 304     int aFocusWidgetIndex = aChildren.indexOf(aFocusWidget);
 305     if (aFocusWidgetIndex >= 0) {
 306       if (theIsNext) {
 307         if (aFocusWidgetIndex == aChildrenCount-1) {
 308           // after the last widget focus should be set to "Apply"
 309           QToolButton* anOkBtn = findChild<QToolButton*>(PROP_PANEL_OK);
 310           if (anOkBtn->isEnabled())
 311             aNewFocusWidget = anOkBtn;
 312           else {
 313             QToolButton* aCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
 314             if (aCancelBtn->isEnabled())
 315               aNewFocusWidget = aCancelBtn;
 316           }
 317         }
 318         else {
 319           aNewFocusWidget = aChildren[aFocusWidgetIndex+1];
 320         }
 321       }
 322       else {
 323         if (aFocusWidgetIndex == 0) {
 324           // before the first widget, the last should accept focus
 325           aNewFocusWidget = aChildren[aChildrenCount - 1];
 326         }
 327         else {
 328           // before the "Apply" button, the last should accept focus for consistency with "Next"
 329           QToolButton* anOkBtn = findChild<QToolButton*>(PROP_PANEL_OK);
 330           if (aFocusWidget == anOkBtn) {
 331             aNewFocusWidget = aChildren[aChildrenCount - 1];
 332           }
 333           else {
 334             aNewFocusWidget = aChildren[aFocusWidgetIndex-1];
 335           }
 336         }
 337       }
 338     }
 339   }
 340   if (aNewFocusWidget) {
 341     if (myActiveWidget) {
 342       myActiveWidget->getControls();
 343       bool isFirstControl = !theIsNext;
 344       QWidget* aLastFocusControl = myActiveWidget->getControlAcceptingFocus(isFirstControl);
 345       if (aFocusWidget == aLastFocusControl) {
 346         setActiveWidget(NULL);
 347       }
 348     }
 349
 350     //ModuleBase_Tools::setFocus(aNewFocusWidget, "XGUI_PropertyPanel::focusNextPrevChild()");
 351     aNewFocusWidget->setFocus(theIsNext ? Qt::TabFocusReason : Qt::BacktabFocusReason);
 352     isChangedFocus = true;
 353   }
 354   return isChangedFocus;
 355 }
 356
 357 void XGUI_PropertyPanel::activateNextWidget()
 358 {
 359   activateNextWidget(myActiveWidget);
 360 }
 361
 362 void XGUI_PropertyPanel::activateWidget(ModuleBase_ModelWidget* theWidget, const bool theEmitSignal)
 363 {
 364   std::string aPreviosAttributeID;
 365   if(myActiveWidget)
 366     aPreviosAttributeID = myActiveWidget->attributeID();
 367
 368   // Avoid activation of already actve widget. It could happen on focusIn event many times
 369   if (setActiveWidget(theWidget) && theEmitSignal) {
 370     emit widgetActivated(myActiveWidget);
 371     if (!myActiveWidget && !isEditingMode()) {
 372       emit noMoreWidgets(aPreviosAttributeID);
 373     }
 374   }
 375 }
 376
 377 bool XGUI_PropertyPanel::setActiveWidget(ModuleBase_ModelWidget* theWidget)
 378 {
 379   // Avoid activation of already actve widget. It could happen on focusIn event many times
 380   if (theWidget == myActiveWidget) {
 381     return false;
 382   }
 383   std::string aPreviosAttributeID;
 384   if(myActiveWidget) {
 385     aPreviosAttributeID = myActiveWidget->attributeID();
 386     myActiveWidget->deactivate();
 387     myActiveWidget->setHighlighted(false);
 388   }
 389   if(theWidget) {
 390     emit beforeWidgetActivated(theWidget);
 391     theWidget->setHighlighted(true);
 392     theWidget->activate();
 393   }
 394   myActiveWidget = theWidget;
 395   return true;
 396 }
 397
 398 void XGUI_PropertyPanel::setFocusOnOkButton()
 399 {
 400   QToolButton* anOkBtn = findChild<QToolButton*>(PROP_PANEL_OK);
 401   ModuleBase_Tools::setFocus(anOkBtn, "XGUI_PropertyPanel::setFocusOnOkButton()");
 402 }
 403
 404 void XGUI_PropertyPanel::setCancelEnabled(bool theEnabled)
 405 {
 406   QToolButton* anCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
 407   anCancelBtn->setEnabled(theEnabled);
 408 }
 409
 410 bool XGUI_PropertyPanel::isCancelEnabled() const
 411 {
 412   QToolButton* anCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
 413   return anCancelBtn->isEnabled();
 414 }
 415
 416 void XGUI_PropertyPanel::setEditingMode(bool isEditing)
 417 {
 418   ModuleBase_IPropertyPanel::setEditingMode(isEditing);
 419   foreach(ModuleBase_ModelWidget* aWgt, myWidgets) {
 420     aWgt->setEditingMode(isEditing);
 421   }
 422 }
 423
 424 void XGUI_PropertyPanel::setupActions(XGUI_ActionsMgr* theMgr)
 425 {
 426   QStringList aButtonNames;
 427   aButtonNames << PROP_PANEL_OK << PROP_PANEL_CANCEL << PROP_PANEL_HELP;
 428   QList<XGUI_ActionsMgr::OperationStateActionId> aActionIds;
 429   aActionIds << XGUI_ActionsMgr::Accept << XGUI_ActionsMgr::Abort << XGUI_ActionsMgr::Help;
 430   for (int i = 0; i < aButtonNames.size(); ++i) {
 431     QToolButton* aBtn = findChild<QToolButton*>(aButtonNames.at(i));
 432     QAction* anAct = theMgr->operationStateAction(aActionIds.at(i));
 433     aBtn->setDefaultAction(anAct);
 434   }
 435 }
 436
 437 ModuleBase_ModelWidget* XGUI_PropertyPanel::preselectionWidget() const
 438 {
 439   return myPreselectionWidget;
 440 }
 441
 442 void XGUI_PropertyPanel::setPreselectionWidget(ModuleBase_ModelWidget* theWidget)
 443 {
 444   myPreselectionWidget = theWidget;
 445 }
 446
 447
 448 void XGUI_PropertyPanel::closeEvent(QCloseEvent* theEvent)
 449 {
 450   ModuleBase_Operation* aOp = myOperationMgr->currentOperation();
 451   if (aOp) {
 452     if (myOperationMgr->canStopOperation(aOp)) {
 453       myOperationMgr->abortOperation(aOp);
 454       if (myOperationMgr->hasOperation())
 455         theEvent->ignore();
 456       else
 457         theEvent->accept();
 458     } else
 459       theEvent->ignore();
 460   } else
 461     ModuleBase_IPropertyPanel::closeEvent(theEvent);
 462 }