property_list.h

Go to the documentation of this file.

/*
    Copyright (C) 2010 Paul Davis

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __pbd_property_list_h__
#define __pbd_property_list_h__

#include <map>

#include "pbd/libpbd_visibility.h"
#include "pbd/property_basics.h"

class XMLNode;

namespace PBD {

class LIBPBD_API PropertyList : public std::map<PropertyID, PropertyBase*>
{
public:
        PropertyList ();
        PropertyList (PropertyList const &);
        
        virtual ~PropertyList();

        void get_changes_as_xml (XMLNode *);
        void invert ();

        bool add (PropertyBase* prop);

        /* Code that is constructing a property list for use
         * in setting the state of an object uses this.
         *
         * Defined below, once we have Property<T>
         */
        template<typename T, typename V> bool add (PropertyDescriptor<T> pid, const V& v);

protected:
        bool _property_owner;
};

class LIBPBD_API OwnedPropertyList : public PropertyList
{
public:
        OwnedPropertyList();

        /* Classes that own property lists use this to add their
         * property members to their plists. Note that it takes
         * a reference argument rather than a pointer like
         * one of the add() methods in PropertyList.
         */
        bool add (PropertyBase& p);
};

}

#endif /* __pbd_property_list_h__ */