gtk2_ardour/group_tabs.h

   1 /*
   2     Copyright (C) 2009 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 __gtk_ardour_group_tabs_h__
  21 #define __gtk_ardour_group_tabs_h__
  22
  23 #include <gtkmm/menu.h>
  24 #include "editor_component.h"
  25 #include "gtkmm2ext/cairo_widget.h"
  26
  27 namespace ARDOUR {
  28         class Session;
  29         class RouteGroup;
  30 }
  31
  32 class Editor;
  33 class RouteGroupDialog;
  34
  35 /** Parent class for tabs which represent route groups as colored tabs;
  36  *  Currently used on the left-hand side of the editor and at the top of the mixer.
  37  *
  38  *  This class also contains a fair bit of code to handle changes to route
  39  *  group colours; it seems a bit out of place, but I could not really think
  40  *  of a better place to put it.
  41  */
  42 class GroupTabs : public CairoWidget, public ARDOUR::SessionHandlePtr
  43 {
  44 public:
  45         GroupTabs ();
  46         virtual ~GroupTabs ();
  47
  48         void set_session (ARDOUR::Session *);
  49
  50         /** @param g Route group, or 0.
  51          *  @return Menu to be popped up on right-click over the given route group.
  52          */
  53         Gtk::Menu* get_menu (ARDOUR::RouteGroup* g, bool tabArea = false);
  54
  55         void run_new_group_dialog (ARDOUR::RouteList const *, bool with_master);
  56
  57         static void set_group_color (ARDOUR::RouteGroup *, uint32_t);
  58         static std::string group_gui_id (ARDOUR::RouteGroup *);
  59         static uint32_t group_color (ARDOUR::RouteGroup *);
  60
  61 protected:
  62
  63         struct Tab {
  64                 Tab () : group (0) {}
  65
  66                 double from;
  67                 double to;
  68                 uint32_t color; ///< color
  69                 ARDOUR::RouteGroup* group; ///< route group
  70         };
  71
  72 private:
  73         static void emit_gui_changed_for_members (boost::shared_ptr<ARDOUR::RouteList>);
  74
  75         /** Compute all the tabs for this widget.
  76          *  @return Tabs.
  77          */
  78         virtual std::list<Tab> compute_tabs () const = 0;
  79
  80         /** Draw a tab.
  81          *  @param cr Cairo context.
  82          *  @param t Tab.
  83          */
  84         virtual void draw_tab (cairo_t* cr, Tab const & t) = 0;
  85
  86         /** @param x x coordinate
  87          *  @param y y coordinate
  88          *  @return x or y, depending on which is the primary coordinate for this widget.
  89          */
  90         virtual double primary_coordinate (double, double) const = 0;
  91
  92         virtual ARDOUR::RouteList routes_for_tab (Tab const * t) const = 0;
  93
  94         /** @return Size of the widget along the primary axis */
  95         virtual double extent () const = 0;
  96
  97         virtual void add_menu_items (Gtk::Menu *, ARDOUR::RouteGroup *) {}
  98         virtual ARDOUR::RouteList selected_routes () const = 0;
  99
 100         void add_new_from_items (Gtk::Menu_Helpers::MenuList&);
 101
 102         void new_from_selection (bool with_master);
 103         void new_from_rec_enabled (bool with_master);
 104         void new_from_soloed (bool with_master);
 105
 106         void new_group_dialog_finished (int, RouteGroupDialog*, ARDOUR::RouteList const *, bool with_master) const;
 107         void edit_group_dialog_finished (int, RouteGroupDialog*) const;
 108
 109         void collect (ARDOUR::RouteGroup *);
 110         void set_activation (ARDOUR::RouteGroup *, bool);
 111         void edit_group (ARDOUR::RouteGroup *);
 112         void subgroup (ARDOUR::RouteGroup *, bool, ARDOUR::Placement);
 113         void un_subgroup (ARDOUR::RouteGroup *);
 114         void activate_all ();
 115         void disable_all ();
 116         void remove_group (ARDOUR::RouteGroup *);
 117
 118         void render (Cairo::RefPtr<Cairo::Context> const&, cairo_rectangle_t*);
 119         void on_size_request (Gtk::Requisition *);
 120         bool on_button_press_event (GdkEventButton *);
 121         bool on_motion_notify_event (GdkEventMotion *);
 122         bool on_button_release_event (GdkEventButton *);
 123
 124         Tab * click_to_tab (double, std::list<Tab>::iterator *, std::list<Tab>::iterator *);
 125
 126         void route_group_property_changed (ARDOUR::RouteGroup *);
 127         void route_added_to_route_group (ARDOUR::RouteGroup *, boost::weak_ptr<ARDOUR::Route>);
 128         void route_removed_from_route_group (ARDOUR::RouteGroup *, boost::weak_ptr<ARDOUR::Route>);
 129
 130         void assign_group_to_master (uint32_t which, ARDOUR::RouteGroup*, bool rename_master) const;
 131         void unassign_group_to_master (uint32_t which, ARDOUR::RouteGroup*) const;
 132         void assign_selection_to_master (uint32_t which);
 133         void assign_recenabled_to_master (uint32_t which);
 134         void assign_soloed_to_master (uint32_t which);
 135         void assign_some_to_master (uint32_t which, ARDOUR::RouteList, std::string vcaname = "");
 136
 137         ARDOUR::RouteList get_soloed ();
 138         ARDOUR::RouteList get_rec_enabled ();
 139
 140         Gtk::Menu* _menu;
 141         std::list<Tab> _tabs; ///< current list of tabs
 142         Tab* _dragging; ///< tab being dragged, or 0
 143         /** routes that were in the tab that is being dragged when the drag started */
 144         ARDOUR::RouteList _initial_dragging_routes;
 145         bool _dragging_new_tab; ///< true if we're dragging a new tab
 146         bool _drag_moved; ///< true if there has been movement during any current drag
 147         double _drag_fixed; ///< the position of the fixed end of the tab being dragged
 148         double _drag_moving; ///< the position of the moving end of the tab being dragged
 149         double _drag_offset; ///< offset from the mouse to the end of the tab being dragged
 150         double _drag_min; ///< minimum position for drag
 151         double _drag_max; ///< maximum position for drag
 152         double _drag_first; ///< first mouse pointer position during drag
 153
 154         /** colors that have been used for new route group tabs */
 155         static std::list<Gdk::Color> _used_colors;
 156 };
 157
 158 #endif // __gtk_ardour_group_tabs_h__