SHAPER  9.12.0
Config_PluginMessage.h
1 // Copyright (C) 2014-2023 CEA, EDF
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 email : webmaster.salome@opencascade.com
18 //
19 
20 #ifndef CONFIG_PLUGINMESSAGE_H
21 #define CONFIG_PLUGINMESSAGE_H
22 
23 #include <Config_def.h>
24 #include <Events_Message.h>
25 
26 #include <string>
27 
37 {
38  std::string myPluginId;
39  std::string myUses;
40 
41  public:
43  inline static const char* EVENT_ID()
44  {
45  static const char * MY_EVENT_ID("BeforePluginLoad");
46  return MY_EVENT_ID;
47  }
48 
50  CONFIG_EXPORT Config_PluginMessage(const Events_ID theId,
51  const std::string& thePluginId, const void* theParent = 0);
53  CONFIG_EXPORT virtual ~Config_PluginMessage();
54 
56  CONFIG_EXPORT const std::string& pluginId() const;
58  CONFIG_EXPORT const std::string& uses() const;
60  CONFIG_EXPORT void setUses(const std::string& theUses);
61 };
62 
63 #endif // CONFIG_MESSAGE_H
Information that plugin is started to load.
Definition: Config_PluginMessage.h:37
CONFIG_EXPORT const std::string & pluginId() const
Plugin Id.
Definition: Config_PluginMessage.cpp:34
virtual CONFIG_EXPORT ~Config_PluginMessage()
Deletes Config_PluginMessage.
Definition: Config_PluginMessage.cpp:29
CONFIG_EXPORT void setUses(const std::string &theUses)
Sets which plugins are used by this one Id.
Definition: Config_PluginMessage.cpp:44
CONFIG_EXPORT Config_PluginMessage(const Events_ID theId, const std::string &thePluginId, const void *theParent=0)
Constructs Config_PluginMessage.
Definition: Config_PluginMessage.cpp:22
static const char * EVENT_ID()
Event ID that plugin will be loaded.
Definition: Config_PluginMessage.h:43
CONFIG_EXPORT const std::string & uses() const
Which plugins are used by this one Id.
Definition: Config_PluginMessage.cpp:39
Identifier of the event kind.
Definition: Events_Message.h:36
Message for communication between sender and listener of event.
Definition: Events_Message.h:65