src/ModuleBase/ModuleBase_WidgetFactory.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * ModuleBase_WidgetFactory.cpp
   5  *
   6  *  Created on: Apr 3, 2014
   7  *      Author: sbh
   8  */
   9
  10 #include <ModuleBase_WidgetFactory.h>
  11 #include <ModuleBase_IconFactory.h>
  12
  13 #include <ModuleBase_Operation.h>
  14 #include <ModuleBase_OperationDescription.h>
  15 #include <ModuleBase_WidgetEditor.h>
  16 #include <ModuleBase_WidgetSwitch.h>
  17 #include <ModuleBase_WidgetShapeSelector.h>
  18 #include <ModuleBase_WidgetFeatureSelector.h>
  19 #include <ModuleBase_WidgetDoubleValue.h>
  20 #include <ModuleBase_WidgetIntValue.h>
  21 #include <ModuleBase_WidgetBoolValue.h>
  22 #include <ModuleBase_WidgetFileSelector.h>
  23 #include <ModuleBase_WidgetChoice.h>
  24 #include <ModuleBase_IWorkshop.h>
  25 #include <ModuleBase_IModule.h>
  26 #include <ModuleBase_Tools.h>
  27 #include <ModuleBase_WidgetLineEdit.h>
  28 #include <ModuleBase_WidgetMultiSelector.h>
  29 #include <ModuleBase_WidgetConcealedObjects.h>
  30 #include <ModuleBase_WidgetLabel.h>
  31 #include <ModuleBase_WidgetToolbox.h>
  32 #include <ModuleBase_PageBase.h>
  33 #include <ModuleBase_PageGroupBox.h>
  34 #include <ModuleBase_WidgetOptionalBox.h>
  35 #include <ModuleBase_PageWidget.h>
  36 #include <ModuleBase_WidgetExprEditor.h>
  37 #include <ModuleBase_WidgetCreatorFactory.h>
  38 #include <ModuleBase_WidgetAction.h>
  39
  40 #include <ModelAPI_Validator.h>
  41 #include <ModelAPI_Session.h>
  42
  43 #include <Config_Keywords.h>
  44 #include <Config_WidgetAPI.h>
  45
  46 #include <QWidget>
  47 #include <QHBoxLayout>
  48 #include <QGridLayout>
  49 #include <QSpinBox>
  50 #include <QMetaProperty>
  51 #include <QLabel>
  52 #include <QPixmap>
  53 #include <QGroupBox>
  54 #include <QToolBox>
  55
  56 #ifdef _DEBUG
  57 #include <QDebug>
  58 #endif
  59
  60 #include <cfloat>
  61 #include <climits>
  62
  63 ModuleBase_WidgetFactory::ModuleBase_WidgetFactory(const std::string& theXmlRepresentation,
  64                                                    ModuleBase_IWorkshop* theWorkshop)
  65     : myWorkshop(theWorkshop)
  66 {
  67   myWidgetApi = new Config_WidgetAPI(theXmlRepresentation);
  68 }
  69
  70 ModuleBase_WidgetFactory::~ModuleBase_WidgetFactory()
  71 {
  72   delete myWidgetApi;
  73 }
  74
  75 void ModuleBase_WidgetFactory::createWidget(ModuleBase_PageBase* thePage, bool alignToTop)
  76 {
  77   std::string aWType = myWidgetApi->widgetType();
  78   if (aWType == NODE_FEATURE) {
  79     // if XML definition of the feature contains the next key, the widgets should not be created,
  80     // but a specific panel should be made. However, to provide persistent of the panel values,
  81     // we need to get into the panel the feature of the operation. As a result this panel should
  82     // be created after the feature creating(create operation). The method setPanel() of this
  83     // class is used for this. Here, we just return to avoid the widgets creation.
  84     std::string aPanelName = myWidgetApi->getProperty(PROPERTY_PANEL_ID);
  85     if (!aPanelName.empty())
  86       return;
  87   }
  88
  89   if (!myWidgetApi->toChildWidget())
  90     return;
  91
  92   do {  //Iterate over each node
  93     std::string aWdgType = myWidgetApi->widgetType();
  94     // Create PageGroup TODO: extract
  95     if (myWidgetApi->isGroupBoxWidget() ||
  96         ModuleBase_WidgetCreatorFactory::get()->hasPageWidget(aWdgType)) {
  97
  98       //if current widget is groupbox (container) process it's children recursively
  99       ModuleBase_PageBase* aPage = createPageByType(aWdgType, thePage->pageWidget());
 100
 101       createWidget(aPage);
 102       thePage->addPageWidget(aPage);
 103     } else {
 104       // Create a ModelWidget
 105       ModuleBase_ModelWidget* aWidget = createWidgetByType(aWdgType, thePage->pageWidget());
 106       if (aWidget) {
 107         if (!myWidgetApi->getBooleanAttribute(ATTR_INTERNAL, false)) {
 108           thePage->addModelWidget(aWidget);
 109         } else {
 110           aWidget->setVisible(false);
 111         }
 112       }
 113       // Create PagedContainer TODO: extract
 114       if (myWidgetApi->isPagedWidget()) {
 115         //If current widget is toolbox or switch-casebox then fetch all
 116         //it's pages recursively and setup into the widget.
 117         if (myWidgetApi->toChildWidget()) {
 118           do {
 119             QString aPageName = qs(myWidgetApi->getProperty(CONTAINER_PAGE_NAME));
 120             QString aCaseId = qs(myWidgetApi->getProperty(_ID));
 121             ModuleBase_PageBase* aPage = new ModuleBase_PageWidget(aWidget);
 122             createWidget(aPage);
 123             if (aWdgType == WDG_SWITCH || aWdgType == WDG_TOOLBOX) {
 124               ModuleBase_PagedContainer* aContainer =
 125                 qobject_cast<ModuleBase_PagedContainer*>(aWidget);
 126
 127               QString anIconPath = qs( myWidgetApi->getProperty( CONTAINER_PAGE_ICON ) );
 128               QPixmap anIcon = ModuleBase_IconFactory::loadPixmap( anIconPath );
 129               aContainer->addPage( aPage, aPageName, aCaseId, anIcon );
 130             }
 131           } while (myWidgetApi->toNextWidget());
 132         }
 133       }
 134     }
 135   } while (myWidgetApi->toNextWidget());
 136
 137   if (alignToTop)
 138     thePage->alignToTop();
 139 }
 140
 141 void ModuleBase_WidgetFactory::createPanel(ModuleBase_PageBase* thePage,
 142                                            const FeaturePtr& theFeature)
 143 {
 144   std::string aPanelName = myWidgetApi->getProperty(PROPERTY_PANEL_ID);
 145   if (!aPanelName.empty() && ModuleBase_WidgetCreatorFactory::get()->hasPanelWidget(aPanelName)) {
 146     QWidget* aPanel = ModuleBase_WidgetCreatorFactory::get()->createPanelByType(aPanelName,
 147                                                                thePage->pageWidget(), theFeature);
 148     thePage->addWidget(aPanel);
 149     thePage->alignToTop();
 150   }
 151 }
 152
 153 void ModuleBase_WidgetFactory::createWidget(ModuleBase_PageBase* thePage,
 154                                             const std::string& theWidgetId)
 155 {
 156   bool aFound = false;
 157   moveToWidgetId(theWidgetId, aFound);
 158   if (aFound) {
 159     std::string aWdgType = myWidgetApi->widgetType();
 160
 161     // Create a ModelWidget
 162     ModuleBase_ModelWidget* aWidget = createWidgetByType(aWdgType, thePage->pageWidget());
 163     if (aWidget) {
 164       if (!myWidgetApi->getBooleanAttribute(ATTR_INTERNAL, false)) {
 165         thePage->addModelWidget(aWidget);
 166       }
 167       else {
 168         aWidget->setVisible(false);
 169       }
 170     }
 171   }
 172   thePage->alignToTop();
 173 }
 174
 175 void ModuleBase_WidgetFactory::getAttributeTitle(const std::string& theAttributeId,
 176                                                  std::string& theTitle)
 177 {
 178   bool aFound = false;
 179   moveToWidgetId(theAttributeId, aFound);
 180   if (aFound) {
 181     theTitle = QString::fromStdString(myWidgetApi->widgetLabel()).toStdString().c_str();
 182     if (theTitle.empty())
 183       theTitle =
 184       QString::fromStdString(myWidgetApi->getProperty(CONTAINER_PAGE_NAME)).toStdString().c_str();
 185   }
 186 }
 187
 188 void ModuleBase_WidgetFactory::getGreedAttribute(std::string& theAttributeId)
 189 {
 190   if (!theAttributeId.empty())
 191     return;
 192
 193   if (!myWidgetApi->toChildWidget())
 194     return;
 195
 196   do {  //Iterate over each node
 197     std::string aWdgType = myWidgetApi->widgetType();
 198     // Find title under PageGroup
 199     if (myWidgetApi->isGroupBoxWidget() ||
 200       ModuleBase_WidgetCreatorFactory::get()->hasPageWidget(aWdgType)) {
 201       getGreedAttribute(theAttributeId);
 202     }
 203     else {
 204       // Find title here
 205       std::string anAttributeId = myWidgetApi->widgetId();
 206       if (myWidgetApi->getBooleanAttribute(ATTR_GREED, false))
 207         theAttributeId = anAttributeId;
 208       if (theAttributeId.empty() && myWidgetApi->isPagedWidget()) {
 209         //If current widget is toolbox or switch-casebox then fetch all
 210         //it's pages recursively and setup into the widget.
 211         if (myWidgetApi->toChildWidget()) {
 212           do {
 213             getGreedAttribute(theAttributeId);
 214           } while (theAttributeId.empty() && myWidgetApi->toNextWidget());
 215         }
 216       }
 217     }
 218   } while (theAttributeId.empty() && myWidgetApi->toNextWidget());
 219 }
 220
 221 void ModuleBase_WidgetFactory::moveToWidgetId(const std::string& theWidgetId, bool& theFound)
 222 {
 223   if (theFound)
 224     return;
 225
 226   if (!myWidgetApi->toChildWidget())
 227     return;
 228
 229   do {  //Iterate over each node
 230     std::string aWdgType = myWidgetApi->widgetType();
 231     // Find title under PageGroup
 232     if (myWidgetApi->isGroupBoxWidget() ||
 233       ModuleBase_WidgetCreatorFactory::get()->hasPageWidget(aWdgType)) {
 234       moveToWidgetId(theWidgetId, theFound);
 235     }
 236     else {
 237       // Find title here
 238       std::string anAttributeId = myWidgetApi->widgetId();
 239       theFound = anAttributeId == theWidgetId;
 240       if (!theFound && myWidgetApi->isPagedWidget()) {
 241         //If current widget is toolbox or switch-casebox then fetch all
 242         //it's pages recursively and setup into the widget.
 243         if (myWidgetApi->toChildWidget()) {
 244           do {
 245             moveToWidgetId(theWidgetId, theFound);
 246           } while (!theFound && myWidgetApi->toNextWidget());
 247         }
 248       }
 249     }
 250   } while (!theFound && myWidgetApi->toNextWidget());
 251 }
 252
 253 ModuleBase_PageBase* ModuleBase_WidgetFactory::createPageByType(const std::string& theType,
 254                                                                 QWidget* theParent)
 255 {
 256   ModuleBase_PageBase* aResult = NULL;
 257
 258   if (theType == WDG_GROUP) {
 259     QString aGroupName = qs(myWidgetApi->getProperty(CONTAINER_PAGE_NAME));
 260     ModuleBase_PageGroupBox* aPage = new ModuleBase_PageGroupBox(theParent);
 261     aPage->setTitle(aGroupName);
 262     aResult = aPage;
 263   }
 264   else if (theType == WDG_OPTIONALBOX) {
 265     ModuleBase_WidgetOptionalBox* aPage = new ModuleBase_WidgetOptionalBox(theParent,
 266                                                                 myWidgetApi);
 267     aResult = aPage;
 268   }
 269   if (!aResult)
 270     aResult = ModuleBase_WidgetCreatorFactory::get()->createPageByType(theType, theParent,
 271                                                                        myWidgetApi);
 272
 273   ModuleBase_ModelWidget* aWidget = dynamic_cast<ModuleBase_ModelWidget*>(aResult);
 274   if (aWidget)
 275     myModelWidgets.append(aWidget);
 276
 277   return aResult;
 278 }
 279
 280 ModuleBase_ModelWidget* ModuleBase_WidgetFactory::createWidgetByType(const std::string& theType,
 281                                                                      QWidget* theParent)
 282 {
 283   ModuleBase_ModelWidget* result = NULL;
 284
 285   if (theType == WDG_INFO) {
 286     result = new ModuleBase_WidgetLabel(theParent, myWidgetApi);
 287   } else if (theType == WDG_DOUBLEVALUE) {
 288     result = new ModuleBase_WidgetDoubleValue(theParent, myWidgetApi);
 289   } else if (theType == WDG_INTEGERVALUE) {
 290     result = new ModuleBase_WidgetIntValue(theParent, myWidgetApi);
 291   } else if (theType == WDG_SHAPE_SELECTOR) {
 292     result = new ModuleBase_WidgetShapeSelector(theParent, myWorkshop, myWidgetApi);
 293   } else if (theType == WDG_FEATURE_SELECTOR) {
 294     result = new ModuleBase_WidgetFeatureSelector(theParent, myWorkshop, myWidgetApi);
 295   } else if (theType == WDG_BOOLVALUE) {
 296     result = new ModuleBase_WidgetBoolValue(theParent, myWidgetApi);
 297   //} else if (theType == WDG_DOUBLEVALUE_EDITOR) {
 298   //  result = new ModuleBase_WidgetEditor(theParent, myWidgetApi);
 299   } else if (theType == WDG_FILE_SELECTOR) {
 300     result = new ModuleBase_WidgetFileSelector(theParent, myWidgetApi);
 301   } else if (theType == WDG_CHOICE) {
 302     result = new ModuleBase_WidgetChoice(theParent, myWidgetApi);
 303   } else if (theType == WDG_STRINGVALUE) {
 304     std::string aPlaceHolder = myWidgetApi->getProperty( WDG_PLACE_HOLDER );
 305     result = new ModuleBase_WidgetLineEdit( theParent, myWidgetApi, aPlaceHolder );
 306   } else if (theType == WDG_EXPR_EDITOR) {
 307     std::string aPlaceHolder = myWidgetApi->getProperty( WDG_PLACE_HOLDER );
 308     result = new ModuleBase_WidgetExprEditor( theParent, myWidgetApi, aPlaceHolder );
 309   } else if (theType == WDG_MULTISELECTOR) {
 310     result = new ModuleBase_WidgetMultiSelector(theParent, myWorkshop, myWidgetApi);
 311   } else if (theType == WDG_CONCEALED_OBJECTS_VIEW) {
 312     result = new ModuleBase_WidgetConcealedObjects(theParent, myWidgetApi);
 313   } else if (theType == WDG_TOOLBOX) {
 314     result = new ModuleBase_WidgetToolbox(theParent, myWidgetApi);
 315   } else if (theType == WDG_SWITCH) {
 316     result = new ModuleBase_WidgetSwitch(theParent, myWidgetApi);
 317   } else if (theType == WDG_TOOLBOX_BOX || theType == WDG_SWITCH_CASE ||
 318              theType == NODE_VALIDATOR) {
 319     // Do nothing for "box" and "case"
 320     result = NULL;
 321   } else if (theType == WDG_ACTION) {
 322     result = new ModuleBase_WidgetAction(theParent, myWidgetApi);
 323   } else {
 324     result = myWorkshop->module()->createWidgetByType(theType, theParent, myWidgetApi);
 325     if (!result)
 326       result = ModuleBase_WidgetCreatorFactory::get()->createWidgetByType(theType, theParent,
 327                                                               myWidgetApi, myWorkshop);
 328     #ifdef _DEBUG
 329     if (!result) {
 330       qDebug("ModuleBase_WidgetFactory::fillWidget: find bad widget type %s", theType.c_str());
 331     }
 332     #endif
 333   }
 334   if (result)
 335     myModelWidgets.append(result);
 336   return result;
 337 }
 338
 339 QString ModuleBase_WidgetFactory::qs(const std::string& theStdString)
 340 {
 341   return QString::fromStdString(theStdString);
 342 }
 343