home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / imetadata.h < prev    next >
C/C++ Source or Header  |  2008-11-30  |  2KB  |  68 lines
  1. #ifndef K3DSDK_IMETADATA_H
  2. #define K3DSDK_IMETADATA_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2008, 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.     \author Tim Shead (tshead@k-3d.com)
  25. */
  26.  
  27. #include "iunknown.h"
  28. #include "signal_system.h"
  29. #include "types.h"
  30. #include <map>
  31.  
  32. namespace k3d
  33. {
  34.  
  35. /// Abstract interface for objects that can store arbitrary metadata (name-value pairs).
  36. class imetadata :
  37.     public virtual iunknown
  38. {
  39. public:
  40.     /// Defines storage for an arbitrary collection of name-value pairs
  41.     typedef std::map<string_t, string_t> metadata_t;
  42.  
  43.     /// Sets a new name-value pair, overwriting the value if the name already exists
  44.     virtual void set_metadata_value(const string_t& Name, const string_t& Value) = 0;
  45.     /// Sets a collection of name-value pair, overwriting any existing values
  46.     virtual void set_metadata(const metadata_t& Values) = 0;
  47.     /// Returns the set of existing name-value pairs
  48.     virtual metadata_t get_metadata() = 0;
  49.     /// Returns a value by name, or empty-string if the name doesn't exist
  50.     virtual const string_t get_metadata_value(const string_t& Name) = 0;
  51.     /// Erases an existing name-value pair
  52.     virtual void erase_metadata_value(const string_t& Name) = 0;
  53.  
  54.     /// Connects a slot to a signal that will be emitted whenever the metadata contents change
  55.     virtual sigc::connection connect_metadata_changed_signal(const sigc::slot<void>& Slot) = 0;
  56.  
  57. protected:
  58.     imetadata() {}
  59.     imetadata(const imetadata&) {}
  60.     imetadata& operator = (const imetadata&) { return *this; }
  61.     virtual ~imetadata() {}
  62. };
  63.  
  64. } // namespace k3d
  65.  
  66. #endif // !K3DSDK_IMETADATA_H
  67.  
  68.