src/ModuleBase/ModuleBase_WidgetAction.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 ModuleBase_WidgetAction_H
  21 #define ModuleBase_WidgetAction_H
  22
  23 #include "ModuleBase.h"
  24 #include "ModuleBase_ModelWidget.h"
  25
  26 class Config_WidgetAPI;
  27 class QWidget;
  28 class QToolButton;
  29
  30 /**
  31 * \ingroup GUI
  32 * Implementation of widget for feature action (tool button)
  33 */
  34 class MODULEBASE_EXPORT ModuleBase_WidgetAction : public ModuleBase_ModelWidget
  35 {
  36 Q_OBJECT
  37  public:
  38   /// Constructor
  39   /// \param theParent the parent object
  40   /// \param theData the widget configuation. The attribute of the model widget is obtained from
  41   ModuleBase_WidgetAction(QWidget* theParent, const Config_WidgetAPI* theData);
  42
  43   virtual ~ModuleBase_WidgetAction();
  44
  45   /// Do not accept focus, returns false
  46   virtual bool focusTo();
  47
  48   /// Returns list of widget controls
  49   /// \return a control list
  50   virtual QList<QWidget*> getControls() const;
  51
  52   /// \return Context for translation
  53   virtual std::string context() const {
  54     std::string aContext = myFeatureId;
  55     if(!aContext.empty() && !myActionID.empty()) {
  56       aContext += ":";
  57     }
  58     aContext += myActionID;
  59
  60     return aContext;
  61   }
  62
  63 protected:
  64   /// Do nothing
  65   /// \return True in success
  66   virtual bool storeValueCustom();
  67
  68   /// Do nothing
  69   virtual bool restoreValueCustom();
  70
  71 protected slots:
  72   /// Listens the button click and call the customAction function of the current feature
  73   void onActionClicked();
  74
  75 private:
  76   QToolButton* myButton; ///< action button
  77   std::string myActionID; ///< action index
  78 };
  79
  80 #endif