group_tabs.h

Go to the documentation of this file.

/*
 * Copyright (C) 2009-2011 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2009-2011 David Robillard <d@drobilla.net>
 * Copyright (C) 2009-2017 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2014-2017 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.
 */
 
#pragma once
 
#include <ytkmm/menu.h>
 
#include "ardour/session_handle.h"
#include "ardour/types.h"
 
#include "gtkmm2ext/cairo_widget.h"
 
#include "editor_component.h"
 
namespace ARDOUR {
        class Session;
        class RouteGroup;
}
 
class Editor;
class RouteGroupDialog;
 
class GroupTabs : public CairoWidget, public ARDOUR::SessionHandlePtr
{
public:
        GroupTabs ();
        virtual ~GroupTabs ();
 
        void set_session (ARDOUR::Session *);
        void clear ();
 
        Gtk::Menu* get_menu (std::shared_ptr<ARDOUR::RouteGroup> g, bool tabArea = false);
 
        void run_new_group_dialog (ARDOUR::RouteList const *, bool with_master);
 
        void set_extent (double);
        void set_offset (double);
 
        static void set_group_color (std::shared_ptr<ARDOUR::RouteGroup>, uint32_t);
        static std::string group_gui_id (std::shared_ptr<ARDOUR::RouteGroup>);
        static uint32_t group_color (std::shared_ptr<ARDOUR::RouteGroup>);
 
protected:
 
        struct Tab {
                Tab () {}
 
                double from;
                double to;
                uint32_t color; 
                std::weak_ptr<ARDOUR::RouteGroup> group; 
        };
 
        virtual double visible_extent () const = 0;
 
        double extent () const { return _extent < 0 ? visible_extent () : _extent; }
 
        double offset () const { return _offset; }
 
        bool _dragging_new_tab; 
 
private:
        static void emit_gui_changed_for_members (std::shared_ptr<ARDOUR::RouteList>);
 
        virtual std::list<Tab> compute_tabs () const = 0;
 
        virtual void draw_tab (cairo_t* cr, Tab const & t) = 0;
 
        virtual double primary_coordinate (double x, double y) const = 0;
 
        virtual ARDOUR::RouteList routes_for_tab (Tab const * t) const = 0;
        virtual void add_menu_items (Gtk::Menu *, std::shared_ptr<ARDOUR::RouteGroup>) {}
        virtual ARDOUR::RouteList selected_routes () const = 0;
 
        void add_new_from_items (Gtk::Menu_Helpers::MenuList&);
 
        void new_from_selection (bool with_master);
        void new_from_rec_enabled (bool with_master);
        void new_from_soloed (bool with_master);
 
        void new_group_dialog_finished (int, RouteGroupDialog*, ARDOUR::RouteList const *, bool with_master) const;
        void edit_group_dialog_finished (int, RouteGroupDialog*) const;
 
        void collect (std::shared_ptr<ARDOUR::RouteGroup>);
        void set_activation (std::shared_ptr<ARDOUR::RouteGroup>, bool);
        void edit_group (std::shared_ptr<ARDOUR::RouteGroup>);
        void subgroup (std::shared_ptr<ARDOUR::RouteGroup>, bool, ARDOUR::Placement);
        void un_subgroup (std::shared_ptr<ARDOUR::RouteGroup>);
        void activate_all ();
        void disable_all ();
        void remove_group (std::shared_ptr<ARDOUR::RouteGroup>);
 
        void render (Cairo::RefPtr<Cairo::Context> const&, cairo_rectangle_t*);
        void on_size_request (Gtk::Requisition *);
        bool on_button_press_event (GdkEventButton *);
        bool on_motion_notify_event (GdkEventMotion *);
        bool on_button_release_event (GdkEventButton *);
 
        bool on_enter_notify_event (GdkEventCrossing*);
        bool on_leave_notify_event (GdkEventCrossing*);
 
        Tab * click_to_tab (double, std::list<Tab>::iterator *, std::list<Tab>::iterator *);
 
        void route_group_property_changed (std::shared_ptr<ARDOUR::RouteGroup>);
        void route_added_to_route_group (std::shared_ptr<ARDOUR::RouteGroup>, std::weak_ptr<ARDOUR::Route>);
        void route_removed_from_route_group (std::shared_ptr<ARDOUR::RouteGroup>, std::weak_ptr<ARDOUR::Route>);
 
        void assign_group_to_master (std::shared_ptr<ARDOUR::RouteGroup>, uint32_t which, bool rename_master) const;
        void unassign_group_to_master (std::shared_ptr<ARDOUR::RouteGroup>, uint32_t which) const;
        void assign_selection_to_master (uint32_t which);
        void assign_recenabled_to_master (uint32_t which);
        void assign_soloed_to_master (uint32_t which);
        void assign_some_to_master (uint32_t which, ARDOUR::RouteList, std::string vcaname = "");
 
        ARDOUR::RouteList get_soloed ();
        ARDOUR::RouteList get_rec_enabled ();
 
        Gtk::Menu* _menu;
        std::list<Tab> _tabs; 
        Tab* _dragging; 
        ARDOUR::RouteList _initial_dragging_routes;
        bool _drag_moved; 
        double _drag_fixed; 
        double _drag_moving; 
        double _drag_offset; 
        double _drag_min; 
        double _drag_max; 
        double _drag_first; 
        double _extent;
        double _offset;
 
        bool  _hovering;
 
        mutable PBD::ScopedConnection _new_route_group_connection;
 
        static std::list<Gdk::Color> _used_colors;
};