1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
4 * ModuleBase_WidgetFileSelector.h
6 * Created on: Aug 28, 2014
10 #ifndef MODULEBASE_WIDGETFILESELECTOR_H_
11 #define MODULEBASE_WIDGETFILESELECTOR_H_
13 #include <ModuleBase.h>
14 #include <ModuleBase_ModelWidget.h>
18 #include <QStringList>
25 * Implementation of model widget for open file widget.
26 * It can be defined as following:
29 * id="import_file_selector"
33 * <validator id="ExchangePlugin_ImportFormat" parameters="BREP:BREPImport,STEP:STEPImport" />
36 * It can use following parameters:
37 * - id - name of object attribute
38 * - type - type of dialog. Possible values: open, save.
40 class MODULEBASE_EXPORT ModuleBase_WidgetFileSelector : public ModuleBase_ModelWidget
45 /// \param theParent the parent object
46 /// \param theData the widget configuration. The attribute of the model widget is obtained from
47 /// \param theParentId is Id of a parent of the current attribute
48 ModuleBase_WidgetFileSelector(QWidget* theParent,
49 const Config_WidgetAPI* theData,
50 const std::string& theParentId);
51 virtual ~ModuleBase_WidgetFileSelector();
53 virtual QList<QWidget*> getControls() const;
55 /// Returns true if a file on the current path in the line edit
56 /// exists and has supported format
57 bool isCurrentPathValid();
60 /// Processing of path selection button press
61 void onPathSelectionBtn();
63 /// Processing of path changing
67 /// Saves the internal parameters to the given feature
68 /// \return True in success
69 virtual bool storeValueCustom() const;
71 virtual bool restoreValueCustom();
74 /// Converts format to filter string
75 static QString formatToFilter(const QString & theFormat);
77 /// Returns a short format string of theFilter string
78 static QString filterToShortFormat(const QString & theFilter);
80 /// Returns a list of extensions from theFilter
81 static QStringList filterToExtensions(const QString & theFilter);
83 /// Returns list of validator formats
84 QStringList getValidatorFormats() const;
86 /// Returns string containing formats
87 QString filterString() const;
89 /// Add an extension to file name if the extension is not defined
90 /// \param theFileName a file name
91 /// \param theFilter a file filter
92 /// \return the file name with extension
93 static QString applyExtension(const QString& theFileName, const QString& theFilter);
96 /// A control for path input
97 QLineEdit* myPathField;
99 /// A title of open file dialog box
103 QString mySelectedFilter;
105 /// A title of open file dialog box
106 enum { WFS_OPEN, WFS_SAVE } myType;
109 QString myDefaultPath;
112 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */