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 coloured 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 EditorComponent
  35 {
  36 public:
  37         GroupTabs (Editor *);
  38
  39         void connect_to_session (ARDOUR::Session *);
  40
  41 protected:
  42
  43         struct Tab {
  44                 double from; ///< start coordinate
  45                 double to; ///< end coordinate
  46                 Gdk::Color colour; ///< colour
  47                 ARDOUR::RouteGroup* group; ///< route group
  48                 double first_ui_size; ///< GUI size of the first route in the group
  49                 double last_ui_size; ///< GUI size of the last route in the group
  50         };
  51
  52 private:
  53         /** Compute all the tabs for this widget.
  54          *  @return Tabs.
  55          */
  56         virtual std::list<Tab> compute_tabs () const = 0;
  57
  58         /** Draw a tab.
  59          *  @param cr Cairo context.
  60          *  @param t Tab.
  61          */
  62         virtual void draw_tab (cairo_t* cr, Tab const & t) const = 0;
  63
  64         /** @param x x coordinate
  65          *  @param y y coordinate
  66          *  @return x or y, depending on which is the primary coordinate for this widget.
  67          */
  68         virtual double primary_coordinate (double, double) const = 0;
  69
  70         /** Take a list of tabs and alter the route groups to reflect the tabs.
  71          *  @param tabs.
  72          */
  73         virtual void reflect_tabs (std::list<Tab> const & tabs) = 0;
  74
  75         /** @return Size of the widget along the primary axis */
  76         virtual double extent () const = 0;
  77
  78         /** @param g Route group, or 0.
  79          *  @return Menu to be popped up on right-click over the given route group.
  80          */
  81         virtual Gtk::Menu* get_menu (ARDOUR::RouteGroup* g) = 0;
  82
  83         void render (cairo_t *);
  84         void on_size_request (Gtk::Requisition *);
  85         bool on_button_press_event (GdkEventButton *);
  86         bool on_motion_notify_event (GdkEventMotion *);
  87         bool on_button_release_event (GdkEventButton *);
  88
  89         Tab * click_to_tab (double, Tab**, Tab**);
  90
  91         std::list<Tab> _tabs; ///< current list of tabs
  92         Tab* _dragging; ///< tab being dragged, or 0
  93         bool _drag_moved; ///< true if there has been movement during any current drag
  94         bool _drag_from; ///< true if the drag is of the `from' end of the tab, otherwise it's the `to' end
  95         double _drag_last; ///< last mouse pointer position during drag
  96         double _drag_limit; ///< limit of the current drag
  97 };