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/
  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 class SUIT_EXPORT SUIT_DataOwner : public RefCount
  33 {
  34 public:
  35   SUIT_DataOwner();//!< constructor
  36   virtual ~SUIT_DataOwner();//!< destructor
  37   //! compare function
  38   virtual bool isEqual( const SUIT_DataOwner& ) const = 0;
  39 };
  40
  41 /*! \typedef SUIT_DataOwnerPtr
  42  * Define smart pointer for SUIT_DataOwner object
  43  */
  44 typedef SMART(SUIT_DataOwner) SUIT_DataOwnerPtr;
  45
  46 /*! Comparing two SUIT_DataOwnerPtr objects.*/
  47 bool operator==( const SUIT_DataOwnerPtr&, const SUIT_DataOwnerPtr& );
  48
  49 /*! \class QValueList
  50  *  \brief For more documentation see <a href="http://doc.trolltech.com">QT documentation</a>.
  51  * QT class
  52  */
  53 /*! \class SUIT_DataOwnerPtrList
  54  * \brief Manage list of SUIT_DataOwnerPtr.
  55  */
  56 class SUIT_EXPORT SUIT_DataOwnerPtrList : public QValueList<SUIT_DataOwnerPtr>
  57 {
  58 public:
  59   SUIT_DataOwnerPtrList();                         //!< constructor
  60   SUIT_DataOwnerPtrList( const bool skipAllEqual );//!< constructor
  61   SUIT_DataOwnerPtrList( const SUIT_DataOwnerPtrList& l );                         //!< copy constructor
  62   SUIT_DataOwnerPtrList( const SUIT_DataOwnerPtrList& l, const bool skipAllEqual );//!< copy constructor
  63 #ifndef QT_NO_STL
  64   SUIT_DataOwnerPtrList( const std::list<SUIT_DataOwnerPtr>& l );                         //!< copy constructor for STL list
  65   SUIT_DataOwnerPtrList( const std::list<SUIT_DataOwnerPtr>& l, const bool skipAllEqual );//!< copy constructor for STL list
  66 #endif
  67
  68   iterator append      ( const SUIT_DataOwnerPtr& x );//!< append function
  69   void     clear       ();
  70   uint     remove      (const SUIT_DataOwnerPtr& x );
  71
  72 private:
  73   // hide this methods: only append() should be used to add items to the list
  74   iterator prepend( const SUIT_DataOwnerPtr& x );//!< hide method
  75   iterator insert ( iterator it, const SUIT_DataOwnerPtr& x );//!< hide method
  76   void push_front ( const SUIT_DataOwnerPtr& x );//!< hide method
  77   void push_back  ( const SUIT_DataOwnerPtr& x );//!< hide method
  78
  79 private:
  80   bool                              mySkipEqual;
  81   QMap<SUIT_DataOwnerPtr, iterator> myMap;
  82 };
  83
  84 #ifdef WIN32
  85 #pragma warning( default:4251 )
  86 #pragma warning( default:4275 )
  87 #endif
  88
  89 #endif