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 #include <gtkmm/menu.h>
  21 #include "editor_component.h"
  22 #include "cairo_widget.h"
  23
  24 namespace ARDOUR {
  25         class Session;
  26         class RouteGroup;
  27 }
  28
  29 class Editor;
  30
  31 /** Parent class for tabs which represent route groups as colored tabs;
  32  *  Currently used on the left-hand side of the editor and at the top of the mixer.
  33  */
  34 class GroupTabs : public CairoWidget, public ARDOUR::SessionHandlePtr
  35 {
  36 public:
  37         GroupTabs ();
  38         virtual ~GroupTabs ();
  39
  40         void set_session (ARDOUR::Session *);
  41
  42         /** @param g Route group, or 0.
  43          *  @return Menu to be popped up on right-click over the given route group.
  44          */
  45         Gtk::Menu* get_menu (ARDOUR::RouteGroup* g);
  46
  47         void run_new_group_dialog (ARDOUR::RouteList const &);
  48
  49         static void set_group_color (ARDOUR::RouteGroup *, Gdk::Color);
  50         static std::string group_gui_id (ARDOUR::RouteGroup *);
  51         static Gdk::Color group_color (ARDOUR::RouteGroup *);
  52
  53 protected:
  54
  55         struct Tab {
  56                 Tab () : group (0) {}
  57
  58                 double from;
  59                 double to;
  60                 Gdk::Color color; ///< color
  61                 ARDOUR::RouteGroup* group; ///< route group
  62         };
  63
  64 private:
  65         /** Compute all the tabs for this widget.
  66          *  @return Tabs.
  67          */
  68         virtual std::list<Tab> compute_tabs () const = 0;
  69
  70         /** Draw a tab.
  71          *  @param cr Cairo context.
  72          *  @param t Tab.
  73          */
  74         virtual void draw_tab (cairo_t* cr, Tab const & t) const = 0;
  75
  76         /** @param x x coordinate
  77          *  @param y y coordinate
  78          *  @return x or y, depending on which is the primary coordinate for this widget.
  79          */
  80         virtual double primary_coordinate (double, double) const = 0;
  81
  82         virtual ARDOUR::RouteList routes_for_tab (Tab const * t) const = 0;
  83
  84         /** @return Size of the widget along the primary axis */
  85         virtual double extent () const = 0;
  86
  87         virtual void add_menu_items (Gtk::Menu *, ARDOUR::RouteGroup *) {}
  88         virtual PBD::PropertyList default_properties () const = 0;
  89         virtual std::string order_key () const = 0;
  90         virtual ARDOUR::RouteList selected_routes () const = 0;
  91         virtual void sync_order_keys () = 0;
  92
  93         void new_from_selection ();
  94         void new_from_rec_enabled ();
  95         void new_from_soloed ();
  96         ARDOUR::RouteGroup* create_and_add_group () const;
  97         void collect (ARDOUR::RouteGroup *);
  98         void set_activation (ARDOUR::RouteGroup *, bool);
  99         void edit_group (ARDOUR::RouteGroup *);
 100         void subgroup (ARDOUR::RouteGroup *, bool, ARDOUR::Placement);
 101         void activate_all ();
 102         void disable_all ();
 103         void remove_group (ARDOUR::RouteGroup *);
 104
 105         void render (cairo_t *);
 106         void on_size_request (Gtk::Requisition *);
 107         bool on_button_press_event (GdkEventButton *);
 108         bool on_motion_notify_event (GdkEventMotion *);
 109         bool on_button_release_event (GdkEventButton *);
 110
 111         Tab * click_to_tab (double, std::list<Tab>::iterator *, std::list<Tab>::iterator *);
 112
 113         Gtk::Menu* _menu;
 114         std::list<Tab> _tabs; ///< current list of tabs
 115         Tab* _dragging; ///< tab being dragged, or 0
 116         bool _dragging_new_tab; ///< true if we're dragging a new tab
 117         bool _drag_moved; ///< true if there has been movement during any current drag
 118         double _drag_fixed; ///< the position of the fixed end of the tab being dragged
 119         double _drag_moving; ///< the position of the moving end of the tab being dragged
 120         double _drag_offset; ///< offset from the mouse to the end of the tab being dragged
 121         double _drag_min; ///< minimum position for drag
 122         double _drag_max; ///< maximum position for drag
 123         double _drag_first; ///< first mouse pointer position during drag
 124
 125         /** colors that have been used for new route group tabs */
 126         static std::list<Gdk::Color> _used_colors;
 127 };