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