updated copyright message

[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetFileSelector.h

diff --git a/src/ModuleBase/ModuleBase_WidgetFileSelector.h b/src/ModuleBase/ModuleBase_WidgetFileSelector.h
index 4f64d215ca7ebdeec9fdfd2192d1f7fd6f4ddb7c..8de9b9ecc071c7ce7f24836d89a54f4e8bca7b96 100644 (file)
--- a/src/ModuleBase/ModuleBase_WidgetFileSelector.h
+++ b/src/ModuleBase/ModuleBase_WidgetFileSelector.h
@@ -1,11 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * ModuleBase_WidgetFileSelector.h
- *
- *  Created on: Aug 28, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2023  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef MODULEBASE_WIDGETFILESELECTOR_H_
 #define MODULEBASE_WIDGETFILESELECTOR_H_
@@ -17,8 +27,9 @@
 #include <QString>
 #include <QStringList>
 
-class QWidget;
+class QFileDialog;
 class QLineEdit;
+class QWidget;
 
 /**
 * \ingroup GUI
@@ -27,11 +38,15 @@ class QLineEdit;
 *  \code
 *      <file_selector
 *          id="import_file_selector"
+*          type="open"
 *          title="Import file"
 *          path="">
 *          <validator id="ExchangePlugin_ImportFormat" parameters="BREP:BREPImport,STEP:STEPImport" />
 *      </file_selector>
 *  \endcode
+* It can use following parameters:
+* - id - name of object attribute
+* - type - type of dialog. Possible values: open, save.
 */
 class MODULEBASE_EXPORT ModuleBase_WidgetFileSelector : public ModuleBase_ModelWidget
 {
@@ -39,24 +54,18 @@ class MODULEBASE_EXPORT ModuleBase_WidgetFileSelector : public ModuleBase_ModelW
  public:
   /// Constructor
   /// \param theParent the parent object
-  /// \param theData the widget configuation. The attribute of the model widget is obtained from
-  /// \param theParentId is Id of a parent of the current attribute
+  /// \param theData the widget configuration. The attribute of the model widget is obtained from
   ModuleBase_WidgetFileSelector(QWidget* theParent,
-                                const Config_WidgetAPI* theData,
-                                const std::string& theParentId);
+                                const Config_WidgetAPI* theData);
   virtual ~ModuleBase_WidgetFileSelector();
 
-  virtual bool restoreValue();
-
-  QWidget* getControl() const;
-
   virtual QList<QWidget*> getControls() const;
 
   /// Returns true if a file on the current path in the line edit
   /// exists and has supported format
   bool isCurrentPathValid();
 
- public slots:
+public slots:
    /// Processing of path selection button press
   void onPathSelectionBtn();
 
@@ -64,29 +73,53 @@ class MODULEBASE_EXPORT ModuleBase_WidgetFileSelector : public ModuleBase_ModelW
   void onPathChanged();
 
 protected:
+  /// Reject the current editor dialog if it is shown and returns true.
+  virtual bool processEscape();
+
   /// Saves the internal parameters to the given feature
   /// \return True in success
-  virtual bool storeValueCustom() const;
+  virtual bool storeValueCustom();
+
+  virtual bool restoreValueCustom();
+
+protected:
+  /// Converts format to filter string
+  static QString formatToFilter(const QString & theFormat);
+
+  /// Returns a short format string of theFilter string
+  static QString filterToShortFormat(const QString & theFilter);
 
- protected:
-   /// Returns string containing formats
-  QString formatsString() const;
+  /// Returns a list of extensions from theFilter
+  static QStringList filterToExtensions(const QString & theFilter);
 
-  /// Return list of validator formats
+  /// Returns list of validator formats
   QStringList getValidatorFormats() const;
 
- private:
+  /// Returns string containing formats
+  QString filterString() const;
+
+  /// Add an extension to file name if the extension is not defined
+  /// \param theFileName a file name
+  /// \param theFilter a file filter
+  /// \return the file name with extension
+  static QString applyExtension(const QString& theFileName, const QString& theFilter);
+
+protected:
    /// A control for path input
   QLineEdit* myPathField;
-
-  /// Container
-  QWidget* myMainWidget;
+  QFileDialog* myFileDialog; ///< started dialog
 
   /// A title of open file dialog box
   QString myTitle;
 
-  /// Default path
-  QString myDefaultPath;
+  /// A current format
+  QString mySelectedFilter;
+
+  /// A title of open file dialog box
+  enum {
+    WFS_OPEN, ///< open file
+    WFS_SAVE ///< save file
+  } myType; ///< type of dialog
 };
 
 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */