src/XGUI/XGUI_ActionsMgr.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 #ifndef HAVE_SALOME
   4 #include <AppElements_Command.h>
   5 #endif
   6
   7 #include <XGUI_ActionsMgr.h>
   8 #include <XGUI_Workshop.h>
   9 #include <XGUI_OperationMgr.h>
  10 #include <XGUI_SalomeConnector.h>
  11 #include <XGUI_Selection.h>
  12 #include <XGUI_SelectionMgr.h>
  13
  14 #include <Events_Loop.h>
  15 #include <Events_InfoMessage.h>
  16
  17 #include <ModelAPI_Session.h>
  18 #include <ModelAPI_Events.h>
  19 #include <ModelAPI_Validator.h>
  20 #include <ModuleBase_Operation.h>
  21 #include <ModuleBase_OperationFeature.h>
  22 #include <ModuleBase_SelectionValidator.h>
  23 #include <ModuleBase_Tools.h>
  24
  25
  26 #include <QAction>
  27 #include <QMainWindow>
  28
  29 #ifdef _DEBUG
  30 #include <iostream>
  31 #include <QDebug>
  32 #endif
  33
  34 XGUI_ActionsMgr::XGUI_ActionsMgr(XGUI_Workshop* theParent)
  35     : QObject(theParent),
  36       myWorkshop(theParent),
  37       myOperationMgr(theParent->operationMgr())
  38 {
  39   // Default shortcuts
  40   myShortcuts << QKeySequence::Save;
  41   myShortcuts << QKeySequence::Undo;
  42   myShortcuts << QKeySequence::Redo;
  43   myShortcuts << QKeySequence::Open;
  44   myShortcuts << QKeySequence::Close;
  45
  46   //Initialize event listening
  47   Events_Loop* aLoop = Events_Loop::loop();
  48   static Events_ID aStateResponseEventId =
  49       Events_Loop::loop()->eventByName(EVENT_FEATURE_STATE_RESPONSE);
  50   aLoop->registerListener(this, aStateResponseEventId, NULL, true);
  51 }
  52
  53 XGUI_ActionsMgr::~XGUI_ActionsMgr()
  54 {
  55 }
  56
  57 void XGUI_ActionsMgr::addCommand(QAction* theCmd)
  58 {
  59   QString aId = theCmd->data().toString();
  60   if (aId.isEmpty()) {
  61     return;
  62   }
  63   myActions.insert(aId, theCmd);
  64 #ifdef HAVE_SALOME
  65     XGUI_Workshop* aWorkshop = static_cast<XGUI_Workshop*>(parent());
  66     const std::shared_ptr<Config_FeatureMessage>& anInfo =
  67                          aWorkshop->salomeConnector()->featureInfo(aId);
  68     if (anInfo.get())
  69       myNestedActions[aId] = QString::fromStdString(anInfo->nestedFeatures())
  70                                    .split(" ", QString::SkipEmptyParts);
  71 #else
  72   AppElements_Command* aXCmd = dynamic_cast<AppElements_Command*>(theCmd);
  73   myNestedActions[aId] = aXCmd->nestedCommands();
  74 #endif
  75 }
  76
  77 void XGUI_ActionsMgr::addNestedCommands(const QString& theId, const QStringList& theCommands)
  78 {
  79   myNestedActions[theId] = theCommands;
  80 }
  81
  82 QStringList XGUI_ActionsMgr::nestedCommands(const QString& theId) const
  83 {
  84   if (myNestedActions.contains(theId))
  85     return myNestedActions[theId];
  86   return QStringList();
  87 }
  88
  89 bool XGUI_ActionsMgr::isNested(const QString& theId) const
  90 {
  91   foreach(QString aId, myNestedActions.keys())
  92   {
  93     QStringList aList = myNestedActions[aId];
  94     if (aList.contains(theId))
  95       return true;
  96   }
  97   return false;
  98 }
  99
 100 void XGUI_ActionsMgr::updateCommandsStatus()
 101 {
 102   setAllEnabled();
 103   XGUI_Selection* aSelection = myWorkshop->selector()->selection();
 104   if (aSelection->getSelected(ModuleBase_ISelection::Viewer).size() > 0)
 105     updateOnViewSelection();
 106
 107   FeaturePtr anActiveFeature = FeaturePtr();
 108   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
 109                                                          (myOperationMgr->currentOperation());
 110   if (aFOperation) {
 111     anActiveFeature = aFOperation->feature();
 112     QStringList aNested = allNestedCommands(aFOperation);
 113     foreach(QString aAction, myActions.keys()) {
 114       if (!aNested.contains(aAction))
 115         setActionEnabled(aAction, false);
 116     }
 117   } else
 118     setNestedCommandsEnabled(false);
 119
 120   updateByPlugins(anActiveFeature);
 121   updateByDocumentKind();
 122   updateCheckState();
 123 }
 124
 125 void XGUI_ActionsMgr::updateCheckState()
 126 {
 127   QString eachCommand = QString();
 128   foreach(eachCommand, myActions.keys()) {
 129     setActionChecked(eachCommand, false);
 130   }
 131   QStringList ltActiveCommands = myOperationMgr->operationList();
 132   foreach(eachCommand, ltActiveCommands) {
 133     setActionChecked(eachCommand, true);
 134   }
 135 }
 136
 137 void XGUI_ActionsMgr::updateOnViewSelection()
 138 {
 139   if (!myOperationMgr->hasOperation())
 140     return;
 141
 142   QStringList aIdList = myOperationMgr->operationList();
 143   //ModuleBase_Operation* anOperation = myOperationMgr->currentOperation();
 144   //FeaturePtr anActiveFeature = anOperation->feature();
 145   //if(!anActiveFeature.get())
 146   if (aIdList.isEmpty())
 147     return;
 148
 149   ModuleBase_Operation* theOperation = myOperationMgr->currentOperation();
 150   //QString aFeatureId = QString::fromStdString(anActiveFeature->getKind());
 151   XGUI_Selection* aSelection = myWorkshop->selector()->selection();
 152   // only viewer selection is processed
 153   SessionPtr aMgr = ModelAPI_Session::get();
 154   ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
 155   foreach(QString aFeatureId, aIdList) {
 156     foreach(QString aId, nestedCommands(aFeatureId)) {
 157       ModelAPI_ValidatorsFactory::Validators aValidators;
 158       aFactory->validators(aId.toStdString(), aValidators);
 159       ModelAPI_ValidatorsFactory::Validators::iterator aValidatorIt = aValidators.begin();
 160       for (; aValidatorIt != aValidators.end(); ++aValidatorIt) {
 161         const ModuleBase_SelectionValidator* aSelValidator =
 162             dynamic_cast<const ModuleBase_SelectionValidator*>(aFactory->validator(aValidatorIt->first));
 163         if (aSelValidator)
 164           setActionEnabled(aId, aSelValidator->isValid(aSelection, theOperation));
 165       }
 166     }
 167   }
 168 }
 169
 170 QKeySequence XGUI_ActionsMgr::registerShortcut(const QKeySequence& theKeySequence)
 171 {
 172   if (theKeySequence.isEmpty()) {
 173     return QKeySequence();
 174   }
 175   if (myShortcuts.contains(theKeySequence)) {
 176     QString aMessage = tr("Shortcut %1 is already defined. Ignore.");
 177     aMessage = aMessage.arg(theKeySequence.toString());
 178     Events_InfoMessage("XGUI_ActionsMgr", aMessage.toStdString()).send();
 179     return QKeySequence();
 180   }
 181   myShortcuts.append(theKeySequence);
 182   return theKeySequence;
 183 }
 184
 185 QKeySequence XGUI_ActionsMgr::registerShortcut(const QString& theKeySequence)
 186 {
 187   if (theKeySequence.isEmpty()) {
 188     return QKeySequence();
 189   }
 190   QKeySequence aResult(theKeySequence);
 191   registerShortcut(aResult);
 192   return aResult;
 193 }
 194
 195 void XGUI_ActionsMgr::processEvent(const std::shared_ptr<Events_Message>& theMessage)
 196 {
 197   const Events_ID kResponseEvent =
 198       Events_Loop::loop()->eventByName(EVENT_FEATURE_STATE_RESPONSE);
 199   if (theMessage->eventID() == kResponseEvent) {
 200     std::shared_ptr<ModelAPI_FeatureStateMessage> aStateMessage =
 201         std::dynamic_pointer_cast<ModelAPI_FeatureStateMessage>(theMessage);
 202     if (!aStateMessage.get())
 203       return;
 204     std::list<std::string> aFeaturesList = aStateMessage->features();
 205     std::list<std::string>::iterator it = aFeaturesList.begin();
 206     for( ; it != aFeaturesList.end(); ++it) {
 207       QString anActionId = QString::fromStdString(*it);
 208       bool theDefaultState = false;
 209       if (myActions.contains(anActionId)) {
 210         theDefaultState = myActions[anActionId]->isEnabled();
 211       }
 212       setActionEnabled(anActionId, aStateMessage->state(*it, theDefaultState));
 213     }
 214   } else if (theMessage.get()) {
 215     #ifdef _DEBUG
 216     std::cout << "XGUI_ActionsMgr::processEvent: unhandled message caught: " << std::endl
 217               << theMessage->eventID().eventText() << std::endl;
 218     #endif
 219   }
 220 }
 221
 222 QAction* XGUI_ActionsMgr::operationStateAction(OperationStateActionId theId)
 223 {
 224   QAction* aResult = NULL;
 225   if (myOperationActions.contains(theId)) {
 226     aResult = myOperationActions.value(theId);
 227     //if (theParent && aResult->parent() != theParent) {
 228     //  aResult->setParent(theParent);
 229     //}
 230   } else {
 231     QWidget* aParent = myWorkshop->desktop();
 232     switch (theId) {
 233       case Accept:
 234       case AcceptAll: {
 235         aResult = ModuleBase_Tools::createAction(QIcon(":pictures/button_ok.png"),
 236                             "Apply" /*empty to show error*/, aParent);
 237       }
 238       break;
 239       case Abort:
 240       case AbortAll: {
 241         aResult = ModuleBase_Tools::createAction(QIcon(":pictures/button_cancel.png"), "Cancel",
 242                                                  aParent);
 243         if (theId == Abort) {
 244           aResult->setShortcut(QKeySequence(Qt::Key_Escape));
 245         }
 246       }
 247       break;
 248       case Help: {
 249         aResult = ModuleBase_Tools::createAction(QIcon(":pictures/button_help.png"), "Help",
 250                                                  aParent);
 251       }
 252       break;
 253       case Preview: {
 254         aResult = ModuleBase_Tools::createAction(QIcon(), tr("See preview"), aParent, 0, 0, "Compute preview");
 255         aResult->setStatusTip(aResult->toolTip());
 256       }
 257       break;
 258       default:
 259         break;
 260     }
 261     myOperationActions.insert(theId, aResult);
 262   }
 263   return aResult;
 264 }
 265
 266 QAction* XGUI_ActionsMgr::action(const QString& theId)
 267 {
 268   QAction* anAction = 0;
 269   if(myActions.contains(theId)) {
 270     anAction = myActions.value(theId);
 271   }
 272   return anAction;
 273 }
 274
 275 ActionInfo XGUI_ActionsMgr::actionInfoById(const QString& theId)
 276 {
 277   ActionInfo aResult;
 278   if(myActions.contains(theId)) {
 279     aResult.initFrom(myActions.value(theId));
 280   } else {
 281    aResult.id = theId;
 282    aResult.text = theId;
 283   }
 284   return aResult;
 285 }
 286
 287 void XGUI_ActionsMgr::setAllEnabled()
 288 {
 289   foreach(QString eachAction, myActions.keys()) {
 290     if (myActions.contains(eachAction)) {
 291       QAction* aAction = myActions[eachAction];
 292       aAction->setEnabled(true);
 293     }
 294   }
 295 }
 296
 297
 298 //!
 299 void XGUI_ActionsMgr::setNestedCommandsEnabled(bool theEnabled, const QString& theParent)
 300 {
 301   QStringList ltNestedActions;
 302   if (theParent.isEmpty()) {  //Disable ALL nested
 303     foreach(QString eachParent, myNestedActions.keys()) {
 304       ltNestedActions << myNestedActions[eachParent];
 305     }
 306   } else {
 307     ltNestedActions << myNestedActions[theParent];
 308   }
 309   foreach(QString eachNested, ltNestedActions) {
 310     setActionEnabled(eachNested, theEnabled);
 311   }
 312 }
 313
 314 void XGUI_ActionsMgr::setNestedStackEnabled(ModuleBase_Operation* theOperation)
 315 {
 316   ModuleBase_OperationFeature* anOperation = dynamic_cast<ModuleBase_OperationFeature*>(theOperation);
 317   if(!anOperation || !anOperation->feature())
 318     return;
 319   FeaturePtr aFeature = anOperation->feature();
 320   QString aFeatureId = QString::fromStdString(aFeature->getKind());
 321   //setActionEnabled(aFeatureId, true);
 322   setNestedCommandsEnabled(true, aFeatureId);
 323
 324   setNestedStackEnabled(myOperationMgr->previousOperation(theOperation));
 325 }
 326
 327 QStringList XGUI_ActionsMgr::allNestedCommands(ModuleBase_Operation* theOperation)
 328 {
 329   QStringList aFeatures;
 330   ModuleBase_OperationFeature* anOperation = dynamic_cast<ModuleBase_OperationFeature*>(theOperation);
 331   if(!anOperation || !anOperation->feature())
 332     return aFeatures;
 333   FeaturePtr aFeature = anOperation->feature();
 334   QString aFeatureId = QString::fromStdString(aFeature->getKind());
 335
 336   aFeatures << myNestedActions[aFeatureId];
 337   aFeatures << allNestedCommands(myOperationMgr->previousOperation(theOperation));
 338   return aFeatures;
 339 }
 340
 341 void XGUI_ActionsMgr::setActionChecked(const QString& theId, const bool theChecked)
 342 {
 343   if (myActions.contains(theId)) {
 344     QAction* anAction = myActions[theId];
 345     if (anAction->isCheckable()) {
 346       anAction->setChecked(theChecked);
 347     }
 348   }
 349 }
 350
 351 void XGUI_ActionsMgr::setActionEnabled(const QString& theId, const bool theEnabled)
 352 {
 353   if (myActions.contains(theId)) {
 354     QAction* aAction = myActions[theId];
 355     // Initially all actions are enabled
 356     // If it was disabled for any reason then we can not enable it
 357     if (aAction->isEnabled())
 358       aAction->setEnabled(theEnabled);
 359   }
 360 }
 361
 362 /*
 363  * Disables all actions which have the Document Kind different to
 364  * the current document's kind
 365  */
 366 void XGUI_ActionsMgr::updateByDocumentKind()
 367 {
 368   std::string aStdDocKind = ModelAPI_Session::get()->activeDocument()->kind();
 369   QString aDocKind = QString::fromStdString(aStdDocKind);
 370   XGUI_Workshop* aWorkshop = static_cast<XGUI_Workshop*>(parent());
 371   foreach(QAction* eachAction, myActions.values()) {
 372     QString aCmdDocKind;
 373 #ifdef HAVE_SALOME
 374     QString aId = eachAction->data().toString();
 375     if (!aId.isEmpty()) {
 376       aCmdDocKind = QString::fromStdString(
 377                  aWorkshop->salomeConnector()->featureInfo(aId)->documentKind());
 378     }
 379 #else
 380     AppElements_Command* aCmd = dynamic_cast<AppElements_Command*>(eachAction);
 381     aCmdDocKind = QString::fromStdString(aCmd->featureMessage()->documentKind());
 382 #endif
 383     if(!aCmdDocKind.isEmpty() && aCmdDocKind != aDocKind) {
 384       eachAction->setEnabled(false);
 385     }
 386   }
 387 }
 388
 389 void XGUI_ActionsMgr::updateByPlugins(FeaturePtr anActiveFeature)
 390 {
 391   static Events_ID aStateRequestEventId = Events_Loop::loop()->eventByName(
 392       EVENT_FEATURE_STATE_REQUEST);
 393   std::shared_ptr<ModelAPI_FeatureStateMessage> aMsg(
 394       new ModelAPI_FeatureStateMessage(aStateRequestEventId, this));
 395   aMsg->setFeature(anActiveFeature);
 396   Events_Loop::loop()->send(aMsg, false);
 397 }