src/XGUI/XGUI_MenuGroup.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 XGUI_MENUGROUP_H_
  22 #define XGUI_MENUGROUP_H_
  23
  24 #include "XGUI.h"
  25
  26 #include <string>
  27 #include <list>
  28 #include <memory>
  29
  30 class Config_FeatureMessage;
  31
  32 /**
  33 * \ingroup GUI
  34 * A class for management of menu actions (features). The actions should be arranged like they are
  35 * in XML file. It listens the read feature of XML and fills internal structure of menu workbenches
  36 * and groups of feature. After, it creates menues and tools in the module.
  37 */
  38 class XGUI_EXPORT XGUI_MenuGroup
  39 {
  40  public:
  41   /// Constructor
  42   XGUI_MenuGroup(const std::string& theName);
  43   virtual ~XGUI_MenuGroup() {}
  44
  45   /// Returns a name of the workbench
  46   /// \return workbench name
  47   std::string getName() const { return myName; }
  48
  49   /// Stores XML information for the feature kind
  50   /// \param theMessage a container of the feature XML properties
  51   virtual void setFeatureInfo(const std::shared_ptr<Config_FeatureMessage>& theMessage);
  52
  53   /// Returns container of existing features
  54   /// \returns list
  55   const std::list<std::shared_ptr<Config_FeatureMessage> >& featuresInfo() const;
  56
  57 private:
  58   std::string myName; /// a name of the workbench
  59
  60   /// container of existing features
  61   std::list<std::shared_ptr<Config_FeatureMessage> > myFeatureInfo;
  62 };
  63
  64 #endif /* XGUI_MENUGROUP_H_ */