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 XGUI_PropertyPanel::XGUI_PropertyPanel(QWidget* theParent, XGUI_OperationMgr* theMgr)
  39     : ModuleBase_IPropertyPanel(theParent),
  40     myActiveWidget(NULL),
  41     myPreselectionWidget(NULL),
  42     myPanelPage(NULL),
  43     myOperationMgr(theMgr)
  44 {
  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 }");
  49
  50   QWidget* aContent = new QWidget(this);
  51   QGridLayout* aMainLayout = new QGridLayout(aContent);
  52   const int kPanelColumn = 0;
  53   int aPanelRow = 0;
  54   aMainLayout->setContentsMargins(3, 3, 3, 3);
  55   this->setWidget(aContent);
  56
  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);
  63
  64   myHeaderWidget = aFrm;
  65
  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);
  75   }
  76   aBtnLay->insertStretch(1, 1);
  77
  78   myPanelPage = new ModuleBase_PageWidget(aContent);
  79   myPanelPage->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::MinimumExpanding);
  80   aMainLayout->addWidget(myPanelPage, aPanelRow, kPanelColumn);
  81 }
  82
  83 XGUI_PropertyPanel::~XGUI_PropertyPanel()
  84 {
  85 }
  86
  87 void XGUI_PropertyPanel::cleanContent()
  88 {
  89   if (myActiveWidget)
  90     myActiveWidget->deactivate();
  91
  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;
 102     if (aWidget) {
 103       aWidget->blockSignals(true);
 104     }
 105   }
 106
 107   myWidgets.clear();
 108   myPanelPage->clearPage();
 109   myActiveWidget = NULL;
 110   setWindowTitle(tr("Property Panel"));
 111 }
 112
 113 void XGUI_PropertyPanel::setModelWidgets(const QList<ModuleBase_ModelWidget*>& theWidgets)
 114 {
 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()));
 126
 127   }
 128 }
 129
 130 const QList<ModuleBase_ModelWidget*>& XGUI_PropertyPanel::modelWidgets() const
 131 {
 132   return myWidgets;
 133 }
 134
 135 ModuleBase_PageBase* XGUI_PropertyPanel::contentWidget()
 136 {
 137   return static_cast<ModuleBase_PageBase*>(myPanelPage);
 138 }
 139
 140 void XGUI_PropertyPanel::updateContentWidget(FeaturePtr theFeature)
 141 {
 142   // Invalid feature case on abort of the operation
 143   if (theFeature.get() == NULL)
 144     return;
 145   if (theFeature->isAction() || !theFeature->data())
 146     return;
 147   foreach(ModuleBase_ModelWidget* eachWidget, myWidgets) {
 148     if (!eachWidget->feature().get())
 149       eachWidget->setFeature(theFeature);
 150     eachWidget->restoreValue();
 151   }
 152   // the repaint is used here to immediately react in GUI to the values change.
 153   repaint();
 154 }
 155
 156 void XGUI_PropertyPanel::activateNextWidget(ModuleBase_ModelWidget* theWidget)
 157 {
 158   // TO CHECK: Editing operation does not have automatical activation of widgets
 159   if (isEditingMode()) {
 160     activateWidget(NULL);
 161     return;
 162   }
 163   ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
 164
 165   QList<ModuleBase_ModelWidget*>::const_iterator anIt = myWidgets.begin(), aLast = myWidgets.end();
 166   bool isFoundWidget = false;
 167   activateWindow();
 168   for (; anIt != aLast; anIt++) {
 169     ModuleBase_ModelWidget* aCurrentWidget = *anIt;
 170     if (isFoundWidget || !theWidget) {
 171
 172       if (!aValidators->isCase(aCurrentWidget->feature(), aCurrentWidget->attributeID()))
 173         continue; // this attribute is not participated in the current case
 174
 175       if (aCurrentWidget->focusTo()) {
 176         return;
 177       }
 178     }
 179     isFoundWidget = isFoundWidget || (*anIt) == theWidget;
 180   }
 181   activateWidget(NULL);
 182 }
 183
 184 bool XGUI_PropertyPanel::focusNextPrevChild(bool theIsNext)
 185 {
 186   // it wraps the Tabs clicking to follow in the chain:
 187   // controls, last control, Apply, Cancel, first control, controls
 188
 189   bool isChangedFocus = false;
 190   if (theIsNext) { // forward by Tab
 191     QToolButton* aCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
 192     if (aCancelBtn->hasFocus()) {
 193       // after cancel, the first control should be focused
 194       QWidget* aFirstControl = 0;
 195       for (int i = 0, aSize = myWidgets.size(); i < aSize && !aFirstControl; i++)
 196         aFirstControl = myWidgets[i]->getControlAcceptingFocus(true);
 197       if (aFirstControl)
 198         aFirstControl->setFocus();
 199         isChangedFocus = true;
 200     }
 201     else {
 202       // after the last control, the Apply button should be focused
 203       QWidget* aLastControl = 0;
 204       for (int i = myWidgets.size()-1; i >= 0 && !aLastControl; i--)
 205         aLastControl = myWidgets[i]->getControlAcceptingFocus(false);
 206       if (aLastControl && aLastControl->hasFocus()) {
 207         setFocusOnOkButton();
 208         isChangedFocus = true;
 209       }
 210     }
 211   }
 212   else { // backward by SHIFT + Tab
 213     QToolButton* anOkBtn = findChild<QToolButton*>(PROP_PANEL_OK);
 214     if (anOkBtn->hasFocus()) {
 215       // after Apply, the last control should be focused
 216       QWidget* aLastControl = 0;
 217       for (int i = myWidgets.size()-1; i >= 0 && !aLastControl; i--)
 218         aLastControl = myWidgets[i]->getControlAcceptingFocus(false);
 219       if (aLastControl)
 220         aLastControl->setFocus();
 221         isChangedFocus = true;
 222     }
 223     else {
 224       // after the first control, the Cancel button should be focused
 225       QWidget* aFirstControl = 0;
 226       for (int i = 0, aSize = myWidgets.size(); i < aSize && !aFirstControl; i++)
 227         aFirstControl = myWidgets[i]->getControlAcceptingFocus(true);
 228       if (aFirstControl && aFirstControl->hasFocus()) {
 229         QToolButton* aCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
 230         aCancelBtn->setFocus();
 231         isChangedFocus = true;
 232       }
 233     }
 234   }
 235
 236   if (!isChangedFocus)
 237     isChangedFocus = ModuleBase_IPropertyPanel::focusNextPrevChild(theIsNext);
 238
 239   return isChangedFocus;
 240 }
 241
 242 void XGUI_PropertyPanel::activateNextWidget()
 243 {
 244   activateNextWidget(myActiveWidget);
 245 }
 246
 247 void XGUI_PropertyPanel::activateWidget(ModuleBase_ModelWidget* theWidget)
 248 {
 249   std::string aPreviosAttributeID;
 250   if(myActiveWidget)
 251     aPreviosAttributeID = myActiveWidget->attributeID();
 252
 253   // Avoid activation of already actve widget. It could happen on focusIn event many times
 254   if (setActiveWidget(theWidget)) {
 255     emit widgetActivated(myActiveWidget);
 256     if (!myActiveWidget && !isEditingMode()) {
 257       emit noMoreWidgets(aPreviosAttributeID);
 258     }
 259   }
 260 }
 261
 262 bool XGUI_PropertyPanel::setActiveWidget(ModuleBase_ModelWidget* theWidget)
 263 {
 264   // Avoid activation of already actve widget. It could happen on focusIn event many times
 265   if (theWidget == myActiveWidget) {
 266     return false;
 267   }
 268   std::string aPreviosAttributeID;
 269   if(myActiveWidget) {
 270     aPreviosAttributeID = myActiveWidget->attributeID();
 271     myActiveWidget->deactivate();
 272     myActiveWidget->setHighlighted(false);
 273   }
 274   if(theWidget) {
 275     emit beforeWidgetActivated(theWidget);
 276     theWidget->setHighlighted(true);
 277     theWidget->activate();
 278   }
 279   myActiveWidget = theWidget;
 280   return true;
 281 }
 282
 283 void XGUI_PropertyPanel::setFocusOnOkButton()
 284 {
 285   QToolButton* anOkBtn = findChild<QToolButton*>(PROP_PANEL_OK);
 286   anOkBtn->setFocus();
 287 }
 288
 289 void XGUI_PropertyPanel::setCancelEnabled(bool theEnabled)
 290 {
 291   QToolButton* anCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
 292   anCancelBtn->setEnabled(theEnabled);
 293 }
 294
 295 bool XGUI_PropertyPanel::isCancelEnabled() const
 296 {
 297   QToolButton* anCancelBtn = findChild<QToolButton*>(PROP_PANEL_CANCEL);
 298   return anCancelBtn->isEnabled();
 299 }
 300
 301 void XGUI_PropertyPanel::setEditingMode(bool isEditing)
 302 {
 303   ModuleBase_IPropertyPanel::setEditingMode(isEditing);
 304   foreach(ModuleBase_ModelWidget* aWgt, myWidgets) {
 305     aWgt->setEditingMode(isEditing);
 306   }
 307 }
 308
 309 void XGUI_PropertyPanel::setupActions(XGUI_ActionsMgr* theMgr)
 310 {
 311   QStringList aButtonNames;
 312   aButtonNames << PROP_PANEL_OK << PROP_PANEL_CANCEL << PROP_PANEL_HELP;
 313   QList<XGUI_ActionsMgr::OperationStateActionId> aActionIds;
 314   aActionIds << XGUI_ActionsMgr::Accept << XGUI_ActionsMgr::Abort << XGUI_ActionsMgr::Help;
 315   for (int i = 0; i < aButtonNames.size(); ++i) {
 316     QToolButton* aBtn = findChild<QToolButton*>(aButtonNames.at(i));
 317     QAction* anAct = theMgr->operationStateAction(aActionIds.at(i));
 318     aBtn->setDefaultAction(anAct);
 319   }
 320 }
 321
 322 ModuleBase_ModelWidget* XGUI_PropertyPanel::preselectionWidget() const
 323 {
 324   return myPreselectionWidget;
 325 }
 326
 327 void XGUI_PropertyPanel::setPreselectionWidget(ModuleBase_ModelWidget* theWidget)
 328 {
 329   myPreselectionWidget = theWidget;
 330 }
 331
 332
 333 void XGUI_PropertyPanel::closeEvent(QCloseEvent* theEvent)
 334 {
 335   ModuleBase_Operation* aOp = myOperationMgr->currentOperation();
 336   if (aOp) {
 337     if (myOperationMgr->canStopOperation(aOp)) {
 338       myOperationMgr->abortAllOperations();
 339       theEvent->accept();
 340     } else
 341       theEvent->ignore();
 342   } else
 343     ModuleBase_IPropertyPanel::closeEvent(theEvent);
 344 }