]> SALOME platform Git repositories - modules/shaper.git/blob - src/Config/Config_FeatureMessage.h
Salome HOME
Reverted some changes in salome build/run scripts.
[modules/shaper.git] / src / Config / Config_FeatureMessage.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_FEATUREMESSAGE_H
22 #define CONFIG_FEATUREMESSAGE_H
23
24 #include <Config_def.h>
25 #include <Events_Message.h>
26
27 #include <string>
28
29 /*!
30  * \class Config_FeatureMessage
31  * \ingroup Config
32  * \brief Class to pass a feature entry extracted from xml file.
33
34  * Example of the feature entry:
35  * \code
36  * <feature id="Part" text="New part" tooltip="Creates a new part" icon=":pictures/part_ico.png"/>
37  * \endcode
38  */
39 class Config_FeatureMessage : public Events_Message
40 {
41   std::string myId;  ///<Feature unique id
42   std::string myText;  ///<Represents action's text
43   std::string myTooltip;  ///<Represents action's tooltip
44   std::string myIcon;  ///<Represents action's icon
45   std::string myKeysequence;  ///<Represents action's key sequence
46   std::string myHelpFile;  ///<Contains name of help file
47
48   std::string myGroupId;  ///<Id of feature's group
49   std::string myWorkbenchId;  ///<Id of feature's workbench
50   std::string myToolBarId;  ///<Id of toolbar/ By default == myWorkbenchId
51   std::string myDocumentKind;  ///< kind of the document of the workbench (all documents if empty)
52   std::string myPluginLibrary;  ///<Name of feature's library
53
54   bool myUseInput;  ///<Action is being checked until user commit the operation
55   bool myInternal;  ///<Internal feature without GUI representation
56   bool myModal;     ///<True if the feature has to be represented by modal dialog box
57   bool myIsAutoPreview; ///< Preview computation is performed automatically
58
59   /// True if the feature can have Apply/Continue button in its property panel
60   bool myIsApplyContinue;
61
62   std::string myNestedFeatures; ///<Space separated list of child features
63   std::string myActionsWhenNested; ///<Space separated list of actions
64
65  public:
66   /// Event ID that feature is loaded in workbench (GUI)
67   inline static const char* GUI_EVENT()
68   {
69     static const char * MY_GUI_EVENT_ID("WorkshopFeatureLoaded");
70     return MY_GUI_EVENT_ID;
71   }
72   /// Event ID that feature is loaded in workbench (Model)
73   inline static const char* MODEL_EVENT()
74   {
75     static const char * MY_MODEL_EVENT_ID("ModelFeatureLoaded");
76     return MY_MODEL_EVENT_ID;
77   }
78
79   /// Constructs Config_FeatureMessage
80   CONFIG_EXPORT Config_FeatureMessage(const Events_ID theId, const void* theParent = 0);
81   /// Deletes Config_FeatureMessage
82   CONFIG_EXPORT virtual ~Config_FeatureMessage();
83
84   //Auto-generated getters/setters
85   /// Feature's Id
86   CONFIG_EXPORT const std::string& id() const;
87   /// Feature's Icon
88   CONFIG_EXPORT const std::string& icon() const;
89   /// Feature's shortcut
90   CONFIG_EXPORT const std::string& keysequence() const;
91   /// Feature's text
92   CONFIG_EXPORT const std::string& text() const;
93   /// Feature's tooltip
94   CONFIG_EXPORT const std::string& tooltip() const;
95   /// Id of Feature's Group
96   CONFIG_EXPORT const std::string& groupId() const;
97   /// Id of Feature's Toolbar
98   CONFIG_EXPORT const std::string& toolBarId() const;
99   /// Returns help file name for the feature
100   CONFIG_EXPORT const std::string& helpFileName() const;
101   /// Id of Feature's Workbench
102   CONFIG_EXPORT const std::string& workbenchId() const;
103   /// Kind of a document which contains the feature
104   CONFIG_EXPORT const std::string& documentKind() const;
105   /// Name of a library which contains the feature
106   CONFIG_EXPORT const std::string& pluginLibrary() const;
107   /// Space separated list of nested features
108   CONFIG_EXPORT const std::string& nestedFeatures() const;
109   /// Space separated list of actions
110   CONFIG_EXPORT const std::string& actionsWhenNested() const;
111   /// If false - feature has no Property panel representation
112   CONFIG_EXPORT bool isUseInput() const;
113   /// If true - feature will not be added into the workbench
114   CONFIG_EXPORT bool isInternal() const;
115   /// If true - the feature will be represented by modal dialog box GUI
116   CONFIG_EXPORT bool isModal() const;
117   /// If true - the feature can have Apply/Continue button in its property panel
118   CONFIG_EXPORT bool isApplyContinue() const;
119
120
121
122   /// If true - preview of the feature is done by any modification of the feature attributes
123   CONFIG_EXPORT bool isAutoPreview() const;
124
125   ///Set feature's Id
126   CONFIG_EXPORT void setId(const std::string& id);
127   ///Set feature's Icon
128   CONFIG_EXPORT void setIcon(const std::string& icon);
129   ///Set feature's shortcut
130   CONFIG_EXPORT void setKeysequence(const std::string& keysequence);
131   ///Set feature's text
132   CONFIG_EXPORT void setText(const std::string& text);
133   ///Set feature's tooltip
134   CONFIG_EXPORT void setTooltip(const std::string& tooltip);
135   ///Set id of Feature's Group
136   CONFIG_EXPORT void setGroupId(const std::string& groupId);
137   ///Set id of Feature's Group
138   CONFIG_EXPORT void setToolBarId(const std::string& aId);
139   ///Set help file name
140   CONFIG_EXPORT void setHelpFileName(const std::string& aName);
141   ///Set id of Feature's Workbench
142   CONFIG_EXPORT void setWorkbenchId(const std::string& workbenchId);
143   ///Set kind of a document which contains the feature
144   CONFIG_EXPORT void setDocumentKind(const std::string& documentKind);
145   ///Set name of a library which contains the feature
146   CONFIG_EXPORT void setPluginLibrary(const std::string& thePluginLibrary);
147   ///Set space separated list of nested features
148   CONFIG_EXPORT void setNestedFeatures(const std::string& theNestedFeatures);
149   ///Set space separated list of nested features
150   CONFIG_EXPORT void setActionsWhenNested(const std::string& theActions);
151   ///Set use input state; If false - feature has no Property panel representation
152   CONFIG_EXPORT void setUseInput(bool isUseInput);
153   ///Set internal state; If true - feature will not be added into the workbench
154   CONFIG_EXPORT void setInternal(bool isInternal);
155   ///Set auto preview state; If true - preview of the feature is computed automatically
156   CONFIG_EXPORT void setAutoPreview(bool isAutoPreview);
157   ///Set modality state; If true - the feature will be represented by modal dialog box GUI
158   CONFIG_EXPORT void setModal(bool isModal);
159   ///Set Apply/Continue state;
160   ///If true - the feature can have Apply/Continue button in its property panel
161   CONFIG_EXPORT void setApplyContinue(bool isModal);
162 };
163
164 #endif // CONFIG_MESSAGE_H