gtk2_ardour/public_editor.h

   1 /*
   2     Copyright (C) 2000-2007 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 #ifndef __gtk_ardour_public_editor_h__
  21 #define __gtk_ardour_public_editor_h__
  22
  23 #ifdef WAF_BUILD
  24 #include "gtk2ardour-config.h"
  25 #endif
  26
  27 #include <map>
  28
  29 #include <string>
  30 #include <glib.h>
  31 #include <gdk/gdktypes.h>
  32 #include <gtkmm/box.h>
  33 #include <gtkmm/window.h>
  34 #include <gtkmm/actiongroup.h>
  35 #include <gtkmm/notebook.h>
  36 #include <sigc++/signal.h>
  37
  38 #include "evoral/Beats.hpp"
  39 #include "evoral/Note.hpp"
  40
  41 #include "pbd/statefuldestructible.h"
  42
  43 #include "ardour/session_handle.h"
  44
  45 #include "canvas/fwd.h"
  46
  47 #include "gtkmm2ext/actions.h"
  48 #include "gtkmm2ext/bindings.h"
  49 #include "gtkmm2ext/tabbable.h"
  50 #include "gtkmm2ext/visibility_tracker.h"
  51
  52 #include "axis_provider.h"
  53 #include "editing.h"
  54 #include "selection.h"
  55
  56 namespace ARDOUR {
  57         class Session;
  58         class Region;
  59         class Playlist;
  60         class RouteGroup;
  61         class Trimmable;
  62         class Movable;
  63         class Stripable;
  64 }
  65
  66 namespace Gtk {
  67         class Container;
  68         class Menu;
  69 }
  70
  71 class AudioRegionView;
  72 class AutomationLine;
  73 class AutomationTimeAxisView;
  74 class ControlPoint;
  75 class DragManager;
  76 class Editor;
  77 class ArdourMarker;
  78 class MeterMarker;
  79 class MouseCursors;
  80 class PlaylistSelector;
  81 class PluginSelector;
  82 class PluginUIWindow;
  83 class RegionView;
  84 class RouteTimeAxisView;
  85 class Selection;
  86 class TempoCurve;
  87 class TempoMarker;
  88 class TimeAxisView;
  89 class TimeAxisViewItem;
  90 class VerboseCursor;
  91 class XMLNode;
  92 struct SelectionRect;
  93
  94 class DisplaySuspender;
  95
  96 namespace ARDOUR_UI_UTILS {
  97 bool relay_key_press (GdkEventKey* ev, Gtk::Window* win);
  98 bool forward_key_press (GdkEventKey* ev);
  99 }
 100
 101 using ARDOUR::framepos_t;
 102 using ARDOUR::framecnt_t;
 103
 104 /// Representation of the interface of the Editor class
 105
 106 /** This class contains just the public interface of the Editor class,
 107  * in order to decouple it from the private implementation, so that callers
 108  * of PublicEditor need not be recompiled if private methods or member variables
 109  * change.
 110  */
 111 class PublicEditor : public Gtkmm2ext::Tabbable,  public ARDOUR::SessionHandlePtr, public AxisViewProvider {
 112   public:
 113         PublicEditor (Gtk::Widget& content);
 114         virtual ~PublicEditor ();
 115
 116         /** @return Singleton PublicEditor instance */
 117         static PublicEditor& instance () { return *_instance; }
 118
 119         virtual bool have_idled() const = 0;
 120         virtual void first_idle() = 0;
 121
 122         virtual void setup_tooltips() = 0;
 123
 124         /** Attach this editor to a Session.
 125          * @param s Session to connect to.
 126          */
 127         virtual void set_session (ARDOUR::Session* s) = 0;
 128
 129         /** Set the snap type.
 130          * @param t Snap type (defined in editing_syms.h)
 131          */
 132         virtual void set_snap_to (Editing::SnapType t) = 0;
 133
 134         virtual Editing::SnapType snap_type () const = 0;
 135         virtual Editing::SnapMode snap_mode () const = 0;
 136
 137         /** Set the snap mode.
 138          * @param m Snap mode (defined in editing_syms.h)
 139          */
 140         virtual void set_snap_mode (Editing::SnapMode m) = 0;
 141
 142         /** Set the snap threshold.
 143          * @param t Snap threshold in `units'.
 144          */
 145         virtual void set_snap_threshold (double t) = 0;
 146
 147         /**
 148          * Snap a value according to the current snap setting.
 149          * ensure_snap overrides SnapOff and magnetic snap
 150          */
 151         virtual void snap_to (ARDOUR::MusicFrame& first,
 152                               ARDOUR::RoundMode   direction = ARDOUR::RoundNearest,
 153                               bool                for_mark  = false,
 154                               bool                ensure_snap = false) = 0;
 155
 156         /** Undo some transactions.
 157          * @param n Number of transactions to undo.
 158          */
 159
 160         virtual void undo (uint32_t n = 1) = 0;
 161
 162         /** Redo some transactions.
 163          * @param n Number of transaction to redo.
 164          */
 165         virtual void redo (uint32_t n = 1) = 0;
 166
 167         /** Set the mouse mode (gain, object, range, timefx etc.)
 168          * @param m Mouse mode (defined in editing_syms.h)
 169          * @param force Perform the effects of the change even if no change is required
 170          * (ie even if the current mouse mode is equal to @param m)
 171          */
 172         virtual void set_mouse_mode (Editing::MouseMode m, bool force = false) = 0;
 173
 174         /** Step the mouse mode onto the next or previous one.
 175          * @param next true to move to the next, otherwise move to the previous
 176          */
 177         virtual void step_mouse_mode (bool next) = 0;
 178
 179         /** @return The current mouse mode (gain, object, range, timefx etc.)
 180          * (defined in editing_syms.h)
 181          */
 182         virtual Editing::MouseMode current_mouse_mode () const = 0;
 183
 184         /** @return Whether the current mouse mode is an "internal" editing mode.
 185          */
 186         virtual bool internal_editing() const = 0;
 187
 188         /** Possibly start the audition of a region.  If @param r is 0, or not an AudioRegion
 189          * any current audition is cancelled.  If we are currently auditioning @param r,
 190          * the audition will be cancelled.  Otherwise an audition of @param r will start.
 191          * \param r Region to consider.
 192          */
 193         virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
 194
 195         /* import dialogs -> ardour-ui ?! */
 196         virtual void external_audio_dialog () = 0;
 197         virtual void session_import_dialog () = 0;
 198
 199         virtual void new_region_from_selection () = 0;
 200         virtual void separate_region_from_selection () = 0;
 201
 202         virtual void transition_to_rolling (bool fwd) = 0;
 203         virtual framepos_t pixel_to_sample (double pixel) const = 0;
 204         virtual framepos_t playhead_cursor_sample () const = 0;
 205         virtual double sample_to_pixel (framepos_t frame) const = 0;
 206         virtual double sample_to_pixel_unrounded (framepos_t frame) const = 0;
 207
 208         virtual Selection& get_selection () const = 0;
 209         virtual bool get_selection_extents (framepos_t &start, framepos_t &end) const = 0;
 210         virtual Selection& get_cut_buffer () const = 0;
 211
 212         virtual void set_selection (std::list<Selectable*>, Selection::Operation) = 0;
 213
 214         virtual bool extend_selection_to_track (TimeAxisView&) = 0;
 215         virtual void play_selection () = 0;
 216         virtual void play_with_preroll () = 0;
 217         virtual void rec_with_preroll () = 0;
 218         virtual void rec_with_count_in () = 0;
 219         virtual void maybe_locate_with_edit_preroll (framepos_t location) = 0;
 220         virtual void goto_nth_marker (int nth) = 0;
 221         virtual void trigger_script (int nth) = 0;
 222         virtual void add_location_from_playhead_cursor () = 0;
 223         virtual void remove_location_at_playhead_cursor () = 0;
 224         virtual void set_show_measures (bool yn) = 0;
 225         virtual bool show_measures () const = 0;
 226         virtual void remove_tracks () = 0;
 227         virtual void set_loop_range (framepos_t start, framepos_t end, std::string cmd) = 0;
 228         virtual void set_punch_range (framepos_t start, framepos_t end, std::string cmd) = 0;
 229
 230         virtual void jump_forward_to_mark () = 0;
 231         virtual void jump_backward_to_mark () = 0;
 232
 233         virtual void set_session_start_from_playhead () = 0;
 234         virtual void set_session_end_from_playhead () = 0;
 235
 236         virtual void toggle_location_at_playhead_cursor () = 0;
 237
 238         virtual void nudge_forward (bool next, bool force_playhead) = 0;
 239         virtual void nudge_backward (bool next, bool force_playhead) = 0;
 240
 241         virtual void playhead_forward_to_grid () = 0;
 242         virtual void playhead_backward_to_grid () = 0;
 243
 244         virtual void keyboard_selection_begin ( Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE) = 0;
 245         virtual void keyboard_selection_finish (bool add, Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE) = 0;
 246
 247         virtual void set_punch_start_from_edit_point () = 0;
 248         virtual void set_punch_end_from_edit_point () = 0;
 249         virtual void set_loop_start_from_edit_point () = 0;
 250         virtual void set_loop_end_from_edit_point () = 0;
 251
 252         virtual Editing::MouseMode effective_mouse_mode () const = 0;
 253
 254         /** Import existing media */
 255         virtual void do_import (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality,
 256                                 ARDOUR::MidiTrackNameSource, ARDOUR::MidiTempoMapDisposition, framepos_t&,
 257                                 boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
 258         virtual void do_embed (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode,
 259                                framepos_t&,
 260                                boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
 261
 262         /** Open main export dialog */
 263         virtual void export_audio () = 0;
 264
 265         /** Open stem export dialog */
 266         virtual void stem_export () = 0;
 267
 268         /** Open export dialog with current selection pre-selected */
 269         virtual void export_selection () = 0;
 270
 271         /** Open export dialog with current range pre-selected */
 272         virtual void export_range () = 0;
 273
 274         virtual void register_actions () = 0;
 275         virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
 276         virtual Editing::ZoomFocus get_zoom_focus () const = 0;
 277         virtual framecnt_t get_current_zoom () const = 0;
 278         virtual void reset_zoom (framecnt_t) = 0;
 279         virtual PlaylistSelector& playlist_selector() const = 0;
 280         virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
 281         virtual void new_playlists (TimeAxisView*) = 0;
 282         virtual void copy_playlists (TimeAxisView*) = 0;
 283         virtual void clear_playlists (TimeAxisView*) = 0;
 284         virtual void select_all_tracks () = 0;
 285         virtual void deselect_all () = 0;
 286         virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
 287         virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
 288         virtual void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false) = 0;
 289         virtual void show_track_in_display (TimeAxisView* tv, bool move_into_view = false) = 0;
 290
 291         virtual void set_stationary_playhead (bool yn) = 0;
 292         virtual void toggle_stationary_playhead () = 0;
 293         virtual bool stationary_playhead() const = 0;
 294
 295         /** Set whether the editor should follow the playhead.
 296          * @param yn true to follow playhead, otherwise false.
 297          * @param catch_up true to reset the editor view to show the playhead (if yn == true), otherwise false.
 298          */
 299         virtual void set_follow_playhead (bool yn, bool catch_up = false) = 0;
 300
 301         /** Toggle whether the editor is following the playhead */
 302         virtual void toggle_follow_playhead () = 0;
 303
 304         /** @return true if the editor is following the playhead */
 305         virtual bool follow_playhead () const = 0;
 306
 307         /** @return true if the playhead is currently being dragged, otherwise false */
 308         virtual bool dragging_playhead () const = 0;
 309         virtual framepos_t leftmost_sample() const = 0;
 310         virtual framecnt_t current_page_samples() const = 0;
 311         virtual double visible_canvas_height () const = 0;
 312         virtual void temporal_zoom_step (bool coarser) = 0;
 313         virtual void ensure_time_axis_view_is_visible (TimeAxisView const & tav, bool at_top = false) = 0;
 314         virtual void override_visible_track_count () = 0;
 315         virtual void scroll_tracks_down_line () = 0;
 316         virtual void scroll_tracks_up_line () = 0;
 317         virtual bool scroll_down_one_track (bool skip_child_views = false) = 0;
 318         virtual bool scroll_up_one_track (bool skip_child_views = false) = 0;
 319         virtual void select_topmost_track () = 0;
 320         virtual void prepare_for_cleanup () = 0;
 321         virtual void finish_cleanup () = 0;
 322         virtual void reset_x_origin (framepos_t frame) = 0;
 323         virtual double get_y_origin () const = 0;
 324         virtual void reset_y_origin (double pos) = 0;
 325         virtual void remove_last_capture () = 0;
 326         virtual void maximise_editing_space () = 0;
 327         virtual void restore_editing_space () = 0;
 328         virtual framepos_t get_preferred_edit_position (Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE, bool from_context_menu = false, bool from_outside_canvas = false) = 0;
 329         virtual void toggle_meter_updating() = 0;
 330         virtual void split_regions_at (ARDOUR::MusicFrame, RegionSelection&, bool snap) = 0;
 331         virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false) = 0;
 332         virtual void mouse_add_new_marker (framepos_t where, bool is_cd=false) = 0;
 333         virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
 334         virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
 335         virtual framecnt_t get_nudge_distance (framepos_t pos, framecnt_t& next) = 0;
 336         virtual framecnt_t get_paste_offset (framepos_t pos, unsigned paste_count, framecnt_t duration) = 0;
 337         virtual unsigned get_grid_beat_divisions(framepos_t position) = 0;
 338         virtual Evoral::Beats get_grid_type_as_beats (bool& success, framepos_t position) = 0;
 339         virtual int32_t get_grid_music_divisions (uint32_t event_state) = 0;
 340         virtual void edit_notes (MidiRegionView*) = 0;
 341
 342         virtual void queue_visual_videotimeline_update () = 0;
 343         virtual void set_close_video_sensitive (bool) = 0;
 344         virtual void toggle_ruler_video (bool) = 0;
 345         virtual void toggle_xjadeo_proc (int) = 0;
 346         virtual void toggle_xjadeo_viewoption (int, int) = 0;
 347         virtual void set_xjadeo_sensitive (bool onoff) = 0;
 348         virtual int  get_videotl_bar_height () const = 0;
 349         virtual void set_video_timeline_height (const int h) = 0;
 350         virtual void embed_audio_from_video (std::string, framepos_t n = 0, bool lock_position_to_video = true) = 0;
 351
 352         virtual bool track_selection_change_without_scroll () const = 0;
 353
 354         virtual RouteTimeAxisView* get_route_view_by_route_id (const PBD::ID& id) const = 0;
 355
 356         virtual TimeAxisView* time_axis_view_from_stripable (boost::shared_ptr<ARDOUR::Stripable> s) const = 0;
 357
 358         virtual void get_equivalent_regions (RegionView* rv, std::vector<RegionView*>&, PBD::PropertyID) const = 0;
 359         virtual RegionView* regionview_from_region (boost::shared_ptr<ARDOUR::Region>) const = 0;
 360         virtual RouteTimeAxisView* rtav_from_route (boost::shared_ptr<ARDOUR::Route>) const = 0;
 361
 362         sigc::signal<void> ZoomChanged;
 363         sigc::signal<void> Realized;
 364         sigc::signal<void,framepos_t> UpdateAllTransportClocks;
 365
 366         static sigc::signal<void> DropDownKeys;
 367
 368         struct RegionAction {
 369                 Glib::RefPtr<Gtk::Action> action;
 370                 Editing::RegionActionTarget target;
 371
 372                 RegionAction (Glib::RefPtr<Gtk::Action> a, Editing::RegionActionTarget tgt)
 373                         : action (a), target (tgt) {}
 374         };
 375
 376         std::map<std::string,RegionAction> region_action_map;
 377
 378         Glib::RefPtr<Gtk::ActionGroup> editor_actions;
 379         Glib::RefPtr<Gtk::ActionGroup> editor_menu_actions;
 380         Glib::RefPtr<Gtk::ActionGroup> _region_actions;
 381
 382         virtual bool canvas_scroll_event (GdkEventScroll* event, bool from_canvas) = 0;
 383         virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
 384         virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
 385         virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 386         virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 387         virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 388         virtual bool canvas_start_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 389         virtual bool canvas_end_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 390         virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 391         virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
 392         virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 393         virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
 394         virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 395         virtual bool canvas_wave_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 396         virtual bool canvas_frame_handle_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 397         virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 398         virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 399         virtual bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 400         virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
 401         virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, ArdourMarker*) = 0;
 402         virtual bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 403         virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
 404         virtual bool canvas_tempo_curve_event (GdkEvent* event, ArdourCanvas::Item*, TempoCurve*) = 0;
 405         virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
 406         virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
 407
 408         virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 409         virtual bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 410         virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 411         virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 412         virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 413         virtual bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 414
 415         static const int window_border_width;
 416         static const int container_border_width;
 417         static const int vertical_spacing;
 418         static const int horizontal_spacing;
 419
 420         virtual ArdourCanvas::Container* get_trackview_group () const = 0;
 421         virtual ArdourCanvas::ScrollGroup* get_hscroll_group () const = 0;
 422         virtual ArdourCanvas::ScrollGroup* get_hvscroll_group () const = 0;
 423         virtual ArdourCanvas::ScrollGroup* get_cursor_scroll_group () const = 0;
 424
 425         virtual ArdourCanvas::GtkCanvasViewport* get_track_canvas() const = 0;
 426
 427         virtual void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>) = 0;
 428         virtual void set_current_movable (boost::shared_ptr<ARDOUR::Movable>) = 0;
 429
 430         virtual void center_screen (framepos_t) = 0;
 431
 432         virtual TrackViewList axis_views_from_routes (boost::shared_ptr<ARDOUR::RouteList>) const = 0;
 433         virtual TrackViewList const & get_track_views () const = 0;
 434
 435         virtual DragManager* drags () const = 0;
 436         virtual void maybe_autoscroll (bool, bool, bool from_headers) = 0;
 437         virtual void stop_canvas_autoscroll () = 0;
 438         virtual bool autoscroll_active() const = 0;
 439
 440         virtual void begin_reversible_selection_op (std::string cmd_name) = 0;
 441         virtual void commit_reversible_selection_op () = 0;
 442         virtual void begin_reversible_command (std::string cmd_name) = 0;
 443         virtual void begin_reversible_command (GQuark) = 0;
 444         virtual void abort_reversible_command () = 0;
 445         virtual void commit_reversible_command () = 0;
 446
 447         virtual void access_action (std::string,std::string) = 0;
 448
 449         virtual MouseCursors const * cursors () const = 0;
 450         virtual VerboseCursor * verbose_cursor () const = 0;
 451
 452         virtual bool get_smart_mode () const = 0;
 453
 454         virtual void get_pointer_position (double &, double &) const = 0;
 455
 456         virtual ARDOUR::Location* find_location_from_marker (ArdourMarker *, bool &) const = 0;
 457         virtual ArdourMarker* find_marker_from_location_id (PBD::ID const &, bool) const = 0;
 458
 459         virtual void snap_to_with_modifier (ARDOUR::MusicFrame& first,
 460                                             GdkEvent const *    ev,
 461                                             ARDOUR::RoundMode   direction = ARDOUR::RoundNearest,
 462                                             bool                for_mark  = false) = 0;
 463
 464         virtual void get_regions_at (RegionSelection &, framepos_t where, TrackViewList const &) const = 0;
 465         virtual void get_regions_after (RegionSelection&, framepos_t where, const TrackViewList& ts) const = 0;
 466         virtual RegionSelection get_regions_from_selection_and_mouse (framepos_t) = 0;
 467         virtual void get_regionviews_by_id (PBD::ID const id, RegionSelection & regions) const = 0;
 468         virtual void get_per_region_note_selection (std::list<std::pair<PBD::ID, std::set<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > > >&) const = 0;
 469
 470         virtual void mouse_add_new_tempo_event (framepos_t where) = 0;
 471         virtual void mouse_add_new_meter_event (framepos_t where) = 0;
 472         virtual void edit_tempo_section (ARDOUR::TempoSection*) = 0;
 473         virtual void edit_meter_section (ARDOUR::MeterSection*) = 0;
 474
 475         /// Singleton instance, set up by Editor::Editor()
 476
 477         static PublicEditor* _instance;
 478
 479         friend bool ARDOUR_UI_UTILS::relay_key_press (GdkEventKey*, Gtk::Window*);
 480         friend bool ARDOUR_UI_UTILS::forward_key_press (GdkEventKey*);
 481
 482         PBD::Signal0<void> SnapChanged;
 483         PBD::Signal0<void> MouseModeChanged;
 484
 485         Gtkmm2ext::Bindings* bindings;
 486
 487 protected:
 488         friend class DisplaySuspender;
 489         virtual void suspend_route_redisplay () = 0;
 490         virtual void resume_route_redisplay () = 0;
 491         gint _suspend_route_redisplay_counter;
 492 };
 493
 494 class DisplaySuspender {
 495         public:
 496                 DisplaySuspender() {
 497                         if (g_atomic_int_add(&PublicEditor::instance()._suspend_route_redisplay_counter, 1) == 0) {
 498                                 PublicEditor::instance().suspend_route_redisplay ();
 499                         }
 500                 }
 501                 ~DisplaySuspender () {
 502                         if (g_atomic_int_dec_and_test (&PublicEditor::instance()._suspend_route_redisplay_counter)) {
 503                                 PublicEditor::instance().resume_route_redisplay ();
 504                         }
 505                 }
 506 };
 507
 508 class MainMenuDisabler {
 509 public:
 510         MainMenuDisabler () {
 511                 /* The global menu bar continues to be accessible to applications
 512                    with modal dialogs on mac, which means that we need to desensitize
 513                    all items in the menu bar.
 514                 */
 515                 ActionManager::disable_active_actions ();
 516         }
 517
 518         ~MainMenuDisabler () {
 519                 ActionManager::enable_active_actions ();
 520         }
 521 };
 522
 523 #endif // __gtk_ardour_public_editor_h__