src/XGUI/XGUI_MenuWorkbench.h

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