gui_object.h

Go to the documentation of this file.

/*
 * Copyright (C) 2011-2012 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2011-2015 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2015-2016 Robin Gareus <robin@gareus.org>
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#ifndef __gtk_ardour_gui_object_h__
#define __gtk_ardour_gui_object_h__
 
#include <map>
#include <string>
 
#include "pbd/xml++.h"
#include "pbd/id.h"
 
class GUIObjectState
{
public:
        GUIObjectState ();
 
        static const std::string xml_node_name;
        void load (const XMLNode&);
 
        int set_state (const XMLNode&);
        XMLNode& get_state () const;
 
        std::string get_string (const std::string& id, const std::string& prop_name, bool* empty = 0);
 
        template<typename T> void set_property (const std::string& id, const std::string& prop_name, const T& val) {
                XMLNode* child = get_or_add_node (id);
                child->set_property (prop_name.c_str(), val);
        }
        void remove_property (const std::string & id, const std:: string & prop_name);
 
        void remove_node (const std::string& id);
        std::list<std::string> all_ids () const;
 
        XMLNode* get_or_add_node (const std::string &);
 
        static XMLNode* get_node (const XMLNode *, const std::string &);
        static XMLNode* get_or_add_node (XMLNode *, const std::string &);
 
  private:
        // no copy construction. object_map saves pointers to _state XMLNodes
        // use set_state(get_state())
        GUIObjectState (const GUIObjectState& other);
 
        XMLNode _state;
        // ideally we'd use a O(1) hash table here,
        // but O(log(N)) is fine already.
        std::map <std::string, XMLNode*> object_map;
};
 
#endif /* __gtk_ardour_gui_object_h__ */