tools/TInspector/TInspector_PluginParameters.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 DFBrowser_Communicator_H
  17 #define DFBrowser_Communicator_H
  18
  19 #include <Standard.hxx>
  20 #include <Standard_Macro.hxx>
  21
  22 #include <inspector/TInspectorAPI_PluginParameters.hxx>
  23 #include <inspector/TInspector_Window.hxx>
  24
  25 //! \class TInspector_PluginParameters.
  26 //! \brief This is plugin parameters extended by a possibility to activate module during setting new parameters
  27 class TInspector_PluginParameters : public TInspectorAPI_PluginParameters
  28 {
  29 public:
  30
  31   //! Constructor
  32   Standard_EXPORT TInspector_PluginParameters (TInspector_Window* theWindow) : myWindow (theWindow) {}
  33
  34   //! Destructor
  35   virtual ~TInspector_PluginParameters() Standard_OVERRIDE {}
  36
  37   //! Stores the parameters for plugin
  38   //! \param thePluginName a plugin name
  39   //! \param theParameters a list of parameters
  40   //! \param theToActivatePlugin a state whether the plugin should be immediately activated
  41   Standard_EXPORT virtual void SetParameters (const TCollection_AsciiString& thePluginName,
  42                                       const NCollection_List<Handle(Standard_Transient)>& theParameters,
  43                                       const Standard_Boolean& theToActivatePlugin = Standard_False) Standard_OVERRIDE;
  44
  45 private:
  46
  47   TInspector_Window* myWindow; //!< the current window
  48 };
  49
  50 #endif