new mouse mode (Draw (notes)); switch into internal mode when draw is selected; notably improve use of dbl-click to enter and exist internal/note edit mode

git-svn-id: svn://localhost/ardour2/branches/3.0@11269 d708f5d6-7413-0410-9779-e7cbd77b26cf

gtk2_ardour/editing_syms.h

@@ -66,6 +66,7 @@ REGIONLISTSORTTYPE(ByTimestamp)
 MOUSEMODE(MouseGain)
 MOUSEMODE(MouseObject)
 MOUSEMODE(MouseRange)
+MOUSEMODE(MouseDraw)
 MOUSEMODE(MouseTimeFX)
 MOUSEMODE(MouseZoom)
 MOUSEMODE(MouseAudition)

gtk2_ardour/editor.cc

@@ -2780,6 +2780,7 @@ Editor::setup_toolbar ()
 
 	mouse_mode_button_box->pack_start (mouse_timefx_button);
 	mouse_mode_button_box->pack_start (mouse_audition_button);
+	mouse_mode_button_box->pack_start (mouse_draw_button);
 	mouse_mode_button_box->pack_start (internal_edit_button);
 
 	edit_mode_strings.push_back (edit_mode_to_string (Slide));
@@ -2962,6 +2963,8 @@ void
 Editor::setup_tooltips ()
 {
 	ARDOUR_UI::instance()->set_tip (mouse_move_button, _("Select/Move Objects"));
+	ARDOUR_UI::instance()->set_tip (mouse_select_button, _("Select/Move Ranges"));
+	ARDOUR_UI::instance()->set_tip (mouse_draw_button, _("Draw/Edit MIDI Notes"));
 	ARDOUR_UI::instance()->set_tip (mouse_gain_button, _("Draw Region Gain"));
 	ARDOUR_UI::instance()->set_tip (mouse_zoom_button, _("Select Zoom Range"));
 	ARDOUR_UI::instance()->set_tip (mouse_timefx_button, _("Stretch/Shrink Regions and MIDI Notes"));

gtk2_ardour/editor.h

@@ -190,6 +190,7 @@ class Editor : public PublicEditor, public PBD::ScopedConnectionList, public ARD
 
 	bool internal_editing() const { return _internal_editing ; }
 	void set_internal_edit (bool yn);
+	bool toggle_internal_editing_from_double_click (GdkEvent*);
 
 #ifdef WITH_CMT
 	void add_imageframe_time_axis(const std::string & track_name, void*) ;
@@ -1551,6 +1552,7 @@ class Editor : public PublicEditor, public PBD::ScopedConnectionList, public ARD
 
 	Gtkmm2ext::TearOff*      _mouse_mode_tearoff;
 	ArdourButton mouse_select_button;
+	ArdourButton mouse_draw_button;
 	ArdourButton mouse_move_button;
 	ArdourButton mouse_gain_button;
 	ArdourButton mouse_zoom_button;

gtk2_ardour/editor_actions.cc

@@ -412,6 +412,11 @@ Editor::register_actions ()
 	mouse_select_button.set_image (::get_icon("tool_range"));
 	mouse_select_button.set_name ("mouse mode button");
 
+	act = ActionManager::register_radio_action (mouse_mode_actions, mouse_mode_group, "set-mouse-mode-draw", _("Note Drawing Tool"), sigc::bind (sigc::mem_fun(*this, &Editor::mouse_mode_toggled), Editing::MouseDraw));	
+	mouse_draw_button.set_related_action (act);
+	mouse_draw_button.set_image (::get_icon("midi_tool_pencil"));
+	mouse_draw_button.set_name ("mouse mode button");
+
 	act = ActionManager::register_toggle_action (mouse_mode_actions, "set-mouse-mode-object-range", _("Link Object / Range Tools"), sigc::mem_fun (*this, &Editor::mouse_mode_object_range_toggled));	
 	join_object_range_button.set_related_action (act);
 	join_object_range_button.set_image (::get_icon ("tool_object_range"));

gtk2_ardour/editor_canvas.cc

@@ -24,7 +24,8 @@
 #include <libgnomecanvasmm/init.h>
 #include <libgnomecanvasmm/pixbuf.h>
 #include <jack/types.h>
-#include <gtkmm2ext/utils.h>
+
+#include "gtkmm2ext/utils.h"
 
 #include "ardour/profile.h"
 #include "ardour/rc_configuration.h"

gtk2_ardour/editor_drag.cc

@@ -834,11 +834,6 @@ RegionMoveDrag::finished (GdkEvent* ev, bool movement_occurred)
 	
 	if (!movement_occurred) {
 		/* just a click */
-		if (ev->type == GDK_2BUTTON_PRESS && ev->button.button == 1) {
-			/* double click - internal edit mode */
-			Glib::RefPtr<Action> act = ActionManager::get_action (X_("MouseMode"), X_("toggle-internal-edit"));
-			act->activate ();
-		}
 		return;
 	}
 

gtk2_ardour/editor_mouse.cc

@@ -179,7 +179,7 @@ Editor::which_grabber_cursor ()
 
 	if (_internal_editing) {
 		switch (mouse_mode) {
-		case MouseRange:
+		case MouseDraw:
 			c = _cursors->midi_pencil;
 			break;
 
@@ -241,7 +241,7 @@ Editor::set_canvas_cursor ()
 	if (_internal_editing) {
 
 		switch (mouse_mode) {
-		case MouseRange:
+		case MouseDraw:
 			current_canvas_cursor = _cursors->midi_pencil;
 			break;
 
@@ -268,6 +268,11 @@ Editor::set_canvas_cursor ()
 			current_canvas_cursor = which_grabber_cursor();
 			break;
 
+		case MouseDraw:
+			/* shouldn't be possible, but just cover it anyway ... */
+			current_canvas_cursor = _cursors->midi_pencil;
+			break;
+
 		case MouseGain:
 			current_canvas_cursor = _cursors->cross_hair;
 			break;
@@ -339,6 +344,10 @@ Editor::set_mouse_mode (MouseMode m, bool force)
 		act = ActionManager::get_action (X_("MouseMode"), X_("set-mouse-mode-object"));
 		break;
 
+	case MouseDraw:
+		act = ActionManager::get_action (X_("MouseMode"), X_("set-mouse-mode-draw"));
+		break;
+
 	case MouseGain:
 		act = ActionManager::get_action (X_("MouseMode"), X_("set-mouse-mode-gain"));
 		break;
@@ -371,6 +380,62 @@ Editor::set_mouse_mode (MouseMode m, bool force)
 void
 Editor::mouse_mode_toggled (MouseMode m)
 {
+	Glib::RefPtr<Action> act;
+	Glib::RefPtr<ToggleAction> tact;
+
+	switch (m) {
+	case MouseRange:
+		act = ActionManager::get_action (X_("MouseMode"), X_("set-mouse-mode-range"));
+		break;
+
+	case MouseObject:
+		act = ActionManager::get_action (X_("MouseMode"), X_("set-mouse-mode-object"));
+		break;
+
+	case MouseDraw:
+		act = ActionManager::get_action (X_("MouseMode"), X_("set-mouse-mode-draw"));
+		break;
+
+	case MouseGain:
+		act = ActionManager::get_action (X_("MouseMode"), X_("set-mouse-mode-gain"));
+		break;
+
+	case MouseZoom:
+		act = ActionManager::get_action (X_("MouseMode"), X_("set-mouse-mode-zoom"));
+		break;
+
+	case MouseTimeFX:
+		act = ActionManager::get_action (X_("MouseMode"), X_("set-mouse-mode-timefx"));
+		break;
+
+	case MouseAudition:
+		act = ActionManager::get_action (X_("MouseMode"), X_("set-mouse-mode-audition"));
+		break;
+	}
+
+	assert (act);
+
+	tact = Glib::RefPtr<ToggleAction>::cast_dynamic (act);
+	assert (tact);
+
+	if (!tact->get_active()) {
+		/* this was just the notification that the old mode has been
+		 * left. we'll get called again with the new mode active in a
+		 * jiffy.
+		 */
+		return;
+	}
+
+	switch (m) {
+	case MouseDraw:
+		act = ActionManager::get_action (X_("MouseMode"), X_("toggle-internal-edit"));
+		tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
+		tact->set_active (true);
+		break;
+	default:
+		break;
+	}
+
 	mouse_mode = m;
 
 	instant_save ();
@@ -420,10 +485,15 @@ Editor::step_mouse_mode (bool next)
 		break;
 
 	case MouseRange:
-		if (next) set_mouse_mode (MouseZoom);
+		if (next) set_mouse_mode (MouseDraw);
 		else set_mouse_mode (MouseObject);
 		break;
 
+	case MouseDraw:
+		if (next) set_mouse_mode (MouseZoom);
+		else set_mouse_mode (MouseRange);
+		break;
+
 	case MouseZoom:
 		if (next) {
 			if (Profile->get_sae()) {
@@ -435,7 +505,7 @@ Editor::step_mouse_mode (bool next)
 			if (Profile->get_sae()) {
 				set_mouse_mode (MouseObject);
 			} else {
-				set_mouse_mode (MouseRange);
+				set_mouse_mode (MouseDraw);
 			}
 		}
 		break;
@@ -485,7 +555,8 @@ Editor::button_selection (ArdourCanvas::Item* /*item*/, GdkEvent* event, ItemTyp
 	     (mouse_mode != MouseAudition || item_type != RegionItem) &&
 	     (mouse_mode != MouseTimeFX || item_type != RegionItem) &&
 	     (mouse_mode != MouseGain) &&
-	     (mouse_mode != MouseRange)) ||
+	     (mouse_mode != MouseRange) &&
+	     (mouse_mode != MouseDraw)) ||
 	    ((event->type != GDK_BUTTON_PRESS && event->type != GDK_BUTTON_RELEASE) || event->button.button > 3) ||
 	    internal_editing()) {
 
@@ -511,7 +582,7 @@ Editor::button_selection (ArdourCanvas::Item* /*item*/, GdkEvent* event, ItemTyp
 	case RegionItem:
 		if (mouse_mode != MouseRange || _join_object_range_state == JOIN_OBJECT_RANGE_OBJECT) {
 			set_selected_regionview_from_click (press, op, true);
-		} else if (event->type == GDK_BUTTON_PRESS) {
+		} else if (press) {
 			selection->clear_tracks ();
 			set_selected_track_as_side_effect (op, true);
 		}
@@ -1127,6 +1198,9 @@ Editor::button_press_handler_2 (ArdourCanvas::Item* item, GdkEvent* event, ItemT
 
 		break;
 
+	case MouseDraw:
+		return false;
+
 	case MouseRange:
 		/* relax till release */
 		return true;
@@ -1150,18 +1224,24 @@ Editor::button_press_handler_2 (ArdourCanvas::Item* item, GdkEvent* event, ItemT
 }
 
 bool
-Editor::button_press_handler (ArdourCanvas::Item* item, GdkEvent* event, ItemType item_type)
+Editor::toggle_internal_editing_from_double_click (GdkEvent* event)
 {
-	if (event->type == GDK_2BUTTON_PRESS) {
 	if (_drags->active()) {
 		_drags->end_grab (event);
-		} else {
+	} 
 	Glib::RefPtr<Action> act = ActionManager::get_action (X_("MouseMode"), X_("toggle-internal-edit"));
 	act->activate ();
-		}
-		return true;
-	}
 
+	/* prevent reversion of edit cursor on button release */
+	
+	pre_press_cursor = 0;
+
+	return true;
+}
+
+bool
+Editor::button_press_handler (ArdourCanvas::Item* item, GdkEvent* event, ItemType item_type)
+{
 	if (event->type != GDK_BUTTON_PRESS) {
 		return false;
 	}
@@ -1578,8 +1658,10 @@ Editor::button_release_handler (ArdourCanvas::Item* item, GdkEvent* event, ItemT
 			}
 			break;
 
-		case MouseRange:
+		case MouseDraw:
+			return true;
 			
+		case MouseRange:
 			// x_style_paste (where, 1.0);
 			return true;
 			break;
@@ -2569,10 +2651,6 @@ Editor::set_internal_edit (bool yn)
 	_internal_editing = yn;
 	
 	if (yn) {
-		mouse_select_button.set_image (::get_icon("midi_tool_pencil"));
-		ARDOUR_UI::instance()->set_tip (mouse_select_button, _("Draw/Edit MIDI Notes"));
-		mouse_mode_toggled (mouse_mode);
-
                 pre_internal_mouse_mode = mouse_mode;
 
                 for (TrackViewList::iterator i = track_views.begin(); i != track_views.end(); ++i) {
@@ -2580,20 +2658,17 @@ Editor::set_internal_edit (bool yn)
                 }
 
 	} else {
-
-		mouse_select_button.set_image (::get_icon("tool_range"));
-		ARDOUR_UI::instance()->set_tip (mouse_select_button, _("Select/Move Ranges"));
-		mouse_mode_toggled (mouse_mode); // sets cursor
-
                 for (TrackViewList::iterator i = track_views.begin(); i != track_views.end(); ++i) {
                         (*i)->leave_internal_edit_mode ();
                 }
 
-                if (mouse_mode == MouseRange && pre_internal_mouse_mode != MouseRange) {
+                if (mouse_mode == MouseDraw && pre_internal_mouse_mode != MouseDraw) {
                         /* we were drawing .. flip back to something sensible */
                         set_mouse_mode (pre_internal_mouse_mode);
                 }
 	}
+	
+	set_canvas_cursor ();
 }
 
 /** Update _join_object_range_state which indicate whether we are over the top or bottom half of a region view,

gtk2_ardour/midi_region_view.cc

@@ -325,6 +325,10 @@ MidiRegionView::canvas_event(GdkEvent* ev)
 		break;
 	}
 
+	if (ev->type == GDK_2BUTTON_PRESS) {
+		return trackview.editor().toggle_internal_editing_from_double_click (ev);
+	}
+
 	if (!trackview.editor().internal_editing()) {
 		return false;
 	}
@@ -342,9 +346,6 @@ MidiRegionView::canvas_event(GdkEvent* ev)
 	case GDK_BUTTON_PRESS:
 		return button_press (&ev->button);
 
-	case GDK_2BUTTON_PRESS:
-		return false;
-
 	case GDK_BUTTON_RELEASE:
 		return button_release (&ev->button);
 
@@ -378,7 +379,7 @@ MidiRegionView::enter_notify (GdkEventCrossing* ev)
 		_mouse_mode_connection, invalidator (*this), ui_bind (&MidiRegionView::mouse_mode_changed, this), gui_context ()
 		);
 
-	if (trackview.editor().current_mouse_mode() == MouseRange && _mouse_state != AddDragging) {
+	if (trackview.editor().current_mouse_mode() == MouseDraw && _mouse_state != AddDragging) {
 		create_ghost_note (ev->x, ev->y);
 	}
 
@@ -406,7 +407,7 @@ MidiRegionView::leave_notify (GdkEventCrossing*)
 void
 MidiRegionView::mouse_mode_changed ()
 {
-	if (trackview.editor().current_mouse_mode() == MouseRange && trackview.editor().internal_editing()) {
+	if (trackview.editor().current_mouse_mode() == MouseDraw && trackview.editor().internal_editing()) {
 		create_ghost_note (_last_event_x, _last_event_y);
 	} else {
 		remove_ghost_note ();
@@ -492,7 +493,7 @@ MidiRegionView::button_release (GdkEventButton* ev)
 
 				break;
 			}
-		case MouseRange:
+		case MouseDraw:
 			{
 				bool success;
 				Evoral::MusicalTime beats = editor.get_grid_type_as_beats (success, editor.pixel_to_frame (event_x));
@@ -537,21 +538,21 @@ MidiRegionView::motion (GdkEventMotion* ev)
 {
 	PublicEditor& editor = trackview.editor ();
 
-	if (!_ghost_note && editor.current_mouse_mode() != MouseRange
+	if (!_ghost_note && editor.current_mouse_mode() != MouseDraw
 	    && Keyboard::modifier_state_contains (ev->state, Keyboard::insert_note_modifier())
 	    && _mouse_state != AddDragging) {
 
 		create_ghost_note (ev->x, ev->y);
-	} else if (_ghost_note && editor.current_mouse_mode() != MouseRange
+	} else if (_ghost_note && editor.current_mouse_mode() != MouseDraw
 	           && Keyboard::modifier_state_contains (ev->state, Keyboard::insert_note_modifier())) {
 
 		update_ghost_note (ev->x, ev->y);
-	} else if (_ghost_note && editor.current_mouse_mode() != MouseRange) {
+	} else if (_ghost_note && editor.current_mouse_mode() != MouseDraw) {
 
 		remove_ghost_note ();
 
 		editor.verbose_cursor()->hide ();
-	} else if (_ghost_note && editor.current_mouse_mode() == MouseRange) {
+	} else if (_ghost_note && editor.current_mouse_mode() == MouseDraw) {
 		update_ghost_note (ev->x, ev->y);
 	}
 

gtk2_ardour/public_editor.h

@@ -176,6 +176,15 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible {
 
 	virtual void set_internal_edit (bool yn) = 0;
 
+	/** Driven by a double-click, switch in or out of a mode in which
+	    editing is primarily focused on "within" regions, rather than
+	    regions as black-box objects. For Ardour3, this is aimed at editing
+	    MIDI regions but may expand in the future to other types of
+	    regions.
+	*/
+
+	virtual bool toggle_internal_editing_from_double_click (GdkEvent*) = 0;
+
 	/** @return Whether editing is currently in "internal" mode or not
 	 */