Representation of the interface of the Editor class. More...

#include <public_editor.h>

Inheritance diagram for PublicEditor:

Public Member Functions
	PublicEditor ()

virtual	~PublicEditor ()

virtual bool	have_idled () const =0

virtual void	first_idle ()=0

virtual void	setup_tooltips ()=0

virtual void	set_session (ARDOUR::Session *s)=0

virtual ARDOUR::Session *	session () const =0

virtual void	set_snap_to (Editing::SnapType t)=0

virtual Editing::SnapType	snap_type () const =0

virtual Editing::SnapMode	snap_mode () const =0

virtual void	set_snap_mode (Editing::SnapMode m)=0

virtual void	set_snap_threshold (double t)=0

virtual void	snap_to (framepos_t &first, ARDOUR::RoundMode direction=ARDOUR::RoundNearest, bool for_mark=false)=0

virtual void	undo (uint32_t n=1)=0

virtual void	redo (uint32_t n=1)=0

virtual void	set_mouse_mode (Editing::MouseMode m, bool force=false)=0

virtual void	step_mouse_mode (bool next)=0

virtual Editing::MouseMode	current_mouse_mode () const =0

virtual bool	internal_editing () const =0

virtual void	consider_auditioning (boost::shared_ptr< ARDOUR::Region > r)=0

virtual void	new_region_from_selection ()=0

virtual void	separate_region_from_selection ()=0

virtual void	transition_to_rolling (bool fwd)=0

virtual framepos_t	pixel_to_sample (double pixel) const =0

virtual double	sample_to_pixel (framepos_t frame) const =0

virtual double	sample_to_pixel_unrounded (framepos_t frame) const =0

virtual Selection &	get_selection () const =0

virtual Selection &	get_cut_buffer () const =0

virtual void	track_mixer_selection ()=0

virtual bool	extend_selection_to_track (TimeAxisView &)=0

virtual void	play_selection ()=0

virtual void	play_with_preroll ()=0

virtual void	maybe_locate_with_edit_preroll (framepos_t location)=0

virtual void	goto_nth_marker (int nth)=0

virtual void	add_location_from_playhead_cursor ()=0

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

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

virtual void	export_audio ()=0

virtual void	stem_export ()=0

virtual void	export_selection ()=0

virtual void	export_range ()=0

virtual void	register_actions ()=0

virtual void	add_transport_frame (Gtk::Container &)=0

virtual void	add_toplevel_menu (Gtk::Container &)=0

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

virtual void	set_stationary_playhead (bool yn)=0

virtual void	toggle_stationary_playhead ()=0

virtual bool	stationary_playhead () const =0

virtual void	set_follow_playhead (bool yn, bool catch_up=false)=0

virtual void	toggle_follow_playhead ()=0

virtual bool	follow_playhead () const =0

virtual bool	dragging_playhead () const =0

virtual void	ensure_float (Gtk::Window &)=0

virtual void	show_window ()=0

virtual framepos_t	leftmost_sample () const =0

virtual framecnt_t	current_page_samples () const =0

virtual double	visible_canvas_height () const =0

virtual void	temporal_zoom_step (bool coarser)=0

virtual void	ensure_time_axis_view_is_visible (TimeAxisView const &tav, bool at_top=false)=0

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 (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 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)=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 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

virtual void	toggle_ruler_video (bool)=0

virtual void	toggle_xjadeo_proc (int)=0

virtual void	toggle_xjadeo_viewoption (int, int)=0

virtual void	set_xjadeo_sensitive (bool onoff)=0

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 RouteTimeAxisView *	get_route_view_by_route_id (const PBD::ID &id) const =0

virtual void	get_equivalent_regions (RegionView rv, std::vector< RegionView > &, PBD::PropertyID) const =0

virtual void	reset_focus ()=0

virtual bool	canvas_scroll_event (GdkEventScroll *event, bool from_canvas)=0

virtual bool	canvas_control_point_event (GdkEvent event, ArdourCanvas::Item , ControlPoint *)=0

virtual bool	canvas_line_event (GdkEvent event, ArdourCanvas::Item , AutomationLine *)=0

virtual bool	canvas_selection_rect_event (GdkEvent event, ArdourCanvas::Item , SelectionRect *)=0

