1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #include <ModuleBase_WidgetFactory.h>
21 #include <ModuleBase_IconFactory.h>
23 #include <ModuleBase_Operation.h>
24 #include <ModuleBase_OperationDescription.h>
25 #include <ModuleBase_WidgetEditor.h>
26 #include <ModuleBase_WidgetSwitch.h>
27 #include <ModuleBase_WidgetShapeSelector.h>
28 #include <ModuleBase_WidgetFeatureSelector.h>
29 #include <ModuleBase_WidgetDoubleValue.h>
30 #include <ModuleBase_WidgetLabelValue.h>
31 #include <ModuleBase_WidgetIntValue.h>
32 #include <ModuleBase_WidgetBoolValue.h>
33 #include <ModuleBase_WidgetFileSelector.h>
34 #include <ModuleBase_WidgetChoice.h>
35 #include <ModuleBase_IWorkshop.h>
36 #include <ModuleBase_IModule.h>
37 #include <ModuleBase_Tools.h>
38 #include <ModuleBase_WidgetLineEdit.h>
39 #include <ModuleBase_WidgetNameEdit.h>
40 #include <ModuleBase_WidgetMultiSelector.h>
41 #include <ModuleBase_WidgetConcealedObjects.h>
42 #include <ModuleBase_WidgetLabel.h>
43 #include <ModuleBase_WidgetUndoLabel.h>
44 #include <ModuleBase_WidgetToolbox.h>
45 #include <ModuleBase_WidgetRadiobox.h>
46 #include <ModuleBase_PageBase.h>
47 #include <ModuleBase_PageGroupBox.h>
48 #include <ModuleBase_WidgetOptionalBox.h>
49 #include <ModuleBase_PageWidget.h>
50 #include <ModuleBase_WidgetExprEditor.h>
51 #include <ModuleBase_WidgetCreatorFactory.h>
52 #include <ModuleBase_WidgetAction.h>
53 #include <ModuleBase_WidgetPointInput.h>
54 #include <ModuleBase_WidgetSelectionFilter.h>
56 #include <ModelAPI_Validator.h>
57 #include <ModelAPI_Session.h>
59 #include <Config_Keywords.h>
60 #include <Config_WidgetAPI.h>
63 #include <QHBoxLayout>
64 #include <QGridLayout>
66 #include <QMetaProperty>
79 ModuleBase_WidgetFactory::ModuleBase_WidgetFactory(const std::string& theXmlRepresentation,
80 ModuleBase_IWorkshop* theWorkshop)
81 : myWorkshop(theWorkshop)
83 myWidgetApi = new Config_WidgetAPI(theXmlRepresentation);
86 ModuleBase_WidgetFactory::~ModuleBase_WidgetFactory()
91 void ModuleBase_WidgetFactory::createWidget(ModuleBase_PageBase* thePage, bool alignToTop)
93 std::string aWType = myWidgetApi->widgetType();
94 if (aWType == NODE_FEATURE) {
95 // if XML definition of the feature contains the next key, the widgets should not be created,
96 // but a specific panel should be made. However, to provide persistent of the panel values,
97 // we need to get into the panel the feature of the operation. As a result this panel should
98 // be created after the feature creating(create operation). The method setPanel() of this
99 // class is used for this. Here, we just return to avoid the widgets creation.
100 std::string aPanelName = myWidgetApi->getProperty(PROPERTY_PANEL_ID);
101 if (!aPanelName.empty())
105 if (!myWidgetApi->toChildWidget())
108 do { //Iterate over each node
109 std::string aWdgType = myWidgetApi->widgetType();
110 // Create PageGroup TODO: extract
111 if (myWidgetApi->isGroupBoxWidget() ||
112 ModuleBase_WidgetCreatorFactory::get()->hasPageWidget(aWdgType)) {
114 //if current widget is groupbox (container) process it's children recursively
115 ModuleBase_PageBase* aPage = createPageByType(aWdgType, thePage->pageWidget());
118 thePage->addPageWidget(aPage);
120 // Create a ModelWidget
121 ModuleBase_ModelWidget* aWidget = createWidgetByType(aWdgType, thePage->pageWidget());
123 if (!myWidgetApi->getBooleanAttribute(ATTR_INTERNAL, false)) {
124 thePage->addModelWidget(aWidget);
126 aWidget->setVisible(false);
129 // Create PagedContainer TODO: extract
130 if (myWidgetApi->isPagedWidget()) {
131 //If current widget is toolbox or switch-casebox then fetch all
132 //it's pages recursively and setup into the widget.
133 if (myWidgetApi->toChildWidget()) {
135 QString aPageName = qs(myWidgetApi->getProperty(CONTAINER_PAGE_NAME));
136 QString aTooltip = qs(myWidgetApi->getProperty(FEATURE_TOOLTIP));
137 QString aCaseId = qs(myWidgetApi->getProperty(_ID));
138 ModuleBase_PageBase* aPage = new ModuleBase_PageWidget(aWidget);
140 if (aWdgType == WDG_SWITCH || aWdgType == WDG_TOOLBOX || aWdgType == WDG_RADIOBOX) {
141 ModuleBase_PagedContainer* aContainer =
142 qobject_cast<ModuleBase_PagedContainer*>(aWidget);
144 QString anIconPath = qs( myWidgetApi->getProperty( CONTAINER_PAGE_ICON ) );
145 QPixmap anIcon = ModuleBase_IconFactory::loadPixmap( anIconPath );
146 aContainer->addPage( aPage, aPageName, aCaseId, anIcon, aTooltip);
148 } while (myWidgetApi->toNextWidget());
152 } while (myWidgetApi->toNextWidget());
155 thePage->alignToTop();
158 void ModuleBase_WidgetFactory::createPanel(ModuleBase_PageBase* thePage,
159 const FeaturePtr& theFeature)
161 std::string aPanelName = myWidgetApi->getProperty(PROPERTY_PANEL_ID);
162 if (!aPanelName.empty() && ModuleBase_WidgetCreatorFactory::get()->hasPanelWidget(aPanelName)) {
163 QWidget* aPanel = ModuleBase_WidgetCreatorFactory::get()->createPanelByType(aPanelName,
164 thePage->pageWidget(), theFeature, myWidgetApi);
165 ModuleBase_ModelWidget* aModelWdg = dynamic_cast<ModuleBase_ModelWidget*>(aPanel);
167 thePage->addModelWidget(aModelWdg);
169 thePage->addWidget(aPanel);
170 thePage->alignToTop();
174 void ModuleBase_WidgetFactory::createWidget(ModuleBase_PageBase* thePage,
175 const std::string& theWidgetId)
178 moveToWidgetId(theWidgetId, aFound);
180 std::string aWdgType = myWidgetApi->widgetType();
182 // Create a ModelWidget
183 ModuleBase_ModelWidget* aWidget = createWidgetByType(aWdgType, thePage->pageWidget());
185 if (!myWidgetApi->getBooleanAttribute(ATTR_INTERNAL, false)) {
186 thePage->addModelWidget(aWidget);
189 aWidget->setVisible(false);
192 thePage->alignToTop();
196 void ModuleBase_WidgetFactory::getAttributeTitle(const std::string& theAttributeId,
197 std::string& theTitle)
200 moveToWidgetId(theAttributeId, aFound);
202 theTitle = QString::fromStdString(myWidgetApi->widgetLabel()).toStdString().c_str();
203 if (theTitle.empty())
205 QString::fromStdString(myWidgetApi->getProperty(CONTAINER_PAGE_NAME)).toStdString().c_str();
208 theTitle = theAttributeId;
211 void ModuleBase_WidgetFactory::getGreedAttribute(std::string& theAttributeId)
213 if (!theAttributeId.empty())
216 if (!myWidgetApi->toChildWidget())
219 do { //Iterate over each node
220 std::string aWdgType = myWidgetApi->widgetType();
221 // Find title under PageGroup
222 if (myWidgetApi->isGroupBoxWidget() ||
223 ModuleBase_WidgetCreatorFactory::get()->hasPageWidget(aWdgType)) {
224 getGreedAttribute(theAttributeId);
228 std::string anAttributeId = myWidgetApi->widgetId();
229 if (myWidgetApi->getBooleanAttribute(ATTR_GREED, false))
230 theAttributeId = anAttributeId;
231 if (theAttributeId.empty() && myWidgetApi->isPagedWidget()) {
232 //If current widget is toolbox or switch-casebox then fetch all
233 //it's pages recursively and setup into the widget.
234 if (myWidgetApi->toChildWidget()) {
236 getGreedAttribute(theAttributeId);
237 } while (theAttributeId.empty() && myWidgetApi->toNextWidget());
241 } while (theAttributeId.empty() && myWidgetApi->toNextWidget());
244 void ModuleBase_WidgetFactory::moveToWidgetId(const std::string& theWidgetId, bool& theFound)
249 if (!myWidgetApi->toChildWidget())
252 do { //Iterate over each node
253 std::string aWdgType = myWidgetApi->widgetType();
254 // Find title under PageGroup
255 if (myWidgetApi->isGroupBoxWidget() ||
256 ModuleBase_WidgetCreatorFactory::get()->hasPageWidget(aWdgType)) {
257 moveToWidgetId(theWidgetId, theFound);
261 std::string anAttributeId = myWidgetApi->widgetId();
262 theFound = anAttributeId == theWidgetId;
263 if (!theFound && myWidgetApi->isPagedWidget()) {
264 //If current widget is toolbox or switch-casebox then fetch all
265 //it's pages recursively and setup into the widget.
266 if (myWidgetApi->toChildWidget()) {
268 moveToWidgetId(theWidgetId, theFound);
269 } while (!theFound && myWidgetApi->toNextWidget());
273 } while (!theFound && myWidgetApi->toNextWidget());
276 ModuleBase_PageBase* ModuleBase_WidgetFactory::createPageByType(const std::string& theType,
279 ModuleBase_PageBase* aResult = NULL;
281 if (theType == WDG_GROUP) {
282 QString aGroupName = qs(myWidgetApi->getProperty(CONTAINER_PAGE_NAME));
283 ModuleBase_PageGroupBox* aPage = new ModuleBase_PageGroupBox(theParent);
284 aPage->setTitle(ModuleBase_Tools::translate(
285 myWidgetApi->myFeatureId, aGroupName.toStdString()));
288 else if (theType == WDG_OPTIONALBOX) {
289 ModuleBase_WidgetOptionalBox* aPage = new ModuleBase_WidgetOptionalBox(theParent,
294 aResult = ModuleBase_WidgetCreatorFactory::get()->createPageByType(theType, theParent,
297 ModuleBase_ModelWidget* aWidget = dynamic_cast<ModuleBase_ModelWidget*>(aResult);
299 myModelWidgets.append(aWidget);
304 ModuleBase_ModelWidget* ModuleBase_WidgetFactory::createWidgetByType(const std::string& theType,
307 ModuleBase_ModelWidget* result = NULL;
309 if (theType == WDG_INFO) {
310 result = new ModuleBase_WidgetLabel(theParent, myWidgetApi);
311 } else if (theType == WDG_DOUBLEVALUE) {
312 result = new ModuleBase_WidgetDoubleValue(theParent, myWidgetApi);
313 } else if (theType == WDG_UNDOLABEL) {
314 result = new ModuleBase_WidgetUndoLabel(theParent, myWorkshop, myWidgetApi);
315 } else if (theType == WDG_DOUBLEVALUELABEL) {
316 result = new ModuleBase_WidgetLabelValue(theParent, myWidgetApi);
317 } else if (theType == WDG_INTEGERVALUE) {
318 result = new ModuleBase_WidgetIntValue(theParent, myWidgetApi);
319 } else if (theType == WDG_SHAPE_SELECTOR) {
320 result = new ModuleBase_WidgetShapeSelector(theParent, myWorkshop, myWidgetApi);
321 } else if (theType == WDG_FEATURE_SELECTOR) {
322 result = new ModuleBase_WidgetFeatureSelector(theParent, myWorkshop, myWidgetApi);
323 } else if (theType == WDG_BOOLVALUE) {
324 result = new ModuleBase_WidgetBoolValue(theParent, myWidgetApi);
325 //} else if (theType == WDG_DOUBLEVALUE_EDITOR) {
326 // result = new ModuleBase_WidgetEditor(theParent, myWidgetApi);
327 } else if (theType == WDG_FILE_SELECTOR) {
328 result = new ModuleBase_WidgetFileSelector(theParent, myWidgetApi);
329 } else if (theType == WDG_CHOICE) {
330 result = new ModuleBase_WidgetChoice(theParent, myWidgetApi);
331 } else if (theType == WDG_STRINGVALUE) {
332 std::string aPlaceHolder = myWidgetApi->getProperty( WDG_PLACE_HOLDER );
333 result = new ModuleBase_WidgetLineEdit( theParent, myWidgetApi, aPlaceHolder );
334 } else if (theType == WDG_NAMEVALUE) {
335 std::string aPlaceHolder = myWidgetApi->getProperty( WDG_PLACE_HOLDER );
336 result = new ModuleBase_WidgetNameEdit( theParent, myWidgetApi, aPlaceHolder );
337 } else if (theType == WDG_EXPR_EDITOR) {
338 std::string aPlaceHolder = myWidgetApi->getProperty( WDG_PLACE_HOLDER );
339 result = new ModuleBase_WidgetExprEditor( theParent, myWidgetApi, aPlaceHolder );
340 } else if (theType == WDG_MULTISELECTOR) {
341 result = new ModuleBase_WidgetMultiSelector(theParent, myWorkshop, myWidgetApi);
342 } else if (theType == WDG_CONCEALED_OBJECTS_VIEW) {
343 result = new ModuleBase_WidgetConcealedObjects(theParent, myWidgetApi);
344 } else if (theType == WDG_TOOLBOX) {
345 result = new ModuleBase_WidgetToolbox(theParent, myWidgetApi);
346 } else if (theType == WDG_RADIOBOX) {
347 result = new ModuleBase_WidgetRadiobox(theParent, myWidgetApi);
348 } else if (theType == WDG_SWITCH) {
349 result = new ModuleBase_WidgetSwitch(theParent, myWidgetApi);
350 } else if (theType == WDG_TOOLBOX_BOX || theType == WDG_SWITCH_CASE ||
351 theType == NODE_VALIDATOR) {
352 // Do nothing for "box" and "case"
354 } else if (theType == WDG_ACTION) {
355 result = new ModuleBase_WidgetAction(theParent, myWidgetApi);
356 } else if (theType == WDG_POINT_INPUT) {
357 result = new ModuleBase_WidgetPointInput(theParent, myWorkshop, myWidgetApi);
358 } else if (theType == WDG_SELECTION_FILTERS) {
359 result = new ModuleBase_WidgetSelectionFilter(theParent, myWorkshop, myWidgetApi);
361 result = myWorkshop->module()->createWidgetByType(theType, theParent, myWidgetApi);
363 result = ModuleBase_WidgetCreatorFactory::get()->createWidgetByType(theType, theParent,
364 myWidgetApi, myWorkshop);
367 qDebug("ModuleBase_WidgetFactory::fillWidget: find bad widget type %s", theType.c_str());
372 myModelWidgets.append(result);
376 QString ModuleBase_WidgetFactory::qs(const std::string& theStdString)
378 return QString::fromStdString(theStdString);