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/presentation_info.h"
43 #include "ardour/region.h"
45 #include "evoral/Parameter.hpp"
47 #include "canvas/line.h"
50 #include "axis_view.h"
67 namespace ArdourCanvas {
74 class RegionSelection;
77 class TimeAxisViewItem;
87 /** Abstract base class for time-axis views (horizontal editor 'strips')
89 * This class provides the basic LHS controls and display methods. This should be
90 * extended to create functional time-axis based views.
92 class TimeAxisView : public virtual AxisView
95 enum NamePackingBits {
96 NameLabelPacked = 0x1,
101 TimeAxisView(ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
102 virtual ~TimeAxisView ();
104 static PBD::Signal1<void,TimeAxisView*> CatchDeletion;
106 static void setup_sizes ();
108 virtual boost::shared_ptr<ARDOUR::Stripable> stripable() const = 0;
109 virtual ARDOUR::PresentationInfo const & presentation_info () const = 0;
111 /** @return index of this TimeAxisView within its parent */
112 int order () const { return _order; }
114 /** @return maximum allowable value of order */
115 static int max_order () { return _max_order; }
117 ArdourCanvas::Container* canvas_display () { return _canvas_display; }
118 ArdourCanvas::Container* ghost_group () { return _ghost_group; }
120 /** @return effective height (taking children into account) in canvas units, or
121 0 if this TimeAxisView has not yet been shown */
122 uint32_t effective_height () const { return _effective_height; }
124 /** @return y position, or -1 if hidden */
125 double y_position () const { return _y_position; }
127 /** @return our Editor */
128 PublicEditor& editor () const { return _editor; }
130 uint32_t current_height() const { return height; }
132 void idle_resize (int32_t);
134 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
135 virtual void hide ();
137 bool touched (double top, double bot);
139 /** @return true if hidden, otherwise false */
140 bool hidden () const { return _hidden; }
142 void set_selected (bool);
143 virtual bool selectable() const { return true; }
146 * potential handler for entered events
149 virtual void entered () {}
150 virtual void exited () {}
152 enum TrackHeightMode {
158 virtual void set_height (uint32_t h, TrackHeightMode m = OnlySelf);
159 void set_height_enum (Height, bool apply_to_selection = false);
162 virtual void reset_visual_state ();
164 std::pair<TimeAxisView*, double> covers_y_position (double) const;
165 bool covered_by_y_range (double y0, double y1) const;
167 virtual void step_height (bool);
169 virtual ARDOUR::RouteGroup* route_group() const { return 0; }
170 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
172 virtual void set_samples_per_pixel (double);
173 virtual void show_selection (TimeSelection&);
174 virtual void hide_selection ();
175 virtual void reshow_selection (TimeSelection&);
176 virtual void show_timestretch (framepos_t start, framepos_t end, int layers, int layer);
177 virtual void hide_timestretch ();
179 /* editing operations */
181 virtual void cut_copy_clear (Selection&, Editing::CutCopyOp) {}
183 /** Paste a selection.
184 * @param pos Position to paste to (session frames).
185 * @param selection Selection to paste.
186 * @param ctx Paste context.
188 virtual bool paste (ARDOUR::framepos_t pos,
189 const Selection& selection,
190 PasteContext& ctx) { return false; }
192 virtual void set_selected_regionviews (RegionSelection&) {}
193 virtual void set_selected_points (PointSelection&) {}
195 virtual void fade_range (TimeSelection&) {}
197 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (framepos_t /*pos*/, ARDOUR::RegionPoint, int32_t /*dir*/) {
198 return boost::shared_ptr<ARDOUR::Region> ();
201 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
203 virtual void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&, bool within = false);
204 virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
206 void add_ghost (RegionView*);
207 void remove_ghost (RegionView*);
208 void erase_ghost (GhostRegion*);
210 /** called at load time when first GUI idle occurs. put
211 expensive data loading/redisplay code in here. */
212 virtual void first_idle () {}
214 TimeAxisView* get_parent () { return parent; }
215 void set_parent (TimeAxisView& p);
217 virtual LayerDisplay layer_display () const { return Overlaid; }
218 virtual StreamView* view () const { return 0; }
220 typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
221 Children get_child_list ();
223 SelectionRect* get_selection_rect(uint32_t id);
225 static uint32_t preset_height (Height);
228 static Glib::RefPtr<Gtk::SizeGroup> controls_meters_size_group;
229 static Glib::RefPtr<Gtk::SizeGroup> midi_scroomer_size_group;
230 static unsigned int name_width_px;
231 /* The Standard LHS Controls */
232 Gtk::Table controls_table;
233 Glib::RefPtr<Gtk::SizeGroup> controls_button_size_group;
234 Gtk::EventBox controls_ebox;
235 Gtk::VBox controls_vbox;
236 Gtk::VBox time_axis_vbox;
237 Gtk::HBox time_axis_hbox;
238 Gtk::Frame time_axis_frame;
240 Gtk::Fixed scroomer_placeholder;
242 uint32_t height; /* in canvas units */
243 std::string controls_base_unselected_name;
244 std::string controls_base_selected_name;
245 Gtk::Menu* display_menu; /* The standard LHS Track control popup-menus */
246 TimeAxisView* parent;
247 ArdourCanvas::Container* selection_group;
248 ArdourCanvas::Container* _ghost_group;
249 std::list<GhostRegion*> ghosts;
250 std::list<SelectionRect*> free_selection_rects;
251 std::list<SelectionRect*> used_selection_rects;
254 Gtk::Menu* _size_menu;
255 ArdourCanvas::Line* _canvas_separator;
256 ArdourCanvas::Container* _canvas_display;
258 PublicEditor& _editor;
260 virtual bool can_edit_name() const;
262 void begin_name_edit ();
263 void end_name_edit (std::string, int);
265 /* derived classes can override these */
267 virtual bool name_entry_changed (std::string const&);
269 /** Handle mouse relaese on our LHS control name ebox.
271 *@ param ev the event
273 virtual bool controls_ebox_button_release (GdkEventButton*);
274 virtual bool controls_ebox_scroll (GdkEventScroll*);
275 virtual bool controls_ebox_button_press (GdkEventButton*);
276 virtual bool controls_ebox_motion (GdkEventMotion*);
277 virtual bool controls_ebox_leave (GdkEventCrossing*);
279 /** Display the standard LHS control menu at when.
281 * @param when the popup activation time
283 virtual void popup_display_menu (guint32 when);
285 /** Build the standard LHS control menu.
286 * Subclasses should extend this method to add their own menu options.
288 virtual void build_display_menu ();
290 /** Do whatever needs to be done to dynamically reset the LHS control menu.
292 virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
295 bool is_child (TimeAxisView*);
297 virtual void remove_child (boost::shared_ptr<TimeAxisView>);
298 void add_child (boost::shared_ptr<TimeAxisView>);
300 /* selection display */
302 virtual void selection_click (GdkEventButton*);
304 void color_handler ();
306 void conditionally_add_to_selection ();
308 void build_size_menu ();
311 Gtk::VBox* control_parent;
313 uint32_t _effective_height;
314 double _resize_drag_start;
316 GdkCursor* _preresize_cursor;
317 bool _have_preresize_cursor;
318 bool _ebox_release_can_act;
320 static uint32_t button_height;
321 static uint32_t extra_height;
322 static int const _max_order;
324 void compute_heights ();
325 bool maybe_set_cursor (int y);
327 }; /* class TimeAxisView */
329 #endif /* __ardour_gtk_time_axis_h__ */