NOOP, remove trailing tabs/whitespace.
[ardour.git] / gtk2_ardour / public_editor.h
index 4b3c83ffb10be26aeb315a5fb9bb32bfae07ad65..bcf98dbac48fe95955b0b0070d2b5f776e68d83f 100644 (file)
 #include <gtkmm/actiongroup.h>
 #include <sigc++/signal.h>
 
+#include "evoral/Note.hpp"
 #include "evoral/types.hpp"
 
 #include "pbd/statefuldestructible.h"
 
 #include "canvas/fwd.h"
+
+#include "gtkmm2ext/actions.h"
 #include "gtkmm2ext/visibility_tracker.h"
 
 #include "editing.h"
@@ -68,7 +71,7 @@ class AutomationTimeAxisView;
 class ControlPoint;
 class DragManager;
 class Editor;
-class Marker;
+class ArdourMarker;
 class MeterMarker;
 class MouseCursors;
 class PlaylistSelector;
@@ -140,8 +143,14 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
         */
        virtual void set_snap_threshold (double t) = 0;
 
-       /** Snap a value according to the current snap setting. */
-       virtual void snap_to (framepos_t& first, int32_t direction = 0, bool for_mark = false) = 0;
+       /**
+        * Snap a value according to the current snap setting.
+        * ensure_snap overrides SnapOff and magnetic snap
+        */
+       virtual void snap_to (framepos_t&       first,
+                             ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
+                             bool              for_mark  = false,
+                             bool              ensure_snap = false) = 0;
 
        /** Undo some transactions.
         * @param n Number of transactions to undo.
@@ -171,25 +180,8 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
         */
        virtual Editing::MouseMode current_mouse_mode () const = 0;
 
-       /** Switch into 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 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
+       /** @return Whether the current mouse mode is an "internal" editing mode.
         */
-
        virtual bool internal_editing() const = 0;
 
        /** Possibly start the audition of a region.  If @param r is 0, or not an AudioRegion
@@ -218,12 +210,13 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
        virtual void remove_location_at_playhead_cursor () = 0;
        virtual void set_show_measures (bool yn) = 0;
        virtual bool show_measures () const = 0;
+       virtual void remove_tracks () = 0;
 
        virtual Editing::MouseMode effective_mouse_mode () const = 0;
 
-        /** Import existing media */
-        virtual void do_import (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality, framepos_t&) = 0;
-        virtual void do_embed (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode,  framepos_t&) = 0;
+       /** Import existing media */
+       virtual void do_import (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality, framepos_t&, boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
+       virtual void do_embed (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode,  framepos_t&, boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
 
        /** Open main export dialog */
        virtual void export_audio () = 0;
@@ -243,12 +236,14 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
        virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
        virtual Editing::ZoomFocus get_zoom_focus () const = 0;
        virtual framecnt_t get_current_zoom () const = 0;
+       virtual void reset_zoom (framecnt_t) = 0;
        virtual PlaylistSelector& playlist_selector() const = 0;
        virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
        virtual void new_playlists (TimeAxisView*) = 0;
        virtual void copy_playlists (TimeAxisView*) = 0;
        virtual void clear_playlists (TimeAxisView*) = 0;
        virtual void select_all_tracks () = 0;
+       virtual void deselect_all () = 0;
        virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
        virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
        virtual void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false) = 0;
@@ -281,25 +276,30 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
         virtual void override_visible_track_count () = 0;
        virtual void scroll_tracks_down_line () = 0;
        virtual void scroll_tracks_up_line () = 0;
-        virtual bool scroll_down_one_track () = 0;
-        virtual bool scroll_up_one_track () = 0;
+        virtual bool scroll_down_one_track (bool skip_child_views = false) = 0;
+        virtual bool scroll_up_one_track (bool skip_child_views = false) = 0;
        virtual void prepare_for_cleanup () = 0;
        virtual void finish_cleanup () = 0;
        virtual void reset_x_origin (framepos_t frame) = 0;
+       virtual double get_y_origin () const = 0;
+       virtual void reset_y_origin (double pos) = 0;
        virtual void remove_last_capture () = 0;
        virtual void maximise_editing_space () = 0;
        virtual void restore_editing_space () = 0;
        virtual void update_tearoff_visibility () = 0;
-       virtual framepos_t get_preferred_edit_position (bool ignore_playhead = false, bool from_context_menu = false) = 0;
+       virtual void reattach_all_tearoffs () = 0;
+       virtual framepos_t get_preferred_edit_position (Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE, bool from_context_menu = false, bool from_outside_canvas = false) = 0;
        virtual void toggle_meter_updating() = 0;
        virtual void split_regions_at (framepos_t, RegionSelection&) = 0;
        virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false) = 0;
-       virtual void mouse_add_new_marker (framepos_t where, bool is_cd=false, bool is_xrun=false) = 0;
+       virtual void mouse_add_new_marker (framepos_t where, bool is_cd=false) = 0;
        virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
        virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
        virtual framecnt_t get_nudge_distance (framepos_t pos, framecnt_t& next) = 0;
