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/frame.h>
28 #include <gtkmm/drawingarea.h>
29 #include <gtkmm/eventbox.h>
30 #include <gtkmm/table.h>
31 #include <gtkmm/entry.h>
32 #include <gtkmm/label.h>
34 #include <gtkmm2ext/focus_entry.h>
36 #include "pbd/stateful.h"
37 #include "pbd/signals.h"
39 #include "ardour/types.h"
40 #include "ardour/region.h"
41 #include "evoral/Parameter.hpp"
44 #include "axis_view.h"
62 class RegionSelection;
65 class TimeAxisViewItem;
72 /** Abstract base class for time-axis views (horizontal editor 'strips')
74 * This class provides the basic LHS controls and display methods. This should be
75 * extended to create functional time-axis based views.
77 class TimeAxisView : public virtual AxisView
80 enum NamePackingBits {
81 NameLabelPacked = 0x1,
87 TimeAxisView(ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
88 virtual ~TimeAxisView ();
90 static PBD::Signal1<void,TimeAxisView*> CatchDeletion;
92 /** @return index of this TimeAxisView within its parent */
93 int order () const { return _order; }
95 /** @return maximum allowable value of order */
96 static int max_order () { return _max_order; }
98 virtual void enter_internal_edit_mode () {}
99 virtual void leave_internal_edit_mode () {}
101 ArdourCanvas::Group* canvas_display () { return _canvas_display; }
102 ArdourCanvas::Group* canvas_background () { return _canvas_background; }
103 ArdourCanvas::Group* ghost_group () { return _ghost_group; }
105 /** @return effective height (taking children into account) in canvas units, or
106 0 if this TimeAxisView has not yet been shown */
107 uint32_t effective_height () const { return _effective_height; }
109 /** @return y position, or -1 if hidden */
110 double y_position () const { return _y_position; }
112 /** @return our Editor */
113 PublicEditor& editor () const { return _editor; }
115 uint32_t current_height() const { return height; }
117 void idle_resize (uint32_t);
119 void show_name_label ();
120 void show_name_entry ();
122 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
123 virtual void hide ();
125 void clip_to_viewport ();
127 bool touched (double top, double bot);
129 /** @return true if hidden, otherwise false */
130 bool hidden () const { return _hidden; }
132 void set_selected (bool);
135 * potential handler for entered events
138 virtual void entered () {}
139 virtual void exited () {}
141 virtual void set_height (uint32_t h);
142 void set_height_enum (Height, bool apply_to_selection = false);
145 virtual void reset_visual_state ();
147 std::pair<TimeAxisView*, double> covers_y_position (double);
149 virtual void step_height (bool);
151 virtual ARDOUR::RouteGroup* route_group() const { return 0; }
152 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
154 virtual void set_samples_per_unit (double);
155 virtual void show_selection (TimeSelection&);
156 virtual void hide_selection ();
157 virtual void reshow_selection (TimeSelection&);
158 virtual void show_timestretch (framepos_t start, framepos_t end, int layers, int layer);
159 virtual void hide_timestretch ();
161 /* editing operations */
163 virtual void cut_copy_clear (Selection&, Editing::CutCopyOp) {}
164 virtual bool paste (ARDOUR::framepos_t, float /*times*/, Selection&, size_t /*nth*/) { return false; }
166 virtual void set_selected_regionviews (RegionSelection&) {}
167 virtual void set_selected_points (PointSelection&) {}
169 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (framepos_t /*pos*/, ARDOUR::RegionPoint, int32_t /*dir*/) {
170 return boost::shared_ptr<ARDOUR::Region> ();
173 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
175 virtual void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&);
176 virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
178 void add_ghost (RegionView*);
179 void remove_ghost (RegionView*);
180 void erase_ghost (GhostRegion*);
182 /** called at load time when first GUI idle occurs. put
183 expensive data loading/redisplay code in here. */
184 virtual void first_idle () {}
186 TimeAxisView* get_parent () { return parent; }
187 void set_parent (TimeAxisView& p);
189 virtual LayerDisplay layer_display () const { return Overlaid; }
190 virtual StreamView* view () const { return 0; }
192 typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
193 Children get_child_list ();
195 SelectionRect* get_selection_rect(uint32_t id);
197 static uint32_t preset_height (Height);
200 /* The Standard LHS Controls */
201 Gtk::HBox controls_hbox;
202 Gtk::Table controls_table;
203 Gtk::EventBox controls_ebox;
204 Gtk::VBox controls_vbox;
205 Gtk::VBox time_axis_vbox;
207 Gtkmm2ext::FocusEntry* name_entry;
208 Gtk::Label name_label;
210 uint32_t height; /* in canvas units */
211 std::string controls_base_unselected_name;
212 std::string controls_base_selected_name;
213 Gtk::Menu* display_menu; /* The standard LHS Track control popup-menus */
214 TimeAxisView* parent;
215 ArdourCanvas::Group* selection_group;
216 std::list<GhostRegion*> ghosts;
217 std::list<SelectionRect*> free_selection_rects;
218 std::list<SelectionRect*> used_selection_rects;
221 Gtk::Menu* _size_menu;
222 ArdourCanvas::Group* _canvas_display;
224 PublicEditor& _editor;
226 virtual bool can_edit_name() const;
228 bool name_entry_button_press (GdkEventButton *ev);
229 bool name_entry_button_release (GdkEventButton *ev);
230 bool name_entry_key_release (GdkEventKey *ev);
231 void name_entry_activated ();
232 sigc::connection name_entry_key_timeout;
233 bool name_entry_key_timed_out ();
234 guint32 last_name_entry_key_press_event;
236 void begin_name_edit (GdkEvent*);
237 void end_name_edit (bool push_focus);
239 /* derived classes can override these */
241 virtual void name_entry_changed ();
242 virtual bool name_entry_focus_in (GdkEventFocus *ev);
243 virtual bool name_entry_focus_out (GdkEventFocus *ev);
245 /** Handle mouse relaese on our LHS control name ebox.
247 *@ param ev the event
249 virtual bool controls_ebox_button_release (GdkEventButton*);
250 virtual bool controls_ebox_scroll (GdkEventScroll*);
251 virtual bool controls_ebox_button_press (GdkEventButton*);
252 virtual bool controls_ebox_motion (GdkEventMotion*);
253 virtual bool controls_ebox_leave (GdkEventCrossing*);
255 /** Display the standard LHS control menu at when.
257 * @param when the popup activation time
259 virtual void popup_display_menu (guint32 when);
261 /** Build the standard LHS control menu.
262 * Subclasses should extend this method to add their own menu options.
264 virtual void build_display_menu ();
266 /** Do whatever needs to be done to dynamically reset the LHS control menu.
268 virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
271 bool is_child (TimeAxisView*);
273 virtual void remove_child (boost::shared_ptr<TimeAxisView>);
274 void add_child (boost::shared_ptr<TimeAxisView>);
276 /* selection display */
278 virtual void selection_click (GdkEventButton*);
280 void color_handler ();
282 void conditionally_add_to_selection ();
284 void build_size_menu ();
287 ArdourCanvas::Group* _canvas_background;
288 Gtk::VBox* control_parent;
290 uint32_t _effective_height;
291 double _resize_drag_start;
292 GdkCursor* _preresize_cursor;
293 bool _have_preresize_cursor;
294 ArdourCanvas::Group* _ghost_group;
295 bool _ebox_release_can_act;
297 static uint32_t button_height;
298 static uint32_t extra_height;
299 static int const _max_order;
301 void compute_heights ();
302 bool maybe_set_cursor (int y);
304 }; /* class TimeAxisView */
306 #endif /* __ardour_gtk_time_axis_h__ */