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