src/XGUI/XGUI_ActiveControlSelector.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_ActiveControlSelector_H
  21 #define XGUI_ActiveControlSelector_H
  22
  23 #include "XGUI.h"
  24
  25 #include <QObject>
  26
  27 /**
  28 * Interface to have an active control and process selection by the control.
  29 * Activation of control may set selection modes and selection filters of the control.
  30 */
  31 class XGUI_ActiveControlSelector : public QObject
  32 {
  33   Q_OBJECT
  34
  35 public:
  36   /// Constructor
  37   /// \param theWorkshop the current workshop instance
  38   XGUI_EXPORT XGUI_ActiveControlSelector() {};
  39   /// Destructor
  40   XGUI_EXPORT virtual ~XGUI_ActiveControlSelector() {};
  41
  42   /// Returns name of the selector
  43   XGUI_EXPORT virtual QString getType() = 0;
  44
  45   /// Clear need to be activated widget if it exists
  46   XGUI_EXPORT virtual void reset() {}
  47
  48   /// Sets enable/disable state of the selector. If disable, it will not react to selection
  49   /// \param theEnabled if true, selector is enabled
  50   XGUI_EXPORT void setEnable(const bool& theEnabled) { myIsEnabled = theEnabled; }
  51
  52   /// Returns whether the selector is enabled or not
  53   /// \return boolean result
  54   XGUI_EXPORT bool isEnabled() const { return myIsEnabled; }
  55
  56   /// Sets control active. It should activates/deactivates selection and selection filters.
  57   /// \param isActive if true, the control becomes active
  58   XGUI_EXPORT virtual void setActive(const bool& isActive) = 0;
  59
  60   /// Returns whether the selector should be activated as soon as possible (by deactivatate other)
  61   /// \return boolean result
  62   XGUI_EXPORT virtual bool needToBeActivated() const { return false; }
  63
  64   /// Processes current selection of workshop. Reaction to selection change in workshop.
  65   XGUI_EXPORT virtual void processSelection() = 0;
  66
  67 signals:
  68   /// control is activated
  69   void activated();
  70   /// control is deactivated
  71   void deactivated();
  72
  73 protected:
  74   bool myIsEnabled; ///< enable state of the selector
  75 };
  76
  77 #endif