Strip trailing whitespace and fix other whitespace errors (e.g. space/tab mixing...

[ardour.git] / gtk2_ardour / group_tabs.h

diff --git a/gtk2_ardour/group_tabs.h b/gtk2_ardour/group_tabs.h
index 0ba4b7bdbb8f4b23ecba3bca83b7f5da30e7541a..3036cfcb39eaf47af387cb95b9301a7ae6367231 100644 (file)
--- a/gtk2_ardour/group_tabs.h
+++ b/gtk2_ardour/group_tabs.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2009 Paul Davis 
+    Copyright (C) 2009 Paul Davis
 
     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
@@ -18,6 +18,7 @@
 */
 
 #include <gtkmm/menu.h>
+#include "editor_component.h"
 #include "cairo_widget.h"
 
 namespace ARDOUR {
@@ -27,33 +28,57 @@ namespace ARDOUR {
 
 class Editor;
 
-class GroupTabs : public CairoWidget
+/** Parent class for tabs which represent route groups as coloured tabs;
+ *  Currently used on the left-hand side of the editor and at the top of the mixer.
+ */
+class GroupTabs : public CairoWidget, public EditorComponent
 {
 public:
-       GroupTabs ();
+       GroupTabs (Editor *);
 
-       void set_session (ARDOUR::Session *);
+       void connect_to_session (ARDOUR::Session *);
 
 protected:
 
        struct Tab {
-               double from;
-               double to;
-               Gdk::Color colour;
-               ARDOUR::RouteGroup* group;
-               double first_ui_size;
-               double last_ui_size;
+               double from; ///< start coordinate
+               double to; ///< end coordinate
+               Gdk::Color colour; ///< colour
+               ARDOUR::RouteGroup* group; ///< route group
+               double first_ui_size; ///< GUI size of the first route in the group
+               double last_ui_size; ///< GUI size of the last route in the group
        };
 
-       ARDOUR::Session* _session;
-
 private:
+       /** Compute all the tabs for this widget.
+        *  @return Tabs.
+        */
        virtual std::list<Tab> compute_tabs () const = 0;
-       virtual void draw_tab (cairo_t *, Tab const &) const = 0;
+
+       /** Draw a tab.
+        *  @param cr Cairo context.
+        *  @param t Tab.
+        */
+       virtual void draw_tab (cairo_t* cr, Tab const & t) const = 0;
+
+       /** @param x x coordinate
+        *  @param y y coordinate
+        *  @return x or y, depending on which is the primary coordinate for this widget.
+        */
        virtual double primary_coordinate (double, double) const = 0;
-       virtual void reflect_tabs (std::list<Tab> const &) = 0;
+
+       /** Take a list of tabs and alter the route groups to reflect the tabs.
+        *  @param tabs.
+        */
+       virtual void reflect_tabs (std::list<Tab> const & tabs) = 0;
+
+       /** @return Size of the widget along the primary axis */
        virtual double extent () const = 0;
-       virtual Gtk::Menu* get_menu (ARDOUR::RouteGroup *) = 0;
+
+       /** @param g Route group, or 0.
+         *  @return Menu to be popped up on right-click over the given route group.
+        */
+       virtual Gtk::Menu* get_menu (ARDOUR::RouteGroup* g) = 0;
 
        void render (cairo_t *);
        void on_size_request (Gtk::Requisition *);
@@ -63,10 +88,10 @@ private:
 
        Tab * click_to_tab (double, Tab**, Tab**);
 
-       std::list<Tab> _tabs;
-       Tab* _dragging;
-       bool _drag_moved;
-       bool _drag_from;
-       double _drag_last;
-       double _drag_limit;
+       std::list<Tab> _tabs; ///< current list of tabs
+       Tab* _dragging; ///< tab being dragged, or 0
+       bool _drag_moved; ///< true if there has been movement during any current drag
+       bool _drag_from; ///< true if the drag is of the `from' end of the tab, otherwise it's the `to' end
+       double _drag_last; ///< last mouse pointer position during drag
+       double _drag_limit; ///< limit of the current drag
 };