Salome HOME
Incorrect dumping of parts with user-defined names (issue #1804)
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Plugin.h
index 3b480410b8b169b23ccdbddfb98faf7455e59dc6..822eeea51b1745803badcf392bf74db1bee378e3 100644 (file)
@@ -1,22 +1,38 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 // File:        SketchPlugin_Plugin.hxx
 // Created:     31 Mar 2014
 // Author:      Mikhail PONIKAROV
 
-#ifndef SketchPlugin_Plugin_H_
-#define SketchPlugin_Plugin_H_
+#ifndef SKETCHPLUGIN_PLUGIN_H_
+#define SKETCHPLUGIN_PLUGIN_H_
 
-#include "SketchPlugin.h"
-#include "ModelAPI_Plugin.h"
-#include "ModelAPI_Feature.h"
+#include <SketchPlugin.h>
+#include <Events_Listener.h>
+#include <ModelAPI_Plugin.h>
+#include <ModelAPI_Feature.h>
+#include <ModelAPI_Events.h>
 
-class SKETCHPLUGIN_EXPORT SketchPlugin_Plugin : public ModelAPI_Plugin
+/**\class SketchPlugin_Plugin
+ * \ingroup Plugins
+ * \brief Interface common for any plugin: allows to use plugin by the plugins manager.
+ */
+class SketchPlugin_Plugin : public ModelAPI_Plugin, public Events_Listener
 {
- public:
+public:
   /// Creates the feature object of this plugin by the feature string ID
-  virtual FeaturePtr createFeature(std::string theFeatureID);
+  SKETCHPLUGIN_EXPORT virtual FeaturePtr createFeature(std::string theFeatureID);
+
+  /// Constructor that registers features and other plugin elements.
+  SKETCHPLUGIN_EXPORT SketchPlugin_Plugin();
+
+  //! Redefinition of Events_Listener method
+  SKETCHPLUGIN_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
 
- public:
-  SketchPlugin_Plugin();
+protected:
+  //! Returns the state of the feature in the WorkBench: enabled or disabled for the moment.
+  std::shared_ptr<ModelAPI_FeatureStateMessage> getFeaturesState(
+      const std::shared_ptr<ModelAPI_Feature>& theFeature) const;
 };
 
 #endif