1 // Copyright (C) 2014-2022 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef CONFIG_PLUGINMESSAGE_H
21 #define CONFIG_PLUGINMESSAGE_H
23 #include <Config_def.h>
24 #include <Events_Message.h>
29 * \class Config_PluginMessage
31 * \brief Information that plugin is started to load.
33 * Contains the plugin name. Event is posted just before load of the plugin
34 * before registerPlugin call.
36 class Config_PluginMessage : public Events_Message
38 std::string myPluginId; ///< Plugin unique id
39 std::string myUses; ///< Which plugins are used by this one Id
42 /// Event ID that plugin will be loaded
43 inline static const char* EVENT_ID()
45 static const char * MY_EVENT_ID("BeforePluginLoad");
49 /// Constructs Config_PluginMessage
50 CONFIG_EXPORT Config_PluginMessage(const Events_ID theId,
51 const std::string& thePluginId, const void* theParent = 0);
52 /// Deletes Config_PluginMessage
53 CONFIG_EXPORT virtual ~Config_PluginMessage();
56 CONFIG_EXPORT const std::string& pluginId() const;
57 /// Which plugins are used by this one Id
58 CONFIG_EXPORT const std::string& uses() const;
59 /// Sets which plugins are used by this one Id
60 CONFIG_EXPORT void setUses(const std::string& theUses);
63 #endif // CONFIG_MESSAGE_H