Salome HOME
Updated copyright comment
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetFactory.cpp
index b5d65a2cd05145ba9206506813fc602002f2ef39..e34798a1ac9ab0e66ebca341a07af55fd8cc98e1 100644 (file)
@@ -1,20 +1,33 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * ModuleBase_WidgetFactory.cpp
- *
- *  Created on: Apr 3, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2024  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #include <ModuleBase_WidgetFactory.h>
+#include <ModuleBase_IconFactory.h>
 
 #include <ModuleBase_Operation.h>
 #include <ModuleBase_OperationDescription.h>
 #include <ModuleBase_WidgetEditor.h>
 #include <ModuleBase_WidgetSwitch.h>
 #include <ModuleBase_WidgetShapeSelector.h>
+#include <ModuleBase_WidgetFeatureSelector.h>
 #include <ModuleBase_WidgetDoubleValue.h>
+#include <ModuleBase_WidgetLabelValue.h>
 #include <ModuleBase_WidgetIntValue.h>
 #include <ModuleBase_WidgetBoolValue.h>
 #include <ModuleBase_WidgetFileSelector.h>
 #include <ModuleBase_IModule.h>
 #include <ModuleBase_Tools.h>
 #include <ModuleBase_WidgetLineEdit.h>
+#include <ModuleBase_WidgetNameEdit.h>
 #include <ModuleBase_WidgetMultiSelector.h>
+#include <ModuleBase_WidgetConcealedObjects.h>
 #include <ModuleBase_WidgetLabel.h>
+#include <ModuleBase_WidgetUndoLabel.h>
 #include <ModuleBase_WidgetToolbox.h>
+#include <ModuleBase_WidgetRadiobox.h>
 #include <ModuleBase_PageBase.h>
 #include <ModuleBase_PageGroupBox.h>
+#include <ModuleBase_WidgetOptionalBox.h>
 #include <ModuleBase_PageWidget.h>
 #include <ModuleBase_WidgetExprEditor.h>
+#include <ModuleBase_WidgetCreatorFactory.h>
+#include <ModuleBase_WidgetAction.h>
+#include <ModuleBase_WidgetPointInput.h>
+#include <ModuleBase_WidgetSelectionFilter.h>
 
 #include <ModelAPI_Validator.h>
 #include <ModelAPI_Session.h>
 #include <climits>
 
 ModuleBase_WidgetFactory::ModuleBase_WidgetFactory(const std::string& theXmlRepresentation,
-                                                   ModuleBase_IWorkshop* theWorkshop)
+                                                   ModuleBase_IWorkshop* theWorkshop,
+                                                   const std::string theAttributePrefix)
     : myWorkshop(theWorkshop)
 {
-  myWidgetApi = new Config_WidgetAPI(theXmlRepresentation);
+  myWidgetApi = new Config_WidgetAPI(theXmlRepresentation, theAttributePrefix);
 }
 
 ModuleBase_WidgetFactory::~ModuleBase_WidgetFactory()
@@ -66,20 +89,32 @@ ModuleBase_WidgetFactory::~ModuleBase_WidgetFactory()
   delete myWidgetApi;
 }
 
