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