src/Config/Config_PluginMessage.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef CONFIG_PLUGINMESSAGE_H
  22 #define CONFIG_PLUGINMESSAGE_H
  23
  24 #include <Config_def.h>
  25 #include <Events_Message.h>
  26
  27 #include <string>
  28
  29 /*!
  30  * \class Config_PluginMessage
  31  * \ingroup Config
  32  * \brief Information that plugin is started to load.
  33  *
  34  * Contains the plugin name. Event is posted just before load of the plugin
  35  * before registerPlugin call.
  36  */
  37 class Config_PluginMessage : public Events_Message
  38 {
  39   std::string myPluginId;  ///< Plugin unique id
  40   std::string myUses;  ///< Which plugins are used by this one Id
  41
  42  public:
  43   /// Event ID that plugin will be loaded
  44   inline static const char* EVENT_ID()
  45   {
  46     static const char * MY_EVENT_ID("BeforePluginLoad");
  47     return MY_EVENT_ID;
  48   }
  49
  50   /// Constructs Config_PluginMessage
  51   CONFIG_EXPORT Config_PluginMessage(const Events_ID theId,
  52     const std::string& thePluginId, const void* theParent = 0);
  53   /// Deletes Config_PluginMessage
  54   CONFIG_EXPORT virtual ~Config_PluginMessage();
  55
  56   /// Plugin Id
  57   CONFIG_EXPORT const std::string& pluginId() const;
  58   /// Which plugins are used by this one Id
  59   CONFIG_EXPORT const std::string& uses() const;
  60   /// Sets which plugins are used by this one Id
  61   CONFIG_EXPORT void setUses(const std::string& theUses);
  62 };
  63
  64 #endif // CONFIG_MESSAGE_H