2 Copyright (C) 2003 Paul Davis
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.
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.
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.
20 #ifndef __ardour_gtk_time_axis_h__
21 #define __ardour_gtk_time_axis_h__
26 #include <gtkmm/box.h>
27 #include <gtkmm/fixed.h>
28 #include <gtkmm/frame.h>
29 #include <gtkmm/drawingarea.h>
30 #include <gtkmm/eventbox.h>
31 #include <gtkmm/table.h>
32 #include <gtkmm/entry.h>
33 #include <gtkmm/label.h>
34 #include <gtkmm/sizegroup.h>
36 #include <gtkmm2ext/focus_entry.h>
38 #include "pbd/stateful.h"
39 #include "pbd/signals.h"
41 #include "ardour/types.h"
42 #include "ardour/region.h"
43 #include "evoral/Parameter.hpp"
45 #include "canvas/line.h"
48 #include "axis_view.h"
64 namespace ArdourCanvas {
71 class RegionSelection;
74 class TimeAxisViewItem;
84 /** Abstract base class for time-axis views (horizontal editor 'strips')
86 * This class provides the basic LHS controls and display methods. This should be
87 * extended to create functional time-axis based views.
89 class TimeAxisView : public virtual AxisView
92 enum NamePackingBits {
93 NameLabelPacked = 0x1,
98 TimeAxisView(ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
99 virtual ~TimeAxisView ();
101 static PBD::Signal1<void,TimeAxisView*> CatchDeletion;
103 static void setup_sizes ();
105 /** @return index of this TimeAxisView within its parent */
106 int order () const { return _order; }
108 /** @return maximum allowable value of order */
109 static int max_order () { return _max_order; }
111 ArdourCanvas::Container* canvas_display () { return _canvas_display; }
112 ArdourCanvas::Container* ghost_group () { return _ghost_group; }
114 /** @return effective height (taking children into account) in canvas units, or
115 0 if this TimeAxisView has not yet been shown */
116 uint32_t effective_height () const { return _effective_height; }
118 /** @return y position, or -1 if hidden */
119 double y_position () const { return _y_position; }
121 /** @return our Editor */
122 PublicEditor& editor () const { return _editor; }
124 uint32_t current_height() const { return height; }
126 void idle_resize (int32_t);
128 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
129 virtual void hide ();
131 bool touched (double top, double bot);
133 /** @return true if hidden, otherwise false */
134 bool hidden () const { return _hidden; }
136 void set_selected (bool);
139 * potential handler for entered events
142 virtual void entered () {}
143 virtual void exited () {}
145 enum TrackHeightMode {
151 virtual void set_height (uint32_t h, TrackHeightMode m = OnlySelf);
152 void set_height_enum (Height, bool apply_to_selection = false);
155 virtual void reset_visual_state ();
157 std::pair<TimeAxisView*, double> covers_y_position (double) const;
158 bool covered_by_y_range (double y0, double y1) const;
160 virtual void step_height (bool);
162 virtual ARDOUR::RouteGroup* route_group() const { return 0; }
163 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
165 virtual void set_samples_per_pixel (double);
166 virtual void show_selection (TimeSelection&);
167 virtual void hide_selection ();
168 virtual void reshow_selection (TimeSelection&);
169 virtual void show_timestretch (framepos_t start, framepos_t end, int layers, int layer);
170 virtual void hide_timestretch ();
172 /* editing operations */
174 virtual void cut_copy_clear (Selection&, Editing::CutCopyOp) {}
176 /** Paste a selection.
177 * @param pos Position to paste to (session frames).
178 * @param selection Selection to paste.
179 * @param ctx Paste context.
181 virtual bool paste (ARDOUR::framepos_t pos,
182 const Selection& selection,
183 PasteContext& ctx) { return false; }
185 virtual void set_selected_regionviews (RegionSelection&) {}
186 virtual void set_selected_points (PointSelection&) {}
188 virtual void fade_range (TimeSelection&) {}
190 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (framepos_t /*pos*/, ARDOUR::RegionPoint, int32_t /*dir*/) {
191 return boost::shared_ptr<ARDOUR::Region> ();
194 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
196 virtual void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&, bool within = false);
197 virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
199 void add_ghost (RegionView*);
200 void remove_ghost (RegionView*);
201 void erase_ghost (GhostRegion*);
203 /** called at load time when first GUI idle occurs. put
204 expensive data loading/redisplay code in here. */
205 virtual void first_idle () {}
207 TimeAxisView* get_parent () { return parent; }
208 void set_parent (TimeAxisView& p);
210 virtual LayerDisplay layer_display () const { return Overlaid; }
211 virtual StreamView* view () const { return 0; }
213 typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
214 Children get_child_list ();
216 SelectionRect* get_selection_rect(uint32_t id);
218 static uint32_t preset_height (Height);
221 static Glib::RefPtr<Gtk::SizeGroup> controls_meters_size_group;
222 static Glib::RefPtr<Gtk::SizeGroup> midi_scroomer_size_group;
223 static unsigned int name_width_px;
224 /* The Standard LHS Controls */
225 Gtk::Table controls_table;
226 Glib::RefPtr<Gtk::SizeGroup> controls_button_size_group;
227 Gtk::EventBox controls_ebox;
228 Gtk::VBox controls_vbox;
229 Gtk::VBox time_axis_vbox;
230 Gtk::HBox time_axis_hbox;
231 Gtk::Frame time_axis_frame;
234 Gtk::Label name_label;
235 Gtk::Fixed scroomer_placeholder;
237 uint32_t height; /* in canvas units */
238 std::string controls_base_unselected_name;
239 std::string controls_base_selected_name;
240 Gtk::Menu* display_menu; /* The standard LHS Track control popup-menus */
241 TimeAxisView* parent;
242 ArdourCanvas::Container* selection_group;
243 ArdourCanvas::Container* _ghost_group;
244 std::list<GhostRegion*> ghosts;
245 std::list<SelectionRect*> free_selection_rects;
246 std::list<SelectionRect*> used_selection_rects;
249 Gtk::Menu* _size_menu;
250 ArdourCanvas::Line* _canvas_separator;
251 ArdourCanvas::Container* _canvas_display;
253 PublicEditor& _editor;
255 virtual bool can_edit_name() const;
257 bool name_entry_key_release (GdkEventKey *ev);
258 bool name_entry_key_press (GdkEventKey *ev);
259 bool name_entry_focus_out (GdkEventFocus *ev);
261 Gtk::Entry* name_entry;
262 bool ending_name_edit;
263 void begin_name_edit ();
264 void end_name_edit (int);
266 /* derived classes can override these */
268 virtual void name_entry_changed ();
270 /** Handle mouse relaese on our LHS control name ebox.
272 *@ param ev the event
274 virtual bool controls_ebox_button_release (GdkEventButton*);
275 virtual bool controls_ebox_scroll (GdkEventScroll*);
276 virtual bool controls_ebox_button_press (GdkEventButton*);
277 virtual bool controls_ebox_motion (GdkEventMotion*);
278 virtual bool controls_ebox_leave (GdkEventCrossing*);
280 /** Display the standard LHS control menu at when.
282 * @param when the popup activation time
284 virtual void popup_display_menu (guint32 when);
286 /** Build the standard LHS control menu.
287 * Subclasses should extend this method to add their own menu options.
289 virtual void build_display_menu ();
291 /** Do whatever needs to be done to dynamically reset the LHS control menu.
293 virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
296 bool is_child (TimeAxisView*);
298 virtual void remove_child (boost::shared_ptr<TimeAxisView>);
299 void add_child (boost::shared_ptr<TimeAxisView>);
301 /* selection display */
303 virtual void selection_click (GdkEventButton*);
305 void color_handler ();
307 void conditionally_add_to_selection ();
309 void build_size_menu ();
312 Gtk::VBox* control_parent;
314 uint32_t _effective_height;
315 double _resize_drag_start;
317 GdkCursor* _preresize_cursor;
318 bool _have_preresize_cursor;
319 bool _ebox_release_can_act;
321 static uint32_t button_height;
322 static uint32_t extra_height;
323 static int const _max_order;
325 void compute_heights ();
326 bool maybe_set_cursor (int y);
328 }; /* class TimeAxisView */
330 #endif /* __ardour_gtk_time_axis_h__ */