-       virtual Evoral::MusicalTime get_grid_type_as_beats (bool& success, framepos_t position) = 0;
-        virtual void edit_notes (TimeAxisViewItem&) = 0;
+       virtual framecnt_t get_paste_offset (framepos_t pos, unsigned paste_count, framecnt_t duration) = 0;
+       virtual unsigned get_grid_beat_divisions(framepos_t position) = 0;
+       virtual Evoral::Beats get_grid_type_as_beats (bool& success, framepos_t position) = 0;
+       virtual void edit_notes (MidiRegionView*) = 0;
 
        virtual void queue_visual_videotimeline_update () = 0;
        virtual void set_close_video_sensitive (bool) = 0;
@@ -310,7 +310,6 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
        virtual int  get_videotl_bar_height () const = 0;
        virtual void set_video_timeline_height (const int h) = 0;
        virtual void embed_audio_from_video (std::string, framepos_t n = 0, bool lock_position_to_video = true) = 0;
-       virtual void export_video (bool range = false) = 0;
 
        virtual RouteTimeAxisView* get_route_view_by_route_id (const PBD::ID& id) const = 0;
 
@@ -347,9 +346,8 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
        virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
        virtual bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
        virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
-       virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, Marker*) = 0;
+       virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, ArdourMarker*) = 0;
        virtual bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
-       virtual bool canvas_zoom_rect_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
        virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
        virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
        virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
@@ -377,8 +375,8 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
 
        virtual ArdourCanvas::Container* get_trackview_group () const = 0;
        virtual ArdourCanvas::ScrollGroup* get_hscroll_group () const = 0;
-       virtual ArdourCanvas::ScrollGroup* get_vscroll_group () const = 0;
        virtual ArdourCanvas::ScrollGroup* get_hvscroll_group () const = 0;
+       virtual ArdourCanvas::ScrollGroup* get_cursor_scroll_group () const = 0;
 
         virtual ArdourCanvas::GtkCanvasViewport* get_track_canvas() const = 0;
 
@@ -400,6 +398,13 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
        virtual void stop_canvas_autoscroll () = 0;
         virtual bool autoscroll_active() const = 0;
 
+       virtual void begin_reversible_selection_op (std::string cmd_name) = 0;
+       virtual void commit_reversible_selection_op () = 0;
+       virtual void begin_reversible_command (std::string cmd_name) = 0;
+       virtual void begin_reversible_command (GQuark) = 0;
+       virtual void abort_reversible_command () = 0;
+       virtual void commit_reversible_command () = 0;
+
        virtual MouseCursors const * cursors () const = 0;
        virtual VerboseCursor * verbose_cursor () const = 0;
 
@@ -407,13 +412,24 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
 
        virtual void get_pointer_position (double &, double &) const = 0;
 
-       virtual ARDOUR::Location* find_location_from_marker (Marker *, bool &) const = 0;
-       virtual Marker* find_marker_from_location_id (PBD::ID const &, bool) const = 0;
+       virtual ARDOUR::Location* find_location_from_marker (ArdourMarker *, bool &) const = 0;
+       virtual ArdourMarker* find_marker_from_location_id (PBD::ID const &, bool) const = 0;
 
-       virtual void snap_to_with_modifier (framepos_t &, GdkEvent const *, int32_t direction = 0, bool for_mark = false) = 0;
+       virtual void snap_to_with_modifier (framepos_t &      first,
+                                           GdkEvent const *  ev,
+                                           ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
+                                           bool              for_mark  = false) = 0;
 
        virtual void get_regions_at (RegionSelection &, framepos_t where, TrackViewList const &) const = 0;
+       virtual void get_regions_after (RegionSelection&, framepos_t where, const TrackViewList& ts) const = 0;
        virtual RegionSelection get_regions_from_selection_and_mouse (framepos_t) = 0;
+       virtual void get_regionviews_by_id (PBD::ID const id, RegionSelection & regions) const = 0;
+       virtual void get_per_region_note_selection (std::list<std::pair<PBD::ID, std::set<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > > >&) const = 0;
+
+       virtual void mouse_add_new_tempo_event (framepos_t where) = 0;
+       virtual void mouse_add_new_meter_event (framepos_t where) = 0;
+       virtual void edit_tempo_section (ARDOUR::TempoSection*) = 0;
+       virtual void edit_meter_section (ARDOUR::MeterSection*) = 0;
 
        /// Singleton instance, set up by Editor::Editor()
 
@@ -446,4 +462,19 @@ class DisplaySuspender {
                }
 };
 
+class MainMenuDisabler {
+public:
+       MainMenuDisabler () {
+               /* The global menu bar continues to be accessible to applications
+                  with modal dialogs on mac, which means that we need to desensitize
+                  all items in the menu bar.
+               */
+               ActionManager::disable_active_actions ();
+       }
+
+       ~MainMenuDisabler () {
+               ActionManager::enable_active_actions ();
+       }
+};
+
 #endif // __gtk_ardour_public_editor_h__