libs/pbd/pbd/property_list.h

   1 /*
   2     Copyright (C) 2010 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __pbd_property_list_h__
  21 #define __pbd_property_list_h__
  22
  23 #include <map>
  24
  25 #include "pbd/property_basics.h"
  26
  27 class XMLNode;
  28
  29 namespace PBD {
  30
  31 /** A list of properties, mapped using their ID */
  32 class PropertyList : public std::map<PropertyID, PropertyBase*>
  33 {
  34 public:
  35         PropertyList ();
  36         PropertyList (PropertyList const &);
  37
  38         virtual ~PropertyList();
  39
  40         void get_changes_as_xml (XMLNode *);
  41         void invert ();
  42
  43         /** Add a property (of some kind) to the list. Used when
  44             constructing PropertyLists that describe a change/operation.
  45         */
  46         bool add (PropertyBase* prop);
  47
  48         /* Code that is constructing a property list for use
  49          * in setting the state of an object uses this.
  50          *
  51          * Defined below, once we have Property<T>
  52          */
  53         template<typename T, typename V> bool add (PropertyDescriptor<T> pid, const V& v);
  54
  55 protected:
  56         bool _property_owner;
  57 };
  58
  59 /** A variant of PropertyList that does not delete its
  60  *  property list in its destructor. Objects with their
  61  *  own Properties store them in an OwnedPropertyList
  62  *  to avoid having them deleted at the wrong time.
  63  */
  64 class OwnedPropertyList : public PropertyList
  65 {
  66 public:
  67         OwnedPropertyList();
  68
  69         /* Classes that own property lists use this to add their
  70          * property members to their plists. Note that it takes
  71          * a reference argument rather than a pointer like
  72          * one of the add() methods in PropertyList.
  73          */
  74         bool add (PropertyBase& p);
  75 };
  76
  77 }
  78
  79 #endif /* __pbd_property_list_h__ */