src/ModuleBase/ModuleBase_WidgetFileSelector.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * ModuleBase_WidgetFileSelector.h
   5  *
   6  *  Created on: Aug 28, 2014
   7  *      Author: sbh
   8  */
   9
  10 #ifndef MODULEBASE_WIDGETFILESELECTOR_H_
  11 #define MODULEBASE_WIDGETFILESELECTOR_H_
  12
  13 #include <ModuleBase.h>
  14 #include <ModuleBase_ModelWidget.h>
  15
  16 #include <QList>
  17 #include <QString>
  18 #include <QStringList>
  19
  20 class QWidget;
  21 class QLineEdit;
  22
  23 /**
  24 * \ingroup GUI
  25 *  Implementation of model widget for open file widget.
  26 *  It can be defined as following:
  27 *  \code
  28 *      <file_selector
  29 *          id="import_file_selector"
  30 *          title="Import file"
  31 *          path="">
  32 *          <validator id="ExchangePlugin_ImportFormat" parameters="BREP:BREPImport,STEP:STEPImport" />
  33 *      </file_selector>
  34 *  \endcode
  35 */
  36 class MODULEBASE_EXPORT ModuleBase_WidgetFileSelector : public ModuleBase_ModelWidget
  37 {
  38   Q_OBJECT
  39  public:
  40   /// Constructor
  41   /// \param theParent the parent object
  42   /// \param theData the widget configuation. The attribute of the model widget is obtained from
  43   /// \param theParentId is Id of a parent of the current attribute
  44   ModuleBase_WidgetFileSelector(QWidget* theParent,
  45                                 const Config_WidgetAPI* theData,
  46                                 const std::string& theParentId);
  47   virtual ~ModuleBase_WidgetFileSelector();
  48
  49   virtual bool restoreValue();
  50
  51   virtual QList<QWidget*> getControls() const;
  52
  53   /// Returns true if a file on the current path in the line edit
  54   /// exists and has supported format
  55   bool isCurrentPathValid();
  56
  57  public slots:
  58    /// Processing of path selection button press
  59   void onPathSelectionBtn();
  60
  61   /// Processing of path changing
  62   void onPathChanged();
  63
  64 protected:
  65   /// Saves the internal parameters to the given feature
  66   /// \return True in success
  67   virtual bool storeValueCustom() const;
  68
  69  protected:
  70    /// Returns string containing formats
  71   QString formatsString() const;
  72
  73   /// Return list of validator formats
  74   QStringList getValidatorFormats() const;
  75
  76  private:
  77    /// A control for path input
  78   QLineEdit* myPathField;
  79
  80   /// A title of open file dialog box
  81   QString myTitle;
  82
  83   /// Default path
  84   QString myDefaultPath;
  85 };
  86
  87 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */