src/SUIT/SUIT_DataOwner.h

   1 // Copyright (C) 2005  OPEN CASCADE, CEA/DEN, EDF R&D, PRINCIPIA 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.
   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 #ifndef SUIT_DATAOWNER_H
  20 #define SUIT_DATAOWNER_H
  21
  22 #include "SUIT_SmartPtr.h"
  23
  24 #include <qvaluelist.h>
  25 #include <qmap.h>
  26
  27 #ifdef WIN32
  28 #pragma warning( disable:4251 )
  29 #pragma warning( disable:4275 )
  30 #endif
  31
  32 /*!
  33   \class SUIT_DataOwner
  34   Represents abstract selected objects.
  35   Used for selection synchronizing between windows(e.g. ObjectBrowser) and viewers
  36 */
  37
  38 class SUIT_EXPORT SUIT_DataOwner : public RefCount
  39 {
  40 public:
  41   SUIT_DataOwner();//!< constructor
  42   virtual ~SUIT_DataOwner();//!< destructor
  43   // *** jfa: The below line has been put here 14.02.2007.
  44   // *** It cancels modifications from branch BR_Dev_For_4_0
  45   virtual QString keyString() const = 0;//!< used for comparison
  46 };
  47
  48 /*! \typedef SUIT_DataOwnerPtr
  49  * Define smart pointer for SUIT_DataOwner object
  50  */
  51 typedef SMART(SUIT_DataOwner) SUIT_DataOwnerPtr;
  52
  53 /*! Comparing two SUIT_DataOwnerPtr objects.*/
  54 bool operator==( const SUIT_DataOwnerPtr&, const SUIT_DataOwnerPtr& );
  55
  56 /*! \class QValueList
  57  *  \brief For more documentation see <a href="http://doc.trolltech.com">QT documentation</a>.
  58  * QT class
  59  */
  60 /*! \class SUIT_DataOwnerPtrList
  61  * \brief Manage list of SUIT_DataOwnerPtr.
  62  */
  63 class SUIT_EXPORT SUIT_DataOwnerPtrList : public QValueList<SUIT_DataOwnerPtr>
  64 {
  65 public:
  66   SUIT_DataOwnerPtrList();                         //!< constructor
  67   SUIT_DataOwnerPtrList( const bool skipAllEqual );//!< constructor
  68   SUIT_DataOwnerPtrList( const SUIT_DataOwnerPtrList& l );                         //!< copy constructor
  69   SUIT_DataOwnerPtrList( const SUIT_DataOwnerPtrList& l, const bool skipAllEqual );//!< copy constructor
  70 #ifndef QT_NO_STL
  71   SUIT_DataOwnerPtrList( const std::list<SUIT_DataOwnerPtr>& l );                         //!< copy constructor for STL list
  72   SUIT_DataOwnerPtrList( const std::list<SUIT_DataOwnerPtr>& l, const bool skipAllEqual );//!< copy constructor for STL list
  73 #endif
  74
  75   iterator append      ( const SUIT_DataOwnerPtr& x );//!< append function
  76   void     clear       ();
  77   uint     remove      (const SUIT_DataOwnerPtr& x );
  78
  79 private:
  80   // hide this methods: only append() should be used to add items to the list
  81   iterator prepend( const SUIT_DataOwnerPtr& x );//!< hide method
  82   iterator insert ( iterator it, const SUIT_DataOwnerPtr& x );//!< hide method
  83   void push_front ( const SUIT_DataOwnerPtr& x );//!< hide method
  84   void push_back  ( const SUIT_DataOwnerPtr& x );//!< hide method
  85
  86 private:
  87   bool                              mySkipEqual;
  88   QMap<SUIT_DataOwnerPtr, iterator> myMap;
  89 };
  90
  91 #ifdef WIN32
  92 #pragma warning( default:4251 )
  93 #pragma warning( default:4275 )
  94 #endif
  95
  96 #endif