-void ModuleBase_WidgetFactory::createWidget(ModuleBase_PageBase* thePage)
+void ModuleBase_WidgetFactory::createWidget(ModuleBase_PageBase* thePage, bool alignToTop)
 {
-  myParentId = myWidgetApi->widgetId();
+  std::string aWType = myWidgetApi->widgetType();
+  if (aWType == NODE_FEATURE) {
+    // if XML definition of the feature contains the next key, the widgets should not be created,
+    // but a specific panel should be made. However, to provide persistent of the panel values,
+    // we need to get into the panel the feature of the operation. As a result this panel should
+    // be created after the feature creating(create operation). The method setPanel() of this
+    // class is used for this. Here, we just return to avoid the widgets creation.
+    std::string aPanelName = myWidgetApi->getProperty(PROPERTY_PANEL_ID);
+    if (!aPanelName.empty())
+      return;
+  }
+
   if (!myWidgetApi->toChildWidget())
     return;
 
   do {  //Iterate over each node
     std::string aWdgType = myWidgetApi->widgetType();
     // Create PageGroup TODO: extract
-    if (myWidgetApi->isGroupBoxWidget()) {
+    if (myWidgetApi->isGroupBoxWidget() ||
+        ModuleBase_WidgetCreatorFactory::get()->hasPageWidget(aWdgType)) {
+
       //if current widget is groupbox (container) process it's children recursively
-      QString aGroupName = qs(myWidgetApi->getProperty(CONTAINER_PAGE_NAME));
-      ModuleBase_PageGroupBox* aPage = new ModuleBase_PageGroupBox(thePage->pageWidget());
-      aPage->setTitle(aGroupName);
+      ModuleBase_PageBase* aPage = createPageByType(aWdgType, thePage->pageWidget());
+
       createWidget(aPage);
       thePage->addPageWidget(aPage);
     } else {
@@ -96,25 +131,176 @@ void ModuleBase_WidgetFactory::createWidget(ModuleBase_PageBase* thePage)
       if (myWidgetApi->isPagedWidget()) {
         //If current widget is toolbox or switch-casebox then fetch all
         //it's pages recursively and setup into the widget.
-        myWidgetApi->toChildWidget();
-        do {
-          QString aPageName = qs(myWidgetApi->getProperty(CONTAINER_PAGE_NAME));
-          QString aCaseId = qs(myWidgetApi->getProperty(_ID));
-          ModuleBase_PageBase* aPage = new ModuleBase_PageWidget(aWidget);
-          createWidget(aPage);
-          if (aWdgType == WDG_SWITCH || aWdgType == WDG_TOOLBOX) {
-            ModuleBase_PagedContainer* aContainer = qobject_cast<ModuleBase_PagedContainer*>(aWidget);
-
-            QString anIconPath = qs( myWidgetApi->getProperty( CONTAINER_PAGE_ICON ) );
-            QIcon anIcon( anIconPath );
-            aContainer->addPage( aPage, aPageName, aCaseId, anIcon );
-          }
-        } while (myWidgetApi->toNextWidget());
+        if (myWidgetApi->toChildWidget()) {
+          do {
+            if (myWidgetApi->getBooleanAttribute(ATTR_INTERNAL, false)) continue;
+            QString aPageName = qs(myWidgetApi->getProperty(CONTAINER_PAGE_NAME));
+            QString aTooltip = qs(myWidgetApi->getProperty(FEATURE_TOOLTIP));
+            QString aCaseId = qs(myWidgetApi->getProperty(_ID));
+            ModuleBase_PageBase* aPage = new ModuleBase_PageWidget(aWidget);
+            createWidget(aPage);
+            if (aWdgType == WDG_SWITCH || aWdgType == WDG_TOOLBOX || aWdgType == WDG_RADIOBOX) {
+              ModuleBase_PagedContainer* aContainer =
+                qobject_cast<ModuleBase_PagedContainer*>(aWidget);
+
+              QString anIconPath = qs( myWidgetApi->getProperty( CONTAINER_PAGE_ICON ) );
+              QPixmap anIcon = ModuleBase_IconFactory::loadPixmap( anIconPath );
+              aContainer->addPage( aPage, aPageName, aCaseId, anIcon, aTooltip);
+            }
+          } while (myWidgetApi->toNextWidget());
+        }
       }
     }
   } while (myWidgetApi->toNextWidget());
 
-  thePage->alignToTop();
+  if (alignToTop)
+    thePage->alignToTop();
+}
+
+void ModuleBase_WidgetFactory::createPanel(ModuleBase_PageBase* thePage,
+                                           const FeaturePtr& theFeature)
+{
+  std::string aPanelName = myWidgetApi->getProperty(PROPERTY_PANEL_ID);
+  if (!aPanelName.empty() && ModuleBase_WidgetCreatorFactory::get()->hasPanelWidget(aPanelName)) {
+    QWidget* aPanel = ModuleBase_WidgetCreatorFactory::get()->createPanelByType(aPanelName,
+        thePage->pageWidget(), theFeature, myWidgetApi);
+    ModuleBase_ModelWidget* aModelWdg = dynamic_cast<ModuleBase_ModelWidget*>(aPanel);
+    if (aModelWdg)
+      thePage->addModelWidget(aModelWdg);
+    else
+      thePage->addWidget(aPanel);
+    thePage->alignToTop();
+  }
+}
+
+void ModuleBase_WidgetFactory::createWidget(ModuleBase_PageBase* thePage,
+                                            const std::string& theWidgetId)
+{
+  bool aFound = false;
+  moveToWidgetId(theWidgetId, aFound);
+  if (aFound) {
+    std::string aWdgType = myWidgetApi->widgetType();
+
+    // Create a ModelWidget
+    ModuleBase_ModelWidget* aWidget = createWidgetByType(aWdgType, thePage->pageWidget());
+    if (aWidget) {
+      if (!myWidgetApi->getBooleanAttribute(ATTR_INTERNAL, false)) {
+        thePage->addModelWidget(aWidget);
+      }
+      else {
+        aWidget->setVisible(false);
+      }
+    }
+    thePage->alignToTop();
+  }
+}
+
+void ModuleBase_WidgetFactory::getAttributeTitle(const std::string& theAttributeId,
+                                                 std::string& theTitle)
+{
+  bool aFound = false;
+  moveToWidgetId(theAttributeId, aFound);
+  if (aFound) {
+    theTitle = QString::fromStdString(myWidgetApi->widgetLabel()).toStdString().c_str();
+    if (theTitle.empty())
+      theTitle =
+      QString::fromStdString(myWidgetApi->getProperty(CONTAINER_PAGE_NAME)).toStdString().c_str();
+  }
+  else
+    theTitle = theAttributeId;
+}
+
+void ModuleBase_WidgetFactory::getGreedAttribute(std::string& theAttributeId)
+{
+  if (!theAttributeId.empty())
+    return;
+
+  if (!myWidgetApi->toChildWidget())
+    return;
+
+  do {  //Iterate over each node
+    std::string aWdgType = myWidgetApi->widgetType();
+    // Find title under PageGroup
+    if (myWidgetApi->isGroupBoxWidget() ||
+      ModuleBase_WidgetCreatorFactory::get()->hasPageWidget(aWdgType)) {
+      getGreedAttribute(theAttributeId);
+    }
+    else {
+      // Find title here
+      std::string anAttributeId = myWidgetApi->widgetId();
+      if (myWidgetApi->getBooleanAttribute(ATTR_GREED, false))
+        theAttributeId = anAttributeId;
+      if (theAttributeId.empty() && myWidgetApi->isPagedWidget()) {
+        //If current widget is toolbox or switch-casebox then fetch all
+        //it's pages recursively and setup into the widget.
+        if (myWidgetApi->toChildWidget()) {
+          do {
+            getGreedAttribute(theAttributeId);
+          } while (theAttributeId.empty() && myWidgetApi->toNextWidget());
+        }
+      }
+    }
+  } while (theAttributeId.empty() && myWidgetApi->toNextWidget());
+}
+
+void ModuleBase_WidgetFactory::moveToWidgetId(const std::string& theWidgetId, bool& theFound)
+{
+  if (theFound)
+    return;
+
+  if (!myWidgetApi->toChildWidget())
+    return;
+
+  do {  //Iterate over each node
+    std::string aWdgType = myWidgetApi->widgetType();
+    // Find title under PageGroup
+    if (myWidgetApi->isGroupBoxWidget() ||
+      ModuleBase_WidgetCreatorFactory::get()->hasPageWidget(aWdgType)) {
+      moveToWidgetId(theWidgetId, theFound);
+    }
+    else {
+      // Find title here
+      std::string anAttributeId = myWidgetApi->widgetId();
+      theFound = anAttributeId == theWidgetId;
+      if (!theFound && myWidgetApi->isPagedWidget()) {
+        //If current widget is toolbox or switch-casebox then fetch all
+        //it's pages recursively and setup into the widget.
+        if (myWidgetApi->toChildWidget()) {
+          do {
+            moveToWidgetId(theWidgetId, theFound);
+          } while (!theFound && myWidgetApi->toNextWidget());
+        }
+      }
+    }
+  } while (!theFound && myWidgetApi->toNextWidget());
+}
+
+ModuleBase_PageBase* ModuleBase_WidgetFactory::createPageByType(const std::string& theType,
+                                                                QWidget* theParent)
+{
+  ModuleBase_PageBase* aResult = NULL;
+
+  if (theType == WDG_GROUP) {
+    QString aGroupName = qs(myWidgetApi->getProperty(CONTAINER_PAGE_NAME));
+    ModuleBase_PageGroupBox* aPage = new ModuleBase_PageGroupBox(theParent);
+    aPage->setTitle(ModuleBase_Tools::translate(
+      myWidgetApi->myFeatureId, aGroupName.toStdString()));
+    aResult = aPage;
+  }
+  else if (theType == WDG_OPTIONALBOX) {
+    ModuleBase_WidgetOptionalBox* aPage = new ModuleBase_WidgetOptionalBox(theParent,
+                                                                myWidgetApi);
+    aResult = aPage;
+  }
+  if (!aResult)
+    aResult = ModuleBase_WidgetCreatorFactory::get()->createPageByType(theType, theParent,
+                                                                       myWidgetApi);
+
+  ModuleBase_ModelWidget* aWidget = dynamic_cast<ModuleBase_ModelWidget*>(aResult);
+  if (aWidget)
+    myModelWidgets.append(aWidget);
+
+  return aResult;
 }
 
 ModuleBase_ModelWidget* ModuleBase_WidgetFactory::createWidgetByType(const std::string& theType,
@@ -123,47 +309,69 @@ ModuleBase_ModelWidget* ModuleBase_WidgetFactory::createWidgetByType(const std::
   ModuleBase_ModelWidget* result = NULL;
 
   if (theType == WDG_INFO) {
-    result = new ModuleBase_WidgetLabel(theParent, myWidgetApi, myParentId);
+    result = new ModuleBase_WidgetLabel(theParent, myWidgetApi);
   } else if (theType == WDG_DOUBLEVALUE) {
-    result = new ModuleBase_WidgetDoubleValue(theParent, myWidgetApi, myParentId);
+    result = new ModuleBase_WidgetDoubleValue(theParent, myWidgetApi);
+  } else if (theType == WDG_UNDOLABEL) {
+    result = new ModuleBase_WidgetUndoLabel(theParent, myWorkshop, myWidgetApi);
+  } else if (theType == WDG_DOUBLEVALUELABEL) {
+    result = new ModuleBase_WidgetLabelValue(theParent, myWidgetApi);
   } else if (theType == WDG_INTEGERVALUE) {
-    result = new ModuleBase_WidgetIntValue(theParent, myWidgetApi, myParentId);
+    result = new ModuleBase_WidgetIntValue(theParent, myWidgetApi);
   } else if (theType == WDG_SHAPE_SELECTOR) {
-    result = new ModuleBase_WidgetShapeSelector(theParent, myWorkshop, myWidgetApi, myParentId);
+    result = new ModuleBase_WidgetShapeSelector(theParent, myWorkshop, myWidgetApi);
+  } else if (theType == WDG_FEATURE_SELECTOR) {
+    result = new ModuleBase_WidgetFeatureSelector(theParent, myWorkshop, myWidgetApi);
   } else if (theType == WDG_BOOLVALUE) {
-    result = new ModuleBase_WidgetBoolValue(theParent, myWidgetApi, myParentId);
+    result = new ModuleBase_WidgetBoolValue(theParent, myWidgetApi);
   //} else if (theType == WDG_DOUBLEVALUE_EDITOR) {
-  //  result = new ModuleBase_WidgetEditor(theParent, myWidgetApi, myParentId);
+  //  result = new ModuleBase_WidgetEditor(theParent, myWidgetApi);
   } else if (theType == WDG_FILE_SELECTOR) {
-    result = new ModuleBase_WidgetFileSelector(theParent, myWidgetApi, myParentId);
+    result = new ModuleBase_WidgetFileSelector(theParent, myWidgetApi);
   } else if (theType == WDG_CHOICE) {
-    result = new ModuleBase_WidgetChoice(theParent, myWidgetApi, myParentId);
+    result = new ModuleBase_WidgetChoice(theParent, myWidgetApi);
   } else if (theType == WDG_STRINGVALUE) {
     std::string aPlaceHolder = myWidgetApi->getProperty( WDG_PLACE_HOLDER );
-    result = new ModuleBase_WidgetLineEdit( theParent, myWidgetApi, myParentId, aPlaceHolder );
+    result = new ModuleBase_WidgetLineEdit( theParent, myWidgetApi, aPlaceHolder );
+  } else if (theType == WDG_NAMEVALUE) {
+    std::string aPlaceHolder = myWidgetApi->getProperty( WDG_PLACE_HOLDER );
+    result = new ModuleBase_WidgetNameEdit( theParent, myWidgetApi, aPlaceHolder );
   } else if (theType == WDG_EXPR_EDITOR) {
     std::string aPlaceHolder = myWidgetApi->getProperty( WDG_PLACE_HOLDER );
-    result = new ModuleBase_WidgetExprEditor( theParent, myWidgetApi, myParentId, aPlaceHolder );
+    result = new ModuleBase_WidgetExprEditor( theParent, myWidgetApi, aPlaceHolder );
   } else if (theType == WDG_MULTISELECTOR) {
-    result = new ModuleBase_WidgetMultiSelector(theParent, myWorkshop, myWidgetApi, myParentId);
+    result = new ModuleBase_WidgetMultiSelector(theParent, myWorkshop, myWidgetApi);
+  } else if (theType == WDG_CONCEALED_OBJECTS_VIEW) {
+    result = new ModuleBase_WidgetConcealedObjects(theParent, myWidgetApi);
   } else if (theType == WDG_TOOLBOX) {
-    result = new ModuleBase_WidgetToolbox(theParent, myWidgetApi, myParentId);
+    result = new ModuleBase_WidgetToolbox(theParent, myWidgetApi);
+  } else if (theType == WDG_RADIOBOX) {
+    result = new ModuleBase_WidgetRadiobox(theParent, myWidgetApi);
   } else if (theType == WDG_SWITCH) {
-    result = new ModuleBase_WidgetSwitch(theParent, myWidgetApi, myParentId);
-  } else if (theType == WDG_TOOLBOX_BOX || theType == WDG_SWITCH_CASE) {
+    result = new ModuleBase_WidgetSwitch(theParent, myWidgetApi);
+  } else if (theType == WDG_TOOLBOX_BOX || theType == WDG_SWITCH_CASE ||
+             theType == NODE_VALIDATOR) {
     // Do nothing for "box" and "case"
     result = NULL;
+  } else if (theType == WDG_ACTION) {
+    result = new ModuleBase_WidgetAction(theParent, myWidgetApi);
+  } else if (theType == WDG_POINT_INPUT) {
+    result = new ModuleBase_WidgetPointInput(theParent, myWorkshop, myWidgetApi);
+  } else if (theType == WDG_SELECTION_FILTERS) {
+    result = new ModuleBase_WidgetSelectionFilter(theParent, myWorkshop, myWidgetApi);
   } else {
-    result = myWorkshop->module()->createWidgetByType(theType, theParent, myWidgetApi, myParentId);
+    result = myWorkshop->module()->createWidgetByType(theType, theParent, myWidgetApi);
+    if (!result)
+      result = ModuleBase_WidgetCreatorFactory::get()->createWidgetByType(theType, theParent,
+                                                              myWidgetApi, myWorkshop);
     #ifdef _DEBUG
     if (!result) {
       qDebug("ModuleBase_WidgetFactory::fillWidget: find bad widget type %s", theType.c_str());
     }
     #endif
   }
-  if (result) {
+  if (result)
     myModelWidgets.append(result);
-  }
   return result;
 }