virtual bool	canvas_selection_start_trim_event (GdkEvent event, ArdourCanvas::Item , SelectionRect *)=0

virtual bool	canvas_selection_end_trim_event (GdkEvent event, ArdourCanvas::Item , SelectionRect *)=0

virtual bool	canvas_start_xfade_event (GdkEvent event, ArdourCanvas::Item , AudioRegionView *)=0

virtual bool	canvas_end_xfade_event (GdkEvent event, ArdourCanvas::Item , AudioRegionView *)=0

virtual bool	canvas_fade_in_event (GdkEvent event, ArdourCanvas::Item , AudioRegionView *)=0

virtual bool	canvas_fade_in_handle_event (GdkEvent event, ArdourCanvas::Item , AudioRegionView *, bool)=0

virtual bool	canvas_fade_out_event (GdkEvent event, ArdourCanvas::Item , AudioRegionView *)=0

virtual bool	canvas_fade_out_handle_event (GdkEvent event, ArdourCanvas::Item , AudioRegionView *, bool)=0

virtual bool	canvas_region_view_event (GdkEvent event, ArdourCanvas::Item , RegionView *)=0

virtual bool	canvas_wave_view_event (GdkEvent event, ArdourCanvas::Item , RegionView *)=0

virtual bool	canvas_frame_handle_event (GdkEvent event, ArdourCanvas::Item , RegionView *)=0

virtual bool	canvas_region_view_name_highlight_event (GdkEvent event, ArdourCanvas::Item , RegionView *)=0

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_videotl_bar_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

virtual bool	canvas_tempo_bar_event (GdkEvent event, ArdourCanvas::Item )=0

virtual bool	canvas_meter_bar_event (GdkEvent event, ArdourCanvas::Item )=0

virtual bool	canvas_marker_bar_event (GdkEvent event, ArdourCanvas::Item )=0

virtual bool	canvas_range_marker_bar_event (GdkEvent event, ArdourCanvas::Item )=0

virtual bool	canvas_transport_marker_bar_event (GdkEvent event, ArdourCanvas::Item )=0

virtual bool	canvas_note_event (GdkEvent event, ArdourCanvas::Item )=0

virtual ArdourCanvas::Container *	get_trackview_group () const =0

virtual ArdourCanvas::ScrollGroup *	get_hscroll_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

virtual TimeAxisView *	axis_view_from_route (boost::shared_ptr< ARDOUR::Route >) const =0

virtual void	set_current_trimmable (boost::shared_ptr< ARDOUR::Trimmable >)=0

virtual void	set_current_movable (boost::shared_ptr< ARDOUR::Movable >)=0

virtual void	center_screen (framepos_t)=0

virtual TrackViewList	axis_views_from_routes (boost::shared_ptr< ARDOUR::RouteList >) const =0

virtual TrackViewList const &	get_track_views ()=0

virtual Gtkmm2ext::TearOff *	mouse_mode_tearoff () const =0

virtual Gtkmm2ext::TearOff *	tools_tearoff () const =0

virtual DragManager *	drags () const =0

virtual void	maybe_autoscroll (bool, bool, bool from_headers)=0

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

virtual bool	get_smart_mode () const =0

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 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 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

Public Member Functions inherited from PBD::Stateful
	Stateful ()

virtual	~Stateful ()

virtual XMLNode &	get_state (void)=0

virtual int	set_state (const XMLNode &, int version)=0

virtual bool	apply_changes (PropertyBase const &)

PropertyChange	apply_changes (PropertyList const &)

const OwnedPropertyList &	properties () const

void	add_property (PropertyBase &s)

void	add_extra_xml (XMLNode &)

XMLNode *	extra_xml (const std::string &str, bool add_if_missing=false)

void	save_extra_xml (const XMLNode &)

const PBD::ID &	id () const

bool	set_id (const XMLNode &)

void	set_id (const std::string &)

void	reset_id ()

void	clear_changes ()

virtual void	clear_owned_changes ()

PropertyList *	get_changes_as_properties (Command *) const

virtual void	rdiff (std::vector< Command * > &) const

bool	changed () const

virtual PropertyList *	property_factory (const XMLNode &) const

virtual void	suspend_property_changes ()

virtual void	resume_property_changes ()

bool	property_changes_suspended () const

Public Member Functions inherited from PBD::Destructible
	Destructible ()

