0029748: Samples - Inspector tool - use recently opened files in TInspectorEXE
[occt.git] / tools / TInspector / TInspector_Window.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 TInspector_Window_H
17 #define TInspector_Window_H
18
19 #include <NCollection_List.hxx>
20 #include <Standard.hxx>
21 #include <Standard_Transient.hxx>
22 #include <TCollection_AsciiString.hxx>
23 #include <inspector/TInspectorAPI_PluginParameters.hxx>
24
25 #include <Standard_WarningsDisable.hxx>
26 #include <QMap>
27 #include <QObject>
28 #include <QString>
29 #include <Standard_WarningsRestore.hxx>
30
31 class TInspectorAPI_Communicator;
32 class TInspector_Shortcut;
33
34 class QButtonGroup;
35 class QMainWindow;
36 class QHBoxLayout;
37 class QPushButton;
38 class QStackedWidget;
39 class QToolButton;
40
41 //! \class Inspector_Window
42 //! Control that contains:
43 //! - stacked widget of loaded plugins
44 //! - Open button to open file in an active plugin
45 //! - plugin parameters container
46 class TInspector_Window : public QObject
47 {
48   Q_OBJECT
49 private:
50
51   //! Container of plugin information
52   struct TInspector_ToolInfo
53   {
54
55     //! Constructor
56     TInspector_ToolInfo (const TCollection_AsciiString& theName = TCollection_AsciiString())
57       : myName(theName), myCommunicator (0), myButton (0), myWidget (0) {}
58
59     TCollection_AsciiString myName; //!< plugin name
60     TInspectorAPI_Communicator* myCommunicator; //!< plugin communicator
61     QPushButton* myButton; //!< button with plugin name, that will be added into TInspector window layout
62     QWidget* myWidget; //!< parent widget of the plugin
63   };
64
65 public:
66
67   //! Constructor
68   Standard_EXPORT TInspector_Window();
69
70   //! Destructor
71   virtual ~TInspector_Window() Standard_OVERRIDE {}
72
73   //! Appends the plugin names into internal conainer
74   //! \param thePluginName a name of the plugin
75   Standard_EXPORT void RegisterPlugin (const TCollection_AsciiString& thePluginName);
76
77   //! Returns list of registered plugins
78   //! \return container of plugin names
79   Standard_EXPORT NCollection_List<TCollection_AsciiString> RegisteredPlugins() const;
80
81   //! Stores parameters for the plugin. If the plugin name is empty, it inits all plugins with the parameters
82   //! \param thePluginName a name of the plugin
83   //! \param theParameters container of parameters(e.g. AIS_InteractiveContext, TDocStd_Application)
84   //! \param theAppend boolean state whethe the parameters should be added to existing
85   Standard_EXPORT void Init (const TCollection_AsciiString& thePluginName,
86                              const NCollection_List<Handle(Standard_Transient)>& theParameters,
87                              const Standard_Boolean theAppend = Standard_False);
88
89   //! Appends to container of parameters the given name, if the given parameter is active, cal UpdateContent
90   //! \param thePluginName a name of the plugin
91   //! \param theParameters container of parameters(e.g. AIS_InteractiveContext, TDocStd_Application)
92   Standard_EXPORT void OpenFile (const TCollection_AsciiString& thePluginName,
93                                  const TCollection_AsciiString& theFileName);
94
95   //! Calls UpdateContent for the active plugin
96   Standard_EXPORT void UpdateContent();
97
98   //! Returns the main TInspector window
99   QMainWindow* GetMainWindow() const { return myMainWindow; }
100
101   //! Activates the plugin. Loads the plugin if it has not been loaded yet
102   //! \param thePluginName a name of the plugin
103   Standard_EXPORT void ActivateTool (const TCollection_AsciiString& thePluginName);
104
105   //! Set item selected in the active plugin
106   //! \param theItemNames a container of name of items in plugin that should become selected
107   Standard_EXPORT void SetSelected (const NCollection_List<TCollection_AsciiString>& theItemNames);
108
109   //! Sets objects to be selected in the plugin
110   //! \param theObjects an objects
111   Standard_EXPORT void SetSelected (const NCollection_List<Handle(Standard_Transient)>& theObjects);
112
113   //! Sets open button. Stores into objectName for the button the name of the current plugin to know where
114   //! the file should be applied
115   //! \param theButton a button
116   Standard_EXPORT void SetOpenButton (QPushButton* theButton);
117
118   //! Loads plugin, appends the plugin widget into layout, stores the plugin information
119   //! \param thePluginName a name of the plugin
120   //! \param theInfo an output parameter for plugin info
121   Standard_EXPORT bool LoadPlugin (const TCollection_AsciiString& thePluginName, TInspector_ToolInfo& theInfo);
122
123   //! Sets path to a directory for temporary plugin files. If parameter is empty, using default directory
124   //! \param thePath a path
125   void SetTemporaryDirectory (const TCollection_AsciiString& thePath)
126   { myParameters->SetTemporaryDirectory (thePath.IsEmpty() ? myDefaultDirectory : thePath); }
127
128   //! Returns path to a directory for temporary plugin files
129   //! \return path
130   TCollection_AsciiString GetTemporaryDirectory() const { return myParameters->GetTemporaryDirectory(); }
131
132   //! Returns plugins parameters container
133   //! \return instance of parameters container
134   Handle(TInspectorAPI_PluginParameters) GetPluginParameters() const { return myParameters; }
135
136   //! Returns plugin preferences: dock widgets state, tree view columns.
137   //! \param theItem container of preference elements
138   Standard_EXPORT void GetPreferences (TInspectorAPI_PreferencesDataMap& theItem);
139
140   //! Applies plugin preferences
141   //! \param theItem container of preference elements
142   Standard_EXPORT void SetPreferences (const TInspectorAPI_PreferencesDataMap& theItem);
143
144   //! Puts in the stream information about communicator
145   //! \param theStream stream for output
146   Standard_EXPORT void Dump (Standard_OStream& theStream) const;
147
148 public slots:
149   //! Stores preferences (current state) of all plugins into a preferences file
150   Standard_EXPORT void OnStorePreferences();
151
152   //! Remove preferences file
153   Standard_EXPORT void OnRemovePreferences();
154
155 protected slots:
156
157   //! Activates plugin correspnded to the clicked button
158   void onButtonClicked();
159
160   //! Updates available actions by the active plugin
161   void onShowActionsMenu();
162
163   //! Updates the TInspector window title giving object name of plugin widget (available only in Qt5)
164   void onCommuncatorNameChanged();
165
166 protected:
167
168   //! Activates plugin by the plugin info 
169   //! \param theToolInfo an information about plugin
170   bool activeToolInfo (TInspector_ToolInfo& theToolInfo) const;
171
172   //! Returns true if there is plugin registered by the given name
173   //! \param thePluginName a name of the plugin
174   //! \param theToolInfo an output parameter for plugin information
175   //! \param theToolId an index in internal map
176   //! \return true if the plugin is found
177   bool findPlugin (const TCollection_AsciiString& thePluginName, TInspector_ToolInfo& theToolInfo,
178                    int& theToolId);
179
180   //! Applies desktop preferences to window
181   void applyPreferences();
182
183   //! Generate default temp directory by 'TEMP' or 'TMP' environment variables
184   //! \return generated path
185   TCollection_AsciiString defaultTemporaryDirectory() const;
186
187 private:
188
189   QWidget* myEmptyWidget; //!< widget that is active in tools stack while no one plugin is loaded
190   QMainWindow* myMainWindow; //!< main control of the window
191   QStackedWidget* myToolsStack; //!< stack widget of plugin windows
192   QWidget* myButtonWidget; //!< container of plugin buttons
193   QPushButton* myOpenButton; //!< button to open file for the active plugin
194   QHBoxLayout* myButtonLay; //!< layout of plugin buttons
195   QButtonGroup* myButtonGroup; //!< exclusive toggled button
196   QToolButton* myActionsWidget; //!< tool button for plugin actions
197   QList<TInspector_ToolInfo> myToolNames; //!< container of plugin names
198   Handle(TInspectorAPI_PluginParameters) myParameters; //!< plugins parameters container
199   TInspector_Shortcut* myShortcut; //!< listener of key events
200   TCollection_AsciiString myDefaultDirectory; //!< default directory
201 };
202
203 #endif