src/SUIT/SUIT_Selector.h

   1 // Copyright (C) 2007-2022  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef SUIT_SELECTOR_H
  24 #define SUIT_SELECTOR_H
  25
  26 #include "SUIT.h"
  27
  28 #include <QList>
  29
  30 class QObject;
  31
  32 class SUIT_SelectionMgr;
  33 class SUIT_DataOwnerPtrList;
  34
  35 /*!
  36   \class SUIT_Selector
  37   Base class for all selectors used in SUIT-based applications.
  38   Provides functionality to get/set selection from/into some widget
  39   (ObjectBrowser, viewers, etc)
  40   Used by selection manager for selection synhronizing
  41 */
  42
  43 class SUIT_EXPORT SUIT_Selector
  44 {
  45   class Destroyer;
  46
  47 public:
  48   SUIT_Selector( SUIT_SelectionMgr*, QObject* = 0 );
  49   virtual ~SUIT_Selector();
  50
  51   virtual QString    type() const = 0;
  52
  53   SUIT_SelectionMgr* selectionMgr() const;
  54
  55   bool               isEnabled() const;
  56   virtual void       setEnabled( const bool );
  57
  58   bool               autoBlock() const;
  59   virtual void       setAutoBlock( const bool );
  60
  61   void               selected( SUIT_DataOwnerPtrList& ) const;
  62   void               setSelected( const SUIT_DataOwnerPtrList& );
  63
  64   bool               hasSelectionMode( const int ) const;
  65   void               selectionModes( QList<int>& ) const;
  66
  67   QObject*           owner() const;
  68
  69 protected:
  70   void               selectionChanged();
  71   virtual void       getSelection( SUIT_DataOwnerPtrList& ) const = 0;
  72   virtual void       setSelection( const SUIT_DataOwnerPtrList& ) = 0;
  73
  74 private:
  75   SUIT_SelectionMgr* mySelMgr;
  76   bool               myBlock;
  77   bool               myEnabled;
  78   bool               myAutoBlock;
  79   Destroyer*         myDestroyer;
  80 };
  81
  82 #endif