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