src/Config/Config_FeatureMessage.h

   1 // Copyright (C) 2014-2019  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 email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef CONFIG_FEATUREMESSAGE_H
  21 #define CONFIG_FEATUREMESSAGE_H
  22
  23 #include <Config_def.h>
  24 #include <Events_Message.h>
  25
  26 #include <string>
  27
  28 /*!
  29  * \class Config_FeatureMessage
  30  * \ingroup Config
  31  * \brief Class to pass a feature entry extracted from xml file.
  32
  33  * Example of the feature entry:
  34  * \code
  35  * <feature id="Part" text="New part" tooltip="Creates a new part" icon=":pictures/part_ico.png"/>
  36  * \endcode
  37  */
  38 class Config_FeatureMessage : public Events_Message
  39 {
  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
  46
  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
  52
  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
  58   /// True if the feature can have Apply/Continue button in its property panel
  59   bool myIsApplyContinue;
  60
  61   std::string myNestedFeatures; ///<Space separated list of child features
  62   std::string myActionsWhenNested; ///<Space separated list of actions
  63
  64  public:
  65   /// Event ID that feature is loaded in workbench (GUI)
  66   inline static const char* GUI_EVENT()
  67   {
  68     static const char * MY_GUI_EVENT_ID("WorkshopFeatureLoaded");
  69     return MY_GUI_EVENT_ID;
  70   }
  71   /// Event ID that feature is loaded in workbench (Model)
  72   inline static const char* MODEL_EVENT()
  73   {
  74     static const char * MY_MODEL_EVENT_ID("ModelFeatureLoaded");
  75     return MY_MODEL_EVENT_ID;
  76   }
  77
  78   /// Constructs Config_FeatureMessage
  79   CONFIG_EXPORT Config_FeatureMessage(const Events_ID theId, const void* theParent = 0);
  80   /// Deletes Config_FeatureMessage
  81   CONFIG_EXPORT virtual ~Config_FeatureMessage();
  82
  83   //Auto-generated getters/setters
  84   /// Feature's Id
  85   CONFIG_EXPORT const std::string& id() const;
  86   /// Feature's Icon
  87   CONFIG_EXPORT const std::string& icon() const;
  88   /// Feature's shortcut
  89   CONFIG_EXPORT const std::string& keysequence() const;
  90   /// Feature's text
  91   CONFIG_EXPORT const std::string& text() const;
  92   /// Feature's tooltip
  93   CONFIG_EXPORT const std::string& tooltip() const;
  94   /// Id of Feature's Group
  95   CONFIG_EXPORT const std::string& groupId() const;
  96   /// Id of Feature's Toolbar
  97   CONFIG_EXPORT const std::string& toolBarId() const;
  98   /// Returns help file name for the feature
  99   CONFIG_EXPORT const std::string& helpFileName() const;
 100   /// Id of Feature's Workbench
 101   CONFIG_EXPORT const std::string& workbenchId() const;
 102   /// Kind of a document which contains the feature
 103   CONFIG_EXPORT const std::string& documentKind() const;
 104   /// Name of a library which contains the feature
 105   CONFIG_EXPORT const std::string& pluginLibrary() const;
 106   /// Space separated list of nested features
 107   CONFIG_EXPORT const std::string& nestedFeatures() const;
 108   /// Space separated list of actions
 109   CONFIG_EXPORT const std::string& actionsWhenNested() const;
 110   /// If false - feature has no Property panel representation
 111   CONFIG_EXPORT bool isUseInput() const;
 112   /// If true - feature will not be added into the workbench
 113   CONFIG_EXPORT bool isInternal() const;
 114   /// If true - the feature will be represented by modal dialog box GUI
 115   CONFIG_EXPORT bool isModal() const;
 116   /// If true - the feature can have Apply/Continue button in its property panel
 117   CONFIG_EXPORT bool isApplyContinue() const;
 118
 119
 120
 121   /// If true - preview of the feature is done by any modification of the feature attributes
 122   CONFIG_EXPORT bool isAutoPreview() const;
 123
 124   ///Set feature's Id
 125   CONFIG_EXPORT void setId(const std::string& id);
 126   ///Set feature's Icon
 127   CONFIG_EXPORT void setIcon(const std::string& icon);
 128   ///Set feature's shortcut
 129   CONFIG_EXPORT void setKeysequence(const std::string& keysequence);
 130   ///Set feature's text
 131   CONFIG_EXPORT void setText(const std::string& text);
 132   ///Set feature's tooltip
 133   CONFIG_EXPORT void setTooltip(const std::string& tooltip);
 134   ///Set id of Feature's Group
 135   CONFIG_EXPORT void setGroupId(const std::string& groupId);
 136   ///Set id of Feature's Group
 137   CONFIG_EXPORT void setToolBarId(const std::string& aId);
 138   ///Set help file name
 139   CONFIG_EXPORT void setHelpFileName(const std::string& aName);
 140   ///Set id of Feature's Workbench
 141   CONFIG_EXPORT void setWorkbenchId(const std::string& workbenchId);
 142   ///Set kind of a document which contains the feature
 143   CONFIG_EXPORT void setDocumentKind(const std::string& documentKind);
 144   ///Set name of a library which contains the feature
 145   CONFIG_EXPORT void setPluginLibrary(const std::string& thePluginLibrary);
 146   ///Set space separated list of nested features
 147   CONFIG_EXPORT void setNestedFeatures(const std::string& theNestedFeatures);
 148   ///Set space separated list of nested features
 149   CONFIG_EXPORT void setActionsWhenNested(const std::string& theActions);
 150   ///Set use input state; If false - feature has no Property panel representation
 151   CONFIG_EXPORT void setUseInput(bool isUseInput);
 152   ///Set internal state; If true - feature will not be added into the workbench
 153   CONFIG_EXPORT void setInternal(bool isInternal);
 154   ///Set auto preview state; If true - preview of the feature is computed automatically
 155   CONFIG_EXPORT void setAutoPreview(bool isAutoPreview);
 156   ///Set modality state; If true - the feature will be represented by modal dialog box GUI
 157   CONFIG_EXPORT void setModal(bool isModal);
 158   ///Set Apply/Continue state;
 159   ///If true - the feature can have Apply/Continue button in its property panel
 160   CONFIG_EXPORT void setApplyContinue(bool isModal);
 161 };
 162
 163 #endif // CONFIG_MESSAGE_H