From 7b010a94aebcbf1261b183853410ebd7f0cadfb9 Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Mon, 22 Jun 2009 15:47:48 +0000 Subject: No-op: comments. git-svn-id: svn://localhost/ardour2/branches/3.0@5245 d708f5d6-7413-0410-9779-e7cbd77b26cf --- gtk2_ardour/group_tabs.h | 58 +++++++++++++++++++++++++++++++++++------------- 1 file changed, 42 insertions(+), 16 deletions(-) (limited to 'gtk2_ardour/group_tabs.h') diff --git a/gtk2_ardour/group_tabs.h b/gtk2_ardour/group_tabs.h index 0ba4b7bdbb..861e66f285 100644 --- a/gtk2_ardour/group_tabs.h +++ b/gtk2_ardour/group_tabs.h @@ -27,6 +27,9 @@ namespace ARDOUR { class Editor; +/** 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: @@ -37,23 +40,46 @@ public: 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; + ARDOUR::Session* _session; ///< our session private: + /** Compute all the tabs for this widget. + * @return Tabs. + */ virtual std::list 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 const &) = 0; + + /** Take a list of tabs and alter the route groups to reflect the tabs. + * @param tabs. + */ + virtual void reflect_tabs (std::list 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. + * @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 +89,10 @@ private: Tab * click_to_tab (double, Tab**, Tab**); - std::list _tabs; - Tab* _dragging; - bool _drag_moved; - bool _drag_from; - double _drag_last; - double _drag_limit; + std::list _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 }; -- cgit v1.2.3