home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / iproperty_collection.h < prev    next >
C/C++ Source or Header  |  2008-11-07  |  3KB  |  72 lines
  1. #ifndef K3DSDK_IPROPERTY_COLLECTION_H
  2. #define K3DSDK_IPROPERTY_COLLECTION_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2005, Timothy M. Shead
  6. //
  7. // Contact: tshead@k-3d.com
  8. //
  9. // This program is free software; you can redistribute it and/or
  10. // modify it under the terms of the GNU General Public
  11. // License as published by the Free Software Foundation; either
  12. // version 2 of the License, or (at your option) any later version.
  13. //
  14. // This program is distributed in the hope that it will be useful,
  15. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17. // General Public License for more details.
  18. //
  19. // You should have received a copy of the GNU General Public
  20. // License along with this program; if not, write to the Free Software
  21. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22.  
  23. /** \file
  24.         \brief Declares iproperty_collection, an abstract interface for wrapping a collection of iproperty objects
  25.         \author Tim Shead (tshead@k-3d.com)
  26. */
  27.  
  28. #include "ihint.h"
  29. #include "signal_system.h"
  30.  
  31. #include <vector>
  32.  
  33. namespace k3d
  34. {
  35.  
  36. class iproperty;
  37.  
  38. /// Abstract interface for a collection of iproperty objects
  39. class iproperty_collection :
  40.     public virtual iunknown
  41. {
  42. public:
  43.     /// Defines a collection of properties
  44.     typedef std::vector<iproperty*> properties_t;
  45.  
  46.     /// Registers a property with the collection - note: the collection will assume responsibility for the lifetime of user properties only
  47.     virtual void register_property(iproperty& Property) = 0;
  48.     /// Registers a set of properties with the collection - note: the collection will assume responsibility for the lifetime of user properties only
  49.     virtual void register_properties(const properties_t& Properties) = 0;
  50.     
  51.     /// Removes a property from the collection
  52.     virtual void unregister_property(iproperty& Property) = 0;
  53.     /// Removes a set of properties from the collection
  54.     virtual void unregister_properties(const properties_t& Properties) = 0;
  55.  
  56.     /// Returns the set of all properties in the collection
  57.     virtual const properties_t& properties() = 0;
  58.     /// Connects a slot to a signal emitted whenever the collection changes - note: the signal is emitted when the collection changes (properties are registered and unregistered), not when individual property values are changed
  59.     virtual sigc::connection connect_properties_changed_signal(const sigc::slot<void, ihint*>& Slot) = 0;
  60.  
  61. protected:
  62.     iproperty_collection() {}
  63.     iproperty_collection(const iproperty_collection&) {}
  64.     iproperty_collection& operator=(const iproperty_collection&) { return *this; }
  65.     virtual ~iproperty_collection() {}
  66. };
  67.  
  68. } // namespace k3d
  69.  
  70. #endif // !K3DSDK_IPROPERTY_COLLECTION_H
  71.  
  72.