src/XGUI/XGUI_MenuMgr.h

   1 // Copyright (C) 2014-2023  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_MENUMGR_H_
  21 #define XGUI_MENUMGR_H_
  22
  23 #include "XGUI.h"
  24
  25 #include <Events_Listener.h>
  26
  27 #include <string>
  28 #include <list>
  29 #include <memory>
  30
  31 class XGUI_MenuWorkbench;
  32 class XGUI_Workshop;
  33 class Config_FeatureMessage;
  34
  35 class QAction;
  36
  37 /**
  38 * \ingroup GUI
  39 * A class for management of menu actions (features). The actions should be arranged like they are
  40 * in XML file. It listens the read feature of XML and fills internal structure of menu workbenches
  41 * and groups of feature. After, it creates menues and tools in the module.
  42 */
  43 class XGUI_MenuMgr : public Events_Listener
  44 {
  45  public:
  46   /// Constructor
  47   /// \param theWorkshop the current workshop
  48   XGUI_EXPORT XGUI_MenuMgr(XGUI_Workshop* theWorkshop);
  49   XGUI_EXPORT virtual ~XGUI_MenuMgr() {}
  50
  51   /// Creates feature actions
  52   XGUI_EXPORT void createFeatureActions();
  53
  54   /// Redefinition of Events_Listener method
  55   /// \param theMessage a message
  56   XGUI_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
  57
  58 protected:
  59   /// Process event "Add a feature"
  60   void addFeature(const std::shared_ptr<Config_FeatureMessage>& theMessage);
  61
  62   /// Finds or creates a workbench for the given name
  63   /// \param theWorkbenchName a name defined in XML
  64   /// \return an instance of workbench
  65   std::shared_ptr<XGUI_MenuWorkbench> findWorkbench(const std::string& theWorkbenchName);
  66
  67   /// Creates a new action by the message
  68   /// \param theMessage an XML information of the feature
  69   /// \param theWchName a workbench name, will be used as menu/tool bar name
  70   /// \param aUseSeparator boolean value if a separator should be added after the action
  71   /// \return an action
  72   QAction* buildAction(const std::shared_ptr<Config_FeatureMessage>& theMessage,
  73                        const std::string& theWchName, const bool aUseSeparator) const;
  74
  75 private:
  76   XGUI_Workshop* myWorkshop; ///< the current workshop
  77
  78   /// container of existing workbenchs
  79   std::list< std::shared_ptr<XGUI_MenuWorkbench> > myWorkbenches;
  80 };
  81
  82 #endif /* XGUI_MENUMGR_H_ */