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;
73 /** Abstract base class for time-axis views (horizontal editor 'strips')
75 * This class provides the basic LHS controls and display methods. This should be
76 * extended to create functional time-axis based views.
78 class TimeAxisView : public virtual AxisView
81 enum NamePackingBits {
82 NameLabelPacked = 0x1,
88 TimeAxisView(ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
89 virtual ~TimeAxisView ();
91 static PBD::Signal1<void,TimeAxisView*> CatchDeletion;
93 /** @return index of this TimeAxisView within its parent */
94 int order () const { return _order; }
96 /** @return maximum allowable value of order */
97 static int max_order () { return _max_order; }
99 virtual void enter_internal_edit_mode () {}
100 virtual void leave_internal_edit_mode () {}
102 ArdourCanvas::Group* canvas_display () { return _canvas_display; }
103 ArdourCanvas::Group* canvas_background () { return _canvas_background; }
104 ArdourCanvas::Group* ghost_group () { return _ghost_group; }
106 /** @return effective height (taking children into account) in canvas units, or
107 0 if this TimeAxisView has not yet been shown */
108 uint32_t effective_height () const { return _effective_height; }
110 /** @return y position, or -1 if hidden */
111 double y_position () const { return _y_position; }
113 /** @return our Editor */
114 PublicEditor& editor () const { return _editor; }
116 uint32_t current_height() const { return height; }
118 void idle_resize (uint32_t);
120 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
121 virtual void hide ();
123 void clip_to_viewport ();
125 bool touched (double top, double bot);
127 /** @return true if hidden, otherwise false */
128 bool hidden () const { return _hidden; }
130 void set_selected (bool);
133 * potential handler for entered events
136 virtual void entered () {}
137 virtual void exited () {}
139 virtual void set_height (uint32_t h);
140 void set_height_enum (Height, bool apply_to_selection = false);
143 virtual void reset_visual_state ();
145 std::pair<TimeAxisView*, double> covers_y_position (double);
147 virtual void step_height (bool);
149 virtual ARDOUR::RouteGroup* route_group() const { return 0; }
150 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
152 virtual void set_samples_per_unit (double);
153 virtual void show_selection (TimeSelection&);
154 virtual void hide_selection ();
155 virtual void reshow_selection (TimeSelection&);
156 virtual void show_timestretch (framepos_t start, framepos_t end, int layers, int layer);
157 virtual void hide_timestretch ();
159 /* editing operations */
161 virtual void cut_copy_clear (Selection&, Editing::CutCopyOp) {}
162 virtual bool paste (ARDOUR::framepos_t, float /*times*/, Selection&, size_t /*nth*/) { return false; }
164 virtual void set_selected_regionviews (RegionSelection&) {}
165 virtual void set_selected_points (PointSelection&) {}
167 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (framepos_t /*pos*/, ARDOUR::RegionPoint, int32_t /*dir*/) {
168 return boost::shared_ptr<ARDOUR::Region> ();
171 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
173 virtual void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&);
174 virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
176 void add_ghost (RegionView*);
177 void remove_ghost (RegionView*);
178 void erase_ghost (GhostRegion*);
180 /** called at load time when first GUI idle occurs. put
181 expensive data loading/redisplay code in here. */
182 virtual void first_idle () {}
184 TimeAxisView* get_parent () { return parent; }
185 void set_parent (TimeAxisView& p);
187 virtual LayerDisplay layer_display () const { return Overlaid; }
188 virtual StreamView* view () const { return 0; }
190 typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
191 Children get_child_list ();
193 SelectionRect* get_selection_rect(uint32_t id);
195 static uint32_t preset_height (Height);
198 /* The Standard LHS Controls */
199 Gtk::HBox controls_hbox;
200 Gtk::Table controls_table;
201 Gtk::EventBox controls_ebox;
202 Gtk::VBox controls_vbox;
203 Gtk::VBox time_axis_vbox;
205 Gtk::Label name_label;
207 uint32_t height; /* in canvas units */
208 std::string controls_base_unselected_name;
209 std::string controls_base_selected_name;
210 Gtk::Menu* display_menu; /* The standard LHS Track control popup-menus */
211 TimeAxisView* parent;
212 ArdourCanvas::Group* selection_group;
213 std::list<GhostRegion*> ghosts;
214 std::list<SelectionRect*> free_selection_rects;
215 std::list<SelectionRect*> used_selection_rects;
218 Gtk::Menu* _size_menu;
219 ArdourCanvas::Group* _canvas_display;
221 PublicEditor& _editor;
223 virtual bool can_edit_name() const;
225 bool name_entry_key_release (GdkEventKey *ev);
226 bool name_entry_key_press (GdkEventKey *ev);
227 bool name_entry_focus_out (GdkEventFocus *ev);
229 Gtk::Entry* name_entry;
230 void begin_name_edit ();
231 void end_name_edit (int);
233 /* derived classes can override these */
235 virtual void name_entry_changed ();
237 /** Handle mouse relaese on our LHS control name ebox.
239 *@ param ev the event
241 virtual bool controls_ebox_button_release (GdkEventButton*);
242 virtual bool controls_ebox_scroll (GdkEventScroll*);
243 virtual bool controls_ebox_button_press (GdkEventButton*);
244 virtual bool controls_ebox_motion (GdkEventMotion*);
245 virtual bool controls_ebox_leave (GdkEventCrossing*);
247 /** Display the standard LHS control menu at when.
249 * @param when the popup activation time
251 virtual void popup_display_menu (guint32 when);
253 /** Build the standard LHS control menu.
254 * Subclasses should extend this method to add their own menu options.
256 virtual void build_display_menu ();
258 /** Do whatever needs to be done to dynamically reset the LHS control menu.
260 virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
263 bool is_child (TimeAxisView*);
265 virtual void remove_child (boost::shared_ptr<TimeAxisView>);
266 void add_child (boost::shared_ptr<TimeAxisView>);
268 /* selection display */
270 virtual void selection_click (GdkEventButton*);
272 void color_handler ();
274 void conditionally_add_to_selection ();
276 void build_size_menu ();
279 ArdourCanvas::Group* _canvas_background;
280 Gtk::VBox* control_parent;
282 uint32_t _effective_height;
283 double _resize_drag_start;
284 GdkCursor* _preresize_cursor;
285 bool _have_preresize_cursor;
286 ArdourCanvas::Group* _ghost_group;
287 bool _ebox_release_can_act;
289 static uint32_t button_height;
290 static uint32_t extra_height;
291 static int const _max_order;
293 void compute_heights ();
294 bool maybe_set_cursor (int y);
296 }; /* class TimeAxisView */
298 #endif /* __ardour_gtk_time_axis_h__ */