virtual	~Destructible ()

void	drop_references ()

Public Member Functions inherited from Gtkmm2ext::VisibilityTracker
	VisibilityTracker (Gtk::Window &)

virtual	~VisibilityTracker ()

void	cycle_visibility ()

bool	fully_visible () const

bool	not_visible () const

bool	partially_visible () const

Gtk::Window &	window () const

Static Public Member Functions
static PublicEditor &	instance ()

Public Attributes
sigc::signal< void >	ZoomChanged

sigc::signal< void >	Realized

sigc::signal< void, framepos_t >	UpdateAllTransportClocks

Glib::RefPtr< Gtk::ActionGroup >	editor_actions

Glib::RefPtr< Gtk::ActionGroup >	editor_menu_actions

Glib::RefPtr< Gtk::ActionGroup >	_region_actions

PBD::Signal0< void >	SnapChanged

PBD::Signal0< void >	MouseModeChanged

Public Attributes inherited from PBD::Stateful
PBD::Signal1< void, const PropertyChange & >	PropertyChanged

Public Attributes inherited from PBD::Destructible
PBD::Signal0< void >	Destroyed

PBD::Signal0< void >	DropReferences

Static Public Attributes
static sigc::signal< void >	DropDownKeys

static const int	window_border_width = 12

static const int	container_border_width = 12

static const int	vertical_spacing = 6

static const int	horizontal_spacing = 6

static PublicEditor *	_instance = 0
	Singleton instance, set up by Editor::Editor() More...

Static Public Attributes inherited from PBD::Stateful
static int	current_state_version = 0

static int	loading_state_version = 0

Protected Member Functions
virtual void	suspend_route_redisplay ()=0

virtual void	resume_route_redisplay ()=0

Protected Member Functions inherited from PBD::Stateful
void	add_instant_xml (XMLNode &, const std::string &directory_path)

XMLNode *	instant_xml (const std::string &str, const std::string &directory_path)

void	add_properties (XMLNode &)

PropertyChange	set_values (XMLNode const &)

virtual void	post_set (const PropertyChange &)

virtual void	send_change (const PropertyChange &)

virtual void	mid_thaw (const PropertyChange &)

Protected Attributes
gint	_suspend_route_redisplay_counter

Protected Attributes inherited from PBD::Stateful
XMLNode *	_extra_xml

XMLNode *	_instant_xml

PBD::PropertyChange	_pending_changed

Glib::Threads::Mutex	_lock

std::string	_xml_node_name
	name of node to use for this object in XML More...

OwnedPropertyList *	_properties

Friends
class	DisplaySuspender

bool	ARDOUR_UI_UTILS::relay_key_press (GdkEventKey , Gtk::Window )

bool	ARDOUR_UI_UTILS::forward_key_press (GdkEventKey *)

Detailed Description

Representation of the interface of the Editor class.

This class contains just the public interface of the Editor class, in order to decouple it from the private implementation, so that callers of PublicEditor need not be recompiled if private methods or member variables change.

Definition at line 105 of file public_editor.h.

Constructor & Destructor Documentation

PublicEditor::PublicEditor ( )

Definition at line 31 of file public_editor.cc.

PublicEditor::~PublicEditor ( )

virtual

Definition at line 38 of file public_editor.cc.

Member Function Documentation

virtual void PublicEditor::abort_reversible_command ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::add_location_from_playhead_cursor ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::add_to_idle_resize	(	TimeAxisView *	,
		int32_t
	)

pure virtual

Implemented in Editor.

virtual void PublicEditor::add_toplevel_menu ( Gtk::Container & )

pure virtual

Implemented in Editor.

virtual void PublicEditor::add_transport_frame ( Gtk::Container & )

pure virtual

Implemented in Editor.

virtual bool PublicEditor::autoscroll_active ( ) const

pure virtual

Implemented in Editor.

virtual TimeAxisView* PublicEditor::axis_view_from_route ( boost::shared_ptr< ARDOUR::Route > ) const

pure virtual

Implemented in Editor.

