0029748: Samples - Inspector tool - use recently opened files in TInspectorEXE
[occt.git] / tools / TInspectorEXE / TInspectorEXE_OpenFileDialog.hxx
1 // Created on: 2017-06-16
2 // Created by: Natalia ERMOLAEVA
3 // Copyright (c) 2017 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement. 
15
16 #ifndef TInspectorEXE_OpenFileDialog_H
17 #define TInspectorEXE_OpenFileDialog_H
18
19 #include <inspector/TInspectorAPI_PreferencesDataMap.hxx>
20
21 #include <NCollection_DataMap.hxx>
22 #include <NCollection_List.hxx>
23 #include <TCollection_AsciiString.hxx>
24
25 #include <Standard_WarningsDisable.hxx>
26 #include <QDialog>
27 #include <QItemSelection>
28 #include <QStringList>
29 #include <Standard_WarningsRestore.hxx>
30
31 #include <map>
32
33 class TInspector_Communicator;
34
35 class QAbstractItemModel;
36 class QLineEdit;
37 class QPushButton;
38 class QTableView;
39 class QToolButton;
40 class QWidget;
41
42 //! \class TInspectorEXE_OpenButton
43 //! Class that contains push button and the button processing. It obtains a file name from the default or current
44 //! directory and gives the name into TInspector communicator
45 //! Object name of the button is the name of the plugin to get the default directory, or the current directory is used.
46 class TInspectorEXE_OpenButton : public QObject
47 {
48   Q_OBJECT
49
50 public:
51
52   //! Constructor
53   TInspectorEXE_OpenButton (QObject* theParent) : QObject (theParent), myStartButton (0) {}
54
55   //! Destructor
56   virtual ~TInspectorEXE_OpenButton() {}
57
58   //! Returns the start button, if this is the first call, it creates the button and connect it to the slot
59   QPushButton* StartButton();
60
61   //! Sets the default directory of plugin.
62   void SetPluginRecentlyOpenedFiles (const TCollection_AsciiString& thePluginName,
63                                      const QStringList& theRecentlyOpenedFiles)
64   { myRecentlyOpenedFiles[thePluginName] = theRecentlyOpenedFiles; }
65
66 private slots:
67
68   //! Processes the button click, open default/current directory to select open file, calls OpenFile of communicator
69   void onStartButtonClicked();
70
71 private:
72
73   QPushButton* myStartButton; //!< processed button
74   //!< plugins recently opened files
75   QMap<TCollection_AsciiString, QStringList> myRecentlyOpenedFiles;
76 };
77
78 //! \class TInspectorEXE_OpenFileDialog
79 //! Control that contains table view of samples and line to select a file name from other directory.
80 //! Click on element of samples table view calls this sample opening else after entering(or opening) file name
81 //! the import becomes active. Click on the button will open selected file if it is possible
82 class TInspectorEXE_OpenFileDialog : public QDialog
83 {
84   Q_OBJECT
85 private:
86
87   //! Constructor
88   Standard_EXPORT TInspectorEXE_OpenFileDialog (QWidget* theParent, const QStringList& theRecentlyOpenedFiles);
89
90 public:
91
92   //! Destructor
93   virtual ~TInspectorEXE_OpenFileDialog() Standard_OVERRIDE {}
94
95   //! Opens this file dialog using for samples view the given directory and try to open new file
96   //! \param theParent a parent for the new dialog
97   //! \param theDataDirName path to default samples directory
98   //! \returns a file name from the open file dialog
99   Standard_EXPORT static QString OpenFile (QWidget* theParent, const QStringList& theRecentlyOpenedFiles);
100
101   //! Returns selection name from the dialog
102   QString GetFileName() const { return myFileName; }
103
104   //! Returns communicator, if this is the first call, create a communicator instance
105   Standard_EXPORT static TInspector_Communicator* Communicator();
106
107   //! Returns preferences: previous opened documents.
108   //! \param thePluginName name of the plugin
109   //! \param theCommunicator source of preferences
110   //! \param theFileNames [out] container of recently opened file names
111   Standard_EXPORT static void GetPluginRecentlyOpenedFiles (const TCollection_AsciiString& thePluginName,
112                                                             TInspector_Communicator* theCommunicator,
113                                                             QStringList& theFileNames);
114
115   //! Sets preferences: previous opened documents.
116   //! \param thePluginName name of the plugin
117   //! \param theCommunicator source of preferences
118   //! \param theFileNames container of recently opened file names to be set into communicator preferences
119   Standard_EXPORT static void SetPluginRecentlyOpenedFiles (const TCollection_AsciiString& thePluginName,
120                                                             TInspector_Communicator* theCommunicator,
121                                                             QStringList& theFileNames);
122
123 private slots:
124
125   //! Stores name of selected sample file
126   void onSampleSelectionChanged (const QItemSelection& theSelected, const QItemSelection& theDeselected);
127
128   //! Open file dialog to select a file name. Fills file name line, enable import button
129   void onSelectClicked();
130
131   //! Accepts open file dialog
132   void onApplySelectClicked();
133
134 private:
135
136   //! Creates view of file names in samples directory
137   //! \param theFileNames a container of names
138   //! \return table view
139   QTableView* createTableView (const QStringList& theFileNames);
140
141   //! Creates view model and fills it by the file names
142   //! \param theFileNames a container of names
143   //! \return model
144   QAbstractItemModel* createModel (const QStringList& theFileNames);
145
146 private:
147
148   QStringList myRecentlyOpenedFiles; //!< recently opened files
149   QString myFileName; //!< result file name
150   QTableView* mySamplesView; //! <view of sample file names
151   QLineEdit* mySelectedName; //!< alternative control to open file
152 };
153
154 #endif