axis_view.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2017 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2005 Taybin Rutkin <taybin@taybin.com>
 * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2009-2012 David Robillard <d@drobilla.net>
 * Copyright (C) 2014-2017 Robin Gareus <robin@gareus.org>
 * Copyright (C) 2016 Tim Mayberry <mojofunk@gmail.com>
 *
 * 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.
 */
 
#pragma once
 
#include <list>
#include <unordered_map>
 
#include <gtkmm/label.h>
#include <gtkmm/table.h>
#include <gdkmm/color.h>
 
#include "pbd/xml++.h"
#include "pbd/signals.h"
 
#include "ardour/automation_control.h"
#include "ardour/session_handle.h"
 
#include "gui_object.h"
#include "selectable.h"
 
namespace PBD {
        class Controllable;
}
 
namespace ARDOUR {
        class Session;
        class Stripable;
        class PresentationInfo;
}
 
class AxisView : public virtual PBD::ScopedConnectionList, public virtual ARDOUR::SessionHandlePtr, public virtual Selectable
{
public:
        virtual std::string name() const = 0;
        virtual Gdk::Color color() const = 0;
 
        sigc::signal<void> Hiding;
 
        virtual std::shared_ptr<ARDOUR::Stripable> stripable() const = 0;
        virtual std::shared_ptr<ARDOUR::AutomationControl> control() const { return std::shared_ptr<ARDOUR::AutomationControl>(); }
 
        virtual std::string state_id() const = 0;
        /* for now, we always return properties in string form.
        */
        std::string gui_property (const std::string& property_name) const;
 
        bool get_gui_property (const std::string& property_name, std::string& value) const;
 
        template <typename T>
                bool get_gui_property (const std::string& property_name, T& value) const
                {
                        std::string str = gui_property (property_name);
 
                        if (!str.empty ()) {
                                return PBD::string_to<T>(str, value);
                        }
                        return false;
                }
 
        template <typename T>
                bool get_gui_property (const std::string& state_id, const std::string& property_name, T& value) const
                {
                        std::string str = gui_object_state().get_string (state_id, property_name);
 
                        if (!str.empty ()) {
                                return PBD::string_to<T>(str, value);
                        }
                        return false;
                }
 
 
        void set_gui_property (const std::string& property_name, const std::string& value);
        void remove_gui_property (const std::string& property_name);
 
        void set_gui_property (const std::string& property_name, const char* value) {
                set_gui_property (property_name, std::string(value));
        }
 
        template <typename T>
        void set_gui_property (const std::string& property_name, const T& value)
        {
                set_gui_property (property_name, PBD::to_string(value));
        }
 
        void cleanup_gui_properties () {
                /* remove related property node from the GUI state */
                gui_object_state().remove_node (state_id());
                property_hashtable.clear ();
        }
 
        void set_selected (bool yn);
 
        virtual bool marked_for_display () const;
        virtual bool set_marked_for_display (bool);
 
        static GUIObjectState& gui_object_state();
        void clear_property_cache() { property_hashtable.clear(); }
 
        static Gdk::Color round_robin_palette_color ();
 
protected:
        AxisView ();
        virtual ~AxisView();
 
        Gtk::Label name_label;
        void set_name_ellipsize_mode ();
 
        Gtk::Label inactive_label;
        Gtk::Table inactive_table;
 
        mutable std::unordered_map<std::string, std::string> property_hashtable;
}; /* class AxisView */