virtual TrackViewList PublicEditor::axis_views_from_routes ( boost::shared_ptr< ARDOUR::RouteList > ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::begin_reversible_command ( std::string cmd_name )

pure virtual

Implemented in Editor.

virtual void PublicEditor::begin_reversible_command ( GQuark )

pure virtual

Implemented in Editor.

virtual void PublicEditor::begin_reversible_selection_op ( std::string cmd_name )

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_automation_track_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		AutomationTimeAxisView *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_control_point_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		ControlPoint *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_end_xfade_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		AudioRegionView *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_fade_in_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		AudioRegionView *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_fade_in_handle_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		AudioRegionView *	,
		bool
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_fade_out_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		AudioRegionView *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_fade_out_handle_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		AudioRegionView *	,
		bool
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_feature_line_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		RegionView *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_frame_handle_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		RegionView *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_line_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		AutomationLine *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_marker_bar_event	(	GdkEvent *	event,
		ArdourCanvas::Item *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_marker_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		Marker *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_meter_bar_event	(	GdkEvent *	event,
		ArdourCanvas::Item *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_meter_marker_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		MeterMarker *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_note_event	(	GdkEvent *	event,
		ArdourCanvas::Item *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_range_marker_bar_event	(	GdkEvent *	event,
		ArdourCanvas::Item *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_region_view_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		RegionView *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_region_view_name_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		RegionView *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_region_view_name_highlight_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		RegionView *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_scroll_event	(	GdkEventScroll *	event,
		bool	from_canvas
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_selection_end_trim_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		SelectionRect *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_selection_rect_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		SelectionRect *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_selection_start_trim_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		SelectionRect *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_start_xfade_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		AudioRegionView *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_stream_view_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		RouteTimeAxisView *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_tempo_bar_event	(	GdkEvent *	event,
		ArdourCanvas::Item *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_tempo_marker_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		TempoMarker *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_transport_marker_bar_event	(	GdkEvent *	event,
		ArdourCanvas::Item *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_videotl_bar_event	(	GdkEvent *	event,
		ArdourCanvas::Item *
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::canvas_wave_view_event	(	GdkEvent *	event,
		ArdourCanvas::Item *	,
		RegionView *
	)

pure virtual

Implemented in Editor.

virtual void PublicEditor::center_screen ( framepos_t )

pure virtual

Implemented in Editor.

virtual void PublicEditor::clear_playlist ( boost::shared_ptr< ARDOUR::Playlist > )

pure virtual

Implemented in Editor.

virtual void PublicEditor::clear_playlists ( TimeAxisView * )

pure virtual

Implemented in Editor.

virtual void PublicEditor::commit_reversible_command ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::commit_reversible_selection_op ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::consider_auditioning ( boost::shared_ptr< ARDOUR::Region > r )

pure virtual

Possibly start the audition of a region. If

Parameters

r	is 0, or not an AudioRegion any current audition is cancelled. If we are currently auditioning
r,the	audition will be cancelled. Otherwise an audition of
r	will start.
r	Region to consider.

Implemented in Editor.

virtual void PublicEditor::copy_playlists ( TimeAxisView * )

pure virtual

Implemented in Editor.

virtual Editing::MouseMode PublicEditor::current_mouse_mode ( ) const

pure virtual

Returns: The current mouse mode (gain, object, range, timefx etc.) (defined in editing_syms.h)

Implemented in Editor.

virtual framecnt_t PublicEditor::current_page_samples ( ) const

pure virtual

Implemented in Editor.

virtual MouseCursors const* PublicEditor::cursors ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::deselect_all ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::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 >()`
	)

pure virtual

Implemented in Editor.

virtual void PublicEditor::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 >()`
	)

pure virtual

Import existing media

Implemented in Editor.

virtual bool PublicEditor::dragging_playhead ( ) const

pure virtual

Returns: true if the playhead is currently being dragged, otherwise false

Implemented in Editor.

virtual DragManager* PublicEditor::drags ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::edit_meter_section ( ARDOUR::MeterSection * )

pure virtual

Implemented in Editor.

virtual void PublicEditor::edit_notes ( MidiRegionView * )

pure virtual

Implemented in Editor.

virtual void PublicEditor::edit_tempo_section ( ARDOUR::TempoSection * )

pure virtual

Implemented in Editor.

virtual Editing::MouseMode PublicEditor::effective_mouse_mode ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::embed_audio_from_video	(	std::string	,
		framepos_t	n = `0`,
		bool	lock_position_to_video = `true`
	)

pure virtual

Implemented in Editor.

virtual void PublicEditor::ensure_float ( Gtk::Window & )

pure virtual

Implemented in Editor.

virtual void PublicEditor::ensure_time_axis_view_is_visible	(	TimeAxisView const &	tav,
		bool	at_top = `false`
	)

pure virtual

Implemented in Editor.

virtual void PublicEditor::export_audio ( )

pure virtual

Open main export dialog

Implemented in Editor.

virtual void PublicEditor::export_range ( )

pure virtual

Open export dialog with current range pre-selected

Implemented in Editor.

virtual void PublicEditor::export_selection ( )

pure virtual

Open export dialog with current selection pre-selected

Implemented in Editor.

virtual bool PublicEditor::extend_selection_to_track ( TimeAxisView & )

pure virtual

Implemented in Editor.

virtual ARDOUR::Location* PublicEditor::find_location_from_marker	(	Marker *	,
		bool &
	)		const

pure virtual

Implemented in Editor.

virtual Marker* PublicEditor::find_marker_from_location_id	(	PBD::ID const &	,
		bool
	)		const

pure virtual

Implemented in Editor.

virtual void PublicEditor::finish_cleanup ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::first_idle ( )

pure virtual

Implemented in Editor.

virtual bool PublicEditor::follow_playhead ( ) const

pure virtual

Returns: true if the editor is following the playhead

Implemented in Editor.

virtual void PublicEditor::foreach_time_axis_view ( sigc::slot< void, TimeAxisView & > )

pure virtual

Implemented in Editor.

virtual framecnt_t PublicEditor::get_current_zoom ( ) const

pure virtual

Implemented in Editor.

virtual ArdourCanvas::ScrollGroup* PublicEditor::get_cursor_scroll_group ( ) const

pure virtual

Implemented in Editor.

virtual Selection& PublicEditor::get_cut_buffer ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::get_equivalent_regions	(	RegionView *	rv,
		std::vector< RegionView * > &	,
		PBD::PropertyID
	)		const

pure virtual

Implemented in Editor.

virtual unsigned PublicEditor::get_grid_beat_divisions ( framepos_t position )

pure virtual

Implemented in Editor.

virtual Evoral::Beats PublicEditor::get_grid_type_as_beats	(	bool &	success,
		framepos_t	position
	)

pure virtual

Implemented in Editor.

virtual ArdourCanvas::ScrollGroup* PublicEditor::get_hscroll_group ( ) const

pure virtual

Implemented in Editor.

virtual ArdourCanvas::ScrollGroup* PublicEditor::get_hvscroll_group ( ) const

pure virtual

Implemented in Editor.

virtual framecnt_t PublicEditor::get_nudge_distance	(	framepos_t	pos,
		framecnt_t &	next
	)

pure virtual

Implemented in Editor.

virtual framecnt_t PublicEditor::get_paste_offset	(	framepos_t	pos,
		unsigned	paste_count,
		framecnt_t	duration
	)

pure virtual

Implemented in Editor.

virtual void PublicEditor::get_per_region_note_selection ( std::list< std::pair< PBD::ID, std::set< boost::shared_ptr< Evoral::Note< Evoral::Beats > > > > > & ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::get_pointer_position	(	double &	,
		double &
	)		const

pure virtual

Implemented in Editor.

virtual framepos_t PublicEditor::get_preferred_edit_position	(	Editing::EditIgnoreOption	= `Editing::EDIT_IGNORE_NONE`,
		bool	from_context_menu = `false`,
		bool	from_outside_canvas = `false`
	)

pure virtual

Implemented in Editor.

virtual void PublicEditor::get_regions_at	(	RegionSelection &	,
		framepos_t	where,
		TrackViewList const &
	)		const

pure virtual

Implemented in Editor.

virtual RegionSelection PublicEditor::get_regions_from_selection_and_mouse ( framepos_t )

pure virtual

Implemented in Editor.

virtual void PublicEditor::get_regionviews_by_id	(	PBD::ID const	id,
		RegionSelection &	regions
	)		const

pure virtual

Implemented in Editor.

virtual RouteTimeAxisView* PublicEditor::get_route_view_by_route_id ( const PBD::ID & id ) const

pure virtual

Implemented in Editor.

virtual Selection& PublicEditor::get_selection ( ) const

pure virtual

Implemented in Editor.

virtual bool PublicEditor::get_smart_mode ( ) const

pure virtual

Implemented in Editor.

virtual ArdourCanvas::GtkCanvasViewport* PublicEditor::get_track_canvas ( ) const

pure virtual

Implemented in Editor.

virtual TrackViewList const& PublicEditor::get_track_views ( )

pure virtual

Implemented in Editor.

virtual ArdourCanvas::Container* PublicEditor::get_trackview_group ( ) const

pure virtual

Implemented in Editor.

virtual int PublicEditor::get_videotl_bar_height ( ) const

pure virtual

Implemented in Editor.

virtual double PublicEditor::get_y_origin ( ) const

pure virtual

Implemented in Editor.

virtual Editing::ZoomFocus PublicEditor::get_zoom_focus ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::goto_nth_marker ( int nth )

pure virtual

Implemented in Editor.

virtual bool PublicEditor::have_idled ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::hide_track_in_display	(	TimeAxisView *	tv,
		bool	apply_to_selection = `false`
	)

pure virtual

Implemented in Editor.

static PublicEditor& PublicEditor::instance ( )

inlinestatic

Returns: Singleton PublicEditor instance

Definition at line 111 of file public_editor.h.

virtual bool PublicEditor::internal_editing ( ) const

pure virtual

Returns: Whether the current mouse mode is an "internal" editing mode.

Implemented in Editor.

virtual framepos_t PublicEditor::leftmost_sample ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::maximise_editing_space ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::maybe_autoscroll	(	bool	,
		bool	,
		bool	from_headers
	)

pure virtual

Implemented in Editor.

virtual void PublicEditor::maybe_locate_with_edit_preroll ( framepos_t location )

pure virtual

Implemented in Editor.

virtual void PublicEditor::mouse_add_new_marker	(	framepos_t	where,
		bool	is_cd = `false`
	)

pure virtual

Implemented in Editor.

virtual void PublicEditor::mouse_add_new_meter_event ( framepos_t where )

pure virtual

Implemented in Editor.

virtual void PublicEditor::mouse_add_new_tempo_event ( framepos_t where )

pure virtual

Implemented in Editor.

virtual Gtkmm2ext::TearOff* PublicEditor::mouse_mode_tearoff ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::new_playlists ( TimeAxisView * )

pure virtual

Implemented in Editor.

virtual void PublicEditor::new_region_from_selection ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::override_visible_track_count ( )

pure virtual

Implemented in Editor.

virtual framepos_t PublicEditor::pixel_to_sample ( double pixel ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::play_selection ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::play_with_preroll ( )

pure virtual

Implemented in Editor.

virtual PlaylistSelector& PublicEditor::playlist_selector ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::prepare_for_cleanup ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::queue_visual_videotimeline_update ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::reattach_all_tearoffs ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::redo ( uint32_t n = 1 )

pure virtual

Redo some transactions.

Parameters

n	Number of transaction to redo.

Implemented in Editor.

virtual void PublicEditor::register_actions ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::remove_last_capture ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::remove_location_at_playhead_cursor ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::remove_tracks ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::reset_focus ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::reset_x_origin ( framepos_t frame )

pure virtual

Implemented in Editor.

virtual void PublicEditor::reset_y_origin ( double pos )

pure virtual

Implemented in Editor.

virtual void PublicEditor::reset_zoom ( framecnt_t )

pure virtual

Implemented in Editor.

virtual void PublicEditor::restore_editing_space ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::resume_route_redisplay ( )

protectedpure virtual

Implemented in Editor.

virtual double PublicEditor::sample_to_pixel ( framepos_t frame ) const

pure virtual

Implemented in Editor.

virtual double PublicEditor::sample_to_pixel_unrounded ( framepos_t frame ) const

pure virtual

Implemented in Editor.

virtual bool PublicEditor::scroll_down_one_track ( bool skip_child_views = false )

pure virtual

Implemented in Editor.

virtual void PublicEditor::scroll_tracks_down_line ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::scroll_tracks_up_line ( )

pure virtual

Implemented in Editor.

virtual bool PublicEditor::scroll_up_one_track ( bool skip_child_views = false )

pure virtual

Implemented in Editor.

virtual void PublicEditor::select_all_tracks ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::separate_region_from_selection ( )

pure virtual

Implemented in Editor.

virtual ARDOUR::Session* PublicEditor::session ( ) const

pure virtual

Returns: The Session that we are editing, or 0

Implemented in Editor.

virtual void PublicEditor::set_close_video_sensitive ( bool )

pure virtual

Implemented in Editor.

virtual void PublicEditor::set_current_movable ( boost::shared_ptr< ARDOUR::Movable > )

pure virtual

Implemented in Editor.

virtual void PublicEditor::set_current_trimmable ( boost::shared_ptr< ARDOUR::Trimmable > )

pure virtual

Implemented in Editor.

virtual void PublicEditor::set_follow_playhead	(	bool	yn,
		bool	catch_up = `false`
	)

pure virtual

Set whether the editor should follow the playhead.

Parameters

yn	true to follow playhead, otherwise false.
catch_up	true to reset the editor view to show the playhead (if yn == true), otherwise false.

Implemented in Editor.

virtual void PublicEditor::set_mouse_mode	(	Editing::MouseMode	m,
		bool	force = `false`
	)

pure virtual

Set the mouse mode (gain, object, range, timefx etc.)

Parameters

m	Mouse mode (defined in editing_syms.h)
force	Perform the effects of the change even if no change is required (ie even if the current mouse mode is equal to
m)

Implemented in Editor.

virtual void PublicEditor::set_selected_mixer_strip ( TimeAxisView & )

pure virtual

Implemented in Editor.

virtual void PublicEditor::set_selected_track	(	TimeAxisView &	,
		Selection::Operation	op = `Selection::Set`,
		bool	no_remove = `false`
	)

pure virtual

Implemented in Editor.

virtual void PublicEditor::set_session ( ARDOUR::Session * s )

pure virtual

Attach this editor to a Session.

Parameters

s	Session to connect to.

Implemented in Editor.

virtual void PublicEditor::set_show_measures ( bool yn )

pure virtual

Implemented in Editor.

virtual void PublicEditor::set_snap_mode ( Editing::SnapMode m )

pure virtual

Set the snap mode.

Parameters

m	Snap mode (defined in editing_syms.h)

Implemented in Editor.

virtual void PublicEditor::set_snap_threshold ( double t )

pure virtual

Set the snap threshold.

Parameters

t	Snap threshold in `units'.

Implemented in Editor.

virtual void PublicEditor::set_snap_to ( Editing::SnapType t )

pure virtual

Set the snap type.

Parameters

t	Snap type (defined in editing_syms.h)

Implemented in Editor.

virtual void PublicEditor::set_stationary_playhead ( bool yn )

pure virtual

Implemented in Editor.

virtual void PublicEditor::set_video_timeline_height ( const int h )

pure virtual

Implemented in Editor.

virtual void PublicEditor::set_xjadeo_sensitive ( bool onoff )

pure virtual

Implemented in Editor.

virtual void PublicEditor::set_zoom_focus ( Editing::ZoomFocus )

pure virtual

Implemented in Editor.

virtual void PublicEditor::setup_tooltips ( )

pure virtual

Implemented in Editor.

virtual bool PublicEditor::show_measures ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::show_window ( )

pure virtual

Implemented in Editor.

virtual Editing::SnapMode PublicEditor::snap_mode ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::snap_to	(	framepos_t &	first,
		ARDOUR::RoundMode	direction = `ARDOUR::RoundNearest`,
		bool	for_mark = `false`
	)

pure virtual

Snap a value according to the current snap setting.

Implemented in Editor.

virtual void PublicEditor::snap_to_with_modifier	(	framepos_t &	first,
		GdkEvent const *	ev,
		ARDOUR::RoundMode	direction = `ARDOUR::RoundNearest`,
		bool	for_mark = `false`
	)

pure virtual

Implemented in Editor.

virtual Editing::SnapType PublicEditor::snap_type ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::split_region_at_points	(	boost::shared_ptr< ARDOUR::Region >	,
		ARDOUR::AnalysisFeatureList &	,
		bool	can_ferret,
		bool	select_new = `false`
	)

pure virtual

Implemented in Editor.

virtual void PublicEditor::split_regions_at	(	framepos_t	,
		RegionSelection &
	)

pure virtual

Implemented in Editor.

virtual bool PublicEditor::stationary_playhead ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::stem_export ( )

pure virtual

Open stem export dialog

Implemented in Editor.

virtual void PublicEditor::step_mouse_mode ( bool next )

pure virtual

Step the mouse mode onto the next or previous one.

Parameters

next	true to move to the next, otherwise move to the previous

Implemented in Editor.

virtual void PublicEditor::stop_canvas_autoscroll ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::suspend_route_redisplay ( )

protectedpure virtual

Implemented in Editor.

virtual void PublicEditor::temporal_zoom_step ( bool coarser )

pure virtual

Implemented in Editor.

virtual void PublicEditor::toggle_follow_playhead ( )

pure virtual

Toggle whether the editor is following the playhead

Implemented in Editor.

virtual void PublicEditor::toggle_meter_updating ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::toggle_ruler_video ( bool )

pure virtual

Implemented in Editor.

virtual void PublicEditor::toggle_stationary_playhead ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::toggle_xjadeo_proc ( int )

pure virtual

Implemented in Editor.

virtual void PublicEditor::toggle_xjadeo_viewoption	(	int	,
		int
	)

pure virtual

Implemented in Editor.

virtual Gtkmm2ext::TearOff* PublicEditor::tools_tearoff ( ) const

pure virtual

Implemented in Editor.

virtual void PublicEditor::track_mixer_selection ( )

pure virtual

Implemented in Editor.

virtual void PublicEditor::transition_to_rolling ( bool fwd )

pure virtual

Implemented in Editor.

virtual void PublicEditor::undo ( uint32_t n = 1 )

pure virtual

Undo some transactions.

Parameters

n	Number of transactions to undo.

Implemented in Editor.

virtual void PublicEditor::update_tearoff_visibility ( )

pure virtual

Implemented in Editor.

virtual VerboseCursor* PublicEditor::verbose_cursor ( ) const

pure virtual

Implemented in Editor.

virtual double PublicEditor::visible_canvas_height ( ) const

pure virtual

Implemented in Editor.

Friends And Related Function Documentation

bool ARDOUR_UI_UTILS::forward_key_press ( GdkEventKey * )

friend

bool ARDOUR_UI_UTILS::relay_key_press	(	GdkEventKey *	,
		Gtk::Window *
	)

friend

friend class DisplaySuspender

friend

Definition at line 438 of file public_editor.h.

Member Data Documentation

PublicEditor * PublicEditor::_instance = 0

static

Singleton instance, set up by Editor::Editor()

Definition at line 429 of file public_editor.h.

Glib::RefPtr<Gtk::ActionGroup> PublicEditor::_region_actions

Definition at line 320 of file public_editor.h.

gint PublicEditor::_suspend_route_redisplay_counter

protected

Definition at line 441 of file public_editor.h.

const int PublicEditor::container_border_width = 12

static

Definition at line 357 of file public_editor.h.

sigc::signal< void > PublicEditor::DropDownKeys

static

Definition at line 316 of file public_editor.h.

Glib::RefPtr<Gtk::ActionGroup> PublicEditor::editor_actions

Definition at line 318 of file public_editor.h.

Glib::RefPtr<Gtk::ActionGroup> PublicEditor::editor_menu_actions

Definition at line 319 of file public_editor.h.

const int PublicEditor::horizontal_spacing = 6

static

Definition at line 359 of file public_editor.h.

PBD::Signal0<void> PublicEditor::MouseModeChanged

Definition at line 435 of file public_editor.h.

sigc::signal<void> PublicEditor::Realized

Definition at line 313 of file public_editor.h.

PBD::Signal0<void> PublicEditor::SnapChanged

Definition at line 434 of file public_editor.h.

sigc::signal<void,framepos_t> PublicEditor::UpdateAllTransportClocks

Definition at line 314 of file public_editor.h.

const int PublicEditor::vertical_spacing = 6

static

Definition at line 358 of file public_editor.h.

const int PublicEditor::window_border_width = 12

static

Definition at line 356 of file public_editor.h.

sigc::signal<void> PublicEditor::ZoomChanged

Definition at line 312 of file public_editor.h.

The documentation for this class was generated from the following files:

/usr/local/music/src/ardour/4.0/gtk2_ardour/public_editor.h
/usr/local/music/src/ardour/4.0/gtk2_ardour/public_editor.cc

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation