Fix compilation error on Linux. Part V.

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

diff --git a/src/ModuleBase/ModuleBase_WidgetFileSelector.h b/src/ModuleBase/ModuleBase_WidgetFileSelector.h
index 2d48e430b57a4510900234ec79090b636a2616e1..b6f029fb088b9eda8c124d32a8c4617e4283b874 100644 (file)
--- a/src/ModuleBase/ModuleBase_WidgetFileSelector.h
+++ b/src/ModuleBase/ModuleBase_WidgetFileSelector.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 /*
  * ModuleBase_WidgetFileSelector.h
  *
@@ -18,27 +20,36 @@
 class QWidget;
 class QLineEdit;
 
+/**
+* \ingroup GUI
+*  Implementation of model widget for open file widget.
+*  It can be defined as following:
+*  \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
 {
   Q_OBJECT
  public:
+  /// Constructor
+  /// \param theParent the parent object
+  /// \param theData the widget configuration. The attribute of the model widget is obtained from
+  /// \param theParentId is Id of a parent of the current attribute
   ModuleBase_WidgetFileSelector(QWidget* theParent,
                                 const Config_WidgetAPI* theData,
                                 const std::string& theParentId);
   virtual ~ModuleBase_WidgetFileSelector();
 
-  /// Saves the internal parameters to the given feature
-  /// \param theObject a model feature to be changed
-  virtual bool storeValue() const;
-
-  virtual bool restoreValue();
-
-  /// Returns the internal parent wiget control, that can be shown anywhere
-  /// \returns the widget
-  QWidget* getControl() const;
-
-  /// Returns list of widget controls
-  /// \return a control list
   virtual QList<QWidget*> getControls() const;
 
   /// Returns true if a file on the current path in the line edit
@@ -46,19 +57,58 @@ class MODULEBASE_EXPORT ModuleBase_WidgetFileSelector : public ModuleBase_ModelW
   bool isCurrentPathValid();
 
  public slots:
+   /// Processing of path selection button press
   void onPathSelectionBtn();
+
+  /// Processing of path changing
   void onPathChanged();
 
- protected:
-  QStringList getSupportedFormats(const Config_WidgetAPI* theData) const;
-  QString formatsString(const QStringList theFormats) const;
+protected:
+  /// Saves the internal parameters to the given feature
+  /// \return True in success
+  virtual bool storeValueCustom() const;
+
+  virtual bool restoreValueCustom();
+
+protected:
+  /// Converts format to filter string
+  static QString formatToFilter(const QString & theFormat);
 
- private:
+  /// Returns a short format string of theFilter string
+  static QString filterToShortFormat(const QString & theFilter);
+
+  /// Returns a list of extensions from theFilter
+  static QStringList filterToExtensions(const QString & theFilter);
+
+  /// Returns list of validator formats
+  QStringList getValidatorFormats() const;
+
+  /// 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;
-  QWidget* myMainWidget;
-  QStringList myFormats;
 
+  /// A title of open file dialog box
   QString myTitle;
+
+  /// 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
+
+  /// Default path
   QString myDefaultPath;
 };