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"
60 namespace ArdourCanvas {
67 class RegionSelection;
70 class TimeAxisViewItem;
78 /** Abstract base class for time-axis views (horizontal editor 'strips')
80 * This class provides the basic LHS controls and display methods. This should be
81 * extended to create functional time-axis based views.
83 class TimeAxisView : public virtual AxisView
86 enum NamePackingBits {
87 NameLabelPacked = 0x1,
93 TimeAxisView(ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
94 virtual ~TimeAxisView ();
96 static PBD::Signal1<void,TimeAxisView*> CatchDeletion;
98 /** @return index of this TimeAxisView within its parent */
99 int order () const { return _order; }
101 /** @return maximum allowable value of order */
102 static int max_order () { return _max_order; }
104 virtual void enter_internal_edit_mode () {}
105 virtual void leave_internal_edit_mode () {}
107 ArdourCanvas::Container* canvas_display () { return _canvas_display; }
108 ArdourCanvas::Container* ghost_group () { return _ghost_group; }
110 /** @return effective height (taking children into account) in canvas units, or
111 0 if this TimeAxisView has not yet been shown */
112 uint32_t effective_height () const { return _effective_height; }
114 /** @return y position, or -1 if hidden */
115 double y_position () const { return _y_position; }
117 /** @return our Editor */
118 PublicEditor& editor () const { return _editor; }
120 uint32_t current_height() const { return height; }
122 void idle_resize (uint32_t);
124 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
125 virtual void hide ();
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) const;
148 bool covered_by_y_range (double y0, double y1) const;
150 virtual void step_height (bool);
152 virtual ARDOUR::RouteGroup* route_group() const { return 0; }
153 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
155 virtual void set_samples_per_pixel (double);
156 virtual void show_selection (TimeSelection&);
157 virtual void hide_selection ();
158 virtual void reshow_selection (TimeSelection&);
159 virtual void show_timestretch (framepos_t start, framepos_t end, int layers, int layer);
160 virtual void hide_timestretch ();
162 /* editing operations */
164 virtual void cut_copy_clear (Selection&, Editing::CutCopyOp) {}
165 virtual bool paste (ARDOUR::framepos_t, float /*times*/, Selection&, size_t /*nth*/) { return false; }
167 virtual void set_selected_regionviews (RegionSelection&) {}
168 virtual void set_selected_points (PointSelection&) {}
170 virtual void fade_range (TimeSelection&) {}
172 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (framepos_t /*pos*/, ARDOUR::RegionPoint, int32_t /*dir*/) {
173 return boost::shared_ptr<ARDOUR::Region> ();
176 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
178 virtual void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&);
179 virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
181 void add_ghost (RegionView*);
182 void remove_ghost (RegionView*);
183 void erase_ghost (GhostRegion*);
185 /** called at load time when first GUI idle occurs. put
186 expensive data loading/redisplay code in here. */
187 virtual void first_idle () {}
189 TimeAxisView* get_parent () { return parent; }
190 void set_parent (TimeAxisView& p);
192 virtual LayerDisplay layer_display () const { return Overlaid; }
193 virtual StreamView* view () const { return 0; }
195 typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
196 Children get_child_list ();
198 SelectionRect* get_selection_rect(uint32_t id);
200 static uint32_t preset_height (Height);
203 /* The Standard LHS Controls */
204 Gtk::HBox controls_hbox;
205 Gtk::Table controls_table;
206 Gtk::Table name_table;
207 Gtk::EventBox controls_ebox;
208 Gtk::VBox controls_vbox;
210 Gtk::VBox time_axis_vbox;
211 Gtk::Frame time_axis_frame;
214 Gtk::Label name_label;
216 uint32_t height; /* in canvas units */
217 std::string controls_base_unselected_name;
218 std::string controls_base_selected_name;
219 Gtk::Menu* display_menu; /* The standard LHS Track control popup-menus */
220 TimeAxisView* parent;
221 ArdourCanvas::Container* selection_group;
222 ArdourCanvas::Container* _ghost_group;
223 std::list<GhostRegion*> ghosts;
224 std::list<SelectionRect*> free_selection_rects;
225 std::list<SelectionRect*> used_selection_rects;
228 Gtk::Menu* _size_menu;
229 ArdourCanvas::Container* _canvas_display;
231 PublicEditor& _editor;
233 virtual bool can_edit_name() const;
235 bool name_entry_key_release (GdkEventKey *ev);
236 bool name_entry_key_press (GdkEventKey *ev);
237 bool name_entry_focus_out (GdkEventFocus *ev);
239 Gtk::Entry* name_entry;
240 void begin_name_edit ();
241 void end_name_edit (int);
243 /* derived classes can override these */
245 virtual void name_entry_changed ();
247 /** Handle mouse relaese on our LHS control name ebox.
249 *@ param ev the event
251 virtual bool controls_ebox_button_release (GdkEventButton*);
252 virtual bool controls_ebox_scroll (GdkEventScroll*);
253 virtual bool controls_ebox_button_press (GdkEventButton*);
254 virtual bool controls_ebox_motion (GdkEventMotion*);
255 virtual bool controls_ebox_leave (GdkEventCrossing*);
257 /** Display the standard LHS control menu at when.
259 * @param when the popup activation time
261 virtual void popup_display_menu (guint32 when);
263 /** Build the standard LHS control menu.
264 * Subclasses should extend this method to add their own menu options.
266 virtual void build_display_menu ();
268 /** Do whatever needs to be done to dynamically reset the LHS control menu.
270 virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
273 bool is_child (TimeAxisView*);
275 virtual void remove_child (boost::shared_ptr<TimeAxisView>);
276 void add_child (boost::shared_ptr<TimeAxisView>);
278 /* selection display */
280 virtual void selection_click (GdkEventButton*);
282 void color_handler ();
284 void conditionally_add_to_selection ();
286 void build_size_menu ();
289 Gtk::VBox* control_parent;
291 uint32_t _effective_height;
292 double _resize_drag_start;
293 GdkCursor* _preresize_cursor;
294 bool _have_preresize_cursor;
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__ */