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 email : webmaster.salome@opencascade.com<mailto: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();
156 bool isResModified = false;
158 // Make a Tab from each section
159 std::list<std::string> aSections = Config_PropManager::getSections();
160 std::list<std::string>::const_iterator it;
161 for (it = aSections.cbegin(); it != aSections.cend(); ++it) {
162 Config_Properties aProps = Config_PropManager::getProperties(*it);
163 int aTab = thePref->prefMgr()->addItem(QString((*it).c_str()), thePageId);
164 thePref->prefMgr()->setItemProperty("columns", 2, aTab);
166 Config_Properties::const_iterator aIt;
167 for (aIt = aProps.cbegin(); aIt != aProps.cend(); ++aIt) {
168 Config_Prop* aProp = (*aIt);
169 // check that the property is defined
170 QString aSection(aProp->section().c_str());
171 QString aName(aProp->name().c_str());
172 if (!aResMgr->hasValue(aSection, aName)) {
173 aResMgr->setValue(aSection, aName, QString(aProp->value().c_str()));
174 isResModified = true;
177 if (aProp->type() != Config_Prop::Disabled) {
178 SUIT_PreferenceMgr::PrefItemType aPrefType = SUIT_PreferenceMgr::Auto;
179 if (aProp->type() == Config_Prop::Directory) {
180 aPrefType = SUIT_PreferenceMgr::File;
182 aPrefType = (SUIT_PreferenceMgr::PrefItemType) aProp->type();
184 int anId = thePref->addPreference(QObject::tr(aProp->title().c_str()), aTab, aPrefType,
185 QString::fromStdString(aProp->section()),
186 QString::fromStdString(aProp->name()));
187 if(aProp->type() == Config_Prop::Directory) {
188 thePref->setItemProperty("path_type", Qtx::PT_Directory, anId);
196 * Implementation of preferences manager interface
198 class ModuleBase_PrefMgr: public ModuleBase_IPrefMgr
202 /// \param theMgr a preferences manager
203 ModuleBase_PrefMgr(ModuleBase_PreferencesMgr* theMgr):myMgr(theMgr) {}
205 virtual int addPreference(const QString& theLbl, int pId,
206 SUIT_PreferenceMgr::PrefItemType theType,
207 const QString& theSection, const QString& theName )
209 return myMgr->addItem(theLbl, pId, theType, theSection, theName);
212 virtual void setItemProperty( const QString& thePropName, const QVariant& theValue,
213 const int theId = -1) {
214 myMgr->setItemProperty(thePropName, theValue, theId);
217 virtual SUIT_PreferenceMgr* prefMgr() const { return myMgr; }
220 ModuleBase_PreferencesMgr* myMgr;
223 //**********************************************************
224 //**********************************************************
225 //**********************************************************
226 ModuleBase_PreferencesDlg::ModuleBase_PreferencesDlg(SUIT_ResourceMgr* theResurces,
228 : QDialog(theParent),
231 setWindowTitle(tr("Edit preferences"));
233 QVBoxLayout* main = new QVBoxLayout(this);
237 myPreferences = new ModuleBase_PreferencesMgr(theResurces, this);
238 main->addWidget(myPreferences);
240 setFocusProxy(myPreferences);
241 myPreferences->setFrameStyle(QFrame::Box | QFrame::Sunken);
243 QDialogButtonBox* aBtnBox = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel |
244 QDialogButtonBox::Reset,
245 Qt::Horizontal, this);
246 QPushButton* aDefaultButton = aBtnBox->button(QDialogButtonBox::Reset);
247 aDefaultButton->setText(tr("Default"));
248 connect(aDefaultButton, SIGNAL(clicked()), this, SLOT(onDefault()));
250 main->addWidget(aBtnBox);
251 connect(aBtnBox, SIGNAL(accepted()), this, SLOT(accept()));
252 connect(aBtnBox, SIGNAL(rejected()), this, SLOT(reject()));
255 myPreferences->retrieve();
256 setMinimumSize(800, 240);
259 ModuleBase_PreferencesDlg::~ModuleBase_PreferencesDlg()
263 void ModuleBase_PreferencesDlg::createEditors()
265 int aPage = myPreferences->addItem(tr("Desktop"));
266 myPreferences->setItemIcon(aPage, QIcon(":pictures/view_prefs.png"));
268 createMenuPage(aPage);
269 createViewerPage(aPage);
271 aPage = myPreferences->addItem(tr("Module"));
272 myPreferences->setItemIcon(aPage, QIcon(":pictures/module.png"));
274 ModuleBase_PrefMgr aMgr(myPreferences);
275 ModuleBase_Preferences::createEditContent(&aMgr, aPage);
278 void ModuleBase_PreferencesDlg::createViewerPage(int thePageId)
280 int viewTab = myPreferences->addItem(tr("Viewer"), thePageId);
282 QStringList gradList;
283 gradList << tr("Horizontal gradient") << tr("Vertical gradient") << tr("First diagonal gradient")
284 << tr("Second diagonal gradient") << tr("First corner gradient")
285 << tr("Second corner gradient") << tr("Third corner gradient")
286 << tr("Fourth corner gradient");
288 QList<QVariant> idList;
289 for (int i = 0; i < gradList.size(); i++)
292 int bgGroup = myPreferences->addItem(tr("Background"), viewTab);
294 QString aImgFiles("Image files (*.bmp *.gif *.pix *.xwd *.rgb *.rs)");
296 int bgId = myPreferences->addItem(tr("Viewer 3d"), bgGroup, SUIT_PreferenceMgr::Background,
297 ModuleBase_Preferences::VIEWER_SECTION, "background");
298 myPreferences->setItemProperty("gradient_names", gradList, bgId);
299 myPreferences->setItemProperty("gradient_ids", idList, bgId);
300 myPreferences->setItemProperty("texture_enabled", true, bgId);
301 myPreferences->setItemProperty("texture_center_enabled", true, bgId);
302 myPreferences->setItemProperty("texture_tile_enabled", true, bgId);
303 myPreferences->setItemProperty("texture_stretch_enabled", true, bgId);
304 myPreferences->setItemProperty("custom_enabled", false, bgId);
305 myPreferences->setItemProperty("image_formats", aImgFiles, bgId);
307 // Create other parameters group in viewer tab
308 int selectionGroup = myPreferences->addItem(tr("Default selection"), viewTab);
309 myPreferences->setItemProperty("columns", 3, selectionGroup);
310 myPreferences->addItem(tr("Faces"), selectionGroup,
311 SUIT_PreferenceMgr::Bool,
312 ModuleBase_Preferences::VIEWER_SECTION, "face-selection");
313 myPreferences->addItem(tr("Edges"), selectionGroup,
314 SUIT_PreferenceMgr::Bool,
315 ModuleBase_Preferences::VIEWER_SECTION, "edge-selection");
316 myPreferences->addItem(tr("Vertices"), selectionGroup,
317 SUIT_PreferenceMgr::Bool,
318 ModuleBase_Preferences::VIEWER_SECTION, "vertex-selection");
320 int sensitivityGroup = myPreferences->addItem(tr("Selection sensitivity"), viewTab);
321 myPreferences->setItemProperty("columns", 2, sensitivityGroup);
322 myPreferences->addItem(tr("Vertex"), sensitivityGroup, SUIT_PreferenceMgr::Double,
323 ModuleBase_Preferences::VIEWER_SECTION, "point-selection-sensitivity");
324 myPreferences->addItem(tr("Edge"), sensitivityGroup, SUIT_PreferenceMgr::Double,
325 ModuleBase_Preferences::VIEWER_SECTION, "edge-selection-sensitivity");
328 void ModuleBase_PreferencesDlg::createMenuPage(int thePageId)
330 int aMenuTab = myPreferences->addItem(tr("Main menu"), thePageId);
332 int aSizeGroup = myPreferences->addItem(tr("Size"), aMenuTab);
333 myPreferences->setItemProperty("columns", 1, aSizeGroup);
335 int aRowsNb = myPreferences->addItem(tr("Number of rows"), aSizeGroup,
336 SUIT_PreferenceMgr::IntSpin,
337 ModuleBase_Preferences::MENU_SECTION,
339 myPreferences->setItemProperty("min", 1, aRowsNb);
340 myPreferences->setItemProperty("max", 6, aRowsNb);
342 myPreferences->addItem(tr("Show Status Bar"), aSizeGroup,
343 SUIT_PreferenceMgr::Bool, ModuleBase_Preferences::MENU_SECTION,
347 void ModuleBase_PreferencesDlg::accept()
349 myPreferences->store();
352 // Save custom properties
353 ModuleBase_Preferences::updateConfigByResources();
357 void ModuleBase_PreferencesDlg::modified(ModuleBase_Prefs& theModified) const
359 theModified = myPreferences->modified();
362 void ModuleBase_PreferencesDlg::onDefault()
364 // reset main resources. It throwns all resource manager items to the
365 // initial/default state. If there is no a default state of the item,
366 // it will be filled with an empty value. It concernerned to plugin
367 // config items, like visualization color. The main xml do not contains
368 // default values for them. So, it is important to reset the config
369 // properties after reseting the resources preferences.
370 ModuleBase_Preferences::resetResourcePreferences(myPreferences);
371 // reset plugin's resources. It fills the config resources with the default
372 // values, stores result in the resource manager and retrieve the preferences
373 // items with these values.
374 ModuleBase_Preferences::resetConfigPropPreferences(myPreferences);
377 //**********************************************************
378 //**********************************************************
379 //**********************************************************
380 void ModuleBase_PreferencesMgr::changedResources(const ResourceMap& theMap)
383 ResourceMap::ConstIterator it;
385 for (it = theMap.begin(); it != theMap.end(); ++it) {
386 ModuleBase_Pref aPref;
387 it.key()->resource(aPref.first, aPref.second);
388 myModified.append(aPref);