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