1 // Copyright (C) 2014-2020 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_Preferences.h"
21 //#include "ModuleBase_Constants.h"
23 #include <Config_PropManager.h>
25 #include <TopAbs_ShapeEnum.hxx>
27 #include <SUIT_ResourceMgr.h>
28 #include <SUIT_PreferenceMgr.h>
32 #include <QApplication>
33 #include <QDialogButtonBox>
34 #include <QPushButton>
36 const QString ModuleBase_Preferences::VIEWER_SECTION = "Viewer";
37 const QString ModuleBase_Preferences::MENU_SECTION = "Menu";
39 SUIT_ResourceMgr* ModuleBase_Preferences::myResourceMgr = 0;
41 SUIT_ResourceMgr* ModuleBase_Preferences::resourceMgr()
44 myResourceMgr = new SUIT_ResourceMgr("SHAPER");
45 myResourceMgr->setCurrentFormat("xml");
50 bool ModuleBase_Preferences::editPreferences(ModuleBase_Prefs& theModified)
52 ModuleBase_PreferencesDlg aDlg(resourceMgr(), QApplication::activeWindow());
54 if (aDlg.isChanged()) {
55 aDlg.modified(theModified);
56 resourceMgr()->save();
62 void ModuleBase_Preferences::updateConfigByResources()
64 Config_Properties aProps = Config_PropManager::getProperties();
65 Config_Properties::iterator aIt;
66 for (aIt = aProps.begin(); aIt != aProps.end(); ++aIt) {
67 Config_Prop* aProp = (*aIt);
68 QString aVal = myResourceMgr->stringValue(QString(aProp->section().c_str()),
69 QString(aProp->name().c_str()));
70 if (!aVal.isEmpty()) {
71 aProp->setValue(aVal.toStdString());
76 void ModuleBase_Preferences::updateResourcesByConfig()
78 Config_Properties aProps = Config_PropManager::getProperties();
79 Config_Properties::iterator aIt;
80 for (aIt = aProps.begin(); aIt != aProps.end(); ++aIt) {
81 Config_Prop* aProp = (*aIt);
82 myResourceMgr->setValue(QString(aProp->section().c_str()), QString(aProp->name().c_str()),
83 QString(aProp->value().c_str()));
87 void ModuleBase_Preferences::resetConfig()
89 Config_Properties aProps = Config_PropManager::getProperties();
90 Config_Properties::iterator aIt;
91 for (aIt = aProps.begin(); aIt != aProps.end(); ++aIt) {
92 Config_Prop* aProp = (*aIt);
93 aProp->setValue(aProp->defaultValue());
97 void ModuleBase_Preferences::loadCustomProps()
101 QStringList aSections = myResourceMgr->sections();
102 foreach (QString aSection, aSections)
104 QStringList aParams = myResourceMgr->parameters(aSection);
105 foreach (QString aParam, aParams)
107 Config_Prop* aProp = Config_PropManager::registerProp(aSection.toStdString(),
108 aParam.toStdString(), "", Config_Prop::Disabled);
109 aProp->setValue(myResourceMgr->stringValue(aSection, aParam).toStdString());
115 void ModuleBase_Preferences::createEditContent(ModuleBase_IPrefMgr* thePref, int thePage)
117 thePref->prefMgr()->setItemIcon(thePage, QIcon(":pictures/module.png"));
118 createCustomPage(thePref, thePage);
121 void ModuleBase_Preferences::resetResourcePreferences(SUIT_PreferenceMgr* thePref)
126 QtxResourceMgr::WorkingMode aPrev =
127 thePref->resourceMgr()->setWorkingMode(QtxResourceMgr::IgnoreUserValues);
129 thePref->resourceMgr()->setWorkingMode(aPrev);
132 void ModuleBase_Preferences::resetConfigPropPreferences(SUIT_PreferenceMgr* thePref)
135 updateResourcesByConfig();
137 // retrieve the reset resource values to the preferences items
138 Config_Properties aProps = Config_PropManager::getProperties();
139 Config_Properties::iterator aIt;
141 QStringList aSections;
142 for (aIt = aProps.begin(); aIt != aProps.end(); ++aIt) {
143 Config_Prop* aProp = (*aIt);
144 aValues.append(QString(aProp->name().c_str()));
145 if (!aSections.contains(aProp->section().c_str()))
146 aSections.append(aProp->section().c_str());
147 QtxPreferenceItem* anItem = thePref->findItem(QString(aProp->title().c_str()), true);
153 void ModuleBase_Preferences::createCustomPage(ModuleBase_IPrefMgr* thePref, int thePageId)
155 SUIT_ResourceMgr* aResMgr = ModuleBase_Preferences::resourceMgr();
157 // Make a Tab from each section
158 std::list<std::string> aSections = Config_PropManager::getSections();
159 std::list<std::string>::const_iterator it;
160 for (it = aSections.cbegin(); it != aSections.cend(); ++it) {
161 Config_Properties aProps = Config_PropManager::getProperties(*it);
162 int aTab = thePref->prefMgr()->addItem(QString((*it).c_str()), thePageId);
163 thePref->prefMgr()->setItemProperty("columns", 2, aTab);
165 Config_Properties::const_iterator aIt;
166 for (aIt = aProps.cbegin(); aIt != aProps.cend(); ++aIt) {
167 Config_Prop* aProp = (*aIt);
168 // check that the property is defined
169 QString aSection(aProp->section().c_str());
170 QString aName(aProp->name().c_str());
171 if (!aResMgr->hasValue(aSection, aName))
172 aResMgr->setValue(aSection, aName, QString(aProp->value().c_str()));
175 if (aProp->type() != Config_Prop::Disabled) {
176 SUIT_PreferenceMgr::PrefItemType aPrefType = SUIT_PreferenceMgr::Auto;
177 switch (aProp->type()) {
178 case Config_Prop::Directory:
179 aPrefType = SUIT_PreferenceMgr::File;
181 case Config_Prop::Cursor:
182 aPrefType = SUIT_PreferenceMgr::Selector;
185 aPrefType = (SUIT_PreferenceMgr::PrefItemType) aProp->type();
188 int anId = thePref->addPreference(QObject::tr(aProp->title().c_str()), aTab, aPrefType,
189 QString::fromStdString(aProp->section()),
190 QString::fromStdString(aProp->name()));
192 switch (aProp->type()) {
193 case Config_Prop::Directory:
194 thePref->setItemProperty("path_type", Qtx::PT_Directory, anId);
196 case SUIT_PreferenceMgr::DblSpin:
197 if (aProp->min() != "") {
198 double aMin = QString(aProp->min().c_str()).toDouble();
199 thePref->setItemProperty("min", aMin, anId);
201 if (aProp->max() != "") {
202 double aMax = QString(aProp->max().c_str()).toDouble();
203 thePref->setItemProperty("max", aMax, anId);
206 case SUIT_PreferenceMgr::IntSpin:
207 if (aProp->min() != "") {
208 int aMin = QString(aProp->min().c_str()).toInt();
209 thePref->setItemProperty("min", aMin, anId);
211 if (aProp->max() != "") {
212 int aMax = QString(aProp->max().c_str()).toInt();
213 thePref->setItemProperty("max", aMax, anId);
216 case Config_Prop::Cursor:
218 QList<QVariant> aIndicesList;
219 QList<QVariant> aIconsList;
220 aIndicesList << 0 << 1 << 2;
221 aIconsList << QPixmap(":pictures/ArrowCursor.png") <<
222 QPixmap(":pictures/CrossCursor.png") <<
223 QPixmap(":pictures/HandCursor.png");
225 thePref->setItemProperty("indexes", aIndicesList, anId);
226 thePref->setItemProperty("icons", aIconsList, anId);
229 default: // [to avoid compilation warnings]
238 * Implementation of preferences manager interface
240 class ModuleBase_PrefMgr: public ModuleBase_IPrefMgr
244 /// \param theMgr a preferences manager
245 ModuleBase_PrefMgr(ModuleBase_PreferencesMgr* theMgr):myMgr(theMgr) {}
247 virtual int addPreference(const QString& theLbl, int pId,
248 SUIT_PreferenceMgr::PrefItemType theType,
249 const QString& theSection, const QString& theName )
251 return myMgr->addItem(theLbl, pId, theType, theSection, theName);
254 virtual void setItemProperty( const QString& thePropName, const QVariant& theValue,
255 const int theId = -1) {
256 myMgr->setItemProperty(thePropName, theValue, theId);
259 virtual SUIT_PreferenceMgr* prefMgr() const { return myMgr; }
262 ModuleBase_PreferencesMgr* myMgr;
265 //**********************************************************
266 //**********************************************************
267 //**********************************************************
268 ModuleBase_PreferencesDlg::ModuleBase_PreferencesDlg(SUIT_ResourceMgr* theResurces,
271 Qt::Dialog | Qt::CustomizeWindowHint | Qt::WindowTitleHint | Qt::WindowCloseButtonHint),
274 setWindowTitle(tr("Edit preferences"));
276 QVBoxLayout* main = new QVBoxLayout(this);
280 myPreferences = new ModuleBase_PreferencesMgr(theResurces, this);
281 main->addWidget(myPreferences);
283 setFocusProxy(myPreferences);
284 myPreferences->setFrameStyle(QFrame::Box | QFrame::Sunken);
286 QDialogButtonBox* aBtnBox = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel |
287 QDialogButtonBox::Reset,
288 Qt::Horizontal, this);
289 QPushButton* aDefaultButton = aBtnBox->button(QDialogButtonBox::Reset);
290 aDefaultButton->setText(tr("Default"));
291 connect(aDefaultButton, SIGNAL(clicked()), this, SLOT(onDefault()));
293 main->addWidget(aBtnBox);
294 connect(aBtnBox, SIGNAL(accepted()), this, SLOT(accept()));
295 connect(aBtnBox, SIGNAL(rejected()), this, SLOT(reject()));
298 myPreferences->retrieve();
301 ModuleBase_PreferencesDlg::~ModuleBase_PreferencesDlg()
305 void ModuleBase_PreferencesDlg::createEditors()
307 int aPage = myPreferences->addItem(tr("Desktop"));
308 myPreferences->setItemIcon(aPage, QIcon(":pictures/view_prefs.png"));
310 createMenuPage(aPage);
311 createViewerPage(aPage);
313 aPage = myPreferences->addItem(tr("Module"));
314 myPreferences->setItemIcon(aPage, QIcon(":pictures/module.png"));
316 ModuleBase_PrefMgr aMgr(myPreferences);
317 ModuleBase_Preferences::createEditContent(&aMgr, aPage);
320 void ModuleBase_PreferencesDlg::createViewerPage(int thePageId)
322 int viewTab = myPreferences->addItem(tr("Viewer"), thePageId);
324 QStringList gradList;
325 gradList << tr("Horizontal gradient") << tr("Vertical gradient") << tr("First diagonal gradient")
326 << tr("Second diagonal gradient") << tr("First corner gradient")
327 << tr("Second corner gradient") << tr("Third corner gradient")
328 << tr("Fourth corner gradient");
330 QList<QVariant> idList;
331 for (int i = 0; i < gradList.size(); i++)
334 int bgGroup = myPreferences->addItem(tr("Background"), viewTab);
336 QString aImgFiles("Image files (*.bmp *.gif *.pix *.xwd *.rgb *.rs)");
338 int bgId = myPreferences->addItem(tr("Viewer 3d"), bgGroup, SUIT_PreferenceMgr::Background,
339 ModuleBase_Preferences::VIEWER_SECTION, "background");
340 myPreferences->setItemProperty("gradient_names", gradList, bgId);
341 myPreferences->setItemProperty("gradient_ids", idList, bgId);
342 myPreferences->setItemProperty("texture_enabled", true, bgId);
343 myPreferences->setItemProperty("texture_center_enabled", true, bgId);
344 myPreferences->setItemProperty("texture_tile_enabled", true, bgId);
345 myPreferences->setItemProperty("texture_stretch_enabled", true, bgId);
346 myPreferences->setItemProperty("custom_enabled", false, bgId);
347 myPreferences->setItemProperty("image_formats", aImgFiles, bgId);
349 // Create other parameters group in viewer tab
350 int selectionGroup = myPreferences->addItem(tr("Default selection"), viewTab);
351 myPreferences->setItemProperty("columns", 3, selectionGroup);
352 myPreferences->addItem(tr("Faces"), selectionGroup,
353 SUIT_PreferenceMgr::Bool,
354 ModuleBase_Preferences::VIEWER_SECTION, "face-selection");
355 myPreferences->addItem(tr("Edges"), selectionGroup,
356 SUIT_PreferenceMgr::Bool,
357 ModuleBase_Preferences::VIEWER_SECTION, "edge-selection");
358 myPreferences->addItem(tr("Vertices"), selectionGroup,
359 SUIT_PreferenceMgr::Bool,
360 ModuleBase_Preferences::VIEWER_SECTION, "vertex-selection");
362 int sensitivityGroup = myPreferences->addItem(tr("Selection sensitivity"), viewTab);
363 myPreferences->setItemProperty("columns", 2, sensitivityGroup);
364 myPreferences->addItem(tr("Vertex"), sensitivityGroup, SUIT_PreferenceMgr::DblSpin,
365 ModuleBase_Preferences::VIEWER_SECTION, "point-selection-sensitivity");
366 myPreferences->addItem(tr("Edge"), sensitivityGroup, SUIT_PreferenceMgr::DblSpin,
367 ModuleBase_Preferences::VIEWER_SECTION, "edge-selection-sensitivity");
369 int highlightGroup = myPreferences->addItem(tr("Additional highlighting"), viewTab);
370 myPreferences->setItemProperty("columns", 2, highlightGroup);
371 myPreferences->addItem(tr("In 3d mode"), highlightGroup,
372 SUIT_PreferenceMgr::Bool, ModuleBase_Preferences::VIEWER_SECTION, "highlighting-3d");
373 myPreferences->addItem(tr("In 2d mode"), highlightGroup,
374 SUIT_PreferenceMgr::Bool, ModuleBase_Preferences::VIEWER_SECTION, "highlighting-2d");
376 int colorScaleGroup = myPreferences->addItem(tr("Color scale"), viewTab);
377 myPreferences->setItemProperty("columns", 4, colorScaleGroup);
378 int aItem = myPreferences->addItem(tr("X position"), colorScaleGroup,
379 SUIT_PreferenceMgr::Double, ModuleBase_Preferences::VIEWER_SECTION, "scalar_bar_x_position");
380 myPreferences->setItemProperty("min", 0, aItem);
381 myPreferences->setItemProperty("max", 1, aItem);
383 aItem = myPreferences->addItem(tr("Y position"), colorScaleGroup,
384 SUIT_PreferenceMgr::Double, ModuleBase_Preferences::VIEWER_SECTION, "scalar_bar_y_position");
385 myPreferences->setItemProperty("min", 0, aItem);
386 myPreferences->setItemProperty("max", 1, aItem);
388 aItem = myPreferences->addItem(tr("Width"), colorScaleGroup,
389 SUIT_PreferenceMgr::Double, ModuleBase_Preferences::VIEWER_SECTION, "scalar_bar_width");
390 myPreferences->setItemProperty("min", 0, aItem);
391 myPreferences->setItemProperty("max", 1, aItem);
393 aItem = myPreferences->addItem(tr("Height"), colorScaleGroup,
394 SUIT_PreferenceMgr::Double, ModuleBase_Preferences::VIEWER_SECTION, "scalar_bar_height");
395 myPreferences->setItemProperty("min", 0, aItem);
396 myPreferences->setItemProperty("max", 1, aItem);
398 aItem = myPreferences->addItem(tr("Intervals number"), colorScaleGroup,
399 SUIT_PreferenceMgr::Integer, ModuleBase_Preferences::VIEWER_SECTION, "scalar_bar_nb_intervals");
400 myPreferences->setItemProperty("min", 0, aItem);
401 myPreferences->setItemProperty("max", 100, aItem);
403 aItem = myPreferences->addItem(tr("Text height"), colorScaleGroup,
404 SUIT_PreferenceMgr::Integer, ModuleBase_Preferences::VIEWER_SECTION, "scalar_bar_text_height");
405 myPreferences->setItemProperty("min", 0, aItem);
406 myPreferences->setItemProperty("max", 100, aItem);
408 aItem = myPreferences->addItem(tr("Text color"), colorScaleGroup,
409 SUIT_PreferenceMgr::Color, ModuleBase_Preferences::VIEWER_SECTION, "scalar_bar_text_color");
412 void ModuleBase_PreferencesDlg::createMenuPage(int thePageId)
414 int aMenuTab = myPreferences->addItem(tr("Main menu"), thePageId);
416 int aSizeGroup = myPreferences->addItem(tr("Size"), aMenuTab);
417 myPreferences->setItemProperty("columns", 1, aSizeGroup);
419 int aRowsNb = myPreferences->addItem(tr("Number of rows"), aSizeGroup,
420 SUIT_PreferenceMgr::IntSpin,
421 ModuleBase_Preferences::MENU_SECTION,
423 myPreferences->setItemProperty("min", 1, aRowsNb);
424 myPreferences->setItemProperty("max", 6, aRowsNb);
426 myPreferences->addItem(tr("Show Status Bar"), aSizeGroup,
427 SUIT_PreferenceMgr::Bool, ModuleBase_Preferences::MENU_SECTION,
431 void ModuleBase_PreferencesDlg::accept()
433 myPreferences->store();
436 // Save custom properties
437 ModuleBase_Preferences::updateConfigByResources();
441 void ModuleBase_PreferencesDlg::modified(ModuleBase_Prefs& theModified) const
443 theModified = myPreferences->modified();
446 void ModuleBase_PreferencesDlg::onDefault()
448 // reset main resources. It throwns all resource manager items to the
449 // initial/default state. If there is no a default state of the item,
450 // it will be filled with an empty value. It concernerned to plugin
451 // config items, like visualization color. The main xml do not contains
452 // default values for them. So, it is important to reset the config
453 // properties after reseting the resources preferences.
454 ModuleBase_Preferences::resetResourcePreferences(myPreferences);
455 // reset plugin's resources. It fills the config resources with the default
456 // values, stores result in the resource manager and retrieve the preferences
457 // items with these values.
458 ModuleBase_Preferences::resetConfigPropPreferences(myPreferences);
461 void ModuleBase_PreferencesDlg::showEvent(QShowEvent* theEvent)
463 QDialog::showEvent(theEvent);
467 //**********************************************************
468 //**********************************************************
469 //**********************************************************
470 void ModuleBase_PreferencesMgr::changedResources(const ResourceMap& theMap)
473 ResourceMap::ConstIterator it;
475 for (it = theMap.begin(); it != theMap.end(); ++it) {
476 ModuleBase_Pref aPref;
477 it.key()->resource(aPref.first, aPref.second);
478 myModified.append(aPref);