src/XGUI/XGUI_ActionsMgr.cpp

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