src/ModuleBase/ModuleBase_WidgetFileSelector.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * ModuleBase_WidgetFileSelector.cpp
   5  *
   6  *  Created on: Aug 28, 2014
   7  *      Author: sbh
   8  */
   9
  10 #include <ModelAPI_AttributeString.h>
  11 #include <ModelAPI_Data.h>
  12 #include <ModelAPI_Object.h>
  13 #include <ModelAPI_Validator.h>
  14 #include <ModelAPI_Session.h>
  15 #include <ModuleBase_WidgetFileSelector.h>
  16 #include <ModuleBase_Tools.h>
  17
  18 #include <Config_WidgetAPI.h>
  19
  20 #include <QFileDialog>
  21 #include <QGridLayout>
  22 #include <QLabel>
  23 #include <QLineEdit>
  24 #include <QList>
  25 #include <QObject>
  26 #include <QPushButton>
  27 #include <QRegExp>
  28 #include <QString>
  29
  30 #include <memory>
  31 #include <string>
  32
  33 ModuleBase_WidgetFileSelector::ModuleBase_WidgetFileSelector(QWidget* theParent,
  34                                                              const Config_WidgetAPI* theData,
  35                                                              const std::string& theParentId)
  36     : ModuleBase_ModelWidget(theParent, theData, theParentId)
  37 {
  38   myTitle = QString::fromStdString(theData->getProperty("title"));
  39   myType = (theData->getProperty("type") == "save") ? WFS_SAVE : WFS_OPEN;
  40   myDefaultPath = QString::fromStdString(theData->getProperty("path"));
  41
  42   QGridLayout* aMainLay = new QGridLayout(this);
  43   ModuleBase_Tools::adjustMargins(aMainLay);
  44   QLabel* aTitleLabel = new QLabel(myTitle, this);
  45   aTitleLabel->setIndent(1);
  46   aMainLay->addWidget(aTitleLabel, 0, 0);
  47   myPathField = new QLineEdit(this);
  48   aMainLay->addWidget(myPathField, 1, 0);
  49   QPushButton* aSelectPathBtn = new QPushButton("...", this);
  50   aSelectPathBtn->setToolTip(tr("Select file..."));
  51   aSelectPathBtn->setMaximumWidth(20);
  52   aSelectPathBtn->setMaximumHeight(20);
  53   aMainLay->addWidget(aSelectPathBtn, 1, 1);
  54   aMainLay->setColumnStretch(0, 1);
  55   myPathField->setMinimumHeight(20);
  56   aMainLay->setHorizontalSpacing(1);
  57   this->setLayout(aMainLay);
  58
  59   connect(myPathField, SIGNAL(textChanged(const QString&)),
  60           this,        SLOT(onPathChanged()));
  61   connect(aSelectPathBtn, SIGNAL(clicked()),
  62           this,        SLOT(onPathSelectionBtn()));
  63 }
  64
  65 ModuleBase_WidgetFileSelector::~ModuleBase_WidgetFileSelector()
  66 {
  67 }
  68
  69 bool ModuleBase_WidgetFileSelector::storeValueCustom() const
  70 {
  71   // A rare case when plugin was not loaded.
  72   if (!myFeature)
  73     return false;
  74   DataPtr aData = myFeature->data();
  75   AttributeStringPtr aStringAttr = aData->string(attributeID());
  76   QString aWidgetValue = myPathField->text();
  77   aStringAttr->setValue(aWidgetValue.toStdString());
  78   updateObject(myFeature);
  79   return true;
  80 }
  81
  82 bool ModuleBase_WidgetFileSelector::restoreValueCustom()
  83 {
  84   // A rare case when plugin was not loaded.
  85   if (!myFeature)
  86     return false;
  87   DataPtr aData = myFeature->data();
  88   AttributeStringPtr aStringAttr = aData->string(attributeID());
  89
  90   bool isBlocked = myPathField->blockSignals(true);
  91   QString aNewText = QString::fromStdString(aStringAttr->value());
  92   if( myPathField->text() != aNewText )
  93     myPathField->setText( aNewText );
  94   myPathField->blockSignals(isBlocked);
  95
  96   return true;
  97 }
  98
  99 QList<QWidget*> ModuleBase_WidgetFileSelector::getControls() const
 100 {
 101   QList<QWidget*> result;
 102   result << myPathField;
 103   return result;
 104 }
 105
 106 bool ModuleBase_WidgetFileSelector::isCurrentPathValid()
 107 {
 108   QFileInfo aFile(myPathField->text());
 109   return aFile.exists();
 110 }
 111
 112 void ModuleBase_WidgetFileSelector::onPathSelectionBtn()
 113 {
 114   QString aDefaultPath = myPathField->text().isEmpty()
 115       ? myDefaultPath
 116       : QFileInfo(myPathField->text()).absolutePath();
 117   QString aFilter = filterString();
 118   QString aFileName = (myType == WFS_SAVE)
 119       ? QFileDialog::getSaveFileName(this, myTitle, aDefaultPath, aFilter, &mySelectedFilter)
 120       : QFileDialog::getOpenFileName(this, myTitle, aDefaultPath, aFilter, &mySelectedFilter);
 121   if (!aFileName.isEmpty()) {
 122     if (myType == WFS_SAVE)
 123       aFileName = applyExtension(aFileName, mySelectedFilter);
 124     myPathField->setText(aFileName);
 125   }
 126 }
 127
 128 void ModuleBase_WidgetFileSelector::onPathChanged()
 129 {
 130   if (myType == WFS_OPEN && !isCurrentPathValid())
 131     return;
 132   storeValue();
 133   emit valuesChanged();
 134 }
 135
 136 QString ModuleBase_WidgetFileSelector::formatToFilter(const QString & theFormat)
 137 {
 138   if (theFormat.isEmpty() && !theFormat.contains(":"))
 139     return QString();
 140
 141   QStringList aExtesionList = theFormat.section(':', 0, 0).split("|");
 142   QString aFormat = theFormat.section(':', 1, 1);
 143   return QString("%1 files (%2)").arg(aFormat)
 144       .arg(QStringList(aExtesionList).replaceInStrings(QRegExp("^(.*)$"), "*.\\1").join(" "));
 145 }
 146
 147 QString ModuleBase_WidgetFileSelector::filterToShortFormat(const QString & theFilter)
 148 {
 149   // Simplified implementation.
 150   // It relies on theFilter was made by formatToFilter() function.
 151   return theFilter.section(' ', 0, 0);
 152 }
 153
 154 QStringList ModuleBase_WidgetFileSelector::filterToExtensions(const QString & theFilter)
 155 {
 156   // Simplified implementation.
 157   // It relies on theFilter was made by formatToFilter() function.
 158   QStringList anExtensions = theFilter.section("(", 1, 1).section(")", 0, 0).split(" ");
 159   return anExtensions;
 160 }
 161
 162 QStringList ModuleBase_WidgetFileSelector::getValidatorFormats() const
 163 {
 164   SessionPtr aMgr = ModelAPI_Session::get();
 165   ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
 166
 167   ModelAPI_ValidatorsFactory::Validators allValidators;
 168   aFactory->validators(myFeature->getKind(), myAttributeID, allValidators);
 169
 170   QStringList aResult;
 171   std::list<std::string> anArgumentList = allValidators.front().second;
 172   std::list<std::string>::const_iterator it = anArgumentList.begin();
 173   for (; it != anArgumentList.end(); ++it) {
 174     QString aFormat = QString::fromStdString(*it);
 175     if (!aFormat.isEmpty())
 176       aResult << aFormat;
 177   }
 178   return aResult;
 179 }
 180
 181 QString ModuleBase_WidgetFileSelector::filterString() const
 182 {
 183   QStringList aResult;
 184   QStringList aValidatorFormats = getValidatorFormats();
 185
 186   foreach(const QString & eachFormat, aValidatorFormats) {
 187     aResult << formatToFilter(eachFormat);
 188   }
 189   if (myType == WFS_OPEN)
 190     aResult << QString("All files (*.*)");
 191   return aResult.join(";;");
 192 }
 193
 194 QString ModuleBase_WidgetFileSelector::applyExtension(const QString& theFileName,
 195                                                       const QString& theFilter)
 196 {
 197   QString aResult = theFileName;
 198   bool hasExtension = false;
 199   QStringList anExtensions = filterToExtensions(theFilter);
 200   foreach(const QString& anExtension, anExtensions) {
 201     if (theFileName.endsWith(anExtension.section(".", 1, 1), Qt::CaseInsensitive)) {
 202       hasExtension = true;
 203       break;
 204     }
 205   }
 206   if (!hasExtension && !anExtensions.isEmpty())
 207     aResult = QString("%1.%2").arg(theFileName).arg(anExtensions[0].section(".", 1, 1));
 208   return aResult;
 209 }