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 "pbd/stateful.h"
37 #include "pbd/signals.h"
39 #include "evoral/Parameter.hpp"
41 #include "ardour/types.h"
42 #include "ardour/presentation_info.h"
43 #include "ardour/region.h"
45 #include "canvas/line.h"
47 #include "widgets/focus_entry.h"
49 #include "axis_view.h"
66 namespace ArdourCanvas {
73 class RegionSelection;
76 class TimeAxisViewItem;
86 /** Abstract base class for time-axis views (horizontal editor 'strips')
88 * This class provides the basic LHS controls and display methods. This should be
89 * extended to create functional time-axis based views.
91 class TimeAxisView : public virtual AxisView
94 enum NamePackingBits {
95 NameLabelPacked = 0x1,
100 TimeAxisView(ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
101 virtual ~TimeAxisView ();
103 static PBD::Signal1<void,TimeAxisView*> CatchDeletion;
105 static void setup_sizes ();
107 /** @return index of this TimeAxisView within its parent */
108 int order () const { return _order; }
110 /** @return maximum allowable value of order */
111 static int max_order () { return _max_order; }
113 ArdourCanvas::Container* canvas_display () { return _canvas_display; }
114 ArdourCanvas::Container* ghost_group () { return _ghost_group; }
116 /** @return effective height (taking children into account) in canvas units, or
117 0 if this TimeAxisView has not yet been shown */
118 uint32_t effective_height () const { return _effective_height; }
120 /** @return y position, or -1 if hidden */
121 double y_position () const { return _y_position; }
123 /** @return our Editor */
124 PublicEditor& editor () const { return _editor; }
126 uint32_t current_height() const { return height; }
128 void idle_resize (int32_t);
130 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
131 virtual void hide ();
133 bool touched (double top, double bot);
135 /** @return true if hidden, otherwise false */
136 bool hidden () const { return _hidden; }
138 void set_selected (bool);
140 virtual bool selectable() const { return true; }
143 * potential handler for entered events
146 virtual void entered () {}
147 virtual void exited () {}
149 enum TrackHeightMode {
155 virtual void set_height (uint32_t h, TrackHeightMode m = OnlySelf);
156 void set_height_enum (Height, bool apply_to_selection = false);
159 virtual void reset_visual_state ();
161 std::pair<TimeAxisView*, double> covers_y_position (double) const;
162 bool covered_by_y_range (double y0, double y1) const;
164 virtual void step_height (bool);
166 virtual ARDOUR::RouteGroup* route_group() const { return 0; }
167 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
169 virtual void set_samples_per_pixel (double);
170 virtual void show_selection (TimeSelection&);
171 virtual void hide_selection ();
172 virtual void reshow_selection (TimeSelection&);
173 virtual void show_timestretch (samplepos_t start, samplepos_t end, int layers, int layer);
174 virtual void hide_timestretch ();
176 /* editing operations */
178 virtual void cut_copy_clear (Selection&, Editing::CutCopyOp) {}
180 /** Paste a selection.
181 * @param pos Position to paste to (session samples).
182 * @param selection Selection to paste.
183 * @param ctx Paste context.
185 virtual bool paste (ARDOUR::samplepos_t pos,
186 const Selection& selection,
188 const int32_t sub_num) { return false; }
190 virtual void set_selected_regionviews (RegionSelection&) {}
191 virtual void set_selected_points (PointSelection&);
193 virtual void fade_range (TimeSelection&) {}
195 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (samplepos_t /*pos*/, ARDOUR::RegionPoint, int32_t /*dir*/) {
196 return boost::shared_ptr<ARDOUR::Region> ();
199 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
201 virtual void get_selectables (ARDOUR::samplepos_t, ARDOUR::samplepos_t, double, double, std::list<Selectable*>&, bool within = false);
202 virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
204 void add_ghost (RegionView*);
205 void remove_ghost (RegionView*);
206 void erase_ghost (GhostRegion*);
208 /** called at load time when first GUI idle occurs. put
209 expensive data loading/redisplay code in here. */
210 virtual void first_idle () {}
212 TimeAxisView* get_parent () { return parent; }
213 void set_parent (TimeAxisView& p);
215 virtual LayerDisplay layer_display () const { return Overlaid; }
216 virtual StreamView* view () const { return 0; }
218 typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
219 Children get_child_list () const;
221 static uint32_t preset_height (Height);
224 static Glib::RefPtr<Gtk::SizeGroup> controls_meters_size_group;
225 static Glib::RefPtr<Gtk::SizeGroup> midi_scroomer_size_group;
226 static unsigned int name_width_px;
227 /* The Standard LHS Controls */
228 Gtk::Table controls_table;
229 Glib::RefPtr<Gtk::SizeGroup> controls_button_size_group;
230 Gtk::EventBox controls_ebox;
231 Gtk::VBox controls_vbox;
232 Gtk::VBox time_axis_vbox;
233 Gtk::HBox time_axis_hbox;
234 Gtk::Frame time_axis_frame;
236 Gtk::Fixed scroomer_placeholder;
238 uint32_t height; /* in canvas units */
239 std::string controls_base_unselected_name;
240 std::string controls_base_selected_name;
241 Gtk::Menu* display_menu; /* The standard LHS Track control popup-menus */
242 TimeAxisView* parent;
243 ArdourCanvas::Container* selection_group;
244 ArdourCanvas::Container* _ghost_group;
245 std::list<GhostRegion*> ghosts;
246 std::list<SelectionRect*> free_selection_rects;
247 std::list<SelectionRect*> used_selection_rects;
250 Gtk::Menu* _size_menu;
251 ArdourCanvas::Line* _canvas_separator;
252 ArdourCanvas::Container* _canvas_display;
254 PublicEditor& _editor;
256 virtual bool can_edit_name() const;
258 void begin_name_edit ();
259 void end_name_edit (std::string, int);
260 virtual std::string name () const { return name_label.get_text (); }
262 /* derived classes can override these */
264 virtual bool name_entry_changed (std::string const&);
266 /** Handle mouse relaese on our LHS control name ebox.
268 *@ param ev the event
270 virtual bool controls_ebox_button_release (GdkEventButton*);
271 virtual bool controls_ebox_scroll (GdkEventScroll*);
272 virtual bool controls_ebox_button_press (GdkEventButton*);
273 virtual bool controls_ebox_motion (GdkEventMotion*);
274 virtual bool controls_ebox_leave (GdkEventCrossing*);
276 /** Display the standard LHS control menu at when.
278 * @param when the popup activation time
280 virtual void popup_display_menu (guint32 when);
282 /** Build the standard LHS control menu.
283 * Subclasses should extend this method to add their own menu options.
285 virtual void build_display_menu ();
287 /** Do whatever needs to be done to dynamically reset the LHS control menu.
289 virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
292 bool is_child (TimeAxisView*);
293 virtual bool propagate_time_selection () const { return false; }
295 virtual void remove_child (boost::shared_ptr<TimeAxisView>);
296 void add_child (boost::shared_ptr<TimeAxisView>);
298 /* selection display */
300 virtual void selection_click (GdkEventButton*);
302 void color_handler ();
304 void conditionally_add_to_selection ();
306 void build_size_menu ();
309 Gtk::VBox* control_parent;
311 uint32_t _effective_height;
312 double _resize_drag_start;
314 GdkCursor* _preresize_cursor;
315 bool _have_preresize_cursor;
316 bool _ebox_release_can_act;
318 static uint32_t button_height;
319 static uint32_t extra_height;
320 static int const _max_order;
322 SelectionRect* get_selection_rect(uint32_t id);
324 void compute_heights ();
325 bool maybe_set_cursor (int y);
327 }; /* class TimeAxisView */
329 #endif /* __ardour_gtk_time_axis_h__ */