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/scoped_connections.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, public PBD::Stateful
80 enum NamePackingBits {
81 NameLabelPacked = 0x1,
86 static uint32_t hLargest;
87 static uint32_t hLarge;
88 static uint32_t hLarger;
89 static uint32_t hNormal;
90 static uint32_t hSmaller;
91 static uint32_t hSmall;
93 TimeAxisView(ARDOUR::Session* sess, PublicEditor& ed, TimeAxisView* parent, ArdourCanvas::Canvas& canvas);
94 virtual ~TimeAxisView ();
96 XMLNode& get_state ();
97 int set_state (const XMLNode&, int version);
99 /** @return index of this TimeAxisView within its parent */
100 int order () const { return _order; }
102 /** @return maximum allowable value of order */
103 static int max_order () { return _max_order; }
105 ArdourCanvas::Group* canvas_display () { return _canvas_display; }
106 ArdourCanvas::Group* canvas_background () { return _canvas_background; }
107 ArdourCanvas::Group* ghost_group () { return _ghost_group; }
109 /** @return effective height (taking children into account) in canvas units, or
110 0 if this TimeAxisView has not yet been shown */
111 uint32_t effective_height () const { return _effective_height; }
113 /** @return y position, or -1 if hidden */
114 double y_position () const { return _y_position; }
116 /** @return our Editor */
117 PublicEditor& editor () const { return _editor; }
119 uint32_t current_height() const { return height; }
121 bool resizer_button_press (GdkEventButton*);
122 bool resizer_button_release (GdkEventButton*);
123 bool resizer_motion (GdkEventMotion*);
124 bool resizer_expose (GdkEventExpose*);
126 void idle_resize (uint32_t);
128 void hide_name_label ();
129 void hide_name_entry ();
130 void show_name_label ();
131 void show_name_entry ();
133 virtual guint32 show_at (double y, int& nth, Gtk::VBox *parent);
135 void clip_to_viewport ();
137 bool touched (double top, double bot);
139 /** Hide this TrackView */
140 virtual void hide ();
142 /** @return true if hidden, otherwise false */
143 bool hidden () const { return _hidden; }
145 virtual void set_selected (bool);
148 * potential handler for entered events
151 virtual void entered () {}
152 virtual void exited () {}
154 virtual void set_height (uint32_t h);
157 std::pair<TimeAxisView*, ARDOUR::layer_t> covers_y_position (double);
160 * Steps through the defined heights for this TrackView.
161 * Sets bigger to true to step up in size, set to fals eot step smaller.
163 * @param bigger true if stepping should increase in size, false otherwise
165 virtual void step_height (bool bigger);
167 virtual ARDOUR::RouteGroup* route_group() const { return 0; }
168 virtual boost::shared_ptr<ARDOUR::Playlist> playlist() const { return boost::shared_ptr<ARDOUR::Playlist> (); }
170 virtual void show_feature_lines (const ARDOUR::AnalysisFeatureList&);
171 virtual void hide_feature_lines ();
173 virtual void set_samples_per_unit (double);
174 virtual void show_selection (TimeSelection&);
175 virtual void hide_selection ();
176 virtual void reshow_selection (TimeSelection&);
177 virtual void show_timestretch (nframes_t start, nframes_t end);
178 virtual void hide_timestretch ();
180 virtual void hide_dependent_views (TimeAxisViewItem&) {}
181 virtual void reveal_dependent_views (TimeAxisViewItem&) {}
183 /* editing operations */
185 virtual bool cut_copy_clear (Selection&, Editing::CutCopyOp) { return false; }
186 virtual bool paste (nframes_t, float /*times*/, Selection&, size_t /*nth*/) { return false; }
188 virtual void set_selected_regionviews (RegionSelection&) {}
189 virtual void set_selected_points (PointSelection&) {}
191 virtual boost::shared_ptr<ARDOUR::Region> find_next_region (nframes_t /*pos*/, ARDOUR::RegionPoint, int32_t /*dir*/) {
192 return boost::shared_ptr<ARDOUR::Region> ();
195 void order_selection_trims (ArdourCanvas::Item *item, bool put_start_on_top);
197 virtual void get_selectables (nframes_t start, nframes_t end, double top, double bot, std::list<Selectable*>& results);
198 virtual void get_inverted_selectables (Selection&, std::list<Selectable *>& results);
200 void add_ghost (RegionView*);
201 void remove_ghost (RegionView*);
202 void erase_ghost (GhostRegion*);
204 /** called at load time when first GUI idle occurs. put
205 expensive data loading/redisplay code in here. */
206 virtual void first_idle () {}
208 TimeAxisView* get_parent () { return parent; }
209 void set_parent (TimeAxisView& p);
210 bool has_state () const;
212 /* call this on the parent */
214 virtual XMLNode* get_automation_child_xml_node (Evoral::Parameter /*param*/) { return 0; }
216 virtual LayerDisplay layer_display () const { return Overlaid; }
217 virtual StreamView* view () const { return 0; }
219 typedef std::vector<boost::shared_ptr<TimeAxisView> > Children;
222 /* The Standard LHS Controls */
223 Gtk::HBox controls_hbox;
224 Gtk::Table controls_table;
225 Gtk::EventBox controls_ebox;
226 Gtk::VBox controls_vbox;
227 Gtk::DrawingArea resizer;
228 Gtk::HBox resizer_box;
230 Gtk::Frame name_frame;
231 Gtkmm2ext::FocusEntry name_entry;
233 uint32_t height; /* in canvas units */
235 std::string controls_base_unselected_name;
236 std::string controls_base_selected_name;
238 bool name_entry_button_press (GdkEventButton *ev);
239 bool name_entry_button_release (GdkEventButton *ev);
240 bool name_entry_key_release (GdkEventKey *ev);
241 void name_entry_activated ();
242 sigc::connection name_entry_key_timeout;
243 bool name_entry_key_timed_out ();
244 guint32 last_name_entry_key_press_event;
246 /* derived classes can override these */
248 virtual void name_entry_changed ();
249 virtual bool name_entry_focus_in (GdkEventFocus *ev);
250 virtual bool name_entry_focus_out (GdkEventFocus *ev);
252 /** Handle mouse relaese on our LHS control name ebox.
254 *@ param ev the event
256 virtual bool controls_ebox_button_release (GdkEventButton *ev);
257 virtual bool controls_ebox_scroll (GdkEventScroll *ev);
259 /** Display the standard LHS control menu at when.
261 * @param when the popup activation time
263 virtual void popup_display_menu (guint32 when);
265 /** Build the standard LHS control menu.
266 * Subclasses should extend this method to add their own menu options.
268 virtual void build_display_menu ();
270 /** Do whatever needs to be done to dynamically reset the LHS control menu.
272 virtual bool handle_display_menu_map_event (GdkEventAny * /*ev*/) { return false; }
274 /** Build the standard LHS control size menu for the default heights options.
276 virtual void build_size_menu();
278 /** Displays the standard LHS controls size menu for the track heights
280 * @param when the popup activation time
282 void popup_size_menu(guint32 when);
284 /** Handle the size option of our main menu.
286 * @param ev the event
288 gint size_click(GdkEventButton *ev);
290 /* The standard LHS Track control popup-menus */
292 Gtk::Menu *display_menu;
293 Gtk::Menu *size_menu;
295 Gtk::Label name_label;
297 TimeAxisView* parent;
299 /** Find the parent with state */
300 TimeAxisView* get_parent_with_state();
303 bool is_child (TimeAxisView*);
305 void remove_child (boost::shared_ptr<TimeAxisView>);
306 void add_child (boost::shared_ptr<TimeAxisView>);
308 /* selection display */
310 ArdourCanvas::Group *selection_group;
312 std::list<GhostRegion*> ghosts;
314 std::list<SelectionRect*> free_selection_rects;
315 std::list<SelectionRect*> used_selection_rects;
317 SelectionRect* get_selection_rect(uint32_t id);
319 virtual void selection_click (GdkEventButton*);
324 NamePackingBits name_packing;
326 static void compute_controls_size_info ();
327 static bool need_size_info;
329 void set_heights (uint32_t h);
330 void color_handler ();
332 std::list<ArdourCanvas::SimpleLine*> feature_lines;
333 ARDOUR::AnalysisFeatureList analysis_features;
334 void reshow_feature_lines ();
336 void conditionally_add_to_selection ();
338 ArdourCanvas::Group* _canvas_display;
340 PublicEditor& _editor;
344 ArdourCanvas::Group* _canvas_background;
345 Gtk::VBox* control_parent;
347 uint32_t _effective_height;
348 double _resize_drag_start;
349 ArdourCanvas::Group* _ghost_group;
351 static int const _max_order;
353 }; /* class TimeAxisView */
355 #endif /* __ardour_gtk_time_axis_h__ */