1 // Copyright (C) 2014-2017 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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #include <ModuleBase_WidgetFactory.h>
22 #include <ModuleBase_IconFactory.h>
24 #include <ModuleBase_Operation.h>
25 #include <ModuleBase_OperationDescription.h>
26 #include <ModuleBase_WidgetEditor.h>
27 #include <ModuleBase_WidgetSwitch.h>
28 #include <ModuleBase_WidgetShapeSelector.h>
29 #include <ModuleBase_WidgetFeatureSelector.h>
30 #include <ModuleBase_WidgetDoubleValue.h>
31 #include <ModuleBase_WidgetLabelValue.h>
32 #include <ModuleBase_WidgetIntValue.h>
33 #include <ModuleBase_WidgetBoolValue.h>
34 #include <ModuleBase_WidgetFileSelector.h>
35 #include <ModuleBase_WidgetChoice.h>
36 #include <ModuleBase_IWorkshop.h>
37 #include <ModuleBase_IModule.h>
38 #include <ModuleBase_Tools.h>
39 #include <ModuleBase_WidgetLineEdit.h>
40 #include <ModuleBase_WidgetNameEdit.h>
41 #include <ModuleBase_WidgetMultiSelector.h>
42 #include <ModuleBase_WidgetConcealedObjects.h>
43 #include <ModuleBase_WidgetLabel.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>
54 #include <ModelAPI_Validator.h>
55 #include <ModelAPI_Session.h>
57 #include <Config_Keywords.h>
58 #include <Config_WidgetAPI.h>
61 #include <QHBoxLayout>
62 #include <QGridLayout>
64 #include <QMetaProperty>
77 ModuleBase_WidgetFactory::ModuleBase_WidgetFactory(const std::string& theXmlRepresentation,
78 ModuleBase_IWorkshop* theWorkshop)
79 : myWorkshop(theWorkshop)
81 myWidgetApi = new Config_WidgetAPI(theXmlRepresentation);
84 ModuleBase_WidgetFactory::~ModuleBase_WidgetFactory()
89 void ModuleBase_WidgetFactory::createWidget(ModuleBase_PageBase* thePage, bool alignToTop)
91 std::string aWType = myWidgetApi->widgetType();
92 if (aWType == NODE_FEATURE) {
93 // if XML definition of the feature contains the next key, the widgets should not be created,
94 // but a specific panel should be made. However, to provide persistent of the panel values,
95 // we need to get into the panel the feature of the operation. As a result this panel should
96 // be created after the feature creating(create operation). The method setPanel() of this
97 // class is used for this. Here, we just return to avoid the widgets creation.
98 std::string aPanelName = myWidgetApi->getProperty(PROPERTY_PANEL_ID);
99 if (!aPanelName.empty())
103 if (!myWidgetApi->toChildWidget())
106 do { //Iterate over each node
107 std::string aWdgType = myWidgetApi->widgetType();
108 // Create PageGroup TODO: extract
109 if (myWidgetApi->isGroupBoxWidget() ||
110 ModuleBase_WidgetCreatorFactory::get()->hasPageWidget(aWdgType)) {
112 //if current widget is groupbox (container) process it's children recursively
113 ModuleBase_PageBase* aPage = createPageByType(aWdgType, thePage->pageWidget());
116 thePage->addPageWidget(aPage);
118 // Create a ModelWidget
119 ModuleBase_ModelWidget* aWidget = createWidgetByType(aWdgType, thePage->pageWidget());
121 if (!myWidgetApi->getBooleanAttribute(ATTR_INTERNAL, false)) {
122 thePage->addModelWidget(aWidget);
124 aWidget->setVisible(false);
127 // Create PagedContainer TODO: extract
128 if (myWidgetApi->isPagedWidget()) {
129 //If current widget is toolbox or switch-casebox then fetch all
130 //it's pages recursively and setup into the widget.
131 if (myWidgetApi->toChildWidget()) {
133 QString aPageName = qs(myWidgetApi->getProperty(CONTAINER_PAGE_NAME));
134 QString aCaseId = qs(myWidgetApi->getProperty(_ID));
135 ModuleBase_PageBase* aPage = new ModuleBase_PageWidget(aWidget);
137 if (aWdgType == WDG_SWITCH || aWdgType == WDG_TOOLBOX || aWdgType == WDG_RADIOBOX) {
138 ModuleBase_PagedContainer* aContainer =
139 qobject_cast<ModuleBase_PagedContainer*>(aWidget);
141 QString anIconPath = qs( myWidgetApi->getProperty( CONTAINER_PAGE_ICON ) );
142 QPixmap anIcon = ModuleBase_IconFactory::loadPixmap( anIconPath );
143 aContainer->addPage( aPage, aPageName, aCaseId, anIcon );
145 } while (myWidgetApi->toNextWidget());
149 } while (myWidgetApi->toNextWidget());
152 thePage->alignToTop();
155 void ModuleBase_WidgetFactory::createPanel(ModuleBase_PageBase* thePage,
156 const FeaturePtr& theFeature)
158 std::string aPanelName = myWidgetApi->getProperty(PROPERTY_PANEL_ID);
159 if (!aPanelName.empty() && ModuleBase_WidgetCreatorFactory::get()->hasPanelWidget(aPanelName)) {
160 QWidget* aPanel = ModuleBase_WidgetCreatorFactory::get()->createPanelByType(aPanelName,
161 thePage->pageWidget(), theFeature);
162 thePage->addWidget(aPanel);
163 thePage->alignToTop();
167 void ModuleBase_WidgetFactory::createWidget(ModuleBase_PageBase* thePage,
168 const std::string& theWidgetId)
171 moveToWidgetId(theWidgetId, aFound);
173 std::string aWdgType = myWidgetApi->widgetType();
175 // Create a ModelWidget
176 ModuleBase_ModelWidget* aWidget = createWidgetByType(aWdgType, thePage->pageWidget());
178 if (!myWidgetApi->getBooleanAttribute(ATTR_INTERNAL, false)) {
179 thePage->addModelWidget(aWidget);
182 aWidget->setVisible(false);
186 thePage->alignToTop();
189 void ModuleBase_WidgetFactory::getAttributeTitle(const std::string& theAttributeId,
190 std::string& theTitle)
193 moveToWidgetId(theAttributeId, aFound);
195 theTitle = QString::fromStdString(myWidgetApi->widgetLabel()).toStdString().c_str();
196 if (theTitle.empty())
198 QString::fromStdString(myWidgetApi->getProperty(CONTAINER_PAGE_NAME)).toStdString().c_str();
202 void ModuleBase_WidgetFactory::getGreedAttribute(std::string& theAttributeId)
204 if (!theAttributeId.empty())
207 if (!myWidgetApi->toChildWidget())
210 do { //Iterate over each node
211 std::string aWdgType = myWidgetApi->widgetType();
212 // Find title under PageGroup
213 if (myWidgetApi->isGroupBoxWidget() ||
214 ModuleBase_WidgetCreatorFactory::get()->hasPageWidget(aWdgType)) {
215 getGreedAttribute(theAttributeId);
219 std::string anAttributeId = myWidgetApi->widgetId();
220 if (myWidgetApi->getBooleanAttribute(ATTR_GREED, false))
221 theAttributeId = anAttributeId;
222 if (theAttributeId.empty() && myWidgetApi->isPagedWidget()) {
223 //If current widget is toolbox or switch-casebox then fetch all
224 //it's pages recursively and setup into the widget.
225 if (myWidgetApi->toChildWidget()) {
227 getGreedAttribute(theAttributeId);
228 } while (theAttributeId.empty() && myWidgetApi->toNextWidget());
232 } while (theAttributeId.empty() && myWidgetApi->toNextWidget());
235 void ModuleBase_WidgetFactory::moveToWidgetId(const std::string& theWidgetId, bool& theFound)
240 if (!myWidgetApi->toChildWidget())
243 do { //Iterate over each node
244 std::string aWdgType = myWidgetApi->widgetType();
245 // Find title under PageGroup
246 if (myWidgetApi->isGroupBoxWidget() ||
247 ModuleBase_WidgetCreatorFactory::get()->hasPageWidget(aWdgType)) {
248 moveToWidgetId(theWidgetId, theFound);
252 std::string anAttributeId = myWidgetApi->widgetId();
253 theFound = anAttributeId == theWidgetId;
254 if (!theFound && myWidgetApi->isPagedWidget()) {
255 //If current widget is toolbox or switch-casebox then fetch all
256 //it's pages recursively and setup into the widget.
257 if (myWidgetApi->toChildWidget()) {
259 moveToWidgetId(theWidgetId, theFound);
260 } while (!theFound && myWidgetApi->toNextWidget());
264 } while (!theFound && myWidgetApi->toNextWidget());
267 ModuleBase_PageBase* ModuleBase_WidgetFactory::createPageByType(const std::string& theType,
270 ModuleBase_PageBase* aResult = NULL;
272 if (theType == WDG_GROUP) {
273 QString aGroupName = qs(myWidgetApi->getProperty(CONTAINER_PAGE_NAME));
274 ModuleBase_PageGroupBox* aPage = new ModuleBase_PageGroupBox(theParent);
275 aPage->setTitle(aGroupName);
278 else if (theType == WDG_OPTIONALBOX) {
279 ModuleBase_WidgetOptionalBox* aPage = new ModuleBase_WidgetOptionalBox(theParent,
284 aResult = ModuleBase_WidgetCreatorFactory::get()->createPageByType(theType, theParent,
287 ModuleBase_ModelWidget* aWidget = dynamic_cast<ModuleBase_ModelWidget*>(aResult);
289 myModelWidgets.append(aWidget);
294 ModuleBase_ModelWidget* ModuleBase_WidgetFactory::createWidgetByType(const std::string& theType,
297 ModuleBase_ModelWidget* result = NULL;
299 if (theType == WDG_INFO) {
300 result = new ModuleBase_WidgetLabel(theParent, myWidgetApi);
301 } else if (theType == WDG_DOUBLEVALUE) {
302 result = new ModuleBase_WidgetDoubleValue(theParent, myWidgetApi);
303 } else if (theType == WDG_DOUBLEVALUELABEL) {
304 result = new ModuleBase_WidgetLabelValue(theParent, myWidgetApi);
305 } else if (theType == WDG_INTEGERVALUE) {
306 result = new ModuleBase_WidgetIntValue(theParent, myWidgetApi);
307 } else if (theType == WDG_SHAPE_SELECTOR) {
308 result = new ModuleBase_WidgetShapeSelector(theParent, myWorkshop, myWidgetApi);
309 } else if (theType == WDG_FEATURE_SELECTOR) {
310 result = new ModuleBase_WidgetFeatureSelector(theParent, myWorkshop, myWidgetApi);
311 } else if (theType == WDG_BOOLVALUE) {
312 result = new ModuleBase_WidgetBoolValue(theParent, myWidgetApi);
313 //} else if (theType == WDG_DOUBLEVALUE_EDITOR) {
314 // result = new ModuleBase_WidgetEditor(theParent, myWidgetApi);
315 } else if (theType == WDG_FILE_SELECTOR) {
316 result = new ModuleBase_WidgetFileSelector(theParent, myWidgetApi);
317 } else if (theType == WDG_CHOICE) {
318 result = new ModuleBase_WidgetChoice(theParent, myWidgetApi);
319 } else if (theType == WDG_STRINGVALUE) {
320 std::string aPlaceHolder = myWidgetApi->getProperty( WDG_PLACE_HOLDER );
321 result = new ModuleBase_WidgetLineEdit( theParent, myWidgetApi, aPlaceHolder );
322 } else if (theType == WDG_NAMEVALUE) {
323 std::string aPlaceHolder = myWidgetApi->getProperty( WDG_PLACE_HOLDER );
324 result = new ModuleBase_WidgetNameEdit( theParent, myWidgetApi, aPlaceHolder );
325 } else if (theType == WDG_EXPR_EDITOR) {
326 std::string aPlaceHolder = myWidgetApi->getProperty( WDG_PLACE_HOLDER );
327 result = new ModuleBase_WidgetExprEditor( theParent, myWidgetApi, aPlaceHolder );
328 } else if (theType == WDG_MULTISELECTOR) {
329 result = new ModuleBase_WidgetMultiSelector(theParent, myWorkshop, myWidgetApi);
330 } else if (theType == WDG_CONCEALED_OBJECTS_VIEW) {
331 result = new ModuleBase_WidgetConcealedObjects(theParent, myWidgetApi);
332 } else if (theType == WDG_TOOLBOX) {
333 result = new ModuleBase_WidgetToolbox(theParent, myWidgetApi);
334 } else if (theType == WDG_RADIOBOX) {
335 result = new ModuleBase_WidgetRadiobox(theParent, myWidgetApi);
336 } else if (theType == WDG_SWITCH) {
337 result = new ModuleBase_WidgetSwitch(theParent, myWidgetApi);
338 } else if (theType == WDG_TOOLBOX_BOX || theType == WDG_SWITCH_CASE ||
339 theType == NODE_VALIDATOR) {
340 // Do nothing for "box" and "case"
342 } else if (theType == WDG_ACTION) {
343 result = new ModuleBase_WidgetAction(theParent, myWidgetApi);
345 result = myWorkshop->module()->createWidgetByType(theType, theParent, myWidgetApi);
347 result = ModuleBase_WidgetCreatorFactory::get()->createWidgetByType(theType, theParent,
348 myWidgetApi, myWorkshop);
351 qDebug("ModuleBase_WidgetFactory::fillWidget: find bad widget type %s", theType.c_str());
356 myModelWidgets.append(result);
360 QString ModuleBase_WidgetFactory::qs(const std::string& theStdString)
362 return QString::fromStdString(